revision: v0.14
HertzianSinterNormalSpecies.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 HertzianSinterNormalSpecies_H
27 #define HertzianSinterNormalSpecies_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 
61 // Species-specific functions
62 
65 
66 
67 //setters and getters
68 
72  void setPlasticParameters(Mdouble loadingModulus, Mdouble unloadingModulusMax, Mdouble cohesionModulus,
73  Mdouble penetrationDepthMax);
74 
78  Mdouble getLoadingModulus() const;
79 
84 
89 
94 
98  void setLoadingModulus(Mdouble loadingModulus);
99 
103  void setUnloadingModulusMax(Mdouble unloadingModulusMax);
104 
108  void setCohesionModulus(Mdouble cohesionModulus);
109 
113  void setPenetrationDepthMax(Mdouble penetrationDepthMax);
114 
118  void setDissipation(Mdouble dissipation);
119 
123  Mdouble getDissipation() const;
124 
128  void setSinterRate(Mdouble sinterRate);
129 
133  Mdouble getSinterRate() const;
134 
139 
140 
141 private:
144 
147 
150 
153 
156 
158 };
159 
160 #endif
HertzianSinterNormalSpecies::setCohesionModulus
void setCohesionModulus(Mdouble cohesionModulus)
Sets the cohesive stiffness of the linear plastic-viscoelastic normal force.
Definition: HertzianSinterNormalSpecies.cc:196
HertzianSinterNormalSpecies::setUnloadingModulusMax
void setUnloadingModulusMax(Mdouble unloadingModulusMax)
Sets the maximum unloading stiffness of the linear plastic-viscoelastic normal force.
Definition: HertzianSinterNormalSpecies.cc:188
HertzianSinterInteraction
Computes normal forces in case of a linear plastic visco-elastic interaction.
Definition: HertzianSinterInteraction.h:40
HertzianSinterNormalSpecies::dissipation_
Mdouble dissipation_
linear dissipation coefficient
Definition: HertzianSinterNormalSpecies.h:155
HertzianSinterNormalSpecies::setSinterRate
void setSinterRate(Mdouble sinterRate)
Sets the linear dissipation coefficient of the linear plastic-viscoelastic normal force.
Definition: HertzianSinterNormalSpecies.cc:246
constants::pi
const Mdouble pi
Definition: ExtendedMath.h:45
HertzianSinterNormalSpecies::getDissipation
Mdouble getDissipation() const
Allows the normal dissipation to be accessed.
Definition: HertzianSinterNormalSpecies.cc:261
HertzianSinterNormalSpecies::setPenetrationDepthMax
void setPenetrationDepthMax(Mdouble penetrationDepthMax)
Sets the maximum penetration depth of the linear plastic-viscoelastic normal force.
Definition: HertzianSinterNormalSpecies.cc:204
HertzianSinterNormalSpecies::penetrationDepthMax_
Mdouble penetrationDepthMax_
the depth (relative to the normalized radius) at which k_2^max is used (phi_f)
Definition: HertzianSinterNormalSpecies.h:152
HertzianSinterNormalSpecies::setLoadingModulus
void setLoadingModulus(Mdouble loadingModulus)
Sets the loading stiffness of the linear plastic-viscoelastic normal force.
Definition: HertzianSinterNormalSpecies.cc:180
logger
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here.
HertzianSinterNormalSpecies::~HertzianSinterNormalSpecies
~HertzianSinterNormalSpecies()
The default destructor.
Definition: HertzianSinterNormalSpecies.cc:68
HertzianSinterNormalSpecies::unloadingModulusMax_
Mdouble unloadingModulusMax_
the maximum elastic constant (k_2^max) for plastic deformations
Definition: HertzianSinterNormalSpecies.h:146
HertzianSinterNormalSpecies::getCohesionModulus
Mdouble getCohesionModulus() const
Returns the cohesive stiffness of the linear plastic-viscoelastic normal force.
Definition: HertzianSinterNormalSpecies.cc:164
BaseNormalForce
Definition: BaseNormalForce.h:31
ParticleSpecies
Definition: ParticleSpecies.h:37
BaseInteractable
Defines the basic properties that a interactable object can have.
Definition: BaseInteractable.h:55
ParticleSpecies::getDensity
Mdouble getDensity() const
Allows density_ to be accessed.
Definition: ParticleSpecies.cc:117
HertzianSinterNormalSpecies::setDissipation
void setDissipation(Mdouble dissipation)
Sets the linear dissipation coefficient of the linear plastic-viscoelastic normal force.
Definition: HertzianSinterNormalSpecies.cc:230
HertzianSinterNormalSpecies::setPlasticParameters
void setPlasticParameters(Mdouble loadingModulus, Mdouble unloadingModulusMax, Mdouble cohesionModulus, Mdouble penetrationDepthMax)
Sets all parameters of the linear plastic-viscoelastic normal force at once.
Definition: HertzianSinterNormalSpecies.cc:131
ParticleSpecies.h
double
HertzianSinterNormalSpecies::getLoadingModulus
Mdouble getLoadingModulus() const
Returns the loading stiffness of the linear plastic-viscoelastic normal force.
Definition: HertzianSinterNormalSpecies.cc:148
HertzianSinterNormalSpecies::getUnloadingModulusMax
Mdouble getUnloadingModulusMax() const
Returns the maximum unloading stiffness of the linear plastic-viscoelastic normal force.
Definition: HertzianSinterNormalSpecies.cc:156
ERROR
LL< Log::ERROR > ERROR
Error log level.
Definition: Logger.cc:53
BaseSpecies::average
static Mdouble average(Mdouble a, Mdouble b)
Returns the harmonic mean of two variables.
Definition: BaseSpecies.cc:110
BaseHandler.h
WARN
LL< Log::WARN > WARN
Warning log level.
Definition: Logger.cc:54
HertzianSinterNormalSpecies::InteractionType
HertzianSinterInteraction InteractionType
The correct Interaction type for this FrictionForceSpecies.
Definition: HertzianSinterNormalSpecies.h:41
HertzianSinterNormalSpecies::computeTimeStep
Mdouble computeTimeStep(Mdouble mass)
Returns the optimal time step to resolve a collision of two particles of a given mass.
Definition: HertzianSinterNormalSpecies.cc:213
HertzianSinterNormalSpecies::read
void read(std::istream &is)
Reads the species properties from an input stream.
Definition: HertzianSinterNormalSpecies.cc:91
HertzianSinterNormalSpecies::getPenetrationDepthMax
Mdouble getPenetrationDepthMax() const
Returns the maximum penetration depth of the linear plastic-viscoelastic normal force.
Definition: HertzianSinterNormalSpecies.cc:172
HertzianSinterNormalSpecies
HertzianSinterNormalSpecies contains the parameters used to describe a plastic-cohesive normal force ...
Definition: HertzianSinterNormalSpecies.h:38
HertzianSinterNormalSpecies::getSinterRate
Mdouble getSinterRate() const
Allows the normal dissipation to be accessed.
Definition: HertzianSinterNormalSpecies.cc:269
HertzianSinterNormalSpecies::sinterRate_
Mdouble sinterRate_
Definition: HertzianSinterNormalSpecies.h:157
BaseParticle
Definition: BaseParticle.h:54
HertzianSinterNormalSpecies::getBaseName
std::string getBaseName() const
Used in Species::getName to obtain a unique name for each Species.
Definition: HertzianSinterNormalSpecies.cc:105
HertzianSinterNormalSpecies::loadingModulus_
Mdouble loadingModulus_
(normal) spring constant (k_1)
Definition: HertzianSinterNormalSpecies.h:143
BaseForce::getBaseSpecies
BaseSpecies * getBaseSpecies() const
Definition: BaseForce.h:35
ExtendedMath.h
HertzianSinterNormalSpecies::cohesionModulus_
Mdouble cohesionModulus_
the adhesive spring constant (k^c) for plastic deformations
Definition: HertzianSinterNormalSpecies.h:149
HertzianSinterNormalSpecies::mix
void mix(HertzianSinterNormalSpecies *S, HertzianSinterNormalSpecies *T)
creates default values for mixed species
Definition: HertzianSinterNormalSpecies.cc:115
HertzianSinterNormalSpecies::HertzianSinterNormalSpecies
HertzianSinterNormalSpecies()
The default constructor.
Definition: HertzianSinterNormalSpecies.cc:37
HertzianSinterNormalSpecies.h
HertzianSinterNormalSpecies::write
void write(std::ostream &os) const
Writes the species properties to an output stream.
Definition: HertzianSinterNormalSpecies.cc:78
HertzianSinterInteraction.h
BaseNormalForce.h