SlidingFrictionInteraction Class Reference

Computes the forces corresponding to sliding friction. More...

#include <SlidingFrictionInteraction.h>

+ Inheritance diagram for SlidingFrictionInteraction:

Public Types

typedef SlidingFrictionSpecies SpeciesType
 An alias name for SlidingFrictionSpecies data type. More...
 

Public Member Functions

 SlidingFrictionInteraction (BaseInteractable *P, BaseInteractable *I, unsigned timeStamp)
 Constructor. More...
 
 SlidingFrictionInteraction ()
 
 SlidingFrictionInteraction (const SlidingFrictionInteraction &p)
 Copy constructor. More...
 
 ~SlidingFrictionInteraction () override
 Destructor. More...
 
void computeFrictionForce ()
 Computes the tangential force generated due to compression in the sliding spring. Does take into account if the interaction is between particle-particle or particle-wall. More...
 
void read (std::istream &is) override
 Interaction read function, which accepts an std::istream as input. More...
 
void write (std::ostream &os) const override
 Interaction write function, which accepts an std::ostream as input. More...
 
void integrate (Mdouble timeStep) override
 Increments the amount of compression in sliding spring. More...
 
Mdouble getElasticEnergy () const override
 Returns the amount of elastic energy stored in sliding spring. More...
 
Mdouble getTangentialOverlap () const override
 Returns the amount of tangential overlap which is needed by BaseInteraction::writeToFstat(). More...
 
std::string getBaseName () const
 Returns the type/name of interaction (sliding friction interaction) More...
 
void setSlidingSpring (Vec3D slidingSpring)
 
Vec3D getSlidingSpring () const
 
const Vec3D getTangentialForce () const override
 Returns the sliding friction force vector. More...
 
void addTangentialForce (Vec3D force)
 adds an extra tangential force, mainly for the tangential lubrication force from LiquidMigrationLS model. More...
 
const SlidingFrictionSpeciesgetSpecies () const
 Returns a const pointer of type SlidingFrictionSpecies*. More...
 
void reverseHistory () override
 A useful feature if one wants to return to the initial state of the spring. However, reverse history decrements the current state to the state corresponding to previous time step. Decrements the value of slidingSpring_. More...
 
void rotateHistory (Matrix3D &rotationMatrix) override
 When periodic particles are used, some interactions need certain history properties rotated (e.g. tangential springs). This is the function for that. More...
 
void moveSlidingSpring (Vec3D displacement)
 
void computeSlidingSpring (const Vec3D &tangentialRelativeVelocity)
 
void setIsSuperQuadricInteraction (bool isSuperQuadricInteraction)
 
- Public Member Functions inherited from BaseInteraction
 BaseInteraction (BaseInteractable *P, BaseInteractable *I, unsigned timeStamp)
 A constructor takes the BaseInteractable objects which are interacting (come into contact) and time the interaction starts. More...
 
 BaseInteraction ()
 
 BaseInteraction (const BaseInteraction &p)
 Copy constructor. More...
 
 ~BaseInteraction () override
 The destructor. It removes this interactions from the objects that were interacting, and writes the time to a file when needed. More...
 
virtual void actionsOnErase ()
 If an interaction needs to do something before it gets erased, add it here. E.g. Liquid bridges rupture at the end of their lifetime, and the liquid bridge volume has to be redistributed. The reason this action is not done in the destructor is that this action should not be taken when erasing ghost interactions. More...
 
virtual void computeForce ()
 Virtual function that contains the force law between the two objects interacting. More...
 
void writeToFStat (std::ostream &os, Mdouble time) const
 Writes forces data to the FStat file. More...
 
std::string getName () const override
 Virtual function which allows interactions to be named. More...
 
void setDistance (Mdouble distance)
 Sets the interaction distance between the two interacting objects. More...
 
void setNormal (Vec3D normal)
 Sets the normal vector between the two interacting objects. More...
 
void setOverlap (Mdouble overlap)
 Set the overlap between the two interacting object. More...
 
