SolidifyingLiquidMigrationWilletInteraction Class Reference

#include <SolidifyingLiquidMigrationWilletInteraction.h>

+ Inheritance diagram for SolidifyingLiquidMigrationWilletInteraction:

Public Types

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

Public Member Functions

 SolidifyingLiquidMigrationWilletInteraction (BaseInteractable *P, BaseInteractable *I, unsigned timeStamp)
 Constructor. More...
 
 SolidifyingLiquidMigrationWilletInteraction (const SolidifyingLiquidMigrationWilletInteraction &p)
 Copy constructor. More...
 
 SolidifyingLiquidMigrationWilletInteraction ()
 
 ~SolidifyingLiquidMigrationWilletInteraction () override
 Destructor. More...
 
void computeAdhesionForce ()
 Computes the Adhesive force. 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...
 
const SolidifyingLiquidMigrationWilletSpeciesgetSpecies () const
 Returns a pointer to the adhesive force species SolidifyingLiquidMigrationWilletSpecies. More...
 
std::string getBaseName () const
 Returns the name of the interaction, see Interaction.h. More...
 
Mdouble getElasticEnergy () const override
 Returns the elastic energy stored in the adhesive spring. More...
 
bool getBonded () const
 Get function. More...
 
void setBonded (bool bonded)
 Set function. More...
 
void bond ()
 
void bondInPlace ()
 
void unbond ()
 
Mdouble getBondForce ()
 Simple access function to return the force of the bond. More...
 
void setBondForce (Mdouble bondForce)
 
double getSolidVolume ()
 Different from bondInteraction: More...
 
void setSolidVolume (Mdouble solidVolume)
 
void setLiquidBridgeVolume (Mdouble liquidBridgeVolume) override
 
void addLiquidBridgeVolume (Mdouble liquidBridgeVolume) override
 
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
 
void rupture () override
 
- 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...
 
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)
 
bool getWasInContact () const
 
void setWasInContact (bool wasInContact)
 
void form ()
 
Mdouble getRuptureDistance ()
 
- 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
 

Private Attributes

bool bonded_
 A history parameter to store if the particles were in contact or not. Useful to compute adhesive forces. More...
 
Mdouble bondForce_
 This stores the extra force created by the bond. More...
 
Mdouble solidVolume_
 

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

Member Typedef Documentation

◆ SpeciesType

An alias name for SolidifyingLiquidMigrationWilletSpecies data type.

Constructor & Destructor Documentation

◆ SolidifyingLiquidMigrationWilletInteraction() [1/3]

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

Constructor.

Parameters
[in]P
[in]I
[in]timeStamp
18  : LiquidMigrationWilletInteraction(P, I, timeStamp)
19 {
20  bonded_ = false;
21  solidVolume_ = 0;
22  bondForce_ = 0;
23 #ifdef DEBUG_CONSTRUCTOR
24  std::cout<<"SolidifyingLiquidMigrationWilletInteraction::SolidifyingLiquidMigrationWilletInteraction() finished"<<std::endl;
25 #endif
26 }
LiquidMigrationWilletInteraction()
Definition: LiquidMigrationWilletInteraction.cc:30
Mdouble bondForce_
This stores the extra force created by the bond.
Definition: SolidifyingLiquidMigrationWilletInteraction.h:148
Mdouble solidVolume_
Definition: SolidifyingLiquidMigrationWilletInteraction.h:151
bool bonded_
A history parameter to store if the particles were in contact or not. Useful to compute adhesive forc...
Definition: SolidifyingLiquidMigrationWilletInteraction.h:143
#define I
Definition: main.h:127
double P
Uniform pressure.
Definition: TwenteMeshGluing.cpp:77

References bonded_, bondForce_, and solidVolume_.

◆ SolidifyingLiquidMigrationWilletInteraction() [2/3]

SolidifyingLiquidMigrationWilletInteraction::SolidifyingLiquidMigrationWilletInteraction ( const SolidifyingLiquidMigrationWilletInteraction p)

Copy constructor.

Parameters
[in]p
Todo:
tw check if the parameters are valid when inserting the species into the handler
33 {
35  bonded_ = p.bonded_;
36  solidVolume_ = p.solidVolume_;
37  bondForce_ = p.bondForce_;
38 #ifdef DEBUG_CONSTRUCTOR
39  std::cout<<"SolidifyingLiquidMigrationWilletInteraction::SolidifyingLiquidMigrationWilletInteraction(const SolidifyingLiquidMigrationWilletInteraction &p finished"<<std::endl;
40 #endif
41 }
float * p
Definition: Tutorial_Map_using.cpp:9

