MercuryDPM
Alpha
|
This class allows one to take all three types of frictional interactions into account. The sliding, rolling and torsional frictional interaction. See. More...
#include <MindlinRollingTorsionInteraction.h>
Public Types | |
typedef MindlinRollingTorsionSpecies | SpeciesType |
An alias for FrictionSpecies. More... | |
Public Types inherited from MindlinInteraction | |
typedef MindlinSpecies | SpeciesType |
An alias name for MindlinSpecies data type. More... | |
Public Member Functions | |
MindlinRollingTorsionInteraction (BaseInteractable *P, BaseInteractable *I, unsigned timeStamp) | |
Constructor. More... | |
MindlinRollingTorsionInteraction () | |
MindlinRollingTorsionInteraction (const MindlinRollingTorsionInteraction &p) | |
Copy constructor. More... | |
virtual | ~MindlinRollingTorsionInteraction () |
Destructor. More... | |
void | computeFrictionForce () |
Computes the forces arising due to all three types of friction, i.e., sliding, rolling and torsional. 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 print function, which accepts an std::ostream as input. More... | |
void | integrate (Mdouble timeStep) override |
Computes the amount of compression in all the springs, i.e., increments the rollingSpring_, slidingSpring_ (see MindlinInteraction.cc) and torsionSpring_. More... | |
Mdouble | getElasticEnergy () const override |
Returns the global amount of energy stored in all the springs (rolling, sliding and torsional). More... | |
std::string | getBaseName () const |
Returns interaction name/type. More... | |
const MindlinRollingTorsionSpecies * | getSpecies () const |
Returns a const pointer of type FrictionSpecies*. More... | |
void | reverseHistory () override |
A useful feature if one wants to return to the initial state of the springs. However, reverse history decrements the current state to the state corresponding to previous time step. Decrements the state or value of rollingSpring_, torsionSpring_ and 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... | |
Vec3D | getRollingSpring () const |
Vec3D | getTorsionSpring () const |
void | setRollingSpring (Vec3D rollingSpring) |
void | setTorsionSpring (Vec3D torsionSpring) |
Public Member Functions inherited from MindlinInteraction | |
MindlinInteraction (BaseInteractable *P, BaseInteractable *I, unsigned timeStamp) | |
Constructor. More... | |
MindlinInteraction (const MindlinInteraction &p) | |
Copy constructor. More... | |
MindlinInteraction () | |
Empty constructor. More... | |
virtual | ~MindlinInteraction () |
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... | |
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... | |
const Vec3D | getTangentialForce () const override |
Returns the sliding friction force vector. More... | |
const Mdouble | getTangentialForceDirection () const |
Mdouble | getAbsoluteNormalForcePrevious () const |
Returns the absolute value of the norm (length) of the previous Normal force vector. More... | |
void | setAbsoluteNormalForcePrevious (Mdouble absoluteNormalForcePrevious) |
allows the previous normal force to be (re)set from external classes More... | |
const MindlinSpecies * | getSpecies () const |
Returns a const pointer of type MindlinSpecies*. More... | |
void | setTangentialStiffnessZero (Mdouble newKt0) |
Mdouble | getTangentialStiffnessZero () |
Mdouble | getTangentialStiffness () |
void | updateTangentialStiffnessZero (Mdouble rad, double shearMod) |
void | updateTangentialStiffnessInitial (Mdouble fric) |
void | updateTangentialStiffnessInitial2 (const Mdouble fric, const Vec3D direction) |
void | updateTangentialStiffnessUnloading (const Mdouble fric, const Vec3D direction) |
void | updateTangentialStiffnessReloading (const Mdouble fric, const Vec3D direction) |
void | updateTangentialStiffnessReloadingTanUp (const Mdouble fric, const Vec3D direction) |
void | updateTangentialStiffnessUnloadingTanDown (const Mdouble fric, const Vec3D direction) |
void | updateK_t (const Mdouble fric, const Vec3D direction, const bool useTurningPoint, const bool isLoading) |
Public Member Functions inherited from BaseInteraction | |
BaseInteraction (BaseInteractable *P, BaseInteractable *I, Mdouble timeStamp) | |
A constructor takes the BaseInteractable objects which are interacting (come into contact) and time the interaction starts. More... | |
BaseInteraction (const BaseInteraction &p) | |
Copy constructor. More... | |
BaseInteraction () | |
Empty constructor. More... | |
virtual | ~BaseInteraction () |
The default destructor. 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) const |
Writes forces data to the FStat file. More... | |
virtual std::string | getName () const |
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 (Mdouble timeStamp) |
Updates the time step of the interacting. Note, timesteps used to find completed interactions. More... | |
void | setSpecies (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 | setHandler (InteractionHandler *handler) |
Sets the pointer to the interaction hander which is storing this interaction. More... | |
InteractionHandler * | getHandler () const |
Gets a point to the interaction handlers to which this interaction belongs. More... | |
const Vec3D & | getForce () const |
Gets the current force (vector) between the two interacting objects. More... | |
const Vec3D & | getTorque () const |
Gets the current torque (vector) between the two interacting objects. More... | |
const Vec3D & | getNormal () const |
Gets the normal vector between the two interacting objects. More... | |
const Vec3D & | getContactPoint () 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 | 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 () |
BaseInteractable * | getP () |
Returns a pointer to first object involved in the interaction (normally a particle). More... | |
BaseInteractable * | getI () |
const BaseInteractable * | getP () const |
const BaseInteractable * | getI () 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 Vec3D & | getRelativeVelocity () 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 BaseInteraction * | copy () const =0 |
Makes a copy of the interaction and returns a pointer to the copy. More... | |
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< Mdouble > | getFieldVTK (unsigned i) const |
void | setForce (Vec3D force) |
set total force (this is used by the normal force, tangential forces are added use addForce) More... | |
Public Member Functions inherited from BaseObject | |
BaseObject () | |
Default constructor. More... | |
BaseObject (const BaseObject &p) | |
Copy constructor, copies all the objects BaseObject contains. More... | |
virtual | ~BaseObject () |
virtual destructor More... | |
virtual void | moveInHandler (const unsigned int index) |
Except that it is virtual, it does the same thing as setIndex() does. More... | |
void | setIndex (const unsigned int index) |
Allows one to assign an index to an object in the handler/container. More... | |
void | setId (const unsigned int 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... | |
Private Attributes | |
Vec3D | rollingSpring_ |
Stores the amount of rolling spring compression. Set in integrate(), used in computing frictional force due to rolling. More... | |
Vec3D | rollingSpringVelocity_ |
Stores the rate at which the rolling spring compresses or relaxes. Set in computeFrictionForce(), used in computing the amount of compression in rolling spring. Used in integrate(). More... | |
Vec3D | torsionSpring_ |
Stores the amount of torsional spring compression. Set in integrate(), used in computing frictional force due to torsion. More... | |
Vec3D | torsionSpringVelocity_ |
Stores the rate at which the torsional spring compresses or relaxes. Set in computeFrictionForce(), used in computing the amount of compression in torsion spring. Used in integrate(). More... | |
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... | |
Mdouble | getEffectiveCorrectedRadius () |
Returns a Mdouble to the effective radius corrected for the overlaps of the particles. More... | |
void | addForce (Vec3D force) |
add an force increment to the total force. More... | |
void | addTorque (Vec3D torque) |
void | setTorque (Vec3D torque) |
set the total force (this is used by the normal force, tangential torques are added use addTorque) 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... | |
const BaseSpecies * | getBaseSpecies () const |
Return a constant point to BaseSpecies of the interaction. More... | |
virtual Mdouble | getElasticEnergyAtEquilibrium (Mdouble adhesiveForce) const |
Protected Attributes inherited from MindlinInteraction | |
Vec3D | slidingSpring_ |
Stores the amount of sliding spring ( ) compression from the expression . Set in the member function integrate(), used in computeFrictionForce(). More... | |
Vec3D | slidingSpringPrevious_ |
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 . Set and computed in computeFrictionForce(). More... | |
Vec3D | tangentialForcePrevious_ |
Mdouble | tangentialForceDirection_ |
Vec3D | tangentialForceTurningPointLU_ |
Vec3D | tangentialForceTurningPointUL_ |
Vec3D | tangentialForceTurningPointLUTemp_ |
Vec3D | tangentialForceTurningPointULTemp_ |
Vec3D | tangentialDisplacementTurningPointUL_ |
Vec3D | tangentialDisplacementTurningPointLU_ |
Mdouble | tangentialStiffnessZero_ |
Mdouble | tangentialStiffnessZeroPrevious_ |
Mdouble | tangentialStiffness_ |
bool | priorLoadingFlag_ |
Vec3D | tangentialForceTemp_ |
Vec3D | tangentialDisplacementTemp_ |
Vec3D | tangentialForceTemp2_ |
Vec3D | tangentialDisplacementTemp2_ |
Mdouble | tangentialDisplacementSL_ |
Vec3D | initialTangentialVelocity_ |
Mdouble | absoluteNormalForcePrevious_ |
This class allows one to take all three types of frictional interactions into account. The sliding, rolling and torsional frictional interaction. See.
Definition at line 41 of file MindlinRollingTorsionInteraction.h.
An alias for FrictionSpecies.
Definition at line 47 of file MindlinRollingTorsionInteraction.h.
MindlinRollingTorsionInteraction::MindlinRollingTorsionInteraction | ( | BaseInteractable * | P, |
BaseInteractable * | I, | ||
unsigned | timeStamp | ||
) |
Constructor.
[in] | P | |
[in] | I | |
[in] | timeStamp |
Definition at line 40 of file MindlinRollingTorsionInteraction.cc.
References rollingSpring_, Vec3D::setZero(), and torsionSpring_.
MindlinRollingTorsionInteraction::MindlinRollingTorsionInteraction | ( | ) |
Definition at line 51 of file MindlinRollingTorsionInteraction.cc.
References rollingSpring_, Vec3D::setZero(), and torsionSpring_.
MindlinRollingTorsionInteraction::MindlinRollingTorsionInteraction | ( | const MindlinRollingTorsionInteraction & | p | ) |
Copy constructor.
[in] | p |
Definition at line 64 of file MindlinRollingTorsionInteraction.cc.
References rollingSpring_, and torsionSpring_.
|
virtual |
Destructor.
Definition at line 76 of file MindlinRollingTorsionInteraction.cc.
void MindlinRollingTorsionInteraction::computeFrictionForce | ( | ) |
Computes the forces arising due to all three types of friction, i.e., sliding, rolling and torsional.
Calls the MindlinInteraction::computeFrictionForce() as well, see MindlinInteraction.cc.
Definition at line 104 of file MindlinRollingTorsionInteraction.cc.
References BaseInteraction::addTorque(), MindlinInteraction::computeFrictionForce(), Vec3D::cross(), Vec3D::dot(), BaseInteraction::getAbsoluteNormalForce(), BaseInteraction::getDistance(), BaseHandler< T >::getDPMBase(), BaseInteraction::getEffectiveRadius(), BaseInteraction::getHandler(), BaseInteraction::getI(), Vec3D::getLengthSquared(), BaseInteraction::getNormal(), BaseInteraction::getP(), MindlinRollingTorsionSpecies::getRollingDissipation(), MindlinRollingTorsionSpecies::getRollingFrictionCoefficient(), MindlinRollingTorsionSpecies::getRollingFrictionCoefficientStatic(), getSpecies(), DPMBase::getTimeStep(), MindlinRollingTorsionSpecies::getTorsionDissipation(), MindlinRollingTorsionSpecies::getTorsionFrictionCoefficient(), MindlinRollingTorsionSpecies::getTorsionFrictionCoefficientStatic(), BaseInteractable::getVelocity(), rollingSpring_, rollingSpringVelocity_, mathsFunc::square(), MindlinInteraction::tangentialStiffnessZero_, torsionSpring_, and torsionSpringVelocity_.
std::string MindlinRollingTorsionInteraction::getBaseName | ( | ) | const |
Returns interaction name/type.
Definition at line 224 of file MindlinRollingTorsionInteraction.cc.
|
overridevirtual |
Returns the global amount of energy stored in all the springs (rolling, sliding and torsional).
Reimplemented from MindlinInteraction.
Definition at line 208 of file MindlinRollingTorsionInteraction.cc.
References MindlinInteraction::getElasticEnergy(), Vec3D::getLengthSquared(), rollingSpring_, MindlinInteraction::tangentialStiffnessZero_, and torsionSpring_.
Vec3D MindlinRollingTorsionInteraction::getRollingSpring | ( | ) | const |
Definition at line 252 of file MindlinRollingTorsionInteraction.cc.
References rollingSpring_.
const MindlinRollingTorsionSpecies * MindlinRollingTorsionInteraction::getSpecies | ( | ) | const |
Returns a const pointer of type FrictionSpecies*.
Definition at line 217 of file MindlinRollingTorsionInteraction.cc.
References BaseInteraction::getBaseSpecies().
Referenced by computeFrictionForce().
Vec3D MindlinRollingTorsionInteraction::getTorsionSpring | ( | ) | const |
Definition at line 257 of file MindlinRollingTorsionInteraction.cc.
References torsionSpring_.
|
overridevirtual |
Computes the amount of compression in all the springs, i.e., increments the rollingSpring_, slidingSpring_ (see MindlinInteraction.cc) and torsionSpring_.
[in] | timeStep | the amount of time by which the solution is evolved |
Reimplemented from MindlinInteraction.
Definition at line 199 of file MindlinRollingTorsionInteraction.cc.
References Vec3D::dot(), BaseInteraction::getNormal(), MindlinInteraction::integrate(), rollingSpring_, rollingSpringVelocity_, torsionSpring_, and torsionSpringVelocity_.
|
overridevirtual |
Interaction read function, which accepts an std::istream as input.
in/out] | is input file stream |
Reimplemented from MindlinInteraction.
Definition at line 94 of file MindlinRollingTorsionInteraction.cc.
References MindlinInteraction::read(), rollingSpring_, and torsionSpring_.
|
overridevirtual |
A useful feature if one wants to return to the initial state of the springs. However, reverse history decrements the current state to the state corresponding to previous time step. Decrements the state or value of rollingSpring_, torsionSpring_ and slidingSpring_.
Reimplemented from MindlinInteraction.
Definition at line 231 of file MindlinRollingTorsionInteraction.cc.
References MindlinInteraction::reverseHistory(), torsionSpring_, and torsionSpringVelocity_.
|
overridevirtual |
When periodic particles are used, some interactions need certain history properties rotated (e.g. tangential springs). This is the function for that.
Reimplemented from MindlinInteraction.
Definition at line 243 of file MindlinRollingTorsionInteraction.cc.
References rollingSpring_, rollingSpringVelocity_, MindlinInteraction::rotateHistory(), torsionSpring_, and torsionSpringVelocity_.
void MindlinRollingTorsionInteraction::setRollingSpring | ( | Vec3D | rollingSpring | ) |
Definition at line 262 of file MindlinRollingTorsionInteraction.cc.
References rollingSpring_.
void MindlinRollingTorsionInteraction::setTorsionSpring | ( | Vec3D | torsionSpring | ) |
Definition at line 267 of file MindlinRollingTorsionInteraction.cc.
References torsionSpring_.
|
overridevirtual |
Interaction print function, which accepts an std::ostream as input.
in/out] | os output file stream |
Reimplemented from MindlinInteraction.
Definition at line 85 of file MindlinRollingTorsionInteraction.cc.
References rollingSpring_, torsionSpring_, and MindlinInteraction::write().
|
private |
Stores the amount of rolling spring compression. Set in integrate(), used in computing frictional force due to rolling.
Definition at line 116 of file MindlinRollingTorsionInteraction.h.
Referenced by computeFrictionForce(), getElasticEnergy(), getRollingSpring(), integrate(), MindlinRollingTorsionInteraction(), read(), rotateHistory(), setRollingSpring(), and write().
|
private |
Stores the rate at which the rolling spring compresses or relaxes. Set in computeFrictionForce(), used in computing the amount of compression in rolling spring. Used in integrate().
Definition at line 121 of file MindlinRollingTorsionInteraction.h.
Referenced by computeFrictionForce(), integrate(), and rotateHistory().
|
private |
Stores the amount of torsional spring compression. Set in integrate(), used in computing frictional force due to torsion.
Definition at line 126 of file MindlinRollingTorsionInteraction.h.
Referenced by computeFrictionForce(), getElasticEnergy(), getTorsionSpring(), integrate(), MindlinRollingTorsionInteraction(), read(), reverseHistory(), rotateHistory(), setTorsionSpring(), and write().
|
private |
Stores the rate at which the torsional spring compresses or relaxes. Set in computeFrictionForce(), used in computing the amount of compression in torsion spring. Used in integrate().
Definition at line 131 of file MindlinRollingTorsionInteraction.h.
Referenced by computeFrictionForce(), integrate(), reverseHistory(), and rotateHistory().