SlidingFrictionInteraction.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 SLIDINGFRICTIONINTERACTION_H
27 #define SLIDINGFRICTIONINTERACTION_H
28 
30 #include "Math/Vector.h"
31 
32 class BaseParticle;
33 
35 
36 class BaseInteractable;
37 
43 {
44 public:
49 
54 
55  //used for mpi
57 
62 
66  ~SlidingFrictionInteraction() override;
67 
72  void computeFrictionForce();
73 
77  void read(std::istream& is) override;
78 
82  void write(std::ostream& os) const override;
83 
87  void integrate(Mdouble timeStep) override;
88 
92  Mdouble getElasticEnergy() const override;
93 
97  Mdouble getTangentialOverlap() const override;
98 
102  std::string getBaseName() const;
103 
104  void setSlidingSpring(Vec3D slidingSpring);
105 
106  Vec3D getSlidingSpring() const;
107 
108  //setters and getters
112  const Vec3D getTangentialForce() const override;
113 
117  void addTangentialForce(Vec3D force) {
118  tangentialForce_ = Vec3D(0.0,0.0,0.0);
119  tangentialForce_ += force;
120  }
121 
125  const SlidingFrictionSpecies* getSpecies() const;
126 
132  void reverseHistory() override;
133 
134  void rotateHistory(Matrix3D& rotationMatrix) override;
135 
136  void moveSlidingSpring(Vec3D displacement);
137 
138  void computeSlidingSpring(const Vec3D& tangentialRelativeVelocity);
139 
140  void computeSlidingSpringSuperQuadric(const Vec3D& tangentialRelativeVelocity);
141 
142  void setIsSuperQuadricInteraction(bool isSuperQuadricInteraction);
143 
144 
145 protected:
160 
162 };
163 
164 #endif
Defines the basic properties that a interactable object can have.
Definition: BaseInteractable.h:55
Stores information about interactions between two interactable objects; often particles but could be ...
Definition: BaseInteraction.h:60
Definition: BaseParticle.h:54
Implementation of a 3D matrix.
Definition: Matrix.h:38
Computes the forces corresponding to sliding friction.
Definition: SlidingFrictionInteraction.h:43
Mdouble getElasticEnergy() const override
Returns the amount of elastic energy stored in sliding spring.
Definition: SlidingFrictionInteraction.cc:241
void computeSlidingSpring(const Vec3D &tangentialRelativeVelocity)
Definition: SlidingFrictionInteraction.cc:179
void integrate(Mdouble timeStep) override
Increments the amount of compression in sliding spring.
Definition: SlidingFrictionInteraction.cc:233
void moveSlidingSpring(Vec3D displacement)
Definition: SlidingFrictionInteraction.cc:312
Vec3D tangentialForce_
Computes the tangential force such that . Set and computed in computeFrictionForce().
Definition: SlidingFrictionInteraction.h:159
void read(std::istream &is) override
Interaction read function, which accepts an std::istream as input.
Definition: SlidingFrictionInteraction.cc:96
const SlidingFrictionSpecies * getSpecies() const
Returns a const pointer of type SlidingFrictionSpecies*.
Definition: SlidingFrictionInteraction.cc:270
const Vec3D getTangentialForce() const override
Returns the sliding friction force vector.
Definition: SlidingFrictionInteraction.cc:262
std::string getBaseName() const
Returns the type/name of interaction (sliding friction interaction)
Definition: SlidingFrictionInteraction.cc:279
SlidingFrictionSpecies SpeciesType
An alias name for SlidingFrictionSpecies data type.
Definition: SlidingFrictionInteraction.h:48
void computeFrictionForce()
Computes the tangential force generated due to compression in the sliding spring. Does take into acco...
Definition: SlidingFrictionInteraction.cc:106
void write(std::ostream &os) const override
Interaction write function, which accepts an std::ostream as input.
Definition: SlidingFrictionInteraction.cc:87
Mdouble getTangentialOverlap() const override
Returns the amount of tangential overlap which is needed by BaseInteraction::writeToFstat().
Definition: SlidingFrictionInteraction.cc:253
Vec3D slidingSpring_
Stores the amount of sliding spring ( ) compression from the expression . Set in the member function ...
Definition: SlidingFrictionInteraction.h:150
void setSlidingSpring(Vec3D slidingSpring)
Definition: SlidingFrictionInteraction.cc:285
void setIsSuperQuadricInteraction(bool isSuperQuadricInteraction)
Definition: SlidingFrictionInteraction.cc:317
void reverseHistory() override
A useful feature if one wants to return to the initial state of the spring. However,...
Definition: SlidingFrictionInteraction.cc:293
SlidingFrictionInteraction()
Definition: SlidingFrictionInteraction.cc:51
void addTangentialForce(Vec3D force)
adds an extra tangential force, mainly for the tangential lubrication force from LiquidMigrationLS mo...
Definition: SlidingFrictionInteraction.h:117
void rotateHistory(Matrix3D &rotationMatrix) override
When periodic particles are used, some interactions need certain history properties rotated (e....
Definition: SlidingFrictionInteraction.cc:300
Vec3D slidingSpringVelocity_
Stores the rate at which the sliding spring compressed or relaxed. Set in the member function compute...
Definition: SlidingFrictionInteraction.h:155
bool isSuperQuadricInteraction_
Definition: SlidingFrictionInteraction.h:161
Vec3D getSlidingSpring() const
Definition: SlidingFrictionInteraction.cc:307
~SlidingFrictionInteraction() override
Destructor.
Definition: SlidingFrictionInteraction.cc:77
void computeSlidingSpringSuperQuadric(const Vec3D &tangentialRelativeVelocity)
Definition: SlidingFrictionInteraction.cc:201
SlidingFrictionSpecies contains the parameters used to describe sliding friction.
Definition: SlidingFrictionSpecies.h:38
Definition: Vector.h:51
double P
Uniform pressure.
Definition: TwenteMeshGluing.cpp:73