LinearViscoelasticInteraction Class Reference

Enables one to compute normal forces in case of a linear visco-elastic interaction. More...

#include <LinearViscoelasticInteraction.h>

+ Inheritance diagram for LinearViscoelasticInteraction:

Public Types

typedef LinearViscoelasticNormalSpecies SpeciesType
 An alias for LinearViscoelasticNormalSpecies. More...
 

Public Member Functions

 LinearViscoelasticInteraction (BaseInteractable *P, BaseInteractable *I, unsigned timeStamp)
 Constructor. More...
 
 LinearViscoelasticInteraction ()
 
 LinearViscoelasticInteraction (const LinearViscoelasticInteraction &p)
 Copy constructor. More...
 
 ~LinearViscoelasticInteraction () override
 Destructor. More...
 
void computeNormalForce ()
 Creates a copy of an object of this class. (Deep copy) 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...
 
std::string getBaseName () const
 Returns the type/name of interaction (linear visco-elastic interaction). More...
 
Mdouble getElasticEnergy () const override
 Returns the amount of energy stored in the spring due to head on collision. More...
 
const LinearViscoelasticNormalSpeciesgetSpecies () const
 Returns a const pointer of type LinearViscoelasticNormalSpecies*. More...
 
void copyHistoryInteraction ()
 
Mdouble getElasticEnergyAtEquilibrium (Mdouble adhesiveForce) const override
 
- 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...
 
virtual void integrate (Mdouble timeStep)
 integrates variables of the interaction which need to be integrate e.g. the tangential overlap. More...
 
virtual Mdouble getTangentialOverlap () const
 get the length of the current tangential overlap 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 rotateHistory (Matrix3D &rotationMatrix)
 When periodic particles are used, some interactions need certain history properties rotated (e.g. tangential springs). This is the function for that. More...
 
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
 

Additional Inherited Members

- Protected Member Functions inherited from BaseInteraction
virtual const Vec3D getTangentialForce () const
 
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 void reverseHistory ()
 When periodic particles some interaction need certain history properties reversing. This is the function for that. More...
 
void writeInteraction (std::ostream &os, bool created) const
 Writes information about a interaction to the interaction file. More...
 

Detailed Description

Enables one to compute normal forces in case of a linear visco-elastic interaction.

Member Typedef Documentation

◆ SpeciesType

An alias for LinearViscoelasticNormalSpecies.

Constructor & Destructor Documentation

◆ LinearViscoelasticInteraction() [1/3]

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

Constructor.

Parameters
[in]P
[in]I
[in]timeStamp
42  : BaseInteraction(P, I, timeStamp)
43 {
44 #ifdef DEBUG_CONSTRUCTOR
45  std::cout<<"LinearViscoelasticInteraction::LinearViscoelasticInteraction() finished"<<std::endl;
46 #endif
47 }
BaseInteraction()
Definition: BaseInteraction.cc:65
double P
Uniform pressure.
Definition: TwenteMeshGluing.cpp:73

◆ LinearViscoelasticInteraction() [2/3]

LinearViscoelasticInteraction::LinearViscoelasticInteraction ( )
51  : BaseInteraction()
52 {
53 #ifdef DEBUG_CONSTRUCTOR
54  std::cout<<"LinearViscoelasticInteraction::LinearViscoelasticInteraction() finished"<<std::endl;
55 #endif
56 }

◆ LinearViscoelasticInteraction() [3/3]

LinearViscoelasticInteraction::LinearViscoelasticInteraction ( const LinearViscoelasticInteraction p)

Copy constructor.

Parameters
[in]p
62  : BaseInteraction(p)
63 {
64 #ifdef DEBUG_CONSTRUCTOR
65  std::cout<<"LinearViscoelasticInteraction::LinearViscoelasticInteraction(const LinearViscoelasticInteraction& p) finished"<<std::endl;
66 #endif
67 }

◆ ~LinearViscoelasticInteraction()

LinearViscoelasticInteraction::~LinearViscoelasticInteraction ( )
override

Destructor.

