MercuryDPM  Beta
 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-2014, 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 #include "Species/BaseSpecies.h"
29 #include "Math/ExtendedMath.h"
31 
36 class ReversibleAdhesiveSpecies : public virtual BaseSpecies
37 {
38 public:
41 
44 
47 
50 
52  void read(std::istream& is);
53 
55  void write(std::ostream& os) const;
56 
58  std::string getBaseName() const;
59 
62 
63 //adhesion-specific functions
64 
67 
68 //setters and getters
70  void setAdhesionStiffness(Mdouble new_k0);
71 
74 
76  void setAdhesionForceMax(Mdouble new_f0);
77 
80 
81 private:
84 
87 };
88 #endif
ReversibleAdhesiveSpecies()
The default constructor.
BaseSpecies is the class from which all other species are derived.
Definition: BaseSpecies.h:44
Mdouble getAdhesionForceMax() const
Allows the spring constant to be accessed.
void setAdhesionStiffness(Mdouble new_k0)
Allows the spring constant to be changed.
double Mdouble
ReversibleAdhesiveSpecies contains the parameters used to describe a linear reversible short-range fo...
ReversibleAdhesiveInteraction InteractionType
The correct Interaction type for this AdhesiveForceSpecies.
Mdouble getInteractionDistance() const
returns the largest separation distance at which adhesive short-range forces can occur.
Mdouble adhesionStiffness_
stiffness of linear adhesion force
virtual ~ReversibleAdhesiveSpecies()
The default constructor.
void mix(ReversibleAdhesiveSpecies *const S, ReversibleAdhesiveSpecies *const T)
creates default values for mixed species
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 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.