MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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
Mdouble slidingStiffness_
tangential stiffness.
void read(std::istream &is)
Reads the species properties from an input stream.
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...
Mdouble getSlidingFrictionCoefficientStatic() const
Allows the static Coulomb friction coefficient to be accessed.
void setIsSuperquadricSpecies(bool isSuperquadricSpecies)
bool getUseAngularDOFs() const override
Returns true if torques have to be calculated.
double Mdouble
Definition: GeneralDefine.h:34
Mdouble slidingFrictionCoefficientStatic_
static Coulomb friction coefficient (by default set equal to mu)
Mdouble beta(Mdouble z, Mdouble w)
This is the beta function, returns the approximation based on cmath's implementation of ln(gamma) ...
Computes the forces corresponding to sliding friction.
void mix(SlidingFrictionSpecies *S, SlidingFrictionSpecies *T)
creates default values for mixed species
SlidingFrictionInteraction InteractionType
The correct Interaction type for this FrictionForceSpecies.
virtual std::string getBaseName() const
Used in Species::getName to obtain a unique name for each Species.
void setSlidingFrictionCoefficientStatic(Mdouble new_mu)
Allows the static Coulomb friction coefficient to be changed.
~SlidingFrictionSpecies()
The default destructor.
void setSlidingStiffness(Mdouble new_kt)
Allows the spring constant to be changed.
void setSlidingFrictionCoefficient(Mdouble new_mu)
Allows the (dynamic) Coulomb friction coefficient to be changed; also sets mu_s by default...
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...
Mdouble slidingDissipation_
tangential dissipation coefficient.
SlidingFrictionSpecies contains the parameters used to describe sliding friction. ...
void write(std::ostream &os) const
Writes the species properties to an output stream.
Mdouble getSlidingStiffness() const
Allows the spring constant to be accessed.
Mdouble getSlidingDissipation() const
Allows the tangential viscosity to be accessed.
void setSlidingDissipation(Mdouble new_dispt)
Allows the tangential viscosity to be changed.
SlidingFrictionSpecies()
The default constructor.
Mdouble slidingFrictionCoefficient_
(dynamic) Coulomb friction coefficient
Mdouble getSlidingFrictionCoefficient() const
Allows the (dynamic) Coulomb friction coefficient to be accessed.