MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ChargedBondedSpecies.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 ChargedBondedSpecies_H
27 #define ChargedBondedSpecies_H
28 
30 #include "Math/ExtendedMath.h"
32 
38 {
39 public:
42 
45 
48 
50  ~ChargedBondedSpecies() = default;
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  //function to allows the charge of a particle to be easily accessed
83  int getCharge() const;
84 
85  //allows the user to set the charge possessed by a particle species
86  void setCharge(int newCharge);
87 
88 //*********************************************************************************************************************
89 //******************************ADDING ADDITIONAL FUNCTIONS FOR BOND INTERACTIONS**************************************
90 //*********************************************************************************************************************
91 
94  void setBondForceMax(Mdouble new_f0);
95 
97  Mdouble getBondForceMax() const;
98 
100  void setBondDissipation(Mdouble disp);
101 
103  Mdouble getBondDissipation() const;
104 
105 private:
108 
111 
112  //creating a simple integer flag to denote whether a particle is charged or not
113  //the boolean will be 0 if the particle has no charge, 1 if positively charged
114  //and -1 if negatively charged
115  int charge_;
116 
117 //*********************************************************************************************************************
118 //******************************ADDING ADDITIONAL VARIABLES FOR BOND INTERACTIONS**************************************
119 //*********************************************************************************************************************
120 
123 
127 
128 
129 //*********************************************************************************************************************
130 //****************************ADDING ADDITIONAL VARIABLES VAN DER WAALS INTERACTIONS***********************************
131 //*********************************************************************************************************************
132  //Adding parameters to recreate a highly simplified (but relatively computationally efficient!)
133  // van der Waals-like force at short distances
134 
135  //The maximal strength of the van der Waals force.
136  //Note that this should, by definition, be great enough to overcome the maximal repulsive force experienced by
137  //a particle, as the net force must be attractive in order to correctly represent vand der Waals
139 
140  //The stiffness used to determine the 'reach' of the van der Waals force applied to particles.
142 
143 public:
144  //Declaring the relevant get and set functions for the van der Waals stiffness and maximal force
146 
148 
150 
152 
153 
154 };
155 
156 #endif
Mdouble adhesionForceMax_
adhesion force at zero overlap
Mdouble getVanDerWaalsForceMax() const
void setAdhesionForceMax(Mdouble new_f0)
Allows the spring constant to be changed.
double Mdouble
Definition: GeneralDefine.h:34
void setBondForceMax(Mdouble new_f0)
Allows the spring constant for the BOND to be changed (Do not confuse with the charged interaction st...
ChargedBondedInteraction InteractionType
The correct Interaction type for this AdhesiveForceSpecies.
Mdouble getAdhesionForceMax() const
Allows the spring constant to be accessed.
void read(std::istream &is)
Reads the species properties from an input stream.
std::string getBaseName() const
Used in Species::getName to obtain a unique name for each Species.
ChargedBondedSpecies contains the parameters used to describe a linear reversible short-range force...
Mdouble getBondDissipation() const
Allows the additional dissipation used to damp oscillations between bondd particles to be accessed...
void setBondDissipation(Mdouble disp)
Allows the additional dissipation used to damp oscillations between bondd particles to be changed...
Mdouble getVanDerWaalsStiffness() const
void setVanDerWaalsForceMax(Mdouble)
Mdouble bondForceMax_
The maximal force which acts to bind together particles which are "bondd" into a single body...
void setVanDerWaalsStiffness(Mdouble)
~ChargedBondedSpecies()=default
The default constructor.
Mdouble getAdhesionStiffness() const
Allows the spring constant to be accessed.
Mdouble bondDissipation_
dissipation in bond
void setCharge(int newCharge)
void setInteractionDistance()
returns the largest separation distance at which adhesive short-range forces can occur.
void setAdhesionStiffness(Mdouble new_k0)
Allows the spring constant to be changed.
ChargedBondedSpecies()
The default constructor.
Mdouble getBondForceMax() const
Allows the maximal force for 'bonding' particles together to be accessed.
void mix(ChargedBondedSpecies *S, ChargedBondedSpecies *T)
creates default values for mixed species
void write(std::ostream &os) const
Writes the species properties to an output stream.
Mdouble adhesionStiffness_
stiffness of linear adhesion force