MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
BondedSpecies.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 BondedSpecies_h
27 #define BondedSpecies_h
28 
30 #include "Math/ExtendedMath.h"
32 #include "../BaseSpecies.h"
33 
39 {
40 public:
43 
45  BondedSpecies();
46 
48  BondedSpecies(const BondedSpecies& s);
49 
52 
54  void read(std::istream& is);
55 
57  void write(std::ostream& os) const;
58 
60  std::string getBaseName() const;
61 
63  void mix(BondedSpecies* S, BondedSpecies* T);
64 
65 //setters and getters
67  void setBondDissipation(Mdouble disp);
68 
71 
73  void setBondForceMax(Mdouble new_f0);
74 
76  Mdouble getBondForceMax() const;
77 
78 private:
81 
84 };
85 
86 #endif
Mdouble getBondDissipation() const
Allows the spring constant to be accessed.
BondedSpecies contains the parameters used to describe a linear irreversible short-range force...
Definition: BondedSpecies.h:38
double Mdouble
Definition: GeneralDefine.h:34
void read(std::istream &is)
Reads the species properties from an input stream.
~BondedSpecies()
The default destructor.
void setBondForceMax(Mdouble new_f0)
Allows bondForceMax_ to be changed.
void setBondDissipation(Mdouble disp)
Allows the spring constant to be changed.
Mdouble bondDissipation_
dissipation in bond
Definition: BondedSpecies.h:80
BondedSpecies()
The default constructor.
Mdouble bondForceMax_
adhesion force at zero overlap
Definition: BondedSpecies.h:83
void mix(BondedSpecies *S, BondedSpecies *T)
creates default values for mixed species
std::string getBaseName() const
Used in Species::getName to obtain a unique name for each Species.
void write(std::ostream &os) const
Writes the species properties to an output stream.
Mdouble getBondForceMax() const
Allows bondForceMax_ to be accessed.
BondedInteraction InteractionType
The correct Interaction type for this AdhesiveForceSpecies.
Definition: BondedSpecies.h:42