MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
LiquidMigrationWilletSpecies.h
Go to the documentation of this file.
1 //Copyright (c) 2013-2020, The MercuryDPM Developers Team. All rights reserved.
2 //For the list of developers, see <http://www.MercuryDPM.org/Team>.
3 //
4 //Redistribution and use in source and binary forms, with or without
5 //modification, are permitted provided that the following conditions are met:
6 // * Redistributions of source code must retain the above copyright
7 // notice, this list of conditions and the following disclaimer.
8 // * Redistributions in binary form must reproduce the above copyright
9 // notice, this list of conditions and the following disclaimer in the
10 // documentation and/or other materials provided with the distribution.
11 // * Neither the name MercuryDPM nor the
12 // names of its contributors may be used to endorse or promote products
13 // derived from this software without specific prior written permission.
14 //
15 //THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
16 //ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17 //WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 //DISCLAIMED. IN NO EVENT SHALL THE MERCURYDPM DEVELOPERS TEAM BE LIABLE FOR ANY
19 //DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 //(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 //LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22 //ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 //(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24 //SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 
26 #ifndef LiquidMigrationWilletSpecies_H
27 #define LiquidMigrationWilletSpecies_H
28 
30 #include "Math/ExtendedMath.h"
32 
38 {
39 public:
42 
45 
48 
51 
53  void read(std::istream& is);
54 
56  void write(std::ostream& os) const;
57 
59  std::string getBaseName() const;
60 
63 
64 //adhesion-specific functions
65 
68 
69 //setters and getters
73  void setLiquidBridgeVolumeMax(Mdouble liquidBridgeVolume);
74 
79 
84 
89 
93  void setDistributionCoefficient(Mdouble distributionCoefficient);
94 
99 
103  void setSurfaceTension(Mdouble surfaceTension);
104 
108  Mdouble getSurfaceTension() const;
109 
113  void setContactAngle(Mdouble contactAngle);
114 
118  Mdouble getContactAngle() const;
119 
120 private:
125 
130 
138 
143 
148 
149 };
150 
151 #endif
LiquidMigrationWilletSpecies contains the parameters used to describe a short-range force caused by l...
void write(std::ostream &os) const
Writes the species properties to an output stream.
Defines the liquid bridge willet interaction between two particles or walls.
double Mdouble
Definition: GeneralDefine.h:34
LiquidMigrationWilletSpecies()
The default constructor.
Mdouble getLiquidBridgeVolumeMin() const
used to access the Volume of the liquid bridge.
void setSurfaceTension(Mdouble surfaceTension)
used to set the surface tension of the liquid.
void read(std::istream &is)
Reads the species properties from an input stream.
Mdouble liquidBridgeVolumeMin_
Minimum volume needed to form a liquid bridge.
void setLiquidBridgeVolumeMin(Mdouble)
used to set the Volume of the liquid bridge.
Mdouble contactAngle_
contact angle between particle and liquid bridge surface
Mdouble getContactAngle() const
used to access the contact angle between particle and liquid bridge surface.
Mdouble getLiquidBridgeVolumeMax() const
used to access the Volume of the liquid bridge.
Mdouble getDistributionCoefficient() const
used to access the surface tension of the liquid.
void mix(LiquidMigrationWilletSpecies *S, LiquidMigrationWilletSpecies *T)
creates default values for mixed species
Mdouble surfaceTension_
surface tension of the liquid
Mdouble liquidBridgeVolumeMax_
Max volume a liquid bridge gets during formation; any excess remains in the liquid film of the partic...
void setDistributionCoefficient(Mdouble distributionCoefficient)
used to set the distribution coefficient of the liquid.
void setLiquidBridgeVolumeMax(Mdouble liquidBridgeVolume)
used to set the Volume of the liquid bridge.
~LiquidMigrationWilletSpecies()
The default destructor.
std::string getBaseName() const
Used in Species::getName to obtain a unique name for each Species.
void setContactAngle(Mdouble contactAngle)
used to set the contact angle between particle and liquid bridge surface (in radians) ...
Mdouble distributionCoefficient_
distribution coefficient of the liquid
Mdouble getSurfaceTension() const
used to access the surface tension of the liquid.
LiquidMigrationWilletInteraction InteractionType
The correct Interaction type for this AdhesiveForceSpecies.
void setInteractionDistance()
returns the largest separation distance at which adhesive short-range forces can occur.