70 {
71 #ifdef DEBUG_DESTRUCTOR
72  std::cout<<"LinearViscoelasticInteraction::~LinearViscoelasticInteraction() finished"<<std::endl;
73 #endif
74 }

Member Function Documentation

◆ computeNormalForce()

void LinearViscoelasticInteraction::computeNormalForce ( )

Creates a copy of an object of this class. (Deep copy)

Computes the normal force caused due to normal collision between particles or particle-wall.

106 {
107  // Compute the relative velocity vector of particle P w.r.t. I
109  getP()->getVelocityAtContact(getContactPoint()) - getI()->getVelocityAtContact(getContactPoint()));
110 
111  // Compute the projection of vrel onto the normal (can be negative)
113 
114  if (getOverlap() > 0) //if contact forces
115  {
116  const LinearViscoelasticNormalSpecies* species = getSpecies();
117 
118  Mdouble normalForce =
119  species->getStiffness() * getOverlap() - species->getDissipation() * getNormalRelativeVelocity();
120 
121 
122 
123  if (species->getConstantRestitution()) normalForce *= 2.0*getEffectiveMass();
124  setAbsoluteNormalForce(std::abs(normalForce)); //used for further corce calculations;
125  setForce(getNormal() * normalForce);
126  setTorque(Vec3D(0.0, 0.0, 0.0));
127 
128 
129 
130  }
131  else
132  {
134  setForce(Vec3D(0.0, 0.0, 0.0));
135  setTorque(Vec3D(0.0, 0.0, 0.0));
136  }
137 }
double Mdouble
Definition: GeneralDefine.h:34
const Vec3D & getRelativeVelocity() const
Returns a constant reference to a vector of relative velocity.
Definition: BaseInteraction.cc:573
Mdouble getEffectiveMass() const
Returns a Mdouble to the effective radius of the interaction. (Not corrected for the overlap)
Definition: BaseInteraction.cc:810
void setAbsoluteNormalForce(Mdouble absoluteNormalForce)
the absolute values of the norm (length) of the normal force
Definition: BaseInteraction.cc:670
const Vec3D & getContactPoint() const
Gets constant reference to contact point (vector).
Definition: BaseInteraction.h:234
const Vec3D & getNormal() const
Gets the normal vector between the two interacting objects.
Definition: BaseInteraction.h:226
Mdouble getNormalRelativeVelocity() const
Returns a double which is the norm (length) of the relative velocity vector.
Definition: BaseInteraction.cc:584
void setRelativeVelocity(Vec3D relativeVelocity)
set the relative velocity of the current of the interactions.
Definition: BaseInteraction.cc:649
BaseInteractable * getI()
Returns a pointer to the second object involved in the interaction (often a wall or a particle).
Definition: BaseInteraction.h:285
BaseInteractable * getP()
Returns a pointer to first object involved in the interaction (normally a particle).
Definition: BaseInteraction.h:274
void setNormalRelativeVelocity(Mdouble normalRelativeVelocit)
set the normal component of the relative velocity.
Definition: BaseInteraction.cc:660
void setForce(Vec3D force)
set total force (this is used by the normal force, tangential forces are added use addForce)
Definition: BaseInteraction.cc:627
void setTorque(Vec3D torque)
set the total force (this is used by the normal force, tangential torques are added use addTorque)
Definition: BaseInteraction.cc:638
Mdouble getOverlap() const
Returns a Mdouble with the current overlap between the two interacting objects.
Definition: BaseInteraction.h:240
bool getConstantRestitution() const
Definition: BaseNormalForce.h:46
const LinearViscoelasticNormalSpecies * getSpecies() const
Returns a const pointer of type LinearViscoelasticNormalSpecies*.
Definition: LinearViscoelasticInteraction.cc:155
LinearViscoelasticNormalSpecies contains the parameters used to describe a linear elastic-dissipative...
Definition: LinearViscoelasticNormalSpecies.h:39
Mdouble getStiffness() const
Allows the spring constant to be accessed.
Definition: LinearViscoelasticNormalSpecies.cc:104
Mdouble getDissipation() const
Allows the normal dissipation to be accessed.
Definition: LinearViscoelasticNormalSpecies.cc:130
Definition: Vector.h:51
static Mdouble dot(const Vec3D &a, const Vec3D &b)
Calculates the dot product of two Vec3D: .
Definition: Vector.cc:76