References bonded_, bondForce_, p, and solidVolume_.

◆ SolidifyingLiquidMigrationWilletInteraction() [3/3]

SolidifyingLiquidMigrationWilletInteraction::SolidifyingLiquidMigrationWilletInteraction ( )
Todo:
MX: add to MPI
44 {
45 #ifdef MERCURY_USE_MPI
46  logger(FATAL,"ChargedSolidifyingLiquidMigrationWilletInteractions are currently not implemented in parallel MercuryDPM");
47 #endif
48 }
Logger< MERCURYDPM_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here.
@ FATAL

References FATAL, and logger.

◆ ~SolidifyingLiquidMigrationWilletInteraction()

SolidifyingLiquidMigrationWilletInteraction::~SolidifyingLiquidMigrationWilletInteraction ( )
override

Destructor.

54 {
55 #ifdef DEBUG_DESTRUCTOR
56  std::cout<<"SolidifyingLiquidMigrationWilletInteraction::~SolidifyingLiquidMigrationWilletInteraction() finished"<<std::endl;
57 #endif
58 }

Member Function Documentation

◆ addLiquidBridgeVolume()

void SolidifyingLiquidMigrationWilletInteraction::addLiquidBridgeVolume ( Mdouble  liquidBridgeVolume)
overridevirtual

Reimplemented from LiquidMigrationWilletInteraction.

194  {
196  solidVolume_ += liquidBridgeVolume * getSpecies()->getSolidFraction();
197 }
virtual void addLiquidBridgeVolume(Mdouble liquidBridgeVolume)
Definition: LiquidMigrationWilletInteraction.cc:280
const SolidifyingLiquidMigrationWilletSpecies * getSpecies() const
Returns a pointer to the adhesive force species SolidifyingLiquidMigrationWilletSpecies.
Definition: SolidifyingLiquidMigrationWilletInteraction.cc:101
Mdouble getSolidFraction() const
Definition: SolidifyingLiquidMigrationWilletSpecies.h:74

References LiquidMigrationWilletInteraction::addLiquidBridgeVolume(), SolidifyingLiquidMigrationWilletSpecies::getSolidFraction(), getSpecies(), and solidVolume_.

◆ bond()

void SolidifyingLiquidMigrationWilletInteraction::bond ( )

This access function create a bond between the particles with the stength of the maximum bondForce

140 {
142  bonded_ = true;
143 }
Mdouble getBondForceMax() const
Definition: SolidifyingLiquidMigrationWilletSpecies.h:63

References bonded_, bondForce_, SolidifyingLiquidMigrationWilletSpecies::getBondForceMax(), and getSpecies().

◆ bondInPlace()

void SolidifyingLiquidMigrationWilletInteraction::bondInPlace ( )

This access function create a bond between the particles with the stength of the current force. So the current distance should be come the equilibrum distance.

Bug:
Make have to things about dispative forces
146 {
148  bonded_ = true;
149 }
const Vec3D & getForce() const
Gets the current force (vector) between the two interacting objects.
Definition: BaseInteraction.h:189
static Mdouble getLength(const Vec3D &a)
Calculates the length of a Vec3D: .
Definition: Vector.cc:350

References bonded_, bondForce_, BaseInteraction::getForce(), and Vec3D::getLength().

Referenced by computeAdhesionForce().

◆ computeAdhesionForce()

void SolidifyingLiquidMigrationWilletInteraction::computeAdhesionForce ( )

Computes the Adhesive force.

Uses the most basic adhesion contact model.

87 {
88  if (bonded_) {
89  addForce(getNormal() * (-getBondForce() - getSpecies()->getBondDissipation() * getNormalRelativeVelocity()));
90  } else {
92  //logger(WARN,"Solidifying contact, V=%", solidVolume_);
93  bondInPlace();
94  }
95  }
96 }
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 getLiquidBridgeVolume() const
Definition: LiquidMigrationWilletInteraction.cc:260
void bondInPlace()
Definition: SolidifyingLiquidMigrationWilletInteraction.cc:145
Mdouble getBondForce()
Simple access function to return the force of the bond.
Definition: SolidifyingLiquidMigrationWilletInteraction.h:103

References BaseInteraction::addForce(), bonded_, bondInPlace(), getBondForce(), LiquidMigrationWilletInteraction::getLiquidBridgeVolume(), BaseInteraction::getNormal(), BaseInteraction::getNormalRelativeVelocity(), getSpecies(), and solidVolume_.

