LiquidMigrationLSInteraction Class Reference

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

#include <LiquidMigrationLSInteraction.h>

Inheritance diagram for LiquidMigrationLSInteraction:

Public Types
typedef LiquidMigrationLSSpecies	SpeciesType
	An alias name for LiquidMigrationLSSpecies data type. More...

Public Member Functions
	LiquidMigrationLSInteraction (BaseInteractable *P, BaseInteractable *I, unsigned timeStamp)
	Constructor. More...
	LiquidMigrationLSInteraction ()
	LiquidMigrationLSInteraction (const LiquidMigrationLSInteraction &p)
	Copy constructor. More...
	~LiquidMigrationLSInteraction () 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 LS 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 LiquidMigrationLSSpecies *	getSpecies () const
	Returns a pointer to the adhesive force species LiquidMigrationLSSpecies. 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 ()
Mdouble	getHalfFillingAngle ()
Mdouble	getLimitingDistance ()
int	getNumberOfContacts (BaseInteractable *interactable)
unsigned	getNumberOfFieldsVTK () const override
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, 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...
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	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 ()
BaseInteractable *	getP ()
	Returns a pointer to first object involved in the interaction (normally a particle). More...
BaseInteractable *	getI ()
	Returns a pointer to the second object involved in the interaction (often a wall or a particle). More...
const BaseInteractable *	getP () const
	Returns a constant pointer to the first object involved in the interaction. More...
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...
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 BaseSpecies *	getBaseSpecies () 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

Static Public Member Functions
static Mdouble	getTotalLiquidFilmVolume (ParticleHandler &)
static Mdouble	getTotalLiquidBridgeVolume (InteractionHandler &)

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...
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 LS interaction between two particles or walls.

Member Typedef Documentation

SpeciesType

typedef LiquidMigrationLSSpecies LiquidMigrationLSInteraction::SpeciesType

An alias name for LiquidMigrationLSSpecies data type.

Constructor & Destructor Documentation

LiquidMigrationLSInteraction() [1/3]

LiquidMigrationLSInteraction::LiquidMigrationLSInteraction	(	BaseInteractable *	P,
		BaseInteractable *	I,
		unsigned	timeStamp
	)

Constructor.

Parameters

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

        : BaseInteraction(P, I, timeStamp)
{
    liquidBridgeVolume_ = 0.0;
    wasInContact_ = false;
#ifdef DEBUG_CONSTRUCTOR
    logger(INFO, "LiquidMigrationLSInteraction::LiquidMigrationLSInteraction() finished");
#endif
}

References INFO, liquidBridgeVolume_, logger, and wasInContact_.

LiquidMigrationLSInteraction() [2/3]

LiquidMigrationLSInteraction::LiquidMigrationLSInteraction

(

)

        : BaseInteraction()
{
    liquidBridgeVolume_ = 0.0;
    wasInContact_ = false;
#ifdef DEBUG_CONSTRUCTOR
    logger(INFO, "LiquidMigrationLSInteraction::LiquidMigrationLSInteraction() finished");
#endif
}

References INFO, liquidBridgeVolume_, logger, and wasInContact_.

LiquidMigrationLSInteraction() [3/3]

LiquidMigrationLSInteraction::LiquidMigrationLSInteraction

(

const LiquidMigrationLSInteraction &

p

)

Copy constructor.

Parameters

[in]

p

        : BaseInteraction(p)
{
    liquidBridgeVolume_ = p.liquidBridgeVolume_;
    wasInContact_ = p.wasInContact_;
#ifdef DEBUG_CONSTRUCTOR
    logger(INFO, "LiquidMigrationLSInteraction::LiquidMigrationLSInteraction(const LiquidMigrationLSInteraction &p finished");
#endif
}

References INFO, liquidBridgeVolume_, logger, and wasInContact_.

~LiquidMigrationLSInteraction()

LiquidMigrationLSInteraction::~LiquidMigrationLSInteraction ( )

override

Destructor.

{
#ifdef DEBUG_DESTRUCTOR
    logger(INFO, "LiquidMigrationLSInteraction::~LiquidMigrationLSInteraction() finished");
#endif
}

References INFO, and logger.

Member Function Documentation

actionsAfterTimeStep()

void LiquidMigrationLSInteraction::actionsAfterTimeStep ( )

overridevirtual

