LiquidBridgeWilletInteraction.h
Go to the documentation of this file.
1 //Copyright (c) 2013-2023, 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 LiquidBridgeWilletInteraction_H
27 #define LiquidBridgeWilletInteraction_H
28 
30 #include "Math/Vector.h"
31 
32 class BaseParticle;
33 
35 
36 class BaseInteractable;
37 
43 {
44 public:
49 
54 
55  //used for mpi
57 
62 
67 
71  void computeAdhesionForce();
72 
76  void read(std::istream& is) override;
77 
81  void write(std::ostream& os) const override;
82 
87  Mdouble getElasticEnergy() const override;
88 
93 
97  std::string getBaseName() const;
98 
99  bool getWasInContact() const;
100 
101  void setWasInContact(bool wasInContact);
102 
103 private:
109 };
110 
111 #endif
Defines the basic properties that a interactable object can have.
Definition: BaseInteractable.h:55
Stores information about interactions between two interactable objects; often particles but could be ...
Definition: BaseInteraction.h:60
Definition: BaseParticle.h:54
Defines the liquid bridge willet interaction between two particles or walls.
Definition: LiquidBridgeWilletInteraction.h:43
LiquidBridgeWilletSpecies SpeciesType
An alias name for LiquidBridgeWilletSpecies data type.
Definition: LiquidBridgeWilletInteraction.h:48
bool wasInContact_
A history parameter to store if the particles were in contact or not. Useful to compute adhesive forc...
Definition: LiquidBridgeWilletInteraction.h:108
std::string getBaseName() const
Returns the name of the interaction, see Interaction.h.
Definition: LiquidBridgeWilletInteraction.cc:144
void write(std::ostream &os) const override
Interaction print function, which accepts an std::ostream as input.
Definition: LiquidBridgeWilletInteraction.cc:84
bool getWasInContact() const
Definition: LiquidBridgeWilletInteraction.cc:149
void read(std::istream &is) override
Interaction read function, which accepts an std::istream as input.
Definition: LiquidBridgeWilletInteraction.cc:92
LiquidBridgeWilletInteraction()
Definition: LiquidBridgeWilletInteraction.cc:50
void setWasInContact(bool wasInContact)
Definition: LiquidBridgeWilletInteraction.cc:154
Mdouble getElasticEnergy() const override
Returns the amount of Elastic energy involved in an interaction. Basically used in case you want to w...
Definition: LiquidBridgeWilletInteraction.cc:126
void computeAdhesionForce()
Computes the adhesive forces for liquid bridge Willet type of interaction.
Definition: LiquidBridgeWilletInteraction.cc:102
const LiquidBridgeWilletSpecies * getSpecies() const
Returns a pointer to the adhesive force species LiquidBridgeWilletSpecies.
Definition: LiquidBridgeWilletInteraction.cc:135
~LiquidBridgeWilletInteraction() override
Destructor.
Definition: LiquidBridgeWilletInteraction.cc:74
LiquidBridgeWilletSpecies contains the parameters used to describe a short-range force caused by liqu...
Definition: LiquidBridgeWilletSpecies.h:38
double P
Uniform pressure.
Definition: TwenteMeshGluing.cpp:73