MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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
Mdouble getSlidingDissipation() const
Allows the tangential viscosity to be accessed.
Mdouble slidingDissipation_
tangential dissipation coefficient.
void write(std::ostream &os) const
Writes the species properties to an output stream.
Mdouble getSlidingFrictionCoefficient() const
Allows the (dynamic) Coulomb friction coefficient to be accessed.
void mix(MindlinSpecies *S, MindlinSpecies *T)
creates default values for mixed species
Mdouble getEffectiveShearModulus() const
Allows the shear modulus to be accessed.
double Mdouble
Definition: GeneralDefine.h:34
void read(std::istream &is)
Reads the species properties from an input stream.
Mdouble getSlidingFrictionCoefficientStatic() const
Allows the static Coulomb friction coefficient to be accessed.
MERCURY_DEPRECATED void setPoissonRatio(Mdouble poissonRatio)
Allows the poisson ratio to be changed.
Computes the forces corresponding to sliding friction.
MindlinSpecies contains the parameters used to describe sliding friction.
#define MERCURY_DEPRECATED
Definition: GeneralDefine.h:37
Mdouble slidingFrictionCoefficient_
(dynamic) Coulomb friction coefficient
void setSlidingFrictionCoefficient(Mdouble new_mu)
Allows the (dynamic) Coulomb friction coefficient to be changed; also sets mu_s by default...
virtual std::string getBaseName() const
Used in Species::getName to obtain a unique name for each Species.
Mdouble slidingFrictionCoefficientStatic_
static Coulomb friction coefficient (by default set equal to mu)
~MindlinSpecies()
The default destructor.
void setSlidingDissipation(Mdouble new_dispt)
Allows the tangential viscosity to be changed.
void setEffectiveShearModulus(Mdouble shearModulus)
allows the shear modulus to be changed
Mdouble shearModulus_
tangential spring constant
MindlinInteraction InteractionType
The correct Interaction type for this FrictionForceSpecies.
void setSlidingFrictionCoefficientStatic(Mdouble new_mu)
Allows the static Coulomb friction coefficient to be changed.
MindlinSpecies()
The default constructor.
bool getUseAngularDOFs() const override
Returns true if torques have to be calculated.