revision: v0.14
SinterLinNormalSpecies.h
Go to the documentation of this file.
1 //Copyright (c) 2013-2018, 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 SinterLinNormalSpecies_H
27 #define SinterLinNormalSpecies_H
28 
29 #include "Species/BaseSpecies.h"
31 #include "Math/ExtendedMath.h"
33 
40 {
41  FRENKEL = 0,
43 };
44 
51 {
52 public:
55 
58 
61 
64 
66  void read(std::istream& is);
67 
69  void write(std::ostream& os) const;
70 
72  std::string getBaseName() const;
73 
74 // Species-specific functions
75 
78 
83 
86 
88  void setRestitutionCoefficient(double eps, Mdouble mass);
89 
93  Mdouble getCollisionTime(Mdouble mass) const;
94 
97 
98 //setters and getters
99 
103  void setPlasticParameters(Mdouble loadingStiffness, Mdouble unloadingStiffnessMax, Mdouble cohesionStiffness,
104  Mdouble penetrationDepthMax);
105 
110 
115 
120 
125 
129  void setLoadingStiffness(Mdouble loadingStiffness);
130 
134  void setUnloadingStiffnessMax(Mdouble unloadingStiffnessMax);
135 
139  void setCohesionStiffness(Mdouble cohesionStiffness);
140 
144  void setPenetrationDepthMax(Mdouble penetrationDepthMax);
145 
149  void setDissipation(Mdouble dissipation);
150 
156 
161 
165  Mdouble getDissipation() const;
166 
170  void setSinterAdhesion(Mdouble sinterAdhesion);
171 
175  Mdouble getSinterAdhesion() const;
176 
180  void setSinterRate(Mdouble sinterRate);
181 
185  Mdouble getSinterRate() const;
186 
191  void setComplianceZero(Mdouble complianceZero);
192 
197  Mdouble getComplianceZero() const;
198 
203  void setSurfTension(Mdouble complianceZero);
204 
209  Mdouble getSurfTension() const;
210 
215  void setFluidity(Mdouble complianceOne);
216 
221  Mdouble getFluidity() const;
222 
227  void setSeparationDis(Mdouble separationDis);
228 
233  Mdouble getSeparationDis() const;
234 
239  void setSinterType(SINTER_APPROACH sinterType);
240 
241  // Sinter declarations:
243 
244 
245 private:
248 
251 
254 
257 
260 
265 
270 
276 
281 
286 
291 
294 
295 };
296 
297 #endif
mathsFunc::square
T square(const T val)
squares a number
Definition: ExtendedMath.h:106
SinterLinNormalSpecies::setUnloadingStiffnessMax
void setUnloadingStiffnessMax(Mdouble unloadingStiffnessMax)
Sets the maximum unloading stiffness of the linear plastic-viscoelastic normal force.
Definition: SinterLinNormalSpecies.cc:223
BaseSpecies.h
SinterLinInteraction.h
SinterLinNormalSpecies::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: SinterLinNormalSpecies.cc:443
constants::pi
const Mdouble pi
Definition: ExtendedMath.h:45
SinterLinNormalSpecies::getCollisionTime
Mdouble getCollisionTime(Mdouble mass) const
Calculates collision time for two copies of a particle of given disp, k, mass.
Definition: SinterLinNormalSpecies.cc:456
SinterLinNormalSpecies::sinterRate_
Mdouble sinterRate_
Definition: SinterLinNormalSpecies.h:269
SinterLinNormalSpecies::read
void read(std::istream &is)
Reads the species properties from an input stream.
Definition: SinterLinNormalSpecies.cc:110
constants::sqr_pi
const Mdouble sqr_pi
Definition: ExtendedMath.h:47
SinterLinNormalSpecies
SinterLinNormalSpecies contains the parameters used to describe a plastic-cohesive normal force (Stef...
Definition: SinterLinNormalSpecies.h:51
logger
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here.
mathsFunc::exp
Mdouble exp(Mdouble Exponent)
Definition: ExtendedMath.cc:84
SinterLinNormalSpecies::setDissipation
void setDissipation(Mdouble dissipation)
Sets the linear dissipation coefficient of the linear plastic-viscoelastic normal force.
Definition: SinterLinNormalSpecies.cc:260
SinterLinNormalSpecies::getSinterRate
Mdouble getSinterRate() const
Accesses sinterRate_.
Definition: SinterLinNormalSpecies.cc:366
SinterLinNormalSpecies::getSurfTension
Mdouble getSurfTension() const
accesses the surface tension.
Definition: SinterLinNormalSpecies.cc:376
SinterLinNormalSpecies::dissipation_
Mdouble dissipation_
linear dissipation coefficient
Definition: SinterLinNormalSpecies.h:259
SinterLinNormalSpecies::setSinterType
void setSinterType(SINTER_APPROACH sinterType)
sets the sintering approach selected.
Definition: SinterLinNormalSpecies.cc:332
SinterLinNormalSpecies::setLoadingStiffnessAndDissipation
MERCURY_DEPRECATED void setLoadingStiffnessAndDissipation(helpers::KAndDisp new_)
Allows the spring and dissipation constants to be changed simultaneously.
Definition: SinterLinNormalSpecies.cc:271
SinterLinNormalSpecies::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: SinterLinNormalSpecies.cc:428
SinterLinNormalSpecies::setCohesionStiffness
void setCohesionStiffness(Mdouble cohesionStiffness)
Sets the cohesive stiffness of the linear plastic-viscoelastic normal force.
Definition: SinterLinNormalSpecies.cc:231
BaseNormalForce
Definition: BaseNormalForce.h:31
INFO
LL< Log::INFO > INFO
Info log level.
Definition: Logger.cc:55
SinterLinNormalSpecies.h
SinterLinNormalSpecies::fluidity
Mdouble fluidity
Definition: SinterLinNormalSpecies.h:285
SinterLinInteraction
Definition: SinterLinInteraction.h:41
BaseInteractable
Defines the basic properties that a interactable object can have.
Definition: BaseInteractable.h:55
SinterLinNormalSpecies::mix
void mix(SinterLinNormalSpecies *S, SinterLinNormalSpecies *T)
creates default values for mixed species
Definition: SinterLinNormalSpecies.cc:143
mathsFunc::log
Mdouble log(Mdouble Power)
Definition: ExtendedMath.cc:104
helpers::KAndDisp::disp
Mdouble disp
Definition: Helpers.h:49
SinterLinNormalSpecies::getComplianceZero
Mdouble getComplianceZero() const
Accesses the instantaneous compliance (compliance zero)
Definition: SinterLinNormalSpecies.cc:371
SinterLinNormalSpecies::getSinterType
SINTER_APPROACH getSinterType() const
Definition: SinterLinNormalSpecies.cc:392
SinterLinNormalSpecies::getLoadingStiffness
Mdouble getLoadingStiffness() const
Returns the loading stiffness of the linear plastic-viscoelastic normal force.
Definition: SinterLinNormalSpecies.cc:183
SinterLinNormalSpecies::setLoadingStiffness
void setLoadingStiffness(Mdouble loadingStiffness)
Sets the loading stiffness of the linear plastic-viscoelastic normal force.
Definition: SinterLinNormalSpecies.cc:215
char
SinterLinNormalSpecies::separationDis_
Mdouble separationDis_
Definition: SinterLinNormalSpecies.h:290
SINTER_APPROACH::FRENKEL
@ FRENKEL
SinterLinNormalSpecies::sinterType_
SINTER_APPROACH sinterType_
Type of sintering.
Definition: SinterLinNormalSpecies.h:293
ParticleSpecies.h
SinterLinNormalSpecies::setSeparationDis
void setSeparationDis(Mdouble separationDis)
sets the critical separation distance. This mimics inter-surface forces.
Definition: SinterLinNormalSpecies.cc:323
SinterLinNormalSpecies::setSurfTension
void setSurfTension(Mdouble complianceZero)
sets the surface tension.
Definition: SinterLinNormalSpecies.cc:305
double
ERROR
LL< Log::ERROR > ERROR
Error log level.
Definition: Logger.cc:53
SinterLinNormalSpecies::InteractionType
SinterLinInteraction InteractionType
The correct Interaction type for this FrictionForceSpecies.
Definition: SinterLinNormalSpecies.h:54
Logger.h
MERCURY_DEPRECATED
#define MERCURY_DEPRECATED
Definition: GeneralDefine.h:37
SinterLinNormalSpecies::setComplianceZero
void setComplianceZero(Mdouble complianceZero)
sets the instantaneous compliance (compliance zero)
Definition: SinterLinNormalSpecies.cc:296
SinterLinNormalSpecies::cohesionStiffness_
Mdouble cohesionStiffness_
the adhesive spring constant (k^c) for plastic deformations
Definition: SinterLinNormalSpecies.h:253
BaseSpecies::average
static Mdouble average(Mdouble a, Mdouble b)
Returns the harmonic mean of two variables.
Definition: BaseSpecies.cc:110
SinterLinNormalSpecies::getBaseName
std::string getBaseName() const
Used in Species::getName to obtain a unique name for each Species.
Definition: SinterLinNormalSpecies.cc:133
SinterLinNormalSpecies::getDissipation
Mdouble getDissipation() const
Allows the normal dissipation to be accessed.
Definition: SinterLinNormalSpecies.cc:350
SinterLinNormalSpecies::setFluidity
void setFluidity(Mdouble complianceOne)
sets the fluidity (inverse of viscosity).
Definition: SinterLinNormalSpecies.cc:314
SinterLinNormalSpecies::sinterAdhesion_
Mdouble sinterAdhesion_
Definition: SinterLinNormalSpecies.h:264
SinterLinNormalSpecies::surfTension_
Mdouble surfTension_
Definition: SinterLinNormalSpecies.h:280
SinterLinNormalSpecies::penetrationDepthMax_
Mdouble penetrationDepthMax_
the depth (relative to the normalized radius) at which k_2^max is used (phi_f)
Definition: SinterLinNormalSpecies.h:256
SinterLinNormalSpecies::write
void write(std::ostream &os) const
Writes the species properties to an output stream.
Definition: SinterLinNormalSpecies.cc:91
SinterLinNormalSpecies::getPenetrationDepthMax
Mdouble getPenetrationDepthMax() const
Returns the maximum penetration depth of the linear plastic-viscoelastic normal force.
Definition: SinterLinNormalSpecies.cc:207
SinterLinNormalSpecies::setCollisionTimeAndRestitutionCoefficient
void setCollisionTimeAndRestitutionCoefficient(Mdouble tc, Mdouble eps, Mdouble mass)
Definition: SinterLinNormalSpecies.cc:406
SinterLinNormalSpecies::getRestitutionCoefficient
Mdouble getRestitutionCoefficient(Mdouble mass) const
Calculates restitution coefficient for two copies of given disp, k, mass.
Definition: SinterLinNormalSpecies.cc:490
SinterLinNormalSpecies::getUnloadingStiffnessMax
Mdouble getUnloadingStiffnessMax() const
Returns the maximum unloading stiffness of the linear plastic-viscoelastic normal force.
Definition: SinterLinNormalSpecies.cc:191
BaseNormalForce::getConstantRestitution
bool getConstantRestitution() const
Definition: BaseNormalForce.h:45
SinterLinNormalSpecies::getSeparationDis
Mdouble getSeparationDis() const
accesses the critical separation distance. This mimics inter-surface forces.
Definition: SinterLinNormalSpecies.cc:386
SinterLinNormalSpecies::setPlasticParameters
void setPlasticParameters(Mdouble loadingStiffness, Mdouble unloadingStiffnessMax, Mdouble cohesionStiffness, Mdouble penetrationDepthMax)
Sets all parameters of the linear plastic-viscoelastic normal force at once.
Definition: SinterLinNormalSpecies.cc:165
BaseParticle
Definition: BaseParticle.h:54
helpers::KAndDisp::k
Mdouble k
Definition: Helpers.h:48
SinterLinNormalSpecies::unloadingStiffnessMax_
Mdouble unloadingStiffnessMax_
the maximum elastic constant (k_2^max) for plastic deformations
Definition: SinterLinNormalSpecies.h:250
helpers::KAndDisp
return type specifically for fuctions returning k and disp at once
Definition: Helpers.h:46
unsigned
SinterLinNormalSpecies::getSinterAdhesion
Mdouble getSinterAdhesion() const
Accesses sinterAdhesion_.
Definition: SinterLinNormalSpecies.cc:358
SinterLinNormalSpecies::complianceZero_
Mdouble complianceZero_
Definition: SinterLinNormalSpecies.h:275
SinterLinNormalSpecies::setSinterRate
void setSinterRate(Mdouble sinterRate)
Sets sinterRate_.
Definition: SinterLinNormalSpecies.cc:287
SinterLinNormalSpecies::~SinterLinNormalSpecies
~SinterLinNormalSpecies()
The default destructor.
Definition: SinterLinNormalSpecies.cc:81
ExtendedMath.h
SinterLinNormalSpecies::getFluidity
Mdouble getFluidity() const
accesses the fluidity (inverse of viscosity).
Definition: SinterLinNormalSpecies.cc:381
SinterLinNormalSpecies::SinterLinNormalSpecies
SinterLinNormalSpecies()
The default constructor.
Definition: SinterLinNormalSpecies.cc:36
SinterLinNormalSpecies::loadingStiffness_
Mdouble loadingStiffness_
(normal) spring constant (k_1)
Definition: SinterLinNormalSpecies.h:247
SinterLinNormalSpecies::getCohesionStiffness
Mdouble getCohesionStiffness() const
Returns the cohesive stiffness of the linear plastic-viscoelastic normal force.
Definition: SinterLinNormalSpecies.cc:199
SinterLinNormalSpecies::computeTimeStep
Mdouble computeTimeStep(Mdouble mass)
Returns the optimal time step to resolve a collision of two particles of a given mass.
Definition: SinterLinNormalSpecies.cc:249
SINTER_APPROACH
SINTER_APPROACH
Definition: SinterLinNormalSpecies.h:40
SinterLinNormalSpecies::setPenetrationDepthMax
void setPenetrationDepthMax(Mdouble penetrationDepthMax)
Sets the maximum penetration depth of the linear plastic-viscoelastic normal force.
Definition: SinterLinNormalSpecies.cc:239
SinterLinNormalSpecies::setSinterAdhesion
void setSinterAdhesion(Mdouble sinterAdhesion)
Sets sinterAdhesion_.
Definition: SinterLinNormalSpecies.cc:277
BaseNormalForce.h