void setContactPoint (Vec3D contactPoint)
 Set the location of the contact point between the two interacting objects. More...
 
void setTimeStamp (unsigned timeStamp)
 Updates the time step of the interacting. Note, time steps used to find completed interactions. More...
 
void setSpecies (const BaseSpecies *species)
 Set the Species of the interaction; note this can either be a Species or MixedSpecies. More...
 
void setP (BaseInteractable *P)
 Sets the first object involved in the interaction (normally a particle). More...
 
void setI (BaseInteractable *I)
 Sets the second object involved in the interaction (often particle or wall). More...
 
void importP (BaseInteractable *P)
 Sets the first object involved in the interaction (normally a particle). More...
 
void importI (BaseInteractable *I)
 Sets the second object involved in the interaction (often particle or wall). More...
 
Vec3D getIP () const
 
Vec3D getIC () const
 
Vec3D getCP () const
 
void setLagrangeMultiplier (Mdouble multiplier)
 
Mdouble getLagrangeMultiplier ()
 
void setHandler (InteractionHandler *handler)
 Sets the pointer to the interaction hander which is storing this interaction. More...
 
InteractionHandlergetHandler () const
 Gets a point to the interaction handlers to which this interaction belongs. More...
 
const Vec3DgetForce () const
 Gets the current force (vector) between the two interacting objects. More...
 
const Vec3DgetTorque () const
 Gets the current torque (vector) between the two interacting objects. More...
 
const Vec3DgetNormal () const
 Gets the normal vector between the two interacting objects. More...
 
const Vec3DgetContactPoint () const
 Gets constant reference to contact point (vector). More...
 
Mdouble getOverlap () const
 Returns a Mdouble with the current overlap between the two interacting objects. More...
 
Mdouble getOverlapVolume () const
 Returns the overlap volume between two interacting objects. More...
 
Mdouble getContactRadius () const
 Returns a Mdouble with the current contact between the two interacting objects. More...
 
void removeFromHandler ()
 Removes this interaction from its interaction hander. More...
 
void copySwitchPointer (const BaseInteractable *original, BaseInteractable *ghost) const
 This copies the interactions of the original particle and replaces the original with the ghost copy. More...
 
void gatherContactStatistics ()
 
BaseInteractablegetP ()
 Returns a pointer to first object involved in the interaction (normally a particle). More...
 
BaseInteractablegetI ()
 Returns a pointer to the second object involved in the interaction (often a wall or a particle). More...
 
const BaseInteractablegetP () const
 Returns a constant pointer to the first object involved in the interaction. More...
 
const BaseInteractablegetI () const
 Returns a constant pointer to the second object involved in the interaction. More...
 
Mdouble getTimeStamp () const
 Returns an Mdouble which is the time stamp of the interaction. More...
 
Mdouble getDistance () const
 Returns an Mdouble which is the norm (length) of distance vector. More...
 
const Vec3DgetRelativeVelocity () const
 Returns a constant reference to a vector of relative velocity. More...
 
Mdouble getNormalRelativeVelocity () const
 Returns a double which is the norm (length) of the relative velocity vector. More...
 
Mdouble getAbsoluteNormalForce () const
 Returns the absolute value of the norm (length) of the Normal force vector. More...
 
virtual BaseInteractioncopy () const =0
 Makes a copy of the interaction and returns a pointer to the copy. More...
 
void setFStatData (std::fstream &fstat, BaseParticle *P, BaseWall *I)
 
void setFStatData (std::fstream &fstat, BaseParticle *P, BaseParticle *I)
 
unsigned int getMultiContactIdentifier () const
 
void setMultiContactIdentifier (unsigned int multiContactIdentifier_)
 
virtual void actionsAfterTimeStep ()
 
virtual unsigned getNumberOfFieldsVTK () const
 
virtual std::string getTypeVTK (unsigned i) const
 
virtual std::string getNameVTK (unsigned i) const
 
