MercuryDPM  Beta
LiquidBridgeWilletInteraction Class Reference

Defines the liquid bridge willet interaction between two particles or walls. More...

#include <LiquidBridgeWilletInteraction.h>

Inheritance diagram for LiquidBridgeWilletInteraction:

## Public Types

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

## Public Member Functions

LiquidBridgeWilletInteraction (BaseInteractable *P, BaseInteractable *I, Mdouble timeStamp)
Constructor. More...

LiquidBridgeWilletInteraction (const LiquidBridgeWilletInteraction &p)
Copy constructor. More...

virtual ~LiquidBridgeWilletInteraction ()
Destructor. More...

void computeAdhesionForce ()
Computes the adhesive forces for liquid bridge Willet type of interaction. More...

void read (std::istream &is)
Interaction read function, which accepts an std::istream as input. More...

void write (std::ostream &os) const
Interaction print function, which accepts an std::ostream as input. More...

Mdouble getElasticEnergy () const
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 LiquidBridgeWilletSpeciesgetSpecies () const
A dynamic_cast of BaseSpecies type pointer to a pointer of type LiquidBridgeWilletSpecies. 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, 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...

virtual ~BaseInteraction ()
The default destructor. 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...

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...

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 ()

const BaseInteractablegetP () const

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...

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...

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

bool wasInContact_
A history parameter to store if the particles were in contact or not. Useful to compute adhesive forces. More...

## 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 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 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...

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 BaseSpeciesgetBaseSpecies () const
Return a constant point to BaseSpecies of the interaction. More...

virtual void reverseHistory ()
When periodic particles some interaction need certain history properties reversing. This is the function for that. More...

## Detailed Description

Defines the liquid bridge willet interaction between two particles or walls.

Definition at line 39 of file LiquidBridgeWilletInteraction.h.

## Member Typedef Documentation

An alias name for LiquidBridgeWilletSpecies data type.

Definition at line 45 of file LiquidBridgeWilletInteraction.h.

## Constructor & Destructor Documentation

 LiquidBridgeWilletInteraction::LiquidBridgeWilletInteraction ( BaseInteractable * P, BaseInteractable * I, Mdouble timeStamp )

Constructor.

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

Definition at line 39 of file LiquidBridgeWilletInteraction.cc.

References wasInContact_.

40  : BaseInteraction(P, I, timeStamp)
41 {
42  wasInContact_=false;
43 #ifdef DEBUG_CONSTRUCTOR
44  std::cout<<"LiquidBridgeWilletInteraction::LiquidBridgeWilletInteraction() finished"<<std::endl;
45 #endif
46 }
BaseInteraction(BaseInteractable *P, BaseInteractable *I, Mdouble timeStamp)
A constructor takes the BaseInteractable objects which are interacting (come into contact) and time t...
bool wasInContact_
A history parameter to store if the particles were in contact or not. Useful to compute adhesive forc...
 LiquidBridgeWilletInteraction::LiquidBridgeWilletInteraction ( const LiquidBridgeWilletInteraction & p )

Copy constructor.

Parameters
 [in] p

Definition at line 50 of file LiquidBridgeWilletInteraction.cc.

References wasInContact_.

51  : BaseInteraction(p)
52 {
54 #ifdef DEBUG_CONSTRUCTOR
55  std::cout<<"LiquidBridgeWilletInteraction::LiquidBridgeWilletInteraction(const LiquidBridgeWilletInteraction &p finished"<<std::endl;
56 #endif
57 }
BaseInteraction(BaseInteractable *P, BaseInteractable *I, Mdouble timeStamp)
A constructor takes the BaseInteractable objects which are interacting (come into contact) and time t...
bool wasInContact_
A history parameter to store if the particles were in contact or not. Useful to compute adhesive forc...
 LiquidBridgeWilletInteraction::~LiquidBridgeWilletInteraction ( )
virtual

Destructor.

Definition at line 61 of file LiquidBridgeWilletInteraction.cc.

62 {
63 #ifdef DEBUG_DESTRUCTOR
64  std::cout<<"LiquidBridgeWilletInteraction::~LiquidBridgeWilletInteraction() finished"<<std::endl;
65 #endif
66 }

## Member Function Documentation

 void LiquidBridgeWilletInteraction::computeAdhesionForce ( )

Computes the adhesive forces for liquid bridge Willet type of interaction.

Definition at line 91 of file LiquidBridgeWilletInteraction.cc.

