MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
LiquidMigrationWilletInteraction.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 LiquidMigrationWilletInteraction_H
27 #define LiquidMigrationWilletInteraction_H
28 
30 #include "Math/Vector.h"
31 #include "ParticleHandler.h"
32 #include "InteractionHandler.h"
33 
34 class BaseParticle;
35 
37 
38 class BaseInteractable;
39 
45 {
46 public:
51 
56 
57  //used for mpi
59 
64 
69 
70  void actionsOnErase() override;
71 
72  void actionsAfterTimeStep() override;
73 
77  void computeAdhesionForce();
78 
82  void read(std::istream& is) override;
83 
87  void write(std::ostream& os) const override;
88 
93  Mdouble getElasticEnergy() const override;
94 
99 
103  std::string getBaseName() const;
104 
106 
107  void setLiquidBridgeVolume(Mdouble liquidBridgeVolume);
108 
109  void addLiquidBridgeVolume(Mdouble liquidBridgeVolume);
110 
111  bool getWasInContact() const;
112 
113  void setWasInContact(bool wasInContact);
114 
115  void rupture();
116 
117  void form();
118 
120 
121  int getNumberOfContacts(BaseInteractable* interactable);
122 
126  unsigned getNumberOfFieldsVTK() const override;
127 
128  std::string getTypeVTK(unsigned i) const override;
129 
130  std::string getNameVTK(unsigned i) const override;
131 
132  std::vector<Mdouble> getFieldVTK(unsigned i) const override;
133 
135 
137 
138 private:
144 
146 };
147 
148 #endif
std::string getTypeVTK(unsigned i) const override
static Mdouble getTotalLiquidBridgeVolume(InteractionHandler &)
unsigned getNumberOfFieldsVTK() const override
writes extra information to the VTK output
LiquidMigrationWilletSpecies contains the parameters used to describe a short-range force caused by l...
int getNumberOfContacts(BaseInteractable *interactable)
Defines the liquid bridge willet interaction between two particles or walls.
static Mdouble getTotalLiquidFilmVolume(ParticleHandler &)
double Mdouble
Definition: GeneralDefine.h:34
Mdouble getElasticEnergy() const override
Returns the amount of Elastic energy involved in an interaction. Basically used in case you want to w...
const std::complex< Mdouble > i
Definition: ExtendedMath.h:50
Stores information about interactions between two interactable objects; often particles but could be ...
std::vector< Mdouble > getFieldVTK(unsigned i) const override
void write(std::ostream &os) const override
Interaction print function, which accepts an std::ostream as input.
bool wasInContact_
A history parameter to store if the particles were in contact or not. Useful to compute adhesive forc...
void read(std::istream &is) override
Interaction read function, which accepts an std::istream as input.
void actionsAfterTimeStep() override
test if particle needs to be ruptured
void actionsOnErase() override
If an interaction needs to do something before it gets erased, add it here. E.g. Liquid bridges ruptu...
Container to store Interaction objects.
std::string getBaseName() const
Returns the name of the interaction, see Interaction.h.
std::string getNameVTK(unsigned i) const override
Container to store all BaseParticle.
void addLiquidBridgeVolume(Mdouble liquidBridgeVolume)
void setLiquidBridgeVolume(Mdouble liquidBridgeVolume)
Defines the basic properties that a interactable object can have.
void computeAdhesionForce()
Computes the adhesive forces for liquid bridge Willet type of interaction.
LiquidMigrationWilletSpecies SpeciesType
An alias name for LiquidMigrationWilletSpecies data type.
const LiquidMigrationWilletSpecies * getSpecies() const
Returns a pointer to the adhesive force species LiquidMigrationWilletSpecies.