virtual std::vector< MdoublegetFieldVTK (unsigned i) const
 
void addForce (Vec3D force)
 add an force increment to the total force. More...
 
void addTorque (Vec3D torque)
 add a torque increment to the total torque. More...
 
void setForce (Vec3D force)
 set total force (this is used by the normal force, tangential forces are added use addForce) More...
 
void setTorque (Vec3D torque)
 set the total force (this is used by the normal force, tangential torques are added use addTorque) More...
 
const BaseSpeciesgetBaseSpecies () const
 Return a constant point to BaseSpecies of the interaction. More...
 
virtual void createMPIType ()
 
virtual void * createMPIInteractionDataArray (unsigned int numberOfInteractions) const
 
virtual void deleteMPIInteractionDataArray (void *dataArray)
 
virtual void getMPIInteraction (void *historyDataArray, unsigned int index) const
 copies the history interactions into the data array More...
 
virtual void getInteractionDetails (void *interactionDataArray, unsigned int index, unsigned int &identificationP, unsigned int &identificationI, bool &isWallInteraction, unsigned &timeStamp)
 
virtual void setMPIInteraction (void *interactionDataArray, unsigned int index, bool resetPointers)
 
void setBasicMPIInteractionValues (int P, int I, unsigned timeStamp, Vec3D force, Vec3D torque, bool isWallInteraction, bool resetPointers)
 
void setIdentificationP (unsigned int identification)
 
void setIdentificationI (int identification)
 
void setWallInteraction (bool flag)
 
unsigned int getIdentificationP ()
 
int getIdentificationI ()
 
bool isWallInteraction ()
 
virtual bool isBonded () const
 
- Public Member Functions inherited from BaseObject
 BaseObject ()=default
 Default constructor. More...
 
 BaseObject (const BaseObject &p)=default
 Copy constructor, copies all the objects BaseObject contains. More...
 
virtual ~BaseObject ()=default
 virtual destructor More...
 
virtual void moveInHandler (unsigned int index)
 Except that it is virtual, it does the same thing as setIndex() does. More...
 
void setIndex (unsigned int index)
 Allows one to assign an index to an object in the handler/container. More...
 
void setId (unsigned long id)
 Assigns a unique identifier to each object in the handler (container) which remains constant even after the object is deleted from the container/handler. More...
 
unsigned int getIndex () const
 Returns the index of the object in the handler. More...
 
unsigned int getId () const
 Returns the unique identifier of any particular object. More...
 
void setGroupId (unsigned groupId)
 
unsigned getGroupId () const
 

Protected Attributes

Vec3D slidingSpring_
 Stores the amount of sliding spring ( \(\delta\)) compression from the expression \(f_t=-k*\delta-\nu*relVel\). Set in the member function integrate(), used in computeFrictionForce(). More...
 
Vec3D slidingSpringVelocity_
 Stores the rate at which the sliding spring compressed or relaxed. Set in the member function computeFrictionForce() and used in integrate(). More...
 
Vec3D tangentialForce_
 Computes the tangential force such that \(|f_t|=\mu*|f_n|\). Set and computed in computeFrictionForce(). More...
 
bool isSuperQuadricInteraction_
 

Additional Inherited Members

- Protected Member Functions inherited from BaseInteraction
Mdouble getEffectiveRadius () const
 Returns a Mdouble to the effective radius of the interaction. (Not corrected for the overlap) More...
 
Mdouble getEffectiveMass () const
 Returns a Mdouble to the effective radius of the interaction. (Not corrected for the overlap) More...
 
void setRelativeVelocity (Vec3D relativeVelocity)
 set the relative velocity of the current of the interactions. More...
 
void setNormalRelativeVelocity (Mdouble normalRelativeVelocit)
 set the normal component of the relative velocity. More...
 
void setAbsoluteNormalForce (Mdouble absoluteNormalForce)
 the absolute values of the norm (length) of the normal force More...
 
virtual Mdouble getElasticEnergyAtEquilibrium (Mdouble adhesiveForce) const
 