test if particle needs to be ruptured

Reimplemented from BaseInteraction.

{
    if (wasInContact_)
    {
        if (-getOverlap() >= getRuptureDistance())
        {
            rupture();
        }
    }
    else
    {
        if (getOverlap() >= 0)
        {
            form();
        }
    }
}

References form(), BaseInteraction::getOverlap(), getRuptureDistance(), rupture(), and wasInContact_.

actionsOnErase()

void LiquidMigrationLSInteraction::actionsOnErase ( )

overridevirtual

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.

{
    rupture();
};

References rupture().

addLiquidBridgeVolume()

void LiquidMigrationLSInteraction::addLiquidBridgeVolume

(

Mdouble

liquidBridgeVolume

)

{
    liquidBridgeVolume_ += liquidBridgeVolume;
}

References liquidBridgeVolume_.

Referenced by rupture().

computeAdhesionForce()

void LiquidMigrationLSInteraction::computeAdhesionForce

(

)

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

The contact model is based on the description given in (Zhang and Wu, 2020): https://www.sciencedirect.com/science/article/pii/S0032591019311258 This model includes a normal capillary force, a normal lubrication force and a tangential lubrication force. The capillary force is valid when particles are within rupture distance. The formulation is in (Lian and Seville, 2015): https://doi.org/10.1016/j.cis.2015.11.003. The lubrication force is valid when particles are within limiting distance. Note: the tangential lubrication force is added to sliding friction force through SlidingFrictionInteraction::addTangentialForce().

{
    // Adding no capillary force for liquid bridge volume = 0
    if (getLiquidBridgeVolume() == 0) return;
    
    if (getOverlap() >= 0)
    {
        // if particles are in contact
        const LiquidMigrationLSSpecies* species = getSpecies();
        const Mdouble effectiveRadius = getEffectiveRadius();
        const Mdouble fdotn = -2.0 * species->getSurfaceTension() * effectiveRadius *
                              (2.0 * constants::pi - 2.082 * pow(getHalfFillingAngle(), 0.9197)) *
                              (std::cos(species->getContactAngle()) - 0.16 * getHalfFillingAngle() *
                              (1.0 + getHalfFillingAngle()) * std::tan(species->getContactAngle())); //max value of capillary;
        addForce(getNormal() * fdotn);
    }
    else if (wasInContact_)
    {
        // if particles are not in contact, but within their interaction distance
        const LiquidMigrationLSSpecies* species = getSpecies();
        const Mdouble effectiveRadius = getEffectiveRadius();
        const Mdouble s_nondim = -getOverlap()/getRuptureDistance() * (1.0 + 0.5 * species->getContactAngle() *
                            std::cos(species->getContactAngle()) * std::cos(getHalfFillingAngle() + species->getContactAngle()) ); //dimensionless S
        const Mdouble fdotnc = -2.0 * species->getSurfaceTension() * effectiveRadius *
                                (2.0 * constants::pi - 2.082 * pow(getHalfFillingAngle(), 0.9197)) *
                                (std::cos(species->getContactAngle()) - 0.16 * getHalfFillingAngle() *
                                (1.0 + getHalfFillingAngle()) * std::tan(species->getContactAngle()))
                                /(1.0 + 0.8438 * pow(getHalfFillingAngle(), -0.724) * s_nondim +
                                1.3393 * pow(getHalfFillingAngle(), -1.459) * pow(s_nondim, 2.0));//capillary force
 
        Mdouble fdotnl = 0.0;//normal lubrication force in value
        Vec3D fdottl = Vec3D(0.0, 0.0, 0.0);//tangential lubrication force in vector
 
        if(-getOverlap() > getLimitingDistance())
        {
            fdotnl = -6.0 * constants::pi * species->getViscosity() * pow(effectiveRadius, 2.0)
                                    * getNormalRelativeVelocity()/(-getOverlap());
 
            Vec3D tangentialRelativeVelocity = getRelativeVelocity() - getNormal() * getNormalRelativeVelocity();
 
            fdottl = -6.0 * constants::pi * species->getViscosity() * effectiveRadius * tangentialRelativeVelocity
                     * (8.0/15.0 * std::log(effectiveRadius/(-getOverlap())) + 0.9588);
 
        }
        addForce(getNormal() * (fdotnc + fdotnl) + fdottl);
 
        //add tangential lubrication force to sliding friction force
        auto slidingFrictionInteraction = dynamic_cast<SlidingFrictionInteraction*>(this);
        slidingFrictionInteraction->addTangentialForce(fdottl);
    }
}

