LiquidMigrationWilletViscousInteraction Class Reference

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

#include <LiquidMigrationWilletViscousInteraction.h>

+ Inheritance diagram for LiquidMigrationWilletViscousInteraction:

Public Types

typedef LiquidMigrationWilletViscousSpecies SpeciesType
 An alias name for LiquidMigrationWilletViscousSpecies data type. More...
 
- Public Types inherited from LiquidMigrationWilletInteraction
typedef LiquidMigrationWilletSpecies SpeciesType
 An alias name for LiquidMigrationWilletSpecies data type. More...
 

Public Member Functions

 LiquidMigrationWilletViscousInteraction (BaseInteractable *P, BaseInteractable *I, unsigned timeStamp)
 Constructor. More...
 
 LiquidMigrationWilletViscousInteraction ()
 
 LiquidMigrationWilletViscousInteraction (const LiquidMigrationWilletViscousInteraction &p)
 Copy constructor. More...
 
 ~LiquidMigrationWilletViscousInteraction () override
 Destructor. More...
 
std::string getBaseName () const
 Returns the name of the interaction, see Interaction.h. More...
 
const LiquidMigrationWilletViscousSpeciesgetSpecies () const
 Returns a pointer to the adhesive force species LiquidMigrationWilletViscousSpecies. More...
 
void computeAdhesionForce ()
 Computes the adhesive forces for liquid bridge Willet and viscous type of interaction. More...
 
Mdouble getLimitingDistance ()
 Accesses the minimum distance that the viscous liquid force is valid. More...
 
- Public Member Functions inherited from LiquidMigrationWilletInteraction
 LiquidMigrationWilletInteraction (BaseInteractable *P, BaseInteractable *I, unsigned timeStamp)
 Constructor. More...
 
 LiquidMigrationWilletInteraction ()
 
 LiquidMigrationWilletInteraction (const LiquidMigrationWilletInteraction &p)
 Copy constructor. More...
 
 ~LiquidMigrationWilletInteraction () override
 Destructor. More...
 
void actionsOnErase () override
 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 () override
 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) 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 LiquidMigrationWilletSpeciesgetSpecies () const
 Returns a pointer to the adhesive force species LiquidMigrationWilletSpecies. More...
 
std::string getBaseName () const
 Returns the name of the interaction, see Interaction.h. More...
 
Mdouble getLiquidBridgeVolume () const
 
void setLiquidBridgeVolumeByEvaporation (Mdouble liquidBridgeVolume)
 
void addLiquidBridgeVolumeByEvaporation (Mdouble liquidBridgeVolume)
 
virtual void setLiquidBridgeVolume (Mdouble liquidBridgeVolume)
 
virtual void addLiquidBridgeVolume (Mdouble liquidBridgeVolume)
 
bool getWasInContact () const
 
void setWasInContact (bool wasInContact)
 
virtual void rupture ()
 
void form ()
 
Mdouble getRuptureDistance ()
 
unsigned getNumberOfFieldsVTK () const override
 
std::string getTypeVTK (unsigned i) const override
 
std::string getNameVTK (unsigned i) const override
 
std::vector< MdoublegetFieldVTK (unsigned i) 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 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 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...
 
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

- Static Public Member Functions inherited from LiquidMigrationWilletInteraction
static Mdouble getTotalLiquidFilmVolume (ParticleHandler &)
 
static Mdouble getTotalLiquidBridgeVolume (InteractionHandler &)
 
- 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 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

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

Member Typedef Documentation

◆ SpeciesType

An alias name for LiquidMigrationWilletViscousSpecies data type.

Constructor & Destructor Documentation

◆ LiquidMigrationWilletViscousInteraction() [1/3]

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

Constructor.

