MercuryDPM
Alpha
|
Defines the liquid bridge willet interaction between two particles or walls. More...
#include <LiquidMigrationWilletInteraction.h>
Public Types | |
typedef LiquidMigrationWilletSpecies | SpeciesType |
An alias name for LiquidMigrationWilletSpecies data type. More... | |
Public Member Functions | |
LiquidMigrationWilletInteraction (BaseInteractable *P, BaseInteractable *I, Mdouble timeStamp) | |
Constructor. More... | |
LiquidMigrationWilletInteraction (const LiquidMigrationWilletInteraction &p) | |
Copy constructor. More... | |
virtual | ~LiquidMigrationWilletInteraction () |
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... | |
void | actionsAfterTimeStep () |
test if particle needs to be ruptured 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 LiquidMigrationWilletSpecies * | getSpecies () const |
A dynamic_cast of BaseSpecies type pointer to a pointer of type LiquidMigrationWilletSpecies. More... | |
std::string | getBaseName () const |
Returns the name of the interaction, see Interaction.h. More... | |
Mdouble | getLiquidBridgeVolume () const |
void | setLiquidBridgeVolume (Mdouble liquidBridgeVolume) |
void | addLiquidBridgeVolume (Mdouble liquidBridgeVolume) |
bool | getWasInContact () const |
void | setWasInContact (bool wasInContact) |
void | rupture () |
void | form () |
Mdouble | getRuptureDistance () |
int | getNumberOfContacts (BaseInteractable *interactable) |
unsigned | getNumberOfFieldsVTK () const override |
writes extra information to the VTK output More... | |
std::string | getTypeVTK (unsigned i) const override |
std::string | getNameVTK (unsigned i) const override |
std::vector< Mdouble > | getFieldVTK (unsigned i) const override |
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 | 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... | |
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 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 | 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... | |
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 | |
bool | wasInContact_ |
A history parameter to store if the particles were in contact or not. Useful to compute adhesive forces. More... | |
Mdouble | liquidBridgeVolume_ |
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... | |
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 |
virtual void | reverseHistory () |
When periodic particles some interaction need certain history properties reversing. This is the function for that. More... | |
Defines the liquid bridge willet interaction between two particles or walls.
Definition at line 39 of file LiquidMigrationWilletInteraction.h.
An alias name for LiquidMigrationWilletSpecies data type.
Definition at line 45 of file LiquidMigrationWilletInteraction.h.
LiquidMigrationWilletInteraction::LiquidMigrationWilletInteraction | ( | BaseInteractable * | P, |
BaseInteractable * | I, | ||
Mdouble | timeStamp | ||
) |
Constructor.
[in] | P | |
[in] | I | |
[in] | timeStamp |
Definition at line 40 of file LiquidMigrationWilletInteraction.cc.
References liquidBridgeVolume_, and wasInContact_.
LiquidMigrationWilletInteraction::LiquidMigrationWilletInteraction | ( | const LiquidMigrationWilletInteraction & | p | ) |
Copy constructor.
[in] | p |
Definition at line 53 of file LiquidMigrationWilletInteraction.cc.
References liquidBridgeVolume_, and wasInContact_.
|
virtual |
Destructor.
Definition at line 66 of file LiquidMigrationWilletInteraction.cc.
|
virtual |
test if particle needs to be ruptured
Reimplemented from BaseInteraction.
Definition at line 126 of file LiquidMigrationWilletInteraction.cc.
References form(), BaseInteraction::getOverlap(), getRuptureDistance(), rupture(), and wasInContact_.
|
virtual |
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.
Reimplemented from BaseInteraction.
Definition at line 73 of file LiquidMigrationWilletInteraction.cc.
References rupture().
void LiquidMigrationWilletInteraction::addLiquidBridgeVolume | ( | Mdouble | liquidBridgeVolume | ) |
Definition at line 482 of file LiquidMigrationWilletInteraction.cc.
References liquidBridgeVolume_.
Referenced by rupture().
void LiquidMigrationWilletInteraction::computeAdhesionForce | ( | ) |
Computes the adhesive forces for liquid bridge Willet type of interaction.
Definition at line 101 of file LiquidMigrationWilletInteraction.cc.
References BaseInteraction::addForce(), mathsFunc::cos(), LiquidMigrationWilletSpecies::getContactAngle(), BaseInteraction::getEffectiveRadius(), getLiquidBridgeVolume(), BaseInteraction::getNormal(), BaseInteraction::getOverlap(), getSpecies(), LiquidMigrationWilletSpecies::getSurfaceTension(), constants::pi, and wasInContact_.
void LiquidMigrationWilletInteraction::form | ( | ) |
Definition at line 142 of file LiquidMigrationWilletInteraction.cc.
References LiquidFilmParticle::addLiquidVolume(), BaseInteraction::getI(), BaseObject::getIndex(), LiquidMigrationWilletSpecies::getLiquidBridgeVolumeMax(), LiquidFilmParticle::getLiquidVolume(), BaseInteraction::getP(), BaseParticle::getPeriodicFromParticle(), getSpecies(), liquidBridgeVolume_, LiquidFilmParticle::setLiquidVolume(), and wasInContact_.
Referenced by actionsAfterTimeStep().
std::string LiquidMigrationWilletInteraction::getBaseName | ( | ) | const |
Returns the name of the interaction, see Interaction.h.
Definition at line 467 of file LiquidMigrationWilletInteraction.cc.
|
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.
Reimplemented from BaseInteraction.
Definition at line 450 of file LiquidMigrationWilletInteraction.cc.
|
overridevirtual |
Reimplemented from BaseInteraction.
Definition at line 516 of file LiquidMigrationWilletInteraction.cc.
References liquidBridgeVolume_.
Mdouble LiquidMigrationWilletInteraction::getLiquidBridgeVolume | ( | ) | const |
Definition at line 472 of file LiquidMigrationWilletInteraction.cc.
References liquidBridgeVolume_.
Referenced by computeAdhesionForce(), getNumberOfContacts(), and rupture().
|
overridevirtual |
Reimplemented from BaseInteraction.
Definition at line 511 of file LiquidMigrationWilletInteraction.cc.
int LiquidMigrationWilletInteraction::getNumberOfContacts | ( | BaseInteractable * | interactable | ) |
Definition at line 222 of file LiquidMigrationWilletInteraction.cc.
References BaseInteractable::getInteractions(), and getLiquidBridgeVolume().
Referenced by rupture().
|
overridevirtual |
writes extra information to the VTK output
Reimplemented from BaseInteraction.
Definition at line 503 of file LiquidMigrationWilletInteraction.cc.
Mdouble LiquidMigrationWilletInteraction::getRuptureDistance | ( | ) |
Definition at line 497 of file LiquidMigrationWilletInteraction.cc.
References LiquidMigrationWilletSpecies::getContactAngle(), getSpecies(), and liquidBridgeVolume_.
Referenced by actionsAfterTimeStep().
const LiquidMigrationWilletSpecies * LiquidMigrationWilletInteraction::getSpecies | ( | ) | const |
A dynamic_cast of BaseSpecies type pointer to a pointer of type LiquidMigrationWilletSpecies.
Definition at line 459 of file LiquidMigrationWilletInteraction.cc.
References BaseInteraction::getBaseSpecies().
Referenced by computeAdhesionForce(), form(), getRuptureDistance(), and rupture().
|
overridevirtual |
Reimplemented from BaseInteraction.
Definition at line 507 of file LiquidMigrationWilletInteraction.cc.
bool LiquidMigrationWilletInteraction::getWasInContact | ( | ) | const |
Definition at line 487 of file LiquidMigrationWilletInteraction.cc.
References wasInContact_.
|
virtual |
Interaction read function, which accepts an std::istream as input.
[in,out] | is |
Reimplemented from BaseInteraction.
Definition at line 91 of file LiquidMigrationWilletInteraction.cc.
References liquidBridgeVolume_, and wasInContact_.
void LiquidMigrationWilletInteraction::rupture | ( | ) |
Definition at line 235 of file LiquidMigrationWilletInteraction.cc.
References addLiquidBridgeVolume(), LiquidFilmParticle::addLiquidVolume(), LiquidMigrationWilletSpecies::getDistributionCoefficient(), BaseHandler< T >::getDPMBase(), BaseInteraction::getHandler(), BaseInteraction::getI(), BaseInteractable::getInteractions(), getLiquidBridgeVolume(), LiquidMigrationWilletSpecies::getLiquidBridgeVolumeMax(), LiquidFilmParticle::getLiquidVolume(), getNumberOfContacts(), BaseInteraction::getP(), getSpecies(), liquidBridgeVolume_, DPMBase::particleHandler, setLiquidBridgeVolume(), LiquidFilmParticle::setLiquidVolume(), and wasInContact_.
Referenced by actionsAfterTimeStep(), and actionsOnErase().
void LiquidMigrationWilletInteraction::setLiquidBridgeVolume | ( | Mdouble | liquidBridgeVolume | ) |
Definition at line 477 of file LiquidMigrationWilletInteraction.cc.
References liquidBridgeVolume_.
Referenced by rupture().
void LiquidMigrationWilletInteraction::setWasInContact | ( | bool | wasInContact | ) |
Definition at line 492 of file LiquidMigrationWilletInteraction.cc.
References wasInContact_.
|
virtual |
Interaction print function, which accepts an std::ostream as input.
[in,out] | os |
Reimplemented from BaseInteraction.
Definition at line 81 of file LiquidMigrationWilletInteraction.cc.
References liquidBridgeVolume_, and wasInContact_.
|
private |
Definition at line 125 of file LiquidMigrationWilletInteraction.h.
Referenced by addLiquidBridgeVolume(), form(), getFieldVTK(), getLiquidBridgeVolume(), getRuptureDistance(), LiquidMigrationWilletInteraction(), read(), rupture(), setLiquidBridgeVolume(), and write().
|
private |
A history parameter to store if the particles were in contact or not. Useful to compute adhesive forces.
Definition at line 123 of file LiquidMigrationWilletInteraction.h.
Referenced by actionsAfterTimeStep(), computeAdhesionForce(), form(), getWasInContact(), LiquidMigrationWilletInteraction(), read(), rupture(), setWasInContact(), and write().