References BaseInteraction::addForce(), SlidingFrictionInteraction::addTangentialForce(), mathsFunc::cos(), LiquidMigrationLSSpecies::getContactAngle(), BaseInteraction::getEffectiveRadius(), getHalfFillingAngle(), getLimitingDistance(), getLiquidBridgeVolume(), BaseInteraction::getNormal(), BaseInteraction::getNormalRelativeVelocity(), BaseInteraction::getOverlap(), BaseInteraction::getRelativeVelocity(), getRuptureDistance(), getSpecies(), LiquidMigrationLSSpecies::getSurfaceTension(), LiquidMigrationLSSpecies::getViscosity(), mathsFunc::log(), constants::pi, mathsFunc::tan(), and wasInContact_.

form()

void LiquidMigrationLSInteraction::form

(

)

Todo:

: maybe we need to check ghost particles?

{
    //form a bridge
    //todo: extend to neighbours
 
    wasInContact_ = true;
    const LiquidMigrationLSSpecies* species = getSpecies();
    LiquidFilmParticle* IParticle = dynamic_cast<LiquidFilmParticle*>(getI());
    LiquidFilmParticle* PParticle = dynamic_cast<LiquidFilmParticle*>(getP());
    if (IParticle == nullptr) //if I is a wall
    {
        //do not form bridge if the volume is below minimum
        if (PParticle->getLiquidVolume() < species->getLiquidBridgeVolumeMin())
        {
            return;
        }
            //if below max bridge volume, move all liquid from film to volume
        else if (PParticle->getLiquidVolume() <= species->getLiquidBridgeVolumeMax())
        {
            liquidBridgeVolume_ = PParticle->getLiquidVolume();
            PParticle->setLiquidVolume(0.0);
        }
            //if above max bridge volume, fill the liquid bridge and keep the rest of the liquid in the particle
        else
        {
            liquidBridgeVolume_ = species->getLiquidBridgeVolumeMax();
            PParticle->setLiquidVolume(PParticle->getLiquidVolume() - species->getLiquidBridgeVolumeMax());
        }
//        if (liquidBridgeVolume_) logger(INFO,"Forming liquid bridge of volume % between particles % and wall %",liquidBridgeVolume_,getP()->getId(),getI()->getId());
    }
    else if (PParticle == nullptr) //if P is a wall
    {
        logger(ERROR,"Should not happen");
    }
    else //if P and I are particles
    {
        //if I is a ghost particle, apply volume change only to real particles (this removes the possibility that contacts are established only on one side of the periodic boundary; the same problem could exist for ruptures!)
        LiquidFilmParticle* IParticleReal;
        if (IParticle->getPeriodicFromParticle())
        {
            IParticleReal = dynamic_cast<LiquidFilmParticle*>(IParticle->getPeriodicFromParticle());
        }
        else
        {
            IParticleReal = IParticle;
        }
 
        Mdouble distributableLiquidVolume =
                PParticle->getLiquidVolume() + IParticleReal->getLiquidVolume();
        //assign all liquid of the contacting particles to the bridge,
        //if the total volume does not exceed LiquidBridgeVolumeMax
        if (distributableLiquidVolume <= species->getLiquidBridgeVolumeMin())
        {
            return;
        }
        else if (distributableLiquidVolume <= species->getLiquidBridgeVolumeMax())
        {
            liquidBridgeVolume_ = distributableLiquidVolume;
            if (!IParticle->getPeriodicFromParticle() ||
                PParticle->getIndex() < IParticle->getPeriodicFromParticle()->getIndex())
            {
                PParticle->setLiquidVolume(0.0);
                IParticleReal->setLiquidVolume(0.0);
            }
        }
        else //if the total volume exceeds LiquidBridgeVolumeMax, only distribute the max value
        {
            liquidBridgeVolume_ = species->getLiquidBridgeVolumeMax();
            Mdouble pFraction =
                    PParticle->getLiquidVolume() / distributableLiquidVolume;
            if (!IParticle->getPeriodicFromParticle() ||
                PParticle->getIndex() < IParticle->getPeriodicFromParticle()->getIndex())
            {
                PParticle->addLiquidVolume(-pFraction * species->getLiquidBridgeVolumeMax());
                IParticleReal->addLiquidVolume(-(1.0 - pFraction) * species->getLiquidBridgeVolumeMax());
            }
        }
//        if (liquidBridgeVolume_) logger(INFO,"Forming liquid bridge of volume % between particles % and % (MPI %%, V % %, overlap %)",liquidBridgeVolume_,getP()->getId(),getI()->getId(),PParticle->isMPIParticle(),IParticle->isMPIParticle(),PParticle->getLiquidVolume(),IParticle->getLiquidVolume(),getOverlap());
    }
}