References Vec3D::dot(), BaseNormalForce::getConstantRestitution(), BaseInteraction::getContactPoint(), LinearViscoelasticNormalSpecies::getDissipation(), BaseInteraction::getEffectiveMass(), BaseInteraction::getI(), BaseInteraction::getNormal(), BaseInteraction::getNormalRelativeVelocity(), BaseInteraction::getOverlap(), BaseInteraction::getP(), BaseInteraction::getRelativeVelocity(), getSpecies(), LinearViscoelasticNormalSpecies::getStiffness(), BaseInteraction::setAbsoluteNormalForce(), BaseInteraction::setForce(), BaseInteraction::setNormalRelativeVelocity(), BaseInteraction::setRelativeVelocity(), and BaseInteraction::setTorque().

◆ copyHistoryInteraction()

void LinearViscoelasticInteraction::copyHistoryInteraction ( )

◆ getBaseName()

std::string LinearViscoelasticInteraction::getBaseName ( ) const

Returns the type/name of interaction (linear visco-elastic interaction).

Returns
std::string
98 {
99  return "LinearViscoelastic";
100 }

◆ getElasticEnergy()

Mdouble LinearViscoelasticInteraction::getElasticEnergy ( ) const
overridevirtual

Returns the amount of energy stored in the spring due to head on collision.

Returns
Mdouble

Reimplemented from BaseInteraction.

143 {
144  if (getOverlap() > 0){
145  Mdouble energy =0.5 * (getSpecies()->getStiffness() * mathsFunc::square(getOverlap()));
147  return energy;
148  } else
149  return 0.0;
150 }
const BaseSpecies * getBaseSpecies() const
Return a constant point to BaseSpecies of the interaction.
Definition: BaseInteraction.cc:682
BaseNormalForce * getNormalForce() const
Definition: BaseSpecies.h:148
T square(const T val)
squares a number
Definition: ExtendedMath.h:106

References BaseInteraction::getBaseSpecies(), BaseNormalForce::getConstantRestitution(), BaseInteraction::getEffectiveMass(), BaseSpecies::getNormalForce(), BaseInteraction::getOverlap(), getSpecies(), LinearViscoelasticNormalSpecies::getStiffness(), and mathsFunc::square().

◆ getElasticEnergyAtEquilibrium()

Mdouble LinearViscoelasticInteraction::getElasticEnergyAtEquilibrium ( Mdouble  adhesiveForce) const
overridevirtual

Reimplemented from BaseInteraction.

163 {
164  double equilibriumOverlap = adhesiveForce / getSpecies()->getStiffness();
165  return 0.5 * adhesiveForce * equilibriumOverlap;
166 }

References getSpecies(), and LinearViscoelasticNormalSpecies::getStiffness().

◆ getSpecies()

const LinearViscoelasticNormalSpecies * LinearViscoelasticInteraction::getSpecies ( ) const

Returns a const pointer of type LinearViscoelasticNormalSpecies*.

Returns
const LinearViscoelasticNormalSpecies*
Todo:
you can remove this by adding the species to the Interaction instead of the base interaction
156 {
158  return static_cast<const LinearViscoelasticNormalSpecies*>(getBaseSpecies()->getNormalForce());
159 }

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

Referenced by computeNormalForce(), getElasticEnergy(), and getElasticEnergyAtEquilibrium().

◆ read()

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

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

Calls the BaseInteraction() read function.

Parameters
[in,out]is

Reimplemented from BaseInteraction.

90 {
92 }
void read(std::istream &is) override
Interaction read function, which accepts an std::istream as input.
Definition: BaseInteraction.cc:188

References BaseInteraction::read().

◆ write()

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

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

Calls the BaseInteraction() write function.

Parameters
[in,out]os

Reimplemented from BaseInteraction.

81 {
83 }
void write(std::ostream &os) const override
Interaction print function, which accepts an std::ostream as input.
Definition: BaseInteraction.cc:159

References BaseInteraction::write().


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