LiquidMigrationWilletSpecies Class Reference

LiquidMigrationWilletSpecies contains the parameters used to describe a short-range force caused by liquid bridges. More...

#include <LiquidMigrationWilletSpecies.h>

+ Inheritance diagram for LiquidMigrationWilletSpecies:

Public Types

typedef LiquidMigrationWilletInteraction InteractionType
 The correct Interaction type for this AdhesiveForceSpecies. More...
 

Public Member Functions

 LiquidMigrationWilletSpecies ()
 The default constructor. More...
 
 LiquidMigrationWilletSpecies (const LiquidMigrationWilletSpecies &s)
 The default copy constructor. More...
 
 ~LiquidMigrationWilletSpecies ()
 The default destructor. More...
 
void read (std::istream &is)
 Reads the species properties from an input stream. More...
 
void write (std::ostream &os) const
 Writes the species properties to an output stream. More...
 
std::string getBaseName () const
 Used in Species::getName to obtain a unique name for each Species. More...
 
void mix (LiquidMigrationWilletSpecies *S, LiquidMigrationWilletSpecies *T)
 creates default values for mixed species More...
 
void setInteractionDistance ()
 returns the largest separation distance at which adhesive short-range forces can occur. More...
 
void setLiquidBridgeVolumeMax (Mdouble liquidBridgeVolume)
 used to set the Volume of the liquid bridge. More...
 
Mdouble getLiquidBridgeVolumeMax () const
 used to access the Volume of the liquid bridge. More...
 
void setLiquidBridgeVolumeMin (Mdouble)
 used to set the Volume of the liquid bridge. More...
 
Mdouble getLiquidBridgeVolumeMin () const
 used to access the Volume of the liquid bridge. More...
 
void setDistributionCoefficient (Mdouble distributionCoefficient)
 used to set the distribution coefficient of the liquid. More...
 
Mdouble getDistributionCoefficient () const
 used to access the surface tension of the liquid. More...
 
void setSurfaceTension (Mdouble surfaceTension)
 used to set the surface tension of the liquid. More...
 
Mdouble getSurfaceTension () const
 used to access the surface tension of the liquid. More...
 
void setContactAngle (Mdouble contactAngle)
 used to set the contact angle between particle and liquid bridge surface (in radians) More...
 
Mdouble getContactAngle () const
 used to access the contact angle between particle and liquid bridge surface. More...
 
- Public Member Functions inherited from BaseForce
BaseSpeciesgetBaseSpecies () const
 
void setBaseSpecies (BaseSpecies *baseSpecies)
 

Private Attributes

Mdouble liquidBridgeVolumeMax_
 Max volume a liquid bridge gets during formation; any excess remains in the liquid film of the particle. More...
 
Mdouble liquidBridgeVolumeMin_
 Minimum volume needed to form a liquid bridge. More...
 
Mdouble distributionCoefficient_
 distribution coefficient of the liquid More...
 
Mdouble contactAngle_
 contact angle between particle and liquid bridge surface More...
 
Mdouble surfaceTension_
 surface tension of the liquid More...
 

Detailed Description

LiquidMigrationWilletSpecies contains the parameters used to describe a short-range force caused by liquid bridges.

See LiquidMigrationWilletInteraction::computeForce for a description of the force law.

Member Typedef Documentation

◆ InteractionType

The correct Interaction type for this AdhesiveForceSpecies.

Constructor & Destructor Documentation

◆ LiquidMigrationWilletSpecies() [1/2]

LiquidMigrationWilletSpecies::LiquidMigrationWilletSpecies ( )

The default constructor.

30 {
31  liquidBridgeVolumeMax_ = 0.0; //std::numeric_limits<double>::infinity();
34  surfaceTension_ = 0.0;
35  contactAngle_ = 0.0;
36 #ifdef DEBUG_CONSTRUCTOR
37  std::cout<<"LiquidMigrationWilletSpecies::LiquidMigrationWilletSpecies() finished"<<std::endl;
38 #endif
39 }
Mdouble contactAngle_
contact angle between particle and liquid bridge surface
Definition: LiquidMigrationWilletSpecies.h:142
Mdouble liquidBridgeVolumeMax_
Max volume a liquid bridge gets during formation; any excess remains in the liquid film of the partic...
Definition: LiquidMigrationWilletSpecies.h:124
Mdouble liquidBridgeVolumeMin_
Minimum volume needed to form a liquid bridge.
Definition: LiquidMigrationWilletSpecies.h:129
Mdouble surfaceTension_
surface tension of the liquid
Definition: LiquidMigrationWilletSpecies.h:147
Mdouble distributionCoefficient_
distribution coefficient of the liquid
Definition: LiquidMigrationWilletSpecies.h:137