References LiquidFilm< Particle >::addLiquidVolume(), ERROR, BaseInteraction::getI(), LiquidMigrationLSSpecies::getLiquidBridgeVolumeMax(), LiquidMigrationLSSpecies::getLiquidBridgeVolumeMin(), LiquidFilm< Particle >::getLiquidVolume(), BaseInteraction::getP(), getSpecies(), liquidBridgeVolume_, logger, LiquidFilm< Particle >::setLiquidVolume(), and wasInContact_.

Referenced by actionsAfterTimeStep().

getBaseName()

std::string LiquidMigrationLSInteraction::getBaseName

(

)

const

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

Returns

std::string

{
    return "LiquidMigrationLS";
}

getElasticEnergy()

Mdouble LiquidMigrationLSInteraction::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

Mdouble

Todo:

TW

Reimplemented from BaseInteraction.

{
    return 0.0;
}

getFieldVTK()

std::vector< Mdouble > LiquidMigrationLSInteraction::getFieldVTK ( unsigned  i ) const

overridevirtual

Reimplemented from BaseInteraction.

{
    return std::vector<Mdouble>(1, cbrt(liquidBridgeVolume_));
}

References liquidBridgeVolume_.

getHalfFillingAngle()

Mdouble LiquidMigrationLSInteraction::getHalfFillingAngle

(

)

{
    const LiquidMigrationLSSpecies* species = getSpecies();
    return pow(liquidBridgeVolume_, 0.26) + (0.285 - 0.4594 * species->getContactAngle()) * pow(liquidBridgeVolume_, (0.6327 + 0.897 * species->getContactAngle()));
}

References LiquidMigrationLSSpecies::getContactAngle(), getSpecies(), and liquidBridgeVolume_.

Referenced by computeAdhesionForce().

getLimitingDistance()

Mdouble LiquidMigrationLSInteraction::getLimitingDistance

(

)

{
    return getRuptureDistance()/4.0;
}

References getRuptureDistance().

Referenced by computeAdhesionForce().

getLiquidBridgeVolume()

Mdouble LiquidMigrationLSInteraction::getLiquidBridgeVolume

(

)

const

{
    return liquidBridgeVolume_;
}

References liquidBridgeVolume_.

Referenced by computeAdhesionForce(), getNumberOfContacts(), and rupture().

getNameVTK()

std::string LiquidMigrationLSInteraction::getNameVTK ( unsigned  i ) const

overridevirtual

Reimplemented from BaseInteraction.

{
    return "liquidBridgeRadius";
    
}

getNumberOfContacts()

int LiquidMigrationLSInteraction::getNumberOfContacts

(

BaseInteractable *

interactable

)

{
    int numContacts = 0;
    for (auto i : interactable->getInteractions())
    {
        LiquidMigrationLSInteraction* j = dynamic_cast<LiquidMigrationLSInteraction*>(i);
        LiquidFilmParticle* jIParticle = dynamic_cast<LiquidFilmParticle*>(i->getI());
        if (j != this && jIParticle != nullptr && j->getLiquidBridgeVolume() != 0.0)
            numContacts++;
    }
    return numContacts;
}

References BaseInteractable::getInteractions(), getLiquidBridgeVolume(), and constants::i.

Referenced by rupture().

getNumberOfFieldsVTK()

unsigned LiquidMigrationLSInteraction::getNumberOfFieldsVTK ( ) const

overridevirtual

writes extra information to the VTK output

Reimplemented from BaseInteraction.

{
    return 1;
}

getRuptureDistance()

Mdouble LiquidMigrationLSInteraction::getRuptureDistance

(

)

