MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
LiquidMigrationWilletSpecies.cc
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 
27 #include "Logger.h"
28 
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 }
40 
45 {
51 #ifdef DEBUG_CONSTRUCTOR
52  std::cout<<"LiquidMigrationWilletSpecies::LiquidMigrationWilletSpecies(const LiquidMigrationWilletSpecies &p) finished"<<std::endl;
53 #endif
54 }
55 
57 {
58 #ifdef DEBUG_DESTRUCTOR
59  std::cout<<"LiquidMigrationWilletSpecies::~LiquidMigrationWilletSpecies() finished"<<std::endl;
60 #endif
61 }
62 
66 void LiquidMigrationWilletSpecies::write(std::ostream& os) const
67 {
68  os << " liquidBridgeVolumeMax " << liquidBridgeVolumeMax_;
69  if (liquidBridgeVolumeMin_) os << " liquidBridgeVolumeMin " << liquidBridgeVolumeMin_;
70  os << " distributionCoefficient " << distributionCoefficient_;
71  os << " surfaceTension " << surfaceTension_;
72  os << " contactAngle " << contactAngle_;
73 }
74 
78 void LiquidMigrationWilletSpecies::read(std::istream& is)
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 }
87 
92 {
93  return "LiquidMigrationWillet";
94 }
95 
102 {
108 }
109 
112 {
114 }
115 
120 {
121  logger.assert_always(liquidBridgeVolumeMax>=0,
122  "Error in setLiquidBridgeVolumeMax: liquidBridgeVolumeMax=%", liquidBridgeVolumeMax);
123  liquidBridgeVolumeMax_ = liquidBridgeVolumeMax;
125 }
126 
128 {
129  logger.assert_always(liquidBridgeVolumeMin>=0,
130  "Error in setLiquidBridgeVolumeMin: liquidBridgeVolumeMin=%", liquidBridgeVolumeMin);
131  liquidBridgeVolumeMin_ = liquidBridgeVolumeMin;
132 }
133 
138 {
139  return liquidBridgeVolumeMax_;
140 }
141 
143 {
144  return liquidBridgeVolumeMin_;
145 }
146 
151 {
152  if (distributionCoefficient >= 0 && distributionCoefficient <= 1.0)
153  distributionCoefficient_ = distributionCoefficient;
154  else
155  {
156  logger(ERROR, "Error in setDistributionCoefficient");
157  }
158 }
159 
164 {
166 }
167 
168 
173 {
174  if (surfaceTension >= 0)
175  surfaceTension_ = surfaceTension;
176  else
177  {
178  logger(ERROR, "Error in setSurfaceTension");
179  }
180 }
181 
186 {
187  return surfaceTension_;
188 }
189 
194 {
195  if (contactAngle >= 0)
196  {
197  contactAngle_ = contactAngle;
199  }
200  else
201  {
202  logger(ERROR, "Error in setContactAngle");
203  }
204 }
205 
210 {
211  return contactAngle_;
212 }
213 
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.
BaseSpecies * getBaseSpecies() const
Definition: BaseForce.h:35
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here...
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.
void setInteractionDistance(Mdouble interactionDistance)
Sets BaseSpecies::interactionDistance_.
Definition: BaseSpecies.cc:156
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
static Mdouble average(Mdouble a, Mdouble b)
Returns the harmonic mean of two variables.
Definition: BaseSpecies.cc:110
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.
bool readOptionalVariable(std::istream &is, const std::string &name, T &variable)
Reads optional variables in the restart file.
Definition: Helpers.h:247
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.
void setInteractionDistance()
returns the largest separation distance at which adhesive short-range forces can occur.