92 {
93  const LiquidBridgeWilletSpecies* species = getSpecies();
94  if (getOverlap()>=0)
95  {
96  wasInContact_=true;
97  Mdouble effectiveRadius = getEffectiveRadius();
98  Mdouble fdotn = -2.0*constants::pi*effectiveRadius*species->getSurfaceTension()*std::cos(species->getContactAngle());
99  addForce(getNormal() * fdotn);
100  }
101  else if (wasInContact_)
102  {
103  Mdouble effectiveRadius = getEffectiveRadius();
104  Mdouble s_c = -getOverlap()*std::sqrt(effectiveRadius/species->getLiquidBridgeVolume());
105  Mdouble fdotn = -2.0*constants::pi*effectiveRadius*species->getSurfaceTension()
106  *std::cos(species->getContactAngle())/(1+(1.05+2.5*s_c)*s_c);
107  addForce(getNormal() * fdotn);
108  }
109 }
Mdouble getEffectiveRadius() const
Returns a Mdouble to the effective radius of the interaction. (Not corrected for the overlap) ...
Mdouble getContactAngle() const
used to access the contact angle between particle and liquid bridge surface.
Mdouble getLiquidBridgeVolume() const
used to access the Volume of the liquid bridge.
double Mdouble
Mdouble getSurfaceTension() const
used to access the surface tension of the liquid.
const LiquidBridgeWilletSpecies * getSpecies() const
A dynamic_cast of BaseSpecies type pointer to a pointer of type LiquidBridgeWilletSpecies.
bool wasInContact_
A history parameter to store if the particles were in contact or not. Useful to compute adhesive forc...
const Mdouble pi
Definition: ExtendedMath.h:42
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.
LiquidBridgeWilletSpecies contains the parameters used to describe a short-range force caused by liqu...
 std::string LiquidBridgeWilletInteraction::getBaseName ( ) const

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

Returns
std::string

Definition at line 128 of file LiquidBridgeWilletInteraction.cc.

129 {
130  return "LiquidBridgeWillet";
131 }
 Mdouble LiquidBridgeWilletInteraction::getElasticEnergy ( ) const
virtual

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
Mdouble
Todo:
TW

Reimplemented from BaseInteraction.

Definition at line 113 of file LiquidBridgeWilletInteraction.cc.

114 {
116  return 0.0;
117 }
 const LiquidBridgeWilletSpecies * LiquidBridgeWilletInteraction::getSpecies ( ) const

A dynamic_cast of BaseSpecies type pointer to a pointer of type LiquidBridgeWilletSpecies.

Returns
const LiquidBridgeWilletSpecies*

Definition at line 121 of file LiquidBridgeWilletInteraction.cc.

References BaseInteraction::getBaseSpecies().

Referenced by computeAdhesionForce().

122 {
123  return dynamic_cast<const LiquidBridgeWilletSpecies *>(getBaseSpecies());
124 }
const BaseSpecies * getBaseSpecies() const
Return a constant point to BaseSpecies of the interaction.
LiquidBridgeWilletSpecies contains the parameters used to describe a short-range force caused by liqu...
 void LiquidBridgeWilletInteraction::read ( std::istream & is )
virtual

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

Parameters
 [in,out] is

Reimplemented from BaseInteraction.

Definition at line 77 of file LiquidBridgeWilletInteraction.cc.

References wasInContact_.

78 {
79  // we read in wasInContact_ like this because an early version did not initialize it.
80  std::string dummy;
81  int dummy2;
82  is >> dummy >> dummy2;
83  if (dummy2==1)
84  wasInContact_ = true;
85  else
86  wasInContact_ = false;
87 }
bool wasInContact_
A history parameter to store if the particles were in contact or not. Useful to compute adhesive forc...
 void LiquidBridgeWilletInteraction::write ( std::ostream & os ) const
virtual

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

Parameters
 [in,out] os

Reimplemented from BaseInteraction.

Definition at line 70 of file LiquidBridgeWilletInteraction.cc.

References wasInContact_.

71 {
72  os << " wasInContact " << wasInContact_;
73 }
bool wasInContact_
A history parameter to store if the particles were in contact or not. Useful to compute adhesive forc...

## Member Data Documentation

 bool LiquidBridgeWilletInteraction::wasInContact_
private

A history parameter to store if the particles were in contact or not. Useful to compute adhesive forces.

Definition at line 89 of file LiquidBridgeWilletInteraction.h.

Referenced by computeAdhesionForce(), LiquidBridgeWilletInteraction(), read(), and write().

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