{
    const LiquidMigrationLSSpecies* species = getSpecies();
    return (1.0 + 0.5 * species->getContactAngle()) * (cbrt(liquidBridgeVolume_) + 0.1 * pow(liquidBridgeVolume_, 2.0/3.0));
}

References LiquidMigrationLSSpecies::getContactAngle(), getSpecies(), and liquidBridgeVolume_.

Referenced by actionsAfterTimeStep(), computeAdhesionForce(), and getLimitingDistance().

getSpecies()

const LiquidMigrationLSSpecies * LiquidMigrationLSInteraction::getSpecies

(

)

const

Returns a pointer to the adhesive force species LiquidMigrationLSSpecies.

Returns

const LiquidMigrationLSSpecies*

{
    return static_cast<const LiquidMigrationLSSpecies*>(getBaseSpecies()->getAdhesiveForce());
 
}

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

Referenced by computeAdhesionForce(), form(), getHalfFillingAngle(), getRuptureDistance(), and rupture().

getTotalLiquidBridgeVolume()

Mdouble LiquidMigrationLSInteraction::getTotalLiquidBridgeVolume ( InteractionHandler &  h )

static

{
    Mdouble volume = 0;
    for (auto i : h)
    {
        auto l = dynamic_cast<LiquidMigrationLSInteraction*>(i);
        if (l)
        {
            volume += l->getLiquidBridgeVolume();
        }
    }
    return volume;
}

References constants::i.

getTotalLiquidFilmVolume()

Mdouble LiquidMigrationLSInteraction::getTotalLiquidFilmVolume ( ParticleHandler &  h )

static

{
    Mdouble volume = 0;
    for (auto p : h)
    {
        auto l = dynamic_cast<LiquidFilmParticle*>(p);
        if (l)
        {
            volume += l->getLiquidVolume();
        }
    }
    return volume;
}

getTypeVTK()

std::string LiquidMigrationLSInteraction::getTypeVTK ( unsigned  i ) const

overridevirtual

Reimplemented from BaseInteraction.

{
    return "Float32";
}

getWasInContact()

bool LiquidMigrationLSInteraction::getWasInContact

(

)

const

{
    return wasInContact_;
}

References wasInContact_.

read()

void LiquidMigrationLSInteraction::read ( std::istream &  is )

overridevirtual

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

Parameters

[in,out]

is

Implements BaseObject.

{
    std::string dummy;
    is >> dummy >> wasInContact_;
    is >> dummy >> liquidBridgeVolume_;
}

References liquidBridgeVolume_, and wasInContact_.

rupture()

void LiquidMigrationLSInteraction::rupture

(

)