References contactAngle_, distributionCoefficient_, liquidBridgeVolumeMax_, liquidBridgeVolumeMin_, and surfaceTension_.

◆ LiquidMigrationWilletSpecies() [2/2]

LiquidMigrationWilletSpecies::LiquidMigrationWilletSpecies ( const LiquidMigrationWilletSpecies s)

The default copy constructor.

Parameters
[in]thespecies that is copied
45 {
51 #ifdef DEBUG_CONSTRUCTOR
52  std::cout<<"LiquidMigrationWilletSpecies::LiquidMigrationWilletSpecies(const LiquidMigrationWilletSpecies &p) finished"<<std::endl;
53 #endif
54 }

References contactAngle_, distributionCoefficient_, liquidBridgeVolumeMax_, liquidBridgeVolumeMin_, and surfaceTension_.

◆ ~LiquidMigrationWilletSpecies()

LiquidMigrationWilletSpecies::~LiquidMigrationWilletSpecies ( )

The default destructor.

57 {
58 #ifdef DEBUG_DESTRUCTOR
59  std::cout<<"LiquidMigrationWilletSpecies::~LiquidMigrationWilletSpecies() finished"<<std::endl;
60 #endif
61 }

Member Function Documentation

◆ getBaseName()

std::string LiquidMigrationWilletSpecies::getBaseName ( ) const

Used in Species::getName to obtain a unique name for each Species.

Returns
a string containing the name of the species (minus the word "Species")
92 {
93  return "LiquidMigrationWillet";
94 }

◆ getContactAngle()

Mdouble LiquidMigrationWilletSpecies::getContactAngle ( ) const

used to access the contact angle between particle and liquid bridge surface.

Returns
the contact angle between particle and liquid bridge surface.
210 {
211  return contactAngle_;
212 }

References contactAngle_.

Referenced by LiquidMigrationWilletInteraction::computeAdhesionForce(), LiquidMigrationWilletInteraction::getRuptureDistance(), and mix().

◆ getDistributionCoefficient()

Mdouble LiquidMigrationWilletSpecies::getDistributionCoefficient ( ) const

used to access the surface tension of the liquid.

Returns
the distribution coefficient of the liquid.
164 {
166 }

References distributionCoefficient_.

Referenced by mix(), and LiquidMigrationWilletInteraction::rupture().

◆ getLiquidBridgeVolumeMax()

Mdouble LiquidMigrationWilletSpecies::getLiquidBridgeVolumeMax ( ) const

used to access the Volume of the liquid bridge.

Returns
the volume of the liquid bridge.
138 {
139  return liquidBridgeVolumeMax_;
140 }

References liquidBridgeVolumeMax_.

Referenced by LiquidMigrationWilletInteraction::form(), mix(), and LiquidMigrationWilletInteraction::rupture().

◆ getLiquidBridgeVolumeMin()

Mdouble LiquidMigrationWilletSpecies::getLiquidBridgeVolumeMin ( ) const

used to access the Volume of the liquid bridge.

143 {
144  return liquidBridgeVolumeMin_;
145 }

References liquidBridgeVolumeMin_.

Referenced by LiquidMigrationWilletInteraction::form(), and mix().

◆ getSurfaceTension()

Mdouble LiquidMigrationWilletSpecies::getSurfaceTension ( ) const

used to access the surface tension of the liquid.

Returns
the surface tension of the liquid.
186 {
187  return surfaceTension_;
188 }

References surfaceTension_.

Referenced by LiquidMigrationWilletInteraction::computeAdhesionForce(), and mix().

◆ mix()

void LiquidMigrationWilletSpecies::mix ( LiquidMigrationWilletSpecies S,
LiquidMigrationWilletSpecies T 
)

creates default values for mixed species

For all parameters we assume that the harmonic mean of the parameters of the original two species is a sensible default.