◆ getBaseName()

std::string SolidifyingLiquidMigrationWilletInteraction::getBaseName ( ) const

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

Returns
std::string
111 {
112  return "Solidifying" + LiquidMigrationWilletInteraction::getBaseName();
113 }
std::string getBaseName() const
Returns the name of the interaction, see Interaction.h.
Definition: LiquidMigrationWilletInteraction.cc:255

References LiquidMigrationWilletInteraction::getBaseName().

◆ getBonded()

bool SolidifyingLiquidMigrationWilletInteraction::getBonded ( ) const

Get function.

129 {
130  return bonded_;
131 }

References bonded_.

Referenced by getFieldVTK(), and rupture().

◆ getBondForce()

Mdouble SolidifyingLiquidMigrationWilletInteraction::getBondForce ( )
inline

Simple access function to return the force of the bond.

103  {
104  return bondForce_;
105  }

References bondForce_.

Referenced by computeAdhesionForce().

◆ getElasticEnergy()

Mdouble SolidifyingLiquidMigrationWilletInteraction::getElasticEnergy ( ) const
overridevirtual

Returns the elastic energy stored in the adhesive spring.

Elastic (=potential) energy is defined as the energy gained by separating two interactables. As it costs energy to separate adhesive interactables, the elastic energy is negative.

Returns
the elastic energy stored in the adhesive spring.

Reimplemented from LiquidMigrationWilletInteraction.

121 {
122  if (!bonded_)
123  return 0.0;
124  else
125  return -getSpecies()->getBondForceMax() * getOverlap();
126 }
Mdouble getOverlap() const
Returns a Mdouble with the current overlap between the two interacting objects.
Definition: BaseInteraction.h:219

References bonded_, SolidifyingLiquidMigrationWilletSpecies::getBondForceMax(), BaseInteraction::getOverlap(), and getSpecies().

◆ getFieldVTK()

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

Reimplemented from LiquidMigrationWilletInteraction.

179 {
180  if (i==0) {
181  return std::vector<Mdouble>(1, cbrt(getLiquidBridgeVolume()));
182  } else if (i==1) {
183  return std::vector<Mdouble>(1, cbrt(solidVolume_));
184  } else {
185  return std::vector<Mdouble>(1, getBonded());
186  }
187 }
int i
Definition: BiCGSTAB_step_by_step.cpp:9
bool getBonded() const
Get function.
Definition: SolidifyingLiquidMigrationWilletInteraction.cc:128
EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE T cbrt(const T &x)
Definition: MathFunctions.h:1320

References Eigen::numext::cbrt(), getBonded(), LiquidMigrationWilletInteraction::getLiquidBridgeVolume(), i, and solidVolume_.

◆ getNameVTK()

std::string SolidifyingLiquidMigrationWilletInteraction::getNameVTK ( unsigned  i) const
overridevirtual

Reimplemented from LiquidMigrationWilletInteraction.

167 {
168  if (i==0) {
169  return "liquidBridgeRadius";
170  } else if (i==1) {
171  return "solidBridgeRadius";
172  } else {
173  return "solidified";
174  }
175 
176 }

References i.

◆ getNumberOfFieldsVTK()

unsigned SolidifyingLiquidMigrationWilletInteraction::getNumberOfFieldsVTK ( ) const
overridevirtual

writes extra information to the VTK output

Reimplemented from LiquidMigrationWilletInteraction.

157 {
158  return 3;
159 }

◆ getSolidVolume()

double SolidifyingLiquidMigrationWilletInteraction::getSolidVolume ( )
inline

Different from bondInteraction:

113 { return solidVolume_; }

References solidVolume_.

◆ getSpecies()

const SolidifyingLiquidMigrationWilletSpecies * SolidifyingLiquidMigrationWilletInteraction::getSpecies ( ) const

Returns a pointer to the adhesive force species SolidifyingLiquidMigrationWilletSpecies.

Returns
const pointer of SolidifyingLiquidMigrationWilletSpecies*
102 {
104 ;
105 }
const BaseSpecies * getBaseSpecies() const
Return a constant point to BaseSpecies of the interaction.
Definition: BaseInteraction.cc:663
BaseAdhesiveForce * getAdhesiveForce() const
Definition: BaseSpecies.h:131
SolidifyingLiquidMigrationWilletSpecies contains the parameters used to describe a linear irreversibl...
Definition: SolidifyingLiquidMigrationWilletSpecies.h:18

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