{
    // remove the contact history
    wasInContact_ = false;
 
    //if the bridge is already empty, do nothing
    if (getLiquidBridgeVolume() == 0.0)
        return;
 
    //else rupture a bridge
    const LiquidMigrationLSSpecies* species = getSpecies();
    LiquidFilmParticle* IParticle = dynamic_cast<LiquidFilmParticle*>(getI());
    LiquidFilmParticle* PParticle = dynamic_cast<LiquidFilmParticle*>(getP());
    if (IParticle == nullptr) //if I is a wall
    {
        int numContactsP = 0;
        for (auto i : getP()->getInteractions())
        {
            LiquidMigrationLSInteraction* j = dynamic_cast<LiquidMigrationLSInteraction*>(i);
            if (j != this && j != nullptr && j->getLiquidBridgeVolume() != 0.0)
            {
                numContactsP++;
            }
 
        }
//        logger(INFO,"Rupturing liquid bridge of volume % between particles % and wall % (numContacts %)",liquidBridgeVolume_,getP()->getId(),getI()->getId(),numContactsP);
        if (numContactsP > 0)
        {
            // Updating new volume with distribution less than critical volume
            Mdouble ExcessBridgeVolume = 0.0;
            Mdouble newVolume = liquidBridgeVolume_ * species->getDistributionCoefficient() / (numContactsP);
 
            for (auto i : getP()->getInteractions())
            {
                LiquidMigrationLSInteraction* j =
                        dynamic_cast<LiquidMigrationLSInteraction*>(i);
                if (j != this && j != nullptr && j->getLiquidBridgeVolume() != 0.0)
                {
                    j->setLiquidBridgeVolume(
                            j->getLiquidBridgeVolume() + newVolume);
                    if (j->getLiquidBridgeVolume() >=
                        species->getLiquidBridgeVolumeMax())
                    {
                        ExcessBridgeVolume +=
                                j->getLiquidBridgeVolume()
                                - species->getLiquidBridgeVolumeMax();
                        j->setLiquidBridgeVolume(
                                species->getLiquidBridgeVolumeMax());
                    }
                }
            }
            PParticle->setLiquidVolume(
                    PParticle->getLiquidVolume() + ExcessBridgeVolume +
                    liquidBridgeVolume_ * (1 - species->getDistributionCoefficient()));
 
            setLiquidBridgeVolume(0.0);
        }
        else
        {
            PParticle->setLiquidVolume(PParticle->getLiquidVolume() + liquidBridgeVolume_);
        }
        liquidBridgeVolume_ = 0.0;
        //for (auto i : *getHandler())
        //{
        //    LiquidMigrationLSInteraction* j =
        //           dynamic_cast<LiquidMigrationLSInteraction*>(i);
        //}
        //for (auto i : getHandler()->getDPMBase()->particleHandler)
        //{
        //    LiquidFilmParticle* j = dynamic_cast<LiquidFilmParticle*>(i);
        //}
    }
    else if (PParticle == nullptr) //if P is a wall
    {
        logger(ERROR,"this should not happen");
    }
    else //if P and I are particles
    {
        //count interaction partners of p (this contact, ghosts and interaction without liquid bridge dont count)
        int numContactsP = getNumberOfContacts(getP());
//        logger(INFO,"Rupturing liquid bridge of volume % between particles % and % (numContacts %, MPI %%, overlap %)",liquidBridgeVolume_,getP()->getId(),getI()->getId(),numContactsP,PParticle->isMPIParticle(),IParticle->isMPIParticle(),getOverlap());
        if (numContactsP < 1) //if P has only one contact (the one that gets ruptured), pass the fluid into it)
        {
            PParticle->addLiquidVolume(0.5 * liquidBridgeVolume_);
        }
        else //if P has only multiple contacts pass the fluid into it)
        {
            // move fluid to neighbouring contacts
            Mdouble perContactVolume = 0.5 * liquidBridgeVolume_ * species->getDistributionCoefficient() / numContactsP;
            for (auto i : getP()->getInteractions())
            {
                LiquidMigrationLSInteraction* j =
                        dynamic_cast<LiquidMigrationLSInteraction*>(i);
                LiquidFilmParticle* jIParticle =
                        dynamic_cast<LiquidFilmParticle*>(i->getI());
                if (j != this && jIParticle != nullptr && j->getLiquidBridgeVolume() != 0.0)
                {
                    Mdouble excessVolume =
                            perContactVolume - (species->getLiquidBridgeVolumeMax() - j->getLiquidBridgeVolume());
                    if (excessVolume < 0.0)
                    {
                        j->addLiquidBridgeVolume(perContactVolume);
                        PParticle->addLiquidVolume(
                                0.5 * liquidBridgeVolume_ * (1 - species->getDistributionCoefficient()) / numContactsP);
                    }
                    else
                    {
                        j->setLiquidBridgeVolume(species->getLiquidBridgeVolumeMax());
                        PParticle->addLiquidVolume(excessVolume);
                        PParticle->addLiquidVolume(
                                0.5 * liquidBridgeVolume_ * (1 - species->getDistributionCoefficient()) / numContactsP);
                    }
                }
            }
            //Mdouble PParticle_fin = PParticle->getLiquidVolume();
 
        }
 
        //count interaction partners of i (ghosts and interaction without liquid bridge dont count)
        int numContactsI = getNumberOfContacts(getI());
        if (numContactsI < 1)
        {
            IParticle->addLiquidVolume(0.5 * liquidBridgeVolume_);
            //std::cout << "added " << 0.5 * liquidBridgeVolume_
            //   << " to particle #" << IParticle->getIndex()
            //<< ", V=" << IParticle->getLiquidVolume() << std::endl;
        }
        else
        {
            // move fluid to neighbouring contacts
            Mdouble perContactVolume =
                    0.5 * liquidBridgeVolume_ * species->getDistributionCoefficient() / (numContactsI);
            for (BaseInteraction* i : getI()->getInteractions())
            {
                LiquidMigrationLSInteraction* j = dynamic_cast<LiquidMigrationLSInteraction*>(i);
                LiquidFilmParticle* jIParticle = dynamic_cast<LiquidFilmParticle*>(i->getI());
                if (j != this && jIParticle != nullptr && j->getLiquidBridgeVolume() != 0.0)
                {
                    Mdouble excessVolume =
                            perContactVolume
                            - species->getLiquidBridgeVolumeMax()
                            + j->getLiquidBridgeVolume();
                    if (excessVolume < 0.0)
                    {
                        j->addLiquidBridgeVolume(perContactVolume);
                        IParticle->addLiquidVolume(
                                0.5 * liquidBridgeVolume_ * (1 - species->getDistributionCoefficient()) /
                                (numContactsI));
                    }
                    else
                    {
                        //std::cout << "excess i-Volume " << excessVolume << std::endl;
                        j->setLiquidBridgeVolume(species->getLiquidBridgeVolumeMax());
                        IParticle->addLiquidVolume(excessVolume);
                        IParticle->addLiquidVolume(
                                0.5 * liquidBridgeVolume_ * (1 - species->getDistributionCoefficient()) /
                                (numContactsI));
                    }
                    //~ std::cout << "added " << perContactVolume 
                    //~ << " to i-contact #" << j->getIndex() 
                    //~ << ", V=" << j->getLiquidBridgeVolume() << std::endl;
                }
            }
        }
 
        //~ std::cout << "ruptured liquid bridge #" << getId()
        //~ << " between particles #"
        //~ << PParticle->getIndex()
        //~ << " and #"
        //~ << IParticle->getIndex()
        //~ << ": V" << liquidBridgeVolume_
        //~ << " -> Vp" << PParticle->getLiquidVolume()
        //~ << " Vi" << IParticle->getLiquidVolume()
        //~ << " Np" << numContactsP
        //~ << " Ni" << numContactsI
        //~ << std::endl;
 
        //to balance the added volume, remove the liquid from the bridge
        liquidBridgeVolume_ = 0.0;
 
    }
}