void writeInteraction (std::ostream &os, bool created) const
 Writes information about a interaction to the interaction file. More...
 

Detailed Description

Computes the forces corresponding to sliding friction.

Member Typedef Documentation

◆ SpeciesType

An alias name for SlidingFrictionSpecies data type.

Constructor & Destructor Documentation

◆ SlidingFrictionInteraction() [1/3]

SlidingFrictionInteraction::SlidingFrictionInteraction ( BaseInteractable P,
BaseInteractable I,
unsigned  timeStamp 
)

Constructor.

Parameters
[in]P
[in]I
[in]timeStamp
19  : BaseInteraction(P, I, timeStamp)
20 {
23 #ifdef DEBUG_CONSTRUCTOR
24  std::cout<<"SlidingFrictionInteraction::SlidingFrictionInteraction() finished"<<std::endl;
25 #endif
26 }
BaseInteraction()
Definition: BaseInteraction.cc:43
Vec3D slidingSpring_
Stores the amount of sliding spring ( ) compression from the expression . Set in the member function ...
Definition: SlidingFrictionInteraction.h:127
bool isSuperQuadricInteraction_
Definition: SlidingFrictionInteraction.h:138
void setZero()
Sets all elements to zero.
Definition: Vector.cc:23
#define I
Definition: main.h:127
double P
Uniform pressure.
Definition: TwenteMeshGluing.cpp:77

References isSuperQuadricInteraction_, Vec3D::setZero(), and slidingSpring_.

◆ SlidingFrictionInteraction() [2/3]

SlidingFrictionInteraction::SlidingFrictionInteraction ( )
30  : BaseInteraction()
31 {
34 #ifdef DEBUG_CONSTRUCTOR
35  std::cout<<"SlidingFrictionInteraction::SlidingFrictionInteraction() finished"<<std::endl;
36 #endif
37 }

References isSuperQuadricInteraction_, Vec3D::setZero(), and slidingSpring_.

◆ SlidingFrictionInteraction() [3/3]

SlidingFrictionInteraction::SlidingFrictionInteraction ( const SlidingFrictionInteraction p)

Copy constructor.

Parameters
[in]p
44 {
45  slidingSpring_ = p.slidingSpring_;
46  isSuperQuadricInteraction_ = p.isSuperQuadricInteraction_;
47 #ifdef DEBUG_CONSTRUCTOR
48  std::cout<<"SlidingFrictionInteraction::SlidingFrictionInteraction(const SlidingFrictionInteraction& p) finished"<<std::endl;
49 #endif
50 }
float * p
Definition: Tutorial_Map_using.cpp:9

References isSuperQuadricInteraction_, p, and slidingSpring_.

◆ ~SlidingFrictionInteraction()

SlidingFrictionInteraction::~SlidingFrictionInteraction ( )
override

Destructor.

56 {
57 #ifdef DEBUG_DESTRUCTOR
58  std::cout<<"SlidingFrictionInteraction::~SlidingFrictionInteraction() finished"<<std::endl;
59 #endif
60 }

Member Function Documentation

◆ addTangentialForce()

void SlidingFrictionInteraction::addTangentialForce ( Vec3D  force)
inline

adds an extra tangential force, mainly for the tangential lubrication force from LiquidMigrationLS model.

96  {
97  tangentialForce_ = Vec3D(0.0,0.0,0.0);
98  tangentialForce_ += force;
99  }
Vec3D tangentialForce_
Computes the tangential force such that . Set and computed in computeFrictionForce().
Definition: SlidingFrictionInteraction.h:136
Definition: Kernel/Math/Vector.h:30

References tangentialForce_.

Referenced by LiquidMigrationLSInteraction::computeAdhesionForce(), and LiquidMigrationWilletViscousInteraction::computeAdhesionForce().

◆ computeFrictionForce()

void SlidingFrictionInteraction::computeFrictionForce ( )

Computes the tangential force generated due to compression in the sliding spring. Does take into account if the interaction is between particle-particle or particle-wall.

