revision: v0.14
SlidingFrictionSpecies.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 SLIDINGFRICTIONSPECIES_H
27 #define SLIDINGFRICTIONSPECIES_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  virtual std::string getBaseName() const;
60 
61 //setters and getters
63  void setSlidingStiffness(Mdouble new_kt);
64 
67 
69  void setSlidingDissipation(Mdouble new_dispt);
70 
73 
75  //mu has to be set to allow tangential forces (sets dispt=disp as default)
77 
80 
83 
86 
90  bool getUseAngularDOFs() const override;
91 
94 
96  void
98 
101  Mdouble mass);
102 
103  void setIsSuperquadricSpecies(bool isSuperquadricSpecies);
104  bool getIsSuperquadricSpecies() const;
105 
106 private:
114 
124 
127 
130 
132 };
133 
134 #endif
mathsFunc::square
T square(const T val)
squares a number
Definition: ExtendedMath.h:106
SlidingFrictionSpecies.h
SlidingFrictionSpecies::setSlidingFrictionCoefficientStatic
void setSlidingFrictionCoefficientStatic(Mdouble new_mu)
Allows the static Coulomb friction coefficient to be changed.
Definition: SlidingFrictionSpecies.cc:161
BaseSpecies.h
constants::pi
const Mdouble pi
Definition: ExtendedMath.h:45
SlidingFrictionSpecies::getSlidingFrictionCoefficientStatic
Mdouble getSlidingFrictionCoefficientStatic() const
Allows the static Coulomb friction coefficient to be accessed.
Definition: SlidingFrictionSpecies.cc:174
SlidingFrictionSpecies::~SlidingFrictionSpecies
~SlidingFrictionSpecies()
The default destructor.
Definition: SlidingFrictionSpecies.cc:63
SlidingFrictionSpecies::read
void read(std::istream &is)
Reads the species properties from an input stream.
Definition: SlidingFrictionSpecies.cc:85
logger
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here.
LinearViscoelasticNormalSpecies::setCollisionTimeAndRestitutionCoefficient
void setCollisionTimeAndRestitutionCoefficient(Mdouble tc, Mdouble eps, BaseParticle *p)
Sets k, disp such that it matches a given tc and eps for a collision of two copies of particle p.
Definition: LinearViscoelasticNormalSpecies.cc:212
SlidingFrictionInteraction.h
SlidingFrictionSpecies::SlidingFrictionSpecies
SlidingFrictionSpecies()
The default constructor.
Definition: SlidingFrictionSpecies.cc:36
SlidingFrictionSpecies::setSlidingDissipation
void setSlidingDissipation(Mdouble new_dispt)
Allows the tangential viscosity to be changed.
Definition: SlidingFrictionSpecies.cc:123
SlidingFrictionSpecies::setSlidingFrictionCoefficient
void setSlidingFrictionCoefficient(Mdouble new_mu)
Allows the (dynamic) Coulomb friction coefficient to be changed; also sets mu_s by default.
Definition: SlidingFrictionSpecies.cc:141
SlidingFrictionSpecies::write
void write(std::ostream &os) const
Writes the species properties to an output stream.
Definition: SlidingFrictionSpecies.cc:73
SlidingFrictionSpecies::getBaseName
virtual std::string getBaseName() const
Used in Species::getName to obtain a unique name for each Species.
Definition: SlidingFrictionSpecies.cc:98
BaseInteractable
Defines the basic properties that a interactable object can have.
Definition: BaseInteractable.h:55
SlidingFrictionSpecies
SlidingFrictionSpecies contains the parameters used to describe sliding friction.
Definition: SlidingFrictionSpecies.h:38
mathsFunc::log
Mdouble log(Mdouble Power)
Definition: ExtendedMath.cc:104
SlidingFrictionInteraction
Computes the forces corresponding to sliding friction.
Definition: SlidingFrictionInteraction.h:43
BaseFrictionForce.h
SlidingFrictionSpecies::slidingDissipation_
Mdouble slidingDissipation_
tangential dissipation coefficient.
Definition: SlidingFrictionSpecies.h:123
SlidingFrictionSpecies::slidingFrictionCoefficient_
Mdouble slidingFrictionCoefficient_
(dynamic) Coulomb friction coefficient
Definition: SlidingFrictionSpecies.h:126
LinearViscoelasticNormalSpecies.h
SlidingFrictionSpecies::InteractionType
SlidingFrictionInteraction InteractionType
The correct Interaction type for this FrictionForceSpecies.
Definition: SlidingFrictionSpecies.h:41
double
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
SlidingFrictionSpecies::getUseAngularDOFs
bool getUseAngularDOFs() const override
Returns true if torques have to be calculated.
Definition: SlidingFrictionSpecies.cc:185
LinearPlasticViscoelasticNormalSpecies.h
SlidingFrictionSpecies::isSuperquadricSpecies_
bool isSuperquadricSpecies_
Definition: SlidingFrictionSpecies.h:131
SlidingFrictionSpecies::getSlidingFrictionCoefficient
Mdouble getSlidingFrictionCoefficient() const
Allows the (dynamic) Coulomb friction coefficient to be accessed.
Definition: SlidingFrictionSpecies.cc:155
LinearPlasticViscoelasticNormalSpecies
LinearPlasticViscoelasticNormalSpecies contains the parameters used to describe a plastic-cohesive no...
Definition: LinearPlasticViscoelasticNormalSpecies.h:41
SlidingFrictionSpecies::getSlidingStiffness
Mdouble getSlidingStiffness() const
Allows the spring constant to be accessed.
Definition: SlidingFrictionSpecies.cc:117
SlidingFrictionSpecies::slidingFrictionCoefficientStatic_
Mdouble slidingFrictionCoefficientStatic_
static Coulomb friction coefficient (by default set equal to mu)
Definition: SlidingFrictionSpecies.h:129
BaseParticle
Definition: BaseParticle.h:54
SlidingFrictionSpecies::setCollisionTimeAndNormalAndTangentialRestitutionCoefficientNoDispt
void setCollisionTimeAndNormalAndTangentialRestitutionCoefficientNoDispt(Mdouble tc, Mdouble eps, Mdouble beta, Mdouble mass)
Sets k, disp, kt (with dispt=0) such that it matches a given tc and eps for a collision of two partic...
Definition: SlidingFrictionSpecies.cc:249
BaseFrictionForce
Definition: BaseFrictionForce.h:31
LinearPlasticViscoelasticNormalSpecies::setLoadingStiffness
void setLoadingStiffness(Mdouble loadingStiffness)
Sets the loading stiffness of the linear plastic-viscoelastic normal force.
Definition: LinearPlasticViscoelasticNormalSpecies.cc:182
SlidingFrictionSpecies::setIsSuperquadricSpecies
void setIsSuperquadricSpecies(bool isSuperquadricSpecies)
Definition: SlidingFrictionSpecies.cc:266
SlidingFrictionSpecies::setCollisionTimeAndNormalAndTangentialRestitutionCoefficient
void setCollisionTimeAndNormalAndTangentialRestitutionCoefficient(Mdouble tc, Mdouble eps, Mdouble beta, Mdouble mass)
Sets k, disp, kt, dispt such that it matches a given tc and eps for a collision of two particles of m...
Definition: SlidingFrictionSpecies.cc:207
SlidingFrictionSpecies::slidingStiffness_
Mdouble slidingStiffness_
tangential stiffness.
Definition: SlidingFrictionSpecies.h:113
SlidingFrictionSpecies::getSlidingDissipation
Mdouble getSlidingDissipation() const
Allows the tangential viscosity to be accessed.
Definition: SlidingFrictionSpecies.cc:134
mathsFunc::beta
Mdouble beta(Mdouble z, Mdouble w)
This is the beta function, returns the approximation based on cmath's implementation of ln(gamma)
Definition: ExtendedMath.cc:164
LinearPlasticViscoelasticNormalSpecies::setDissipation
void setDissipation(Mdouble dissipation)
Sets the linear dissipation coefficient of the linear plastic-viscoelastic normal force.
Definition: LinearPlasticViscoelasticNormalSpecies.cc:227
ExtendedMath.h
LinearViscoelasticNormalSpecies
LinearViscoelasticNormalSpecies contains the parameters used to describe a linear elastic-dissipative...
Definition: LinearViscoelasticNormalSpecies.h:39
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
SlidingFrictionSpecies::mix
void mix(SlidingFrictionSpecies *S, SlidingFrictionSpecies *T)
creates default values for mixed species
Definition: SlidingFrictionSpecies.cc:196
LinearViscoelasticNormalSpecies::getStiffness
Mdouble getStiffness() const
Allows the spring constant to be accessed.
Definition: LinearViscoelasticNormalSpecies.cc:104
SlidingFrictionSpecies::setSlidingStiffness
void setSlidingStiffness(Mdouble new_kt)
Allows the spring constant to be changed.
Definition: SlidingFrictionSpecies.cc:104
SlidingFrictionSpecies::getIsSuperquadricSpecies
bool getIsSuperquadricSpecies() const
Definition: SlidingFrictionSpecies.cc:271