revision: v0.14
MindlinSpecies.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 MINDLINSPECIES_H
27 #define MINDLINSPECIES_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
62 
64  void setSlidingDissipation(Mdouble new_dispt);
65 
68 
70  //mu has to be set to allow tangential forces (sets dispt=disp as default)
72 
75 
78 
81 
83  MERCURY_DEPRECATED void setPoissonRatio(Mdouble poissonRatio);
84 
86  void setEffectiveShearModulus(Mdouble shearModulus);
87 
90 
94  bool getUseAngularDOFs() const override;
95 
97  void mix(MindlinSpecies* S, MindlinSpecies* T);
98 
99 private:
100 
110 
113 
116 
119 
120 
121 };
122 
123 #endif
MindlinSpecies::read
void read(std::istream &is)
Reads the species properties from an input stream.
Definition: MindlinSpecies.cc:85
MindlinSpecies::shearModulus_
Mdouble shearModulus_
tangential spring constant
Definition: MindlinSpecies.h:118
BaseSpecies.h
MindlinSpecies::getUseAngularDOFs
bool getUseAngularDOFs() const override
Returns true if torques have to be calculated.
Definition: MindlinSpecies.cc:200
MindlinSpecies::getSlidingFrictionCoefficient
Mdouble getSlidingFrictionCoefficient() const
Allows the (dynamic) Coulomb friction coefficient to be accessed.
Definition: MindlinSpecies.cc:137
MindlinSpecies::write
void write(std::ostream &os) const
Writes the species properties to an output stream.
Definition: MindlinSpecies.cc:73
constants::pi
const Mdouble pi
Definition: ExtendedMath.h:45
MindlinSpecies::getSlidingFrictionCoefficientStatic
Mdouble getSlidingFrictionCoefficientStatic() const
Allows the static Coulomb friction coefficient to be accessed.
Definition: MindlinSpecies.cc:189
MindlinSpecies::setEffectiveShearModulus
void setEffectiveShearModulus(Mdouble shearModulus)
allows the shear modulus to be changed
Definition: MindlinSpecies.cc:175
MindlinSpecies::~MindlinSpecies
~MindlinSpecies()
The default destructor.
Definition: MindlinSpecies.cc:62
logger
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here.
MindlinInteraction
Computes the forces corresponding to sliding friction.
Definition: MindlinInteraction.h:43
MindlinSpecies::getSlidingDissipation
Mdouble getSlidingDissipation() const
Allows the tangential viscosity to be accessed.
Definition: MindlinSpecies.cc:116
INFO
LL< Log::INFO > INFO
Info log level.
Definition: Logger.cc:55
MindlinSpecies::getBaseName
virtual std::string getBaseName() const
Used in Species::getName to obtain a unique name for each Species.
Definition: MindlinSpecies.cc:98
BaseInteractable
Defines the basic properties that a interactable object can have.
Definition: BaseInteractable.h:55
MindlinSpecies.h
HertzianViscoelasticMindlinSpecies.h
BaseFrictionForce.h
Mdouble
double Mdouble
Definition: GeneralDefine.h:34
LinearViscoelasticNormalSpecies.h
double
ERROR
LL< Log::ERROR > ERROR
Error log level.
Definition: Logger.cc:53
MindlinSpecies::setSlidingFrictionCoefficient
void setSlidingFrictionCoefficient(Mdouble new_mu)
Allows the (dynamic) Coulomb friction coefficient to be changed; also sets mu_s by default.
Definition: MindlinSpecies.cc:123
MERCURY_DEPRECATED
#define MERCURY_DEPRECATED
Definition: GeneralDefine.h:37
BaseSpecies::average
static Mdouble average(Mdouble a, Mdouble b)
Returns the harmonic mean of two variables.
Definition: BaseSpecies.cc:110
Species
Contains material and contact force properties.
Definition: Species.h:35
HertzianViscoelasticSlidingFrictionSpecies.h
MindlinSpecies::setSlidingDissipation
void setSlidingDissipation(Mdouble new_dispt)
Allows the tangential viscosity to be changed.
Definition: MindlinSpecies.cc:105
helpers::normalAndTangentialLoadingTest
void normalAndTangentialLoadingTest(const ParticleSpecies *species, Mdouble displacement, Mdouble tangentialDisplacement, Mdouble velocity, Mdouble radius, std::string name)
Definition: Helpers.cc:692
MindlinSpecies::getEffectiveShearModulus
Mdouble getEffectiveShearModulus() const
Allows the shear modulus to be accessed.
Definition: MindlinSpecies.cc:183
DPMBase.h
LinearPlasticViscoelasticNormalSpecies.h
MindlinSpecies::slidingDissipation_
Mdouble slidingDissipation_
tangential dissipation coefficient.
Definition: MindlinSpecies.h:109
HertzianViscoelasticNormalSpecies
HertzianViscoelasticNormalSpecies contains the parameters used to describe a Hertzian normal force (T...
Definition: HertzianViscoelasticNormalSpecies.h:38
MindlinSpecies::setPoissonRatio
MERCURY_DEPRECATED void setPoissonRatio(Mdouble poissonRatio)
Allows the poisson ratio to be changed.
Definition: MindlinSpecies.cc:156
BaseParticle
Definition: BaseParticle.h:54
MindlinSpecies::MindlinSpecies
MindlinSpecies()
The default constructor.
Definition: MindlinSpecies.cc:37
helpers::objectivenessTest
void objectivenessTest(const ParticleSpecies *species, Mdouble displacement, Mdouble tangentialDisplacement, Mdouble velocity, Mdouble radius, std::string name)
Definition: Helpers.cc:772
MindlinSpecies::slidingFrictionCoefficient_
Mdouble slidingFrictionCoefficient_
(dynamic) Coulomb friction coefficient
Definition: MindlinSpecies.h:112
HertzianViscoelasticNormalSpecies.h
BaseFrictionForce
Definition: BaseFrictionForce.h:31
main
int main(int argc, char *argv[])
Definition: MindlinSelfTest.cpp:30
helpers::loadingTest
void loadingTest(const ParticleSpecies *species, Mdouble displacement, Mdouble velocity, Mdouble radius, std::string name)
Definition: Helpers.cc:618
MindlinInteraction.h
MindlinSpecies::setSlidingFrictionCoefficientStatic
void setSlidingFrictionCoefficientStatic(Mdouble new_mu)
Allows the static Coulomb friction coefficient to be changed.
Definition: MindlinSpecies.cc:143
MindlinSpecies::slidingFrictionCoefficientStatic_
Mdouble slidingFrictionCoefficientStatic_
static Coulomb friction coefficient (by default set equal to mu)
Definition: MindlinSpecies.h:115
MindlinSpecies::mix
void mix(MindlinSpecies *S, MindlinSpecies *T)
creates default values for mixed species
Definition: MindlinSpecies.cc:211
BaseForce::getBaseSpecies
BaseSpecies * getBaseSpecies() const
Definition: BaseForce.h:35
MindlinSpecies
MindlinSpecies contains the parameters used to describe sliding friction.
Definition: MindlinSpecies.h:38
ExtendedMath.h
MindlinSpecies::InteractionType
MindlinInteraction InteractionType
The correct Interaction type for this FrictionForceSpecies.
Definition: MindlinSpecies.h:41