MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
LiquidBridgeWilletInteraction.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 
26 
29 #include "Particles/BaseParticle.h"
30 #include "InteractionHandler.h"
31 #include <iomanip>
32 #include <fstream>
33 
40  unsigned timeStamp)
41  : BaseInteraction(P, I, timeStamp)
42 {
43  wasInContact_ = false;
44 #ifdef DEBUG_CONSTRUCTOR
45  std::cout<<"LiquidBridgeWilletInteraction::LiquidBridgeWilletInteraction() finished"<<std::endl;
46 #endif
47 }
48 
49 //used for mpi
51  : BaseInteraction()
52 {
53  wasInContact_ = false;
54 #ifdef DEBUG_CONSTRUCTOR
55  std::cout<<"LiquidBridgeWilletInteraction::LiquidBridgeWilletInteraction() finished"<<std::endl;
56 #endif
57 }
58 
63  : BaseInteraction(p)
64 {
66 #ifdef DEBUG_CONSTRUCTOR
67  std::cout<<"LiquidBridgeWilletInteraction::LiquidBridgeWilletInteraction(const LiquidBridgeWilletInteraction &p finished"<<std::endl;
68 #endif
69 }
70 
75 {
76 #ifdef DEBUG_DESTRUCTOR
77  std::cout<<"LiquidBridgeWilletInteraction::~LiquidBridgeWilletInteraction() finished"<<std::endl;
78 #endif
79 }
80 
84 void LiquidBridgeWilletInteraction::write(std::ostream& os) const
85 {
86  os << " wasInContact " << wasInContact_;
87 }
88 
93 {
94  // we read in wasInContact_ like this because an early version did not initialize it.
95  std::string dummy;
96  is >> dummy >> wasInContact_;
97 }
98 
103 {
104  const LiquidBridgeWilletSpecies* species = getSpecies();
105  if (getOverlap() >= 0)
106  {
107  wasInContact_ = true;
108  Mdouble effectiveRadius = 2.0 * getEffectiveRadius();
109  Mdouble fdotn = -2.0 * constants::pi * effectiveRadius * species->getSurfaceTension() *
110  std::cos(species->getContactAngle());
111  addForce(getNormal() * fdotn);
112  }
113  else if (wasInContact_)
114  {
115  Mdouble effectiveRadius = 2.0 * getEffectiveRadius();
116  Mdouble s_c = -getOverlap() * std::sqrt(effectiveRadius / species->getLiquidBridgeVolume());
117  Mdouble fdotn = -2.0 * constants::pi * effectiveRadius * species->getSurfaceTension()
118  * std::cos(species->getContactAngle()) / (1 + (1.05 + 2.5 * s_c) * s_c);
119  addForce(getNormal() * fdotn);
120  }
121 }
122 
127 {
129  return 0.0;
130 }
131 
136 {
137  return static_cast<const LiquidBridgeWilletSpecies*>(getBaseSpecies()->getAdhesiveForce());
138 ;
139 }
140 
145 {
146  return "LiquidBridgeWillet";
147 }
148 
150 {
151  return wasInContact_;
152 }
153 
155 {
156  wasInContact_ = wasInContact;
157 }
Mdouble getEffectiveRadius() const
Returns a Mdouble to the effective radius of the interaction. (Not corrected for the overlap) ...
Mdouble getContactAngle() const
used to access the contact angle between particle and liquid bridge surface.
void read(std::istream &is) override
Interaction read function, which accepts an std::istream as input.
Mdouble getLiquidBridgeVolume() const
used to access the Volume of the liquid bridge.
void computeAdhesionForce()
Computes the adhesive forces for liquid bridge Willet type of interaction.
double Mdouble
Definition: GeneralDefine.h:34
BaseAdhesiveForce * getAdhesiveForce() const
Definition: BaseSpecies.h:152
Mdouble getSurfaceTension() const
used to access the surface tension of the liquid.
Stores information about interactions between two interactable objects; often particles but could be ...
const Vec3D & getNormal() const
Gets the normal vector between the two interacting objects.
Mdouble cos(Mdouble x)
Definition: ExtendedMath.cc:64
void write(std::ostream &os) const override
Interaction print function, which accepts an std::ostream as input.
const LiquidBridgeWilletSpecies * getSpecies() const
Returns a pointer to the adhesive force species LiquidBridgeWilletSpecies.
bool wasInContact_
A history parameter to store if the particles were in contact or not. Useful to compute adhesive forc...
const BaseSpecies * getBaseSpecies() const
Return a constant point to BaseSpecies of the interaction.
std::string getBaseName() const
Returns the name of the interaction, see Interaction.h.
const Mdouble pi
Definition: ExtendedMath.h:45
~LiquidBridgeWilletInteraction() override
Destructor.
Defines the liquid bridge willet interaction between two particles or walls.
Mdouble getOverlap() const
Returns a Mdouble with the current overlap between the two interacting objects.
void addForce(Vec3D force)
add an force increment to the total force.
LiquidBridgeWilletSpecies contains the parameters used to describe a short-range force caused by liqu...
Mdouble getElasticEnergy() const override
Returns the amount of Elastic energy involved in an interaction. Basically used in case you want to w...
Defines the basic properties that a interactable object can have.