MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ReversibleAdhesiveSpecies.h
Go to the documentation of this file.
1 //Copyright (c) 2013-2020, The MercuryDPM Developers Team. All rights reserved.
2 //For the list of developers, see <http://www.MercuryDPM.org/Team>.
3 //
4 //Redistribution and use in source and binary forms, with or without
5 //modification, are permitted provided that the following conditions are met:
6 // * Redistributions of source code must retain the above copyright
7 // notice, this list of conditions and the following disclaimer.
8 // * Redistributions in binary form must reproduce the above copyright
9 // notice, this list of conditions and the following disclaimer in the
10 // documentation and/or other materials provided with the distribution.
11 // * Neither the name MercuryDPM nor the
12 // names of its contributors may be used to endorse or promote products
13 // derived from this software without specific prior written permission.
14 //
15 //THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
16 //ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17 //WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 //DISCLAIMED. IN NO EVENT SHALL THE MERCURYDPM DEVELOPERS TEAM BE LIABLE FOR ANY
19 //DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 //(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 //LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22 //ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 //(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24 //SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 
26 #ifndef LINEARREVERSIBLEADHESIVESPECIES_H
27 #define LINEARREVERSIBLEADHESIVESPECIES_H
28 
30 #include "Math/ExtendedMath.h"
32 
38 {
39 public:
42 
45 
48 
51 
53  void read(std::istream& is);
54 
56  void write(std::ostream& os) const;
57 
59  std::string getBaseName() const;
60 
63 
64 //adhesion-specific functions
65 
68 
69 //setters and getters
71  void setAdhesionStiffness(Mdouble new_k0);
72 
75 
77  void setAdhesionForceMax(Mdouble new_f0);
78 
81 
82 private:
85 
88 };
89 
90 #endif
ReversibleAdhesiveSpecies()
The default constructor.
double Mdouble
Definition: GeneralDefine.h:34
Mdouble getAdhesionForceMax() const
Allows the spring constant to be accessed.
void setAdhesionStiffness(Mdouble new_k0)
Allows the spring constant to be changed.
ReversibleAdhesiveSpecies contains the parameters used to describe a linear reversible short-range fo...
void setInteractionDistance()
returns the largest separation distance at which adhesive short-range forces can occur.
ReversibleAdhesiveInteraction InteractionType
The correct Interaction type for this AdhesiveForceSpecies.
Mdouble adhesionStiffness_
stiffness of linear adhesion force
~ReversibleAdhesiveSpecies()
The default constructor.
Mdouble adhesionForceMax_
adhesion force at zero overlap
void read(std::istream &is)
Reads the species properties from an input stream.
Mdouble getAdhesionStiffness() const
Allows the spring constant to be accessed.
void mix(ReversibleAdhesiveSpecies *S, ReversibleAdhesiveSpecies *T)
creates default values for mixed species
void write(std::ostream &os) const
Writes the species properties to an output stream.
std::string getBaseName() const
Used in Species::getName to obtain a unique name for each Species.
void setAdhesionForceMax(Mdouble new_f0)
Allows the spring constant to be changed.