revision: v0.14
LinearPlasticViscoelasticNormalSpecies.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 LinearPlasticViscoelasticNormalSpecies_H
27 #define LinearPlasticViscoelasticNormalSpecies_H
28 
30 #include "Math/ExtendedMath.h"
33 #include "Math/Helpers.h"
34 
35 
41 {
42 public:
45 
48 
51 
54 
56  void read(std::istream& is);
57 
59  void write(std::ostream& os) const;
60 
62  std::string getBaseName() const;
63 
64 // Species-specific functions
65 
68 
73 
76 
78  void setRestitutionCoefficient(double eps, Mdouble mass);
79 
83  Mdouble getCollisionTime(Mdouble mass) const;
84 
87 
88 //setters and getters
89 
93  void setPlasticParameters(Mdouble loadingStiffness, Mdouble unloadingStiffnessMax, Mdouble cohesionStiffness,
94  Mdouble penetrationDepthMax);
95 
100 
105 
110 
115 
119  void setLoadingStiffness(Mdouble loadingStiffness);
120 
124  void setUnloadingStiffnessMax(Mdouble unloadingStiffnessMax);
125 
129  void setCohesionStiffness(Mdouble cohesionStiffness);
130 
134  void setPenetrationDepthMax(Mdouble penetrationDepthMax);
135 
139  void setDissipation(Mdouble dissipation);
140 
145 
150 
154  Mdouble getDissipation() const;
155 
167  Mdouble computeBondNumberMax(Mdouble harmonicMeanRadius, Mdouble gravitationalAcceleration) const;
168 
170 
171  void setDoConstantUnloadingStiffness(bool doConstantUnloadingStiffness) {doConstantUnloadingStiffness_ = doConstantUnloadingStiffness;}
172 
173 private:
176 
179 
182 
185 
188 
189  //whether unloading stiffness is variable (Luding) or constant (WaltonBraun)
191 };
192 
193 #endif
mathsFunc::square
T square(const T val)
squares a number
Definition: ExtendedMath.h:106
SlidingFrictionSpecies.h
LinearPlasticViscoelasticNormalSpecies::~LinearPlasticViscoelasticNormalSpecies
~LinearPlasticViscoelasticNormalSpecies()
The default destructor.
Definition: LinearPlasticViscoelasticNormalSpecies.cc:67
constants::pi
const Mdouble pi
Definition: ExtendedMath.h:45
LinearPlasticViscoelasticNormalSpecies::getRestitutionCoefficient
Mdouble getRestitutionCoefficient(Mdouble mass) const
Calculates restitution coefficient for two copies of given disp, k, mass.
Definition: LinearPlasticViscoelasticNormalSpecies.cc:329
LinearPlasticViscoelasticNormalSpecies::setUnloadingStiffnessMax
void setUnloadingStiffnessMax(Mdouble unloadingStiffnessMax)
Sets the maximum unloading stiffness of the linear plastic-viscoelastic normal force.
Definition: LinearPlasticViscoelasticNormalSpecies.cc:190
LinearPlasticViscoelasticNormalSpecies::write
void write(std::ostream &os) const
Writes the species properties to an output stream.
Definition: LinearPlasticViscoelasticNormalSpecies.cc:77
constants::sqr_pi
const Mdouble sqr_pi
Definition: ExtendedMath.h:47
logger
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here.
LinearPlasticViscoelasticNormalSpecies::cohesionStiffness_
Mdouble cohesionStiffness_
the adhesive spring constant (k^c) for plastic deformations
Definition: LinearPlasticViscoelasticNormalSpecies.h:181
mathsFunc::exp
Mdouble exp(Mdouble Exponent)
Definition: ExtendedMath.cc:84
LinearPlasticViscoelasticNormalSpecies::getUnloadingStiffnessMax
Mdouble getUnloadingStiffnessMax() const
Returns the maximum unloading stiffness of the linear plastic-viscoelastic normal force.
Definition: LinearPlasticViscoelasticNormalSpecies.cc:158
LinearPlasticViscoelasticNormalSpecies::InteractionType
LinearPlasticViscoelasticInteraction InteractionType
The correct Interaction type for this FrictionForceSpecies.
Definition: LinearPlasticViscoelasticNormalSpecies.h:44
BaseNormalForce
Definition: BaseNormalForce.h:31
LinearPlasticViscoelasticNormalSpecies::getCollisionTime
Mdouble getCollisionTime(Mdouble mass) const
Calculates collision time for two copies of a particle of given disp, k, mass.
Definition: LinearPlasticViscoelasticNormalSpecies.cc:314
ParticleSpecies
Definition: ParticleSpecies.h:37
LinearPlasticViscoelasticNormalSpecies::setCollisionTimeAndRestitutionCoefficient
void setCollisionTimeAndRestitutionCoefficient(Mdouble tc, Mdouble eps, Mdouble mass)
Definition: LinearPlasticViscoelasticNormalSpecies.cc:259
BaseInteractable
Defines the basic properties that a interactable object can have.
Definition: BaseInteractable.h:55
mathsFunc::log
Mdouble log(Mdouble Power)
Definition: ExtendedMath.cc:104
helpers::KAndDisp::disp
Mdouble disp
Definition: Helpers.h:49
LinearPlasticViscoelasticNormalSpecies::read
void read(std::istream &is)
Reads the species properties from an input stream.
Definition: LinearPlasticViscoelasticNormalSpecies.cc:90
Helpers.h
LinearPlasticViscoelasticNormalSpecies::doConstantUnloadingStiffness_
bool doConstantUnloadingStiffness_
Definition: LinearPlasticViscoelasticNormalSpecies.h:190
LinearPlasticViscoelasticNormalSpecies::setPlasticParameters
void setPlasticParameters(Mdouble loadingStiffness, Mdouble unloadingStiffnessMax, Mdouble cohesionStiffness, Mdouble penetrationDepthMax)
Sets all parameters of the linear plastic-viscoelastic normal force at once.
Definition: LinearPlasticViscoelasticNormalSpecies.cc:133
LinearPlasticViscoelasticNormalSpecies::setLoadingStiffnessAndDissipation
MERCURY_DEPRECATED void setLoadingStiffnessAndDissipation(helpers::KAndDisp new_)
Allows the spring and dissipation constants to be changed simultaneously.
Definition: LinearPlasticViscoelasticNormalSpecies.cc:236
ParticleSpecies.h
double
ERROR
LL< Log::ERROR > ERROR
Error log level.
Definition: Logger.cc:53
MERCURY_DEPRECATED
#define MERCURY_DEPRECATED
Definition: GeneralDefine.h:37
LinearPlasticViscoelasticNormalSpecies::dissipation_
Mdouble dissipation_
linear dissipation coefficient
Definition: LinearPlasticViscoelasticNormalSpecies.h:187
LinearPlasticViscoelasticNormalSpecies::computeBondNumberMax
Mdouble computeBondNumberMax(Mdouble harmonicMeanRadius, Mdouble gravitationalAcceleration) const
1) Computes the maximum plastic overlap delta_p* = phi*r 2) Computes the overlap at which the maximum...
Definition: LinearPlasticViscoelasticNormalSpecies.cc:336
BaseSpecies::average
static Mdouble average(Mdouble a, Mdouble b)
Returns the harmonic mean of two variables.
Definition: BaseSpecies.cc:110
LinearPlasticViscoelasticNormalSpecies::getCohesionStiffness
Mdouble getCohesionStiffness() const
Returns the cohesive stiffness of the linear plastic-viscoelastic normal force.
Definition: LinearPlasticViscoelasticNormalSpecies.cc:166
LinearPlasticViscoelasticNormalSpecies::getPenetrationDepthMax
Mdouble getPenetrationDepthMax() const
Returns the maximum penetration depth of the linear plastic-viscoelastic normal force.
Definition: LinearPlasticViscoelasticNormalSpecies.cc:174
LinearPlasticViscoelasticNormalSpecies.h
LinearPlasticViscoelasticNormalSpecies::setRestitutionCoefficient
void setRestitutionCoefficient(double eps, Mdouble mass)
Sets disp to obtain a restitution coefficient eps for a collision of two particles of mass m.
Definition: LinearPlasticViscoelasticNormalSpecies.cc:297
LinearPlasticViscoelasticNormalSpecies::setPenetrationDepthMax
void setPenetrationDepthMax(Mdouble penetrationDepthMax)
Sets the maximum penetration depth of the linear plastic-viscoelastic normal force.
Definition: LinearPlasticViscoelasticNormalSpecies.cc:206
LinearPlasticViscoelasticNormalSpecies::penetrationDepthMax_
Mdouble penetrationDepthMax_
the depth (relative to the normalized radius) at which k_2^max is used (phi_f)
Definition: LinearPlasticViscoelasticNormalSpecies.h:184
LinearPlasticViscoelasticInteraction
Computes normal forces in case of a linear plastic visco-elastic interaction.
Definition: LinearPlasticViscoelasticInteraction.h:40
LinearPlasticViscoelasticNormalSpecies::setStiffnessAndRestitutionCoefficient
void setStiffnessAndRestitutionCoefficient(Mdouble k_, Mdouble eps, Mdouble mass)
Sets k, disp such that it matches a given tc and eps for a collision of two copies of P.
Definition: LinearPlasticViscoelasticNormalSpecies.cc:283
LinearPlasticViscoelasticNormalSpecies
LinearPlasticViscoelasticNormalSpecies contains the parameters used to describe a plastic-cohesive no...
Definition: LinearPlasticViscoelasticNormalSpecies.h:41
BaseNormalForce::getConstantRestitution
bool getConstantRestitution() const
Definition: BaseNormalForce.h:45
LinearPlasticViscoelasticNormalSpecies::unloadingStiffnessMax_
Mdouble unloadingStiffnessMax_
the maximum elastic constant (k_2^max) for plastic deformations
Definition: LinearPlasticViscoelasticNormalSpecies.h:178
BaseParticle
Definition: BaseParticle.h:54
LinearPlasticViscoelasticNormalSpecies::setDoConstantUnloadingStiffness
void setDoConstantUnloadingStiffness(bool doConstantUnloadingStiffness)
Definition: LinearPlasticViscoelasticNormalSpecies.h:171
LinearPlasticViscoelasticInteraction.h
LinearPlasticViscoelasticNormalSpecies::loadingStiffness_
Mdouble loadingStiffness_
(normal) spring constant (k_1)
Definition: LinearPlasticViscoelasticNormalSpecies.h:175
LinearPlasticViscoelasticNormalSpecies::mix
void mix(LinearPlasticViscoelasticNormalSpecies *S, LinearPlasticViscoelasticNormalSpecies *T)
creates default values for mixed species
Definition: LinearPlasticViscoelasticNormalSpecies.cc:114
LinearPlasticViscoelasticNormalSpecies::setLoadingStiffness
void setLoadingStiffness(Mdouble loadingStiffness)
Sets the loading stiffness of the linear plastic-viscoelastic normal force.
Definition: LinearPlasticViscoelasticNormalSpecies.cc:182
LinearPlasticViscoelasticNormalSpecies::computeTimeStep
Mdouble computeTimeStep(Mdouble mass)
Returns the optimal time step to resolve a collision of two particles of a given mass.
Definition: LinearPlasticViscoelasticNormalSpecies.cc:216
helpers::KAndDisp::k
Mdouble k
Definition: Helpers.h:48
helpers::KAndDisp
return type specifically for fuctions returning k and disp at once
Definition: Helpers.h:46
LinearPlasticViscoelasticNormalSpecies::setDissipation
void setDissipation(Mdouble dissipation)
Sets the linear dissipation coefficient of the linear plastic-viscoelastic normal force.
Definition: LinearPlasticViscoelasticNormalSpecies.cc:227
BaseForce::getBaseSpecies
BaseSpecies * getBaseSpecies() const
Definition: BaseForce.h:35
LinearPlasticViscoelasticNormalSpecies::getDoConstantUnloadingStiffness
bool getDoConstantUnloadingStiffness() const
Definition: LinearPlasticViscoelasticNormalSpecies.h:169
ExtendedMath.h
LinearPlasticViscoelasticNormalSpecies::setCohesionStiffness
void setCohesionStiffness(Mdouble cohesionStiffness)
Sets the cohesive stiffness of the linear plastic-viscoelastic normal force.
Definition: LinearPlasticViscoelasticNormalSpecies.cc:198
LinearPlasticViscoelasticNormalSpecies::LinearPlasticViscoelasticNormalSpecies
LinearPlasticViscoelasticNormalSpecies()
The default constructor.
Definition: LinearPlasticViscoelasticNormalSpecies.cc:35
LinearPlasticViscoelasticNormalSpecies::getBaseName
std::string getBaseName() const
Used in Species::getName to obtain a unique name for each Species.
Definition: LinearPlasticViscoelasticNormalSpecies.cc:104
LinearPlasticViscoelasticNormalSpecies::getLoadingStiffness
Mdouble getLoadingStiffness() const
Returns the loading stiffness of the linear plastic-viscoelastic normal force.
Definition: LinearPlasticViscoelasticNormalSpecies.cc:150
LinearPlasticViscoelasticNormalSpecies::getDissipation
Mdouble getDissipation() const
Allows the normal dissipation to be accessed.
Definition: LinearPlasticViscoelasticNormalSpecies.cc:245
BaseNormalForce.h