Referenced by addLiquidBridgeVolume(), bond(), computeAdhesionForce(), getElasticEnergy(), and setLiquidBridgeVolume().

◆ getTypeVTK()

std::string SolidifyingLiquidMigrationWilletInteraction::getTypeVTK ( unsigned  i) const
overridevirtual

Reimplemented from LiquidMigrationWilletInteraction.

162 {
163  return "Float32";
164 }

◆ read()

void SolidifyingLiquidMigrationWilletInteraction::read ( std::istream &  is)
overridevirtual

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

Parameters
[in,out]is

Reimplemented from LiquidMigrationWilletInteraction.

75 {
77  std::string dummy;
78  is >> dummy >> bonded_;
79  is >> dummy >> solidVolume_;
80  is >> dummy >> bondForce_;
81 }
void read(std::istream &is) override
Interaction read function, which accepts an std::istream as input.
Definition: LiquidMigrationWilletInteraction.cc:81
std::string string(const unsigned &i)
Definition: oomph_definitions.cc:286

References bonded_, bondForce_, LiquidMigrationWilletInteraction::read(), solidVolume_, and oomph::Global_string_for_annotation::string().

◆ rupture()

void SolidifyingLiquidMigrationWilletInteraction::rupture ( )
inlineoverridevirtual

Reimplemented from LiquidMigrationWilletInteraction.

134  {
136  }
virtual void rupture()
Definition: LiquidMigrationWilletInteraction.cc:206

References getBonded(), and LiquidMigrationWilletInteraction::rupture().

◆ setBonded()

void SolidifyingLiquidMigrationWilletInteraction::setBonded ( bool  bonded)

Set function.

134 {
135  bonded_ = bonded;
136 }

References bonded_.

◆ setBondForce()

void SolidifyingLiquidMigrationWilletInteraction::setBondForce ( Mdouble  bondForce)
inline
107  {
108  bondForce_ = bondForce;
109  }

References bondForce_.

◆ setLiquidBridgeVolume()

void SolidifyingLiquidMigrationWilletInteraction::setLiquidBridgeVolume ( Mdouble  liquidBridgeVolume)
overridevirtual

Reimplemented from LiquidMigrationWilletInteraction.

189  {
191  solidVolume_ = liquidBridgeVolume * getSpecies()->getSolidFraction();
192 }
virtual void setLiquidBridgeVolume(Mdouble liquidBridgeVolume)
Definition: LiquidMigrationWilletInteraction.cc:275

References SolidifyingLiquidMigrationWilletSpecies::getSolidFraction(), getSpecies(), LiquidMigrationWilletInteraction::setLiquidBridgeVolume(), and solidVolume_.

◆ setSolidVolume()

void SolidifyingLiquidMigrationWilletInteraction::setSolidVolume ( Mdouble  solidVolume)
inline
115  {
116  solidVolume_ = solidVolume;
117  }

References solidVolume_.

◆ unbond()

void SolidifyingLiquidMigrationWilletInteraction::unbond ( )
152 {
153  bonded_ = false;
154 }

References bonded_.

◆ write()

void SolidifyingLiquidMigrationWilletInteraction::write ( std::ostream &  os) const
overridevirtual

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

Parameters
[in,out]os

Reimplemented from LiquidMigrationWilletInteraction.

64 {
66  os << " bonded " << bonded_;
67  os << " solidVolume " << solidVolume_;
68  os << " bondForce " << bondForce_;
69 }
void write(std::ostream &os) const override
Interaction print function, which accepts an std::ostream as input.
Definition: LiquidMigrationWilletInteraction.cc:71

References bonded_, bondForce_, solidVolume_, and LiquidMigrationWilletInteraction::write().

Member Data Documentation

◆ bonded_

bool SolidifyingLiquidMigrationWilletInteraction::bonded_
private

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

Referenced by bond(), bondInPlace(), computeAdhesionForce(), getBonded(), getElasticEnergy(), read(), setBonded(), SolidifyingLiquidMigrationWilletInteraction(), unbond(), and write().

◆ bondForce_

Mdouble SolidifyingLiquidMigrationWilletInteraction::bondForce_
private

This stores the extra force created by the bond.

Referenced by bond(), bondInPlace(), getBondForce(), read(), setBondForce(), SolidifyingLiquidMigrationWilletInteraction(), and write().

◆ solidVolume_


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