Parameters
[in]P
[in]I
[in]timeStamp
21  : BaseInteraction(P, I, timeStamp), LiquidMigrationWilletInteraction(P, I, timeStamp)
22 {
23 #ifdef DEBUG_CONSTRUCTOR
24  std::cout << "LiquidMigrationWilletViscousInteraction::LiquidMigrationWilletViscousInteraction() finished" << std::endl;
25 #endif
26 }
BaseInteraction()
Definition: BaseInteraction.cc:43
LiquidMigrationWilletInteraction()
Definition: LiquidMigrationWilletInteraction.cc:30
#define I
Definition: main.h:127
double P
Uniform pressure.
Definition: TwenteMeshGluing.cpp:77

◆ LiquidMigrationWilletViscousInteraction() [2/3]

LiquidMigrationWilletViscousInteraction::LiquidMigrationWilletViscousInteraction ( )
31 {
32 #ifdef DEBUG_CONSTRUCTOR
33  std::cout << "LiquidMigrationWilletViscousInteraction::LiquidMigrationWilletViscousInteraction() finished" << std::endl;
34 #endif
35 }

◆ LiquidMigrationWilletViscousInteraction() [3/3]

LiquidMigrationWilletViscousInteraction::LiquidMigrationWilletViscousInteraction ( const LiquidMigrationWilletViscousInteraction p)

Copy constructor.

Parameters
[in]p
42 {
43 #ifdef DEBUG_CONSTRUCTOR
44  std::cout << "LiquidMigrationWilletViscousInteraction::LiquidMigrationWilletViscousInteraction(const LiquidMigrationWilletViscousInteraction &p finished" << std::endl;
45 #endif
46 }
float * p
Definition: Tutorial_Map_using.cpp:9

◆ ~LiquidMigrationWilletViscousInteraction()

LiquidMigrationWilletViscousInteraction::~LiquidMigrationWilletViscousInteraction ( )
override

Destructor.

52 {
53 #ifdef DEBUG_DESTRUCTOR
54  std::cout << "LiquidMigrationWilletViscousInteraction::~LiquidMigrationWilletViscousInteraction() finished" << std::endl;
55 #endif
56 }

Member Function Documentation

◆ computeAdhesionForce()

void LiquidMigrationWilletViscousInteraction::computeAdhesionForce ( )

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

This model is a combination of Willet capillary model and a viscous lubrication model, which includes a normal capillary force (same as Willet model), a normal lubrication force and a tangential lubrication force. The description of the viscous lubrication forces can be found here: https://doi.org/10.1016/j.powtec.2019.12.021 The capillary force is valid when particles are within rupture distance. The lubrication force is valid when particles are between the limiting distance and the rupture distance. Note: the tangential lubrication force is added to sliding friction force through SlidingFrictionInteraction::addTangentialForce().

67  {
70  const Mdouble effectiveRadius = getEffectiveRadius();//note here is different from in Willet capillary force. 1/R*=1/RI+1/RP
72  Mdouble fdotnl = 0.0;//normal lubrication force in value
73  Vec3D fdottl = Vec3D(0.0, 0.0, 0.0);//tangential lubrication force in vector
74 
75  if (-getOverlap() > getLimitingDistance()) {
76  fdotnl = -6.0 * constants::pi * species->getViscosity() * pow(effectiveRadius, 2.0)
78 
79  Vec3D tangentialRelativeVelocity = getRelativeVelocity() - getNormal() * getNormalRelativeVelocity();
80 
81  fdottl = -6.0 * constants::pi * species->getViscosity() * effectiveRadius * tangentialRelativeVelocity
82  * (8.0 / 15.0 * std::log(effectiveRadius / (-getOverlap())) + 0.9588);
83 
84  }
85  addForce(getNormal() * fdotnl + fdottl);
86 
87  auto slidingFrictionInteraction = dynamic_cast<SlidingFrictionInteraction *>(this);
88  slidingFrictionInteraction->addTangentialForce(fdottl);
89  }
90 
91 }
const Vec3D & getRelativeVelocity() const
Returns a constant reference to a vector of relative velocity.
Definition: BaseInteraction.cc:554
const Vec3D & getNormal() const
Gets the normal vector between the two interacting objects.
Definition: BaseInteraction.h:205
void addForce(Vec3D force)
add an force increment to the total force.
Definition: BaseInteraction.cc:587
Mdouble getNormalRelativeVelocity() const
Returns a double which is the norm (length) of the relative velocity vector.
Definition: BaseInteraction.cc:565
Mdouble getEffectiveRadius() const
Returns a Mdouble to the effective radius of the interaction. (Not corrected for the overlap)
Definition: BaseInteraction.cc:774
Mdouble getOverlap() const
Returns a Mdouble with the current overlap between the two interacting objects.
Definition: BaseInteraction.h:219
void computeAdhesionForce()
Computes the adhesive forces for liquid bridge Willet type of interaction.
Definition: LiquidMigrationWilletInteraction.cc:91
bool getWasInContact() const
Definition: LiquidMigrationWilletInteraction.cc:285
const LiquidMigrationWilletViscousSpecies * getSpecies() const
Returns a pointer to the adhesive force species LiquidMigrationWilletViscousSpecies.
Definition: LiquidMigrationWilletViscousInteraction.cc:112
Mdouble getLimitingDistance()
Accesses the minimum distance that the viscous liquid force is valid.
Definition: LiquidMigrationWilletViscousInteraction.cc:96
LiquidMigrationWilletViscousSpecies contains the parameters used to describe a short-range force caus...
Definition: LiquidMigrationWilletViscousSpecies.h:18
Mdouble getViscosity() const
used to access the Viscosity of the liquid.
Definition: LiquidMigrationWilletViscousSpecies.cc:89
Computes the forces corresponding to sliding friction.
Definition: SlidingFrictionInteraction.h:22
void addTangentialForce(Vec3D force)
adds an extra tangential force, mainly for the tangential lubrication force from LiquidMigrationLS mo...
Definition: SlidingFrictionInteraction.h:96
Definition: Kernel/Math/Vector.h:30
EIGEN_STRONG_INLINE EIGEN_DEVICE_FUNC bfloat16 pow(const bfloat16 &a, const bfloat16 &b)
Definition: BFloat16.h:625
EIGEN_STRONG_INLINE EIGEN_DEVICE_FUNC bfloat16 log(const bfloat16 &a)
Definition: BFloat16.h:618
const Mdouble pi
Definition: ExtendedMath.h:23

References BaseInteraction::addForce(), SlidingFrictionInteraction::addTangentialForce(), LiquidMigrationWilletInteraction::computeAdhesionForce(), BaseInteraction::getEffectiveRadius(), getLimitingDistance(), BaseInteraction::getNormal(), BaseInteraction::getNormalRelativeVelocity(), BaseInteraction::getOverlap(), BaseInteraction::getRelativeVelocity(), getSpecies(), LiquidMigrationWilletViscousSpecies::getViscosity(), LiquidMigrationWilletInteraction::getWasInContact(), Eigen::bfloat16_impl::log(), constants::pi, and Eigen::bfloat16_impl::pow().

◆ getBaseName()

std::string LiquidMigrationWilletViscousInteraction::getBaseName ( ) const

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

Returns
std::string
105 {
106  return "LiquidMigrationWilletViscous";
107 }

◆ getLimitingDistance()

Mdouble LiquidMigrationWilletViscousInteraction::getLimitingDistance ( )

Accesses the minimum distance that the viscous liquid force is valid.

Defines and accesses the minimum distance for the viscous lubrication force to be valid

97 {
98  return getEffectiveRadius()/100.0;
99 }

References BaseInteraction::getEffectiveRadius().

Referenced by computeAdhesionForce().

◆ getSpecies()

const LiquidMigrationWilletViscousSpecies * LiquidMigrationWilletViscousInteraction::getSpecies ( ) const

Returns a pointer to the adhesive force species LiquidMigrationWilletViscousSpecies.

Returns
const LiquidMigrationWilletViscousSpecies*
113 {
115 }
const BaseSpecies * getBaseSpecies() const
Return a constant point to BaseSpecies of the interaction.
Definition: BaseInteraction.cc:663
BaseAdhesiveForce * getAdhesiveForce() const
Definition: BaseSpecies.h:131

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

Referenced by computeAdhesionForce().


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