Parameters
[in]S,Tthe two species whose properties are mixed to create the new species
102 {
108 }
static Mdouble average(Mdouble a, Mdouble b)
Returns the harmonic mean of two variables.
Definition: BaseSpecies.cc:110
Mdouble getContactAngle() const
used to access the contact angle between particle and liquid bridge surface.
Definition: LiquidMigrationWilletSpecies.cc:209
void setLiquidBridgeVolumeMax(Mdouble liquidBridgeVolume)
used to set the Volume of the liquid bridge.
Definition: LiquidMigrationWilletSpecies.cc:119
Mdouble getSurfaceTension() const
used to access the surface tension of the liquid.
Definition: LiquidMigrationWilletSpecies.cc:185
void setLiquidBridgeVolumeMin(Mdouble)
used to set the Volume of the liquid bridge.
Definition: LiquidMigrationWilletSpecies.cc:127
Mdouble getLiquidBridgeVolumeMin() const
used to access the Volume of the liquid bridge.
Definition: LiquidMigrationWilletSpecies.cc:142
Mdouble getLiquidBridgeVolumeMax() const
used to access the Volume of the liquid bridge.
Definition: LiquidMigrationWilletSpecies.cc:137
Mdouble getDistributionCoefficient() const
used to access the surface tension of the liquid.
Definition: LiquidMigrationWilletSpecies.cc:163

References BaseSpecies::average(), contactAngle_, distributionCoefficient_, getContactAngle(), getDistributionCoefficient(), getLiquidBridgeVolumeMax(), getLiquidBridgeVolumeMin(), getSurfaceTension(), setLiquidBridgeVolumeMax(), setLiquidBridgeVolumeMin(), and surfaceTension_.

◆ read()

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

Reads the species properties from an input stream.

Parameters
[in]inputstream (typically the restart file)
79 {
80  std::string dummy;
81  is >> dummy >> liquidBridgeVolumeMax_;
82  helpers::readOptionalVariable(is,"liquidBridgeVolumeMin",liquidBridgeVolumeMin_);
83  is >> dummy >> distributionCoefficient_;
84  is >> dummy >> surfaceTension_;
85  is >> dummy >> contactAngle_;
86 }
bool readOptionalVariable(std::istream &is, const std::string &name, T &variable)
Reads optional variables in the restart file.
Definition: FileIOHelpers.h:82

References contactAngle_, distributionCoefficient_, liquidBridgeVolumeMax_, liquidBridgeVolumeMin_, helpers::readOptionalVariable(), and surfaceTension_.

◆ setContactAngle()

void LiquidMigrationWilletSpecies::setContactAngle ( Mdouble  contactAngle)

used to set the contact angle between particle and liquid bridge surface (in radians)

Parameters
[in]contactAnglethe contact angle between particle and liquid bridge surface.
194 {
195  if (contactAngle >= 0)
196  {
197  contactAngle_ = contactAngle;
199  }
200  else
201  {
202  logger(ERROR, "Error in setContactAngle");
203  }
204 }
Logger< MERCURYDPM_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here.
@ ERROR
void setInteractionDistance()
returns the largest separation distance at which adhesive short-range forces can occur.
Definition: LiquidMigrationWilletSpecies.cc:111

References contactAngle_, ERROR, logger, and setInteractionDistance().

◆ setDistributionCoefficient()

void LiquidMigrationWilletSpecies::setDistributionCoefficient ( Mdouble  distributionCoefficient)

used to set the distribution coefficient of the liquid.

Parameters
[in]distributionCoefficientthe distribution coefficient of the liquid.
151 {
152  if (distributionCoefficient >= 0 && distributionCoefficient <= 1.0)
153  distributionCoefficient_ = distributionCoefficient;
154  else
155  {
156  logger(ERROR, "Error in setDistributionCoefficient");
157  }
158 }

References distributionCoefficient_, ERROR, and logger.

◆ setInteractionDistance()

void LiquidMigrationWilletSpecies::setInteractionDistance ( )

returns the largest separation distance at which adhesive short-range forces can occur.

Returns
the maximum separation distance below which adhesive forces can occur (needed for contact detection)
112 {
114 }
BaseSpecies * getBaseSpecies() const
Definition: BaseForce.h:35
void setInteractionDistance(Mdouble interactionDistance)
Definition: BaseSpecies.cc:156

References contactAngle_, BaseForce::getBaseSpecies(), liquidBridgeVolumeMax_, and BaseSpecies::setInteractionDistance().

