LiquidMigrationWilletSpecies.h
Go to the documentation of this file.
1 // This file is part of the MercuryDPM project (https://www.mercurydpm.org).
2 // Copyright (c), The MercuryDPM Developers Team. All rights reserved.
3 // License: BSD 3-Clause License; see the LICENSE file in the root directory.
4 
5 #ifndef LiquidMigrationWilletSpecies_H
6 #define LiquidMigrationWilletSpecies_H
7 
9 #include "Math/ExtendedMath.h"
11 
17 {
18 public:
21 
24 
27 
30 
32  void read(std::istream& is);
33 
35  void write(std::ostream& os) const;
36 
38  std::string getBaseName() const;
39 
42 
43 //adhesion-specific functions
44 
47 
48 //setters and getters
52  void setLiquidBridgeVolumeMax(Mdouble liquidBridgeVolume);
53 
58 
63 
68 
72  void setDistributionCoefficient(Mdouble distributionCoefficient);
73 
78 
82  void setSurfaceTension(Mdouble surfaceTension);
83 
87  Mdouble getSurfaceTension() const;
88 
92  void setContactAngle(Mdouble contactAngle);
93 
97  Mdouble getContactAngle() const;
98 
99 private:
104 
109 
117 
122 
127 
128 };
129 
130 #endif
Definition: BaseAdhesiveForce.h:10
Defines the liquid bridge willet interaction between two particles or walls.
Definition: LiquidMigrationWilletInteraction.h:30
LiquidMigrationWilletSpecies contains the parameters used to describe a short-range force caused by l...
Definition: LiquidMigrationWilletSpecies.h:17
Mdouble contactAngle_
contact angle between particle and liquid bridge surface
Definition: LiquidMigrationWilletSpecies.h:121
LiquidMigrationWilletSpecies()
The default constructor.
Definition: LiquidMigrationWilletSpecies.cc:8
LiquidMigrationWilletInteraction InteractionType
The correct Interaction type for this AdhesiveForceSpecies.
Definition: LiquidMigrationWilletSpecies.h:20
void read(std::istream &is)
Reads the species properties from an input stream.
Definition: LiquidMigrationWilletSpecies.cc:57
void mix(LiquidMigrationWilletSpecies *S, LiquidMigrationWilletSpecies *T)
creates default values for mixed species
Definition: LiquidMigrationWilletSpecies.cc:81
~LiquidMigrationWilletSpecies()
The default destructor.
Definition: LiquidMigrationWilletSpecies.cc:35
void setSurfaceTension(Mdouble surfaceTension)
used to set the surface tension of the liquid.
Definition: LiquidMigrationWilletSpecies.cc:151
Mdouble getContactAngle() const
used to access the contact angle between particle and liquid bridge surface.
Definition: LiquidMigrationWilletSpecies.cc:178
void setLiquidBridgeVolumeMax(Mdouble liquidBridgeVolume)
used to set the Volume of the liquid bridge.
Definition: LiquidMigrationWilletSpecies.cc:100
Mdouble getSurfaceTension() const
used to access the surface tension of the liquid.
Definition: LiquidMigrationWilletSpecies.cc:160
Mdouble liquidBridgeVolumeMax_
Max volume a liquid bridge gets during formation; any excess remains in the liquid film of the partic...
Definition: LiquidMigrationWilletSpecies.h:103
std::string getBaseName() const
Used in Species::getName to obtain a unique name for each Species.
Definition: LiquidMigrationWilletSpecies.cc:71
void setInteractionDistance()
returns the largest separation distance at which adhesive short-range forces can occur.
Definition: LiquidMigrationWilletSpecies.cc:92
Mdouble liquidBridgeVolumeMin_
Minimum volume needed to form a liquid bridge.
Definition: LiquidMigrationWilletSpecies.h:108
Mdouble surfaceTension_
surface tension of the liquid
Definition: LiquidMigrationWilletSpecies.h:126
void setDistributionCoefficient(Mdouble distributionCoefficient)
used to set the distribution coefficient of the liquid.
Definition: LiquidMigrationWilletSpecies.cc:131
void setLiquidBridgeVolumeMin(Mdouble)
used to set the Volume of the liquid bridge.
Definition: LiquidMigrationWilletSpecies.cc:108
Mdouble getLiquidBridgeVolumeMin() const
used to access the Volume of the liquid bridge.
Definition: LiquidMigrationWilletSpecies.cc:123
Mdouble getLiquidBridgeVolumeMax() const
used to access the Volume of the liquid bridge.
Definition: LiquidMigrationWilletSpecies.cc:118
void setContactAngle(Mdouble contactAngle)
used to set the contact angle between particle and liquid bridge surface (in radians)
Definition: LiquidMigrationWilletSpecies.cc:168
Mdouble getDistributionCoefficient() const
used to access the surface tension of the liquid.
Definition: LiquidMigrationWilletSpecies.cc:142
void write(std::ostream &os) const
Writes the species properties to an output stream.
Definition: LiquidMigrationWilletSpecies.cc:45
Mdouble distributionCoefficient_
distribution coefficient of the liquid
Definition: LiquidMigrationWilletSpecies.h:116
RealScalar s
Definition: level1_cplx_impl.h:130
std::string string(const unsigned &i)
Definition: oomph_definitions.cc:286
@ S
Definition: quadtree.h:62