85 {
86  //If tangential forces are absent
87  if (getAbsoluteNormalForce() == 0.0) return;
88 
89  const SlidingFrictionSpecies* species = getSpecies();//dynamic_cast
91 
92  if (species->getSlidingFrictionCoefficient() != 0.0)
93  {
94  //Compute the tangential component of relativeVelocity_
95  // relativeVelocity = [v_p + (r_p-c) x w_p] - [v_i + (r_i-c) x w_i]
96  // tangentialRelativeVelocity = relativeVelocity - (relativeVelocity . n) n
97  Vec3D tangentialRelativeVelocity = getRelativeVelocity() - getNormal() * getNormalRelativeVelocity();
98 
99  if (species->getSlidingStiffness() != 0.0)
100  {
101 
102  computeSlidingSpring(tangentialRelativeVelocity);
103 
104  //Calculate test force acting on P including viscous force
106  species->getSlidingDissipation() * tangentialRelativeVelocity;
107  if (getBaseSpecies()->getNormalForce()->getConstantRestitution()) tangentialForce_ *=2.0*getEffectiveMass();
108 
109  //tangential forces are modelled by a spring-damper of elasticity kt and viscosity dispt (sticking),
110  //but the force is limited by Coulomb friction (sliding):
111  Mdouble tangentialForceSquared = tangentialForce_.getLengthSquared();
112  if (tangentialForceSquared <=
114  {
115  //if sticking (|ft|<=mu*|fn|), apply the force
117  }
118  else
119  {
120  //if sliding, resize the tangential force such that |ft|=mu*|fn|
122  std::sqrt(tangentialForceSquared);
124  //resize the tangential spring accordingly such ft=-k*delta-nu*relVel
125  slidingSpring_ = -(tangentialForce_ + species->getSlidingDissipation() * tangentialRelativeVelocity) /
126  species->getSlidingStiffness();
127  }
128  }
129  else //if no spring stiffness is set
130  {
131 // if (species->getSlidingDissipation()==0.0)
132 // {
133 // std::cerr << "SlidingFrictionInteraction::getForce(): warning: both sliding stiffness and dissipation are zero" << std::endl;
134 // }
135  Mdouble tangentialRelativeVelocitySquared = tangentialRelativeVelocity.getLengthSquared();
136  if (tangentialRelativeVelocitySquared * mathsFunc::square(species->getSlidingDissipation()) <=
138  tangentialForce_ = -species->getSlidingDissipation() * tangentialRelativeVelocity;
139  else //if sliding, set force to Coulomb limit
141  std::sqrt(tangentialRelativeVelocitySquared)) * tangentialRelativeVelocity;
142 
144  }
145  }
146 
147  /* And if species->getSlidingFrictionCoefficient() == 0.0, then there is no
148  * friction force at all. */
149 }
AnnoyingScalar sqrt(const AnnoyingScalar &x)
Definition: AnnoyingScalar.h:134
const Vec3D & getRelativeVelocity() const
Returns a constant reference to a vector of relative velocity.
Definition: BaseInteraction.cc:554
Mdouble getEffectiveMass() const
Returns a Mdouble to the effective radius of the interaction. (Not corrected for the overlap)
Definition: BaseInteraction.cc:792
Mdouble getAbsoluteNormalForce() const
Returns the absolute value of the norm (length) of the Normal force vector.
Definition: BaseInteraction.cc:577
const Vec3D & getNormal() const
Gets the normal vector between the two interacting objects.
Definition: BaseInteraction.h:205
void addForce(Vec3D force)
add an force increment to the total force.
Definition: BaseInteraction.cc:587
Mdouble getNormalRelativeVelocity() const
Returns a double which is the norm (length) of the relative velocity vector.
Definition: BaseInteraction.cc:565
const BaseSpecies * getBaseSpecies() const
Return a constant point to BaseSpecies of the interaction.
Definition: BaseInteraction.cc:663
void computeSlidingSpring(const Vec3D &tangentialRelativeVelocity)
Definition: SlidingFrictionInteraction.cc:151
const SlidingFrictionSpecies * getSpecies() const
Returns a const pointer of type SlidingFrictionSpecies*.
Definition: SlidingFrictionInteraction.cc:214
SlidingFrictionSpecies contains the parameters used to describe sliding friction.
Definition: SlidingFrictionSpecies.h:17
Mdouble getSlidingFrictionCoefficientStatic() const
Allows the static Coulomb friction coefficient to be accessed.
Definition: SlidingFrictionSpecies.cc:153
Mdouble getSlidingFrictionCoefficient() const
Allows the (dynamic) Coulomb friction coefficient to be accessed.
Definition: SlidingFrictionSpecies.cc:134
Mdouble getSlidingStiffness() const
Allows the spring constant to be accessed.
Definition: SlidingFrictionSpecies.cc:96
Mdouble getSlidingDissipation() const
Allows the tangential viscosity to be accessed.
Definition: SlidingFrictionSpecies.cc:113
bool getIsSuperquadricSpecies() const
Definition: SlidingFrictionSpecies.cc:250
static Mdouble getLengthSquared(const Vec3D &a)
Calculates the squared length of a Vec3D: .
Definition: Kernel/Math/Vector.h:324
T square(const T val)
squares a number
Definition: ExtendedMath.h:86

References BaseInteraction::addForce(), computeSlidingSpring(), BaseInteraction::getAbsoluteNormalForce(), BaseInteraction::getBaseSpecies(), BaseInteraction::getEffectiveMass(), SlidingFrictionSpecies::getIsSuperquadricSpecies(), Vec3D::getLengthSquared(), BaseInteraction::getNormal(), BaseInteraction::getNormalRelativeVelocity(), BaseInteraction::getRelativeVelocity(), SlidingFrictionSpecies::getSlidingDissipation(), SlidingFrictionSpecies::getSlidingFrictionCoefficient(), SlidingFrictionSpecies::getSlidingFrictionCoefficientStatic(), SlidingFrictionSpecies::getSlidingStiffness(), getSpecies(), isSuperQuadricInteraction_, slidingSpring_, sqrt(), mathsFunc::square(), and tangentialForce_.

Referenced by FrictionInteraction::computeFrictionForce().

◆ computeSlidingSpring()

void SlidingFrictionInteraction::computeSlidingSpring ( const Vec3D tangentialRelativeVelocity)
152 {
153  // Calculating the tangential spring using Luding, S. (2008) eq. (17)
154  const Mdouble springLength = slidingSpring_.getLength();
155  if (springLength > 1e-10)
156  {
158  slidingSpring_ *= springLength / slidingSpring_.getLength();
159 
160  // Check length
161  logger.assert_debug(std::abs(slidingSpring_.getLength() - springLength) < 1e-10 * springLength, "SlidingFrictionInteraction::computeSlidingSpring: Spring length not the same after rotation (before = %, after = %)", springLength, slidingSpring_.getLength());
162 
163  // Check orthogonality
164  logger.assert_debug(std::abs(Vec3D::dot(slidingSpring_, getNormal())) < 1e-10 * springLength, "SlidingFrictionInteraction::computeSlidingSpring: sliding spring not perpendicular to normal (after rotation)");
165  }
166 
167 
168  // integrate(getHandler()->timeStep_);
169  slidingSpringVelocity_ = tangentialRelativeVelocity;
171 }
AnnoyingScalar abs(const AnnoyingScalar &x)
Definition: AnnoyingScalar.h:135
Array< double, 1, 3 > e(1./3., 0.5, 2.)
Logger< MERCURYDPM_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here.
DPMBase * getDPMBase()
Gets the problem that is solved using this handler.
Definition: BaseHandler.h:733
InteractionHandler * getHandler() const
Gets a point to the interaction handlers to which this interaction belongs.
Definition: BaseInteraction.cc:247
Mdouble getTimeStep() const
Returns the simulation time step.
Definition: DPMBase.cc:1241
Vec3D slidingSpringVelocity_
Stores the rate at which the sliding spring compressed or relaxed. Set in the member function compute...
Definition: SlidingFrictionInteraction.h:132
static Mdouble getLength(const Vec3D &a)
Calculates the length of a Vec3D: .
Definition: Vector.cc:350
static Mdouble dot(const Vec3D &a, const Vec3D &b)
Calculates the dot product of two Vec3D: .
Definition: Vector.cc:56

References abs(), Vec3D::dot(), e(), BaseHandler< T >::getDPMBase(), BaseInteraction::getHandler(), Vec3D::getLength(), BaseInteraction::getNormal(), DPMBase::getTimeStep(), logger, slidingSpring_, and slidingSpringVelocity_.

Referenced by computeFrictionForce().

◆ getBaseName()

std::string SlidingFrictionInteraction::getBaseName ( ) const

Returns the type/name of interaction (sliding friction interaction)

Returns
std::string
224 {
225  return "SlidingFriction";
226 }

◆ getElasticEnergy()

Mdouble SlidingFrictionInteraction::getElasticEnergy ( ) const
overridevirtual

Returns the amount of elastic energy stored in sliding spring.

Returns
Mdouble

Reimplemented from BaseInteraction.

186 {
187  if (getBaseSpecies()->getNormalForce()->getConstantRestitution()) {
189  } else {
191  }
192 }

References BaseInteraction::getBaseSpecies(), BaseInteraction::getEffectiveMass(), Vec3D::getLengthSquared(), SlidingFrictionSpecies::getSlidingStiffness(), getSpecies(), and slidingSpring_.

Referenced by FrictionInteraction::getElasticEnergy().

◆ getSlidingSpring()

Vec3D SlidingFrictionInteraction::getSlidingSpring ( ) const
252 {
253  return slidingSpring_;
254 }

References slidingSpring_.

◆ getSpecies()

const SlidingFrictionSpecies * SlidingFrictionInteraction::getSpecies ( ) const

Returns a const pointer of type SlidingFrictionSpecies*.

Returns
const SlidingFrictionSpecies*
215 {
216  return static_cast<const SlidingFrictionSpecies*>(getBaseSpecies()->getFrictionForce());
217 ;
218 }
BaseFrictionForce * getFrictionForce() const
Definition: BaseSpecies.h:129

References BaseInteraction::getBaseSpecies(), and BaseSpecies::getFrictionForce().

Referenced by computeFrictionForce(), and getElasticEnergy().

◆ getTangentialForce()

const Vec3D SlidingFrictionInteraction::getTangentialForce ( ) const
overridevirtual

Returns the sliding friction force vector.

Returns
const Vec3D

Reimplemented from BaseInteraction.

207 {
208  return tangentialForce_;
209 }

References tangentialForce_.

◆ getTangentialOverlap()

Mdouble SlidingFrictionInteraction::getTangentialOverlap ( ) const
overridevirtual

Returns the amount of tangential overlap which is needed by BaseInteraction::writeToFstat().

Returns
Mdouble
Todo:
TWnow this should be positive

Reimplemented from BaseInteraction.

198 {
200  return -slidingSpring_.getLength();
201 }

References Vec3D::getLength(), and slidingSpring_.

◆ integrate()

void SlidingFrictionInteraction::integrate ( Mdouble timeStep  )
overridevirtual

Increments the amount of compression in sliding spring.

Parameters
[in]timeStepthe dt

Reimplemented from BaseInteraction.

178 {
180 }

References slidingSpring_, and slidingSpringVelocity_.

Referenced by FrictionInteraction::integrate().

◆ moveSlidingSpring()

void SlidingFrictionInteraction::moveSlidingSpring ( Vec3D  displacement)
257 {
258  slidingSpring_ += displacement;
259 }

References slidingSpring_.

◆ read()

void SlidingFrictionInteraction::read ( std::istream &  is)
overridevirtual

Interaction read function, which accepts an std::istream as input.

Parameters
[in,out]is

Reimplemented from BaseInteraction.

75 {
76  //BaseInteraction::read(is);
77  std::string dummy;
78  is >> dummy >> slidingSpring_;
79 }
std::string string(const unsigned &i)
Definition: oomph_definitions.cc:286

References slidingSpring_, and oomph::Global_string_for_annotation::string().

Referenced by FrictionInteraction::read().

◆ reverseHistory()

void SlidingFrictionInteraction::reverseHistory ( )
overridevirtual

A useful feature if one wants to return to the initial state of the spring. However, reverse history decrements the current state to the state corresponding to previous time step. Decrements the value of slidingSpring_.

Reimplemented from BaseInteraction.

References slidingSpring_, slidingSpringVelocity_, and tangentialForce_.

Referenced by FrictionInteraction::reverseHistory().

◆ rotateHistory()

void SlidingFrictionInteraction::rotateHistory ( Matrix3D rotationMatrix)
overridevirtual

When periodic particles are used, some interactions need certain history properties rotated (e.g. tangential springs). This is the function for that.

Todo:
some of these might be unneccesary

Reimplemented from BaseInteraction.

245 {
246  slidingSpring_ = rotationMatrix * slidingSpring_;
248  tangentialForce_ = rotationMatrix * tangentialForce_;
249 }

References slidingSpring_, slidingSpringVelocity_, and tangentialForce_.

Referenced by FrictionInteraction::rotateHistory().

◆ setIsSuperQuadricInteraction()

void SlidingFrictionInteraction::setIsSuperQuadricInteraction ( bool  isSuperQuadricInteraction)
262 {
263  isSuperQuadricInteraction_ = isSuperQuadricInteraction;
264 }

References isSuperQuadricInteraction_.

◆ setSlidingSpring()

void SlidingFrictionInteraction::setSlidingSpring ( Vec3D  slidingSpring)
Bug:
may need to remove the consts
230 {
231  slidingSpring_ = slidingSpring;
232 }

References slidingSpring_.

◆ write()

void SlidingFrictionInteraction::write ( std::ostream &  os) const
overridevirtual

Interaction write function, which accepts an std::ostream as input.

Parameters
[in,out]os

Reimplemented from BaseInteraction.

66 {
67  //BaseInteraction::write(os);
68  os << " slidingSpring " << slidingSpring_;
69 }

References slidingSpring_.

Referenced by FrictionInteraction::write().

Member Data Documentation

◆ isSuperQuadricInteraction_

bool SlidingFrictionInteraction::isSuperQuadricInteraction_
protected

◆ slidingSpring_

Vec3D SlidingFrictionInteraction::slidingSpring_
protected

Stores the amount of sliding spring ( \(\delta\)) compression from the expression \(f_t=-k*\delta-\nu*relVel\). Set in the member function integrate(), used in computeFrictionForce().

Referenced by computeFrictionForce(), computeSlidingSpring(), getElasticEnergy(), getSlidingSpring(), getTangentialOverlap(), integrate(), moveSlidingSpring(), read(), reverseHistory(), rotateHistory(), setSlidingSpring(), SlidingFrictionInteraction(), and write().

◆ slidingSpringVelocity_

Vec3D SlidingFrictionInteraction::slidingSpringVelocity_
protected

Stores the rate at which the sliding spring compressed or relaxed. Set in the member function computeFrictionForce() and used in integrate().

Referenced by computeSlidingSpring(), integrate(), reverseHistory(), and rotateHistory().

◆ tangentialForce_

Vec3D SlidingFrictionInteraction::tangentialForce_
protected

Computes the tangential force such that \(|f_t|=\mu*|f_n|\). Set and computed in computeFrictionForce().

Referenced by addTangentialForce(), computeFrictionForce(), getTangentialForce(), reverseHistory(), and rotateHistory().


The documentation for this class was generated from the following files: