MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ReversibleAdhesiveInteraction Class Reference

#include <ReversibleAdhesiveInteraction.h>

+ Inheritance diagram for ReversibleAdhesiveInteraction:

Public Types

typedef ReversibleAdhesiveSpecies SpeciesType
 Setting an alias name for ReversibleAdhesiveSpecies. More...
 

Public Member Functions

 ReversibleAdhesiveInteraction (BaseInteractable *P, BaseInteractable *I, unsigned timeStamp)
 Constructor. More...
 
 ReversibleAdhesiveInteraction ()
 
 ReversibleAdhesiveInteraction (const ReversibleAdhesiveInteraction &p)
 Copy constructor. More...
 
 ~ReversibleAdhesiveInteraction () override
 Destructor. More...
 
void computeAdhesionForce ()
 Computes the adhesive forces. 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...
 
Mdouble getElasticEnergy () const override
 Returns the amount of Elastic energy involved in an interaction. Basically used in case you want to write the elastic energy into an output file. More...
 
const ReversibleAdhesiveSpeciesgetSpecies () const
 Returns a pointer to the adhesive force species ReversibleAdhesiveSpecies. More...
 
std::string getBaseName () const
 Returns the name of the interaction, see Interaction.h. More...
 
- 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. 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 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 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 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 setForce (Vec3D force)
 set total force (this is used by the normal force, tangential forces are added use addForce) 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 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...
 
virtual Mdouble getElasticEnergyAtEquilibrium (Mdouble adhesiveForce) const
 
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

Definition at line 42 of file ReversibleAdhesiveInteraction.h.

Member Typedef Documentation

Constructor & Destructor Documentation

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

Constructor.

Parameters
[in]P
[in]I
[in]timeStamp

Definition at line 39 of file ReversibleAdhesiveInteraction.cc.

41  : BaseInteraction(P, I, timeStamp)
42 {
43 #ifdef DEBUG_CONSTRUCTOR
44  std::cout<<"ReversibleAdhesiveInteraction::ReversibleAdhesiveInteraction() finished"<<std::endl;
45 #endif
46 }
ReversibleAdhesiveInteraction::ReversibleAdhesiveInteraction ( )

Definition at line 50 of file ReversibleAdhesiveInteraction.cc.

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

Copy constructor.

Parameters
[in]p

Definition at line 61 of file ReversibleAdhesiveInteraction.cc.

62  : BaseInteraction(p)
63 {
64 #ifdef DEBUG_CONSTRUCTOR
65  std::cout<<"ReversibleAdhesiveInteraction::ReversibleAdhesiveInteraction(const ReversibleAdhesiveInteraction &p finished"<<std::endl;
66 #endif
67 }
ReversibleAdhesiveInteraction::~ReversibleAdhesiveInteraction ( )
override

Destructor.

Definition at line 72 of file ReversibleAdhesiveInteraction.cc.

73 {
74 #ifdef DEBUG_DESTRUCTOR
75  std::cout<<"ReversibleAdhesiveInteraction::~ReversibleAdhesiveInteraction() finished"<<std::endl;
76 #endif
77 }

Member Function Documentation

void ReversibleAdhesiveInteraction::computeAdhesionForce ( )

Computes the adhesive forces.

Definition at line 94 of file ReversibleAdhesiveInteraction.cc.

References BaseInteraction::addForce(), ReversibleAdhesiveSpecies::getAdhesionForceMax(), ReversibleAdhesiveSpecies::getAdhesionStiffness(), BaseInteraction::getNormal(), BaseInteraction::getOverlap(), and getSpecies().

95 {
96  //std::cout << "ReversibleAdhesiveInteraction::computeAdhesionForce" << std::endl;
97  const ReversibleAdhesiveSpecies* species = getSpecies();
98 
99  if (getOverlap() >= 0)
100  addForce(getNormal() * (-species->getAdhesionForceMax()));
101  else
102  addForce(getNormal() * (-species->getAdhesionStiffness() * getOverlap() - species->getAdhesionForceMax()));
103 }
Mdouble getAdhesionForceMax() const
Allows the spring constant to be accessed.
ReversibleAdhesiveSpecies contains the parameters used to describe a linear reversible short-range fo...
const Vec3D & getNormal() const
Gets the normal vector between the two interacting objects.
Mdouble getOverlap() const
Returns a Mdouble with the current overlap between the two interacting objects.
void addForce(Vec3D force)
add an force increment to the total force.
const ReversibleAdhesiveSpecies * getSpecies() const
Returns a pointer to the adhesive force species ReversibleAdhesiveSpecies.
Mdouble getAdhesionStiffness() const
Allows the spring constant to be accessed.
std::string ReversibleAdhesiveInteraction::getBaseName ( ) const

Returns the name of the interaction, see Interaction.h.

Returns
std::string

Definition at line 125 of file ReversibleAdhesiveInteraction.cc.

126 {
127  return "ReversibleAdhesive";
128 }
Mdouble ReversibleAdhesiveInteraction::getElasticEnergy ( ) const
overridevirtual

Returns the amount of Elastic energy involved in an interaction. Basically used in case you want to write the elastic energy into an output file.

Returns the elastic energy stored in the adhesive spring.

Todo:
TW
Returns
Mdouble

Reimplemented from BaseInteraction.

Definition at line 109 of file ReversibleAdhesiveInteraction.cc.

110 {
111  return 0.0;
112 }
const ReversibleAdhesiveSpecies * ReversibleAdhesiveInteraction::getSpecies ( ) const

Returns a pointer to the adhesive force species ReversibleAdhesiveSpecies.

Returns
a constant pointer to an instance of this class.

Definition at line 117 of file ReversibleAdhesiveInteraction.cc.

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

Referenced by computeAdhesionForce().

118 {
119  return static_cast<const ReversibleAdhesiveSpecies*> (getBaseSpecies()->getAdhesiveForce()); //downcast
120 }
BaseAdhesiveForce * getAdhesiveForce() const
Definition: BaseSpecies.h:152
ReversibleAdhesiveSpecies contains the parameters used to describe a linear reversible short-range fo...
const BaseSpecies * getBaseSpecies() const
Return a constant point to BaseSpecies of the interaction.
void ReversibleAdhesiveInteraction::read ( std::istream &  is)
overridevirtual

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

Parameters
[in]is

Implements BaseObject.

Definition at line 88 of file ReversibleAdhesiveInteraction.cc.

89 {}
void ReversibleAdhesiveInteraction::write ( std::ostream &  os) const
overridevirtual

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

Parameters
[in]os

Implements BaseObject.

Definition at line 82 of file ReversibleAdhesiveInteraction.cc.

83 {}

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