Referenced by setContactAngle(), and setLiquidBridgeVolumeMax().

◆ setLiquidBridgeVolumeMax()

void LiquidMigrationWilletSpecies::setLiquidBridgeVolumeMax ( Mdouble  liquidBridgeVolumeMax)

used to set the Volume of the liquid bridge.

Parameters
[in]liquidBridgeVolumethe volume of the liquid bridge.
120 {
121  logger.assert_always(liquidBridgeVolumeMax>=0,
122  "Error in setLiquidBridgeVolumeMax: liquidBridgeVolumeMax=%", liquidBridgeVolumeMax);
123  liquidBridgeVolumeMax_ = liquidBridgeVolumeMax;
125 }

References liquidBridgeVolumeMax_, logger, and setInteractionDistance().

Referenced by mix().

◆ setLiquidBridgeVolumeMin()

void LiquidMigrationWilletSpecies::setLiquidBridgeVolumeMin ( Mdouble  liquidBridgeVolumeMin)

used to set the Volume of the liquid bridge.

128 {
129  logger.assert_always(liquidBridgeVolumeMin>=0,
130  "Error in setLiquidBridgeVolumeMin: liquidBridgeVolumeMin=%", liquidBridgeVolumeMin);
131  liquidBridgeVolumeMin_ = liquidBridgeVolumeMin;
132 }

References liquidBridgeVolumeMin_, and logger.

Referenced by mix().

◆ setSurfaceTension()

void LiquidMigrationWilletSpecies::setSurfaceTension ( Mdouble  surfaceTension)

used to set the surface tension of the liquid.

Parameters
[in]surfaceTensionthe surface tension of the liquid.
173 {
174  if (surfaceTension >= 0)
175  surfaceTension_ = surfaceTension;
176  else
177  {
178  logger(ERROR, "Error in setSurfaceTension");
179  }
180 }

References ERROR, logger, and surfaceTension_.

◆ write()

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

Writes the species properties to an output stream.

Parameters
[out]outputstream (typically the restart file)
67 {
68  os << " liquidBridgeVolumeMax " << liquidBridgeVolumeMax_;
69  if (liquidBridgeVolumeMin_) os << " liquidBridgeVolumeMin " << liquidBridgeVolumeMin_;
70  os << " distributionCoefficient " << distributionCoefficient_;
71  os << " surfaceTension " << surfaceTension_;
72  os << " contactAngle " << contactAngle_;
73 }

References contactAngle_, distributionCoefficient_, liquidBridgeVolumeMax_, liquidBridgeVolumeMin_, and surfaceTension_.

Member Data Documentation

◆ contactAngle_

Mdouble LiquidMigrationWilletSpecies::contactAngle_
private

contact angle between particle and liquid bridge surface

Referenced by getContactAngle(), LiquidMigrationWilletSpecies(), mix(), read(), setContactAngle(), setInteractionDistance(), and write().

◆ distributionCoefficient_

Mdouble LiquidMigrationWilletSpecies::distributionCoefficient_
private

distribution coefficient of the liquid

This is a variable that determines the fraction of the liquid that is to be distributed to the neighboring contacts of the particles after a liquid bridge rupture.

Referenced by getDistributionCoefficient(), LiquidMigrationWilletSpecies(), mix(), read(), setDistributionCoefficient(), and write().

◆ liquidBridgeVolumeMax_

Mdouble LiquidMigrationWilletSpecies::liquidBridgeVolumeMax_
private

Max volume a liquid bridge gets during formation; any excess remains in the liquid film of the particle.

Referenced by getLiquidBridgeVolumeMax(), LiquidMigrationWilletSpecies(), read(), setInteractionDistance(), setLiquidBridgeVolumeMax(), and write().

◆ liquidBridgeVolumeMin_

Mdouble LiquidMigrationWilletSpecies::liquidBridgeVolumeMin_
private

Minimum volume needed to form a liquid bridge.

Referenced by getLiquidBridgeVolumeMin(), LiquidMigrationWilletSpecies(), read(), setLiquidBridgeVolumeMin(), and write().

◆ surfaceTension_

Mdouble LiquidMigrationWilletSpecies::surfaceTension_
private

surface tension of the liquid

Referenced by getSurfaceTension(), LiquidMigrationWilletSpecies(), mix(), read(), setSurfaceTension(), and write().


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