MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
BondedInteraction.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 BondInteraction_h
27 #define BondInteraction_h
28 
29 #include "../BaseInteraction.h"
30 #include "Math/Vector.h"
31 
32 class BaseParticle;
33 
34 class BondedSpecies;
35 
36 class BaseInteractable;
37 
41 class BondedInteraction : public virtual BaseInteraction
42 {
43 public:
48 
52  BondedInteraction(BaseInteractable* P, BaseInteractable* I, unsigned timeStamp);
53 
58 
61 
65  ~BondedInteraction() override;
66 
70  void computeAdhesionForce();
71 
75  void read(std::istream& is) override;
76 
80  void write(std::ostream& os) const override;
81 
85  const BondedSpecies* getSpecies() const;
86 
90  std::string getBaseName() const;
91 
95  Mdouble getElasticEnergy() const override;
96 
100  bool getBonded() const;
101 
105  void setBonded(bool bonded);
106 
107  void bond();
108 
109  void unbond();
110 
111 private:
116  bool bonded_;
117 };
118 
119 #endif
BondedSpecies contains the parameters used to describe a linear irreversible short-range force...
Definition: BondedSpecies.h:38
void write(std::ostream &os) const override
Interaction print function, which accepts an std::ostream as input.
~BondedInteraction() override
Destructor.
double Mdouble
Definition: GeneralDefine.h:34
const BondedSpecies * getSpecies() const
Returns a pointer to the adhesive force species BondedSpecies.
Stores information about interactions between two interactable objects; often particles but could be ...
Mdouble getElasticEnergy() const override
Returns the elastic energy stored in the adhesive spring.
bool getBonded() const
Get function.
void setBonded(bool bonded)
Set function.
std::string getBaseName() const
Returns the name of the interaction, see Interaction.h.
void computeAdhesionForce()
Computes the Adhesive force.
Defines the basic properties that a interactable object can have.
void read(std::istream &is) override
Interaction read function, which accepts an std::istream as input.
bool bonded_
A history parameter to store if the particles were in contact or not. Useful to compute adhesive forc...
BondedSpecies SpeciesType
An alias name for BondedSpecies data type.