References addLiquidBridgeVolume(), LiquidFilm< Particle >::addLiquidVolume(), ERROR, LiquidMigrationLSSpecies::getDistributionCoefficient(), BaseInteraction::getI(), BaseInteractable::getInteractions(), getLiquidBridgeVolume(), LiquidMigrationLSSpecies::getLiquidBridgeVolumeMax(), LiquidFilm< Particle >::getLiquidVolume(), getNumberOfContacts(), BaseInteraction::getP(), getSpecies(), constants::i, liquidBridgeVolume_, logger, setLiquidBridgeVolume(), LiquidFilm< Particle >::setLiquidVolume(), and wasInContact_.

Referenced by actionsAfterTimeStep(), and actionsOnErase().

setLiquidBridgeVolume()

void LiquidMigrationLSInteraction::setLiquidBridgeVolume

(

Mdouble

liquidBridgeVolume

)

{
    liquidBridgeVolume_ = liquidBridgeVolume;
}

References liquidBridgeVolume_.

Referenced by rupture().

setWasInContact()

void LiquidMigrationLSInteraction::setWasInContact

(

bool

wasInContact

)

{
    wasInContact_ = wasInContact;
}

References wasInContact_.

write()

void LiquidMigrationLSInteraction::write ( std::ostream &  os ) const

overridevirtual

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

Parameters

[in,out]

os

Implements BaseObject.

{
    os
            << " wasInContact " << wasInContact_
            << " liquidBridgeVolume " << liquidBridgeVolume_;
}

References liquidBridgeVolume_, and wasInContact_.

Member Data Documentation

liquidBridgeVolume_

Mdouble LiquidMigrationLSInteraction::liquidBridgeVolume_

private

Referenced by addLiquidBridgeVolume(), form(), getFieldVTK(), getHalfFillingAngle(), getLiquidBridgeVolume(), getRuptureDistance(), LiquidMigrationLSInteraction(), read(), rupture(), setLiquidBridgeVolume(), and write().

wasInContact_

bool LiquidMigrationLSInteraction::wasInContact_

private

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

Referenced by actionsAfterTimeStep(), computeAdhesionForce(), form(), getWasInContact(), LiquidMigrationLSInteraction(), read(), rupture(), setWasInContact(), and write().

---

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

• LiquidMigrationLSInteraction.h
• LiquidMigrationLSInteraction.cc