MindlinRollingTorsionSpecies.h
Go to the documentation of this file.
1 //Copyright (c) 2013-2023, 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 MindlinRollingTorsionSpecies_H
27 #define MindlinRollingTorsionSpecies_H
28 
29 #include "MindlinSpecies.h"
30 #include "Math/ExtendedMath.h"
32 
39 {
40 public:
43 
46 
49 
52 
54  void read(std::istream& is);
55 
57  void write(std::ostream& os) const;
58 
60  std::string getBaseName() const override;
61 
65  bool getUseAngularDOFs() const override;
66 
69 
70 //setters and getters
71 
73  //void setRollingStiffness(Mdouble new_kt);
74 
76  //Mdouble getRollingStiffness() const;
77 
79  void setRollingDissipation(Mdouble new_dispt);
80 
83 
85  //mu has to be set to allow tangential forces (sets dispt=disp as default)
87 
90 
93 
96 
97 // ///Allows the torsion stiffness to be changed
98 // void setTorsionStiffness(Mdouble new_kt);
99 //
100 // ///Allows the torsion stiffness to be accessed
101 // Mdouble getTorsionStiffness() const;
102 
104  void setTorsionDissipation(Mdouble new_dispt);
105 
108 
110  //mu has to be set to allow tangential forces (sets dispt=disp as default)
112 
115 
118 
121 
122 private:
130 
138 
139 
144 
150 
158 
166 
171 
177 };
178 
179 #endif
This class allows one to take all three types of frictional interactions into account....
Definition: MindlinRollingTorsionInteraction.h:45
MindlinRollingTorsionSpecies contains the parameters used to describe sliding, rolling and torsional ...
Definition: MindlinRollingTorsionSpecies.h:39
Mdouble getTorsionFrictionCoefficient() const
Allows the (dynamic) Coulomb torsion friction coefficient to be accessed.
Definition: MindlinRollingTorsionSpecies.cc:276
void read(std::istream &is)
Reads the species properties from an input stream.
Definition: MindlinRollingTorsionSpecies.cc:95
void write(std::ostream &os) const
Writes the species properties to an output stream.
Definition: MindlinRollingTorsionSpecies.cc:79
Mdouble getTorsionDissipation() const
Allows the torsion viscosity to be accessed.
Definition: MindlinRollingTorsionSpecies.cc:255
Mdouble getTorsionFrictionCoefficientStatic() const
Allows the static Coulomb torsion friction coefficient to be accessed.
Definition: MindlinRollingTorsionSpecies.cc:295
Mdouble rollingFrictionCoefficientStatic_
static Coulomb rolling friction coefficient (by default set equal to the dynamic one).
Definition: MindlinRollingTorsionSpecies.h:149
void setTorsionFrictionCoefficientStatic(Mdouble new_mu)
Allows the static Coulomb torsion friction coefficient to be accessed.
Definition: MindlinRollingTorsionSpecies.cc:282
Mdouble getRollingFrictionCoefficient() const
Allows the (dynamic) Coulomb friction coefficient to be accessed.
Definition: MindlinRollingTorsionSpecies.cc:199
MindlinRollingTorsionInteraction InteractionType
The correct Interaction type for this FrictionForceSpecies.
Definition: MindlinRollingTorsionSpecies.h:42
void setRollingFrictionCoefficientStatic(Mdouble new_mu)
Allows the static Coulomb rolling friction coefficient to be changed.
Definition: MindlinRollingTorsionSpecies.cc:205
void setTorsionFrictionCoefficient(Mdouble new_mu)
Allows the (dynamic) Coulomb torsion friction coefficient to be changed; also sets mu_s by default.
Definition: MindlinRollingTorsionSpecies.cc:262
~MindlinRollingTorsionSpecies()
The default destructor.
Definition: MindlinRollingTorsionSpecies.cc:69
MindlinRollingTorsionSpecies()
The default constructor.
Definition: MindlinRollingTorsionSpecies.cc:34
Mdouble torsionDissipation_
rolling dissipation coefficient.
Definition: MindlinRollingTorsionSpecies.h:165
Mdouble getRollingDissipation() const
Allows the tangential viscosity to be accessed.
Definition: MindlinRollingTorsionSpecies.cc:178
Mdouble getRollingFrictionCoefficientStatic() const
Allows the static Coulomb rolling friction coefficient to be accessed.
Definition: MindlinRollingTorsionSpecies.cc:218
bool getUseAngularDOFs() const override
Returns true if torques have to be calculated.
Definition: MindlinRollingTorsionSpecies.cc:123
Mdouble torsionFrictionCoefficient_
(dynamic) Coulomb torsion friction coefficient.
Definition: MindlinRollingTorsionSpecies.h:170
std::string getBaseName() const override
Used in Species::getName to obtain a unique name for each Species.
Definition: MindlinRollingTorsionSpecies.cc:112
Mdouble rollingStiffness_
rolling stiffness.
Definition: MindlinRollingTorsionSpecies.h:129
Mdouble rollingFrictionCoefficient_
(dynamic) Coulomb rolling friction coefficient.
Definition: MindlinRollingTorsionSpecies.h:143
Mdouble rollingDissipation_
rolling dissipation coefficient.
Definition: MindlinRollingTorsionSpecies.h:137
Mdouble torsionStiffness_
rolling stiffness.
Definition: MindlinRollingTorsionSpecies.h:157
void setRollingDissipation(Mdouble new_dispt)
Allows the spring constant to be changed.
Definition: MindlinRollingTorsionSpecies.cc:167
void setRollingFrictionCoefficient(Mdouble new_mu)
Allows the (dynamic) Coulomb friction coefficient to be changed; also sets mu_s by default.
Definition: MindlinRollingTorsionSpecies.cc:185
Mdouble torsionFrictionCoefficientStatic_
static Coulomb torsion friction coefficient (by default set equal to the dynamic one).
Definition: MindlinRollingTorsionSpecies.h:176
void mix(MindlinRollingTorsionSpecies *S, MindlinRollingTorsionSpecies *T)
creates default values for mixed species
Definition: MindlinRollingTorsionSpecies.cc:133
void setTorsionDissipation(Mdouble new_dispt)
Allows the torsion viscosity to be changed.
Definition: MindlinRollingTorsionSpecies.cc:244
MindlinSpecies contains the parameters used to describe sliding friction.
Definition: MindlinSpecies.h:38