MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ChargedBondedInteraction.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 LINEARChargedInteraction_H
27 #define LINEARChargedInteraction_H
28 
30 #include "Math/Vector.h"
31 
32 class BaseParticle;
33 
35 
37 
43 {
44 public:
49 
54 
59 
62 
66  ~ChargedBondedInteraction() override;
67 
71  void computeAdhesionForce();
72 
76  void read(std::istream& is) override;
77 
81  void write(std::ostream& os) const override;
90  Mdouble getElasticEnergy() const override;
91 
95  const ChargedBondedSpecies* getSpecies() const;
96 
100  std::string getBaseName() const;
101 
102 
103  //*********************************************************************************************************************
104  //******************************ADDING ADDITIONAL VARIABLES FOR BOND INTERACTIONS**************************************
105  //*********************************************************************************************************************
106 
110  void bond();
111 
112  void unbond();
113 
114  bool isBonded() const override {return bonded_;}
115 
116 private:
125  bool bonded_;
126 
127 };
128 
129 #endif
double Mdouble
Definition: GeneralDefine.h:34
std::string getBaseName() const
Returns the name of the interaction, see Interaction.h.
ChargedBondedSpecies SpeciesType
Setting an alias name for ChargedBondedSpecies.
void write(std::ostream &os) const override
Interaction print function, which accepts an std::ostream as input.
Stores information about interactions between two interactable objects; often particles but could be ...
ChargedBondedSpecies contains the parameters used to describe a linear reversible short-range force...
void read(std::istream &is) override
Interaction read function, which accepts an std::istream as input.
Mdouble getElasticEnergy() const override
Returns the amount of Elastic energy involved in an interaction. Basically used in case you want to w...
const ChargedBondedSpecies * getSpecies() const
Returns a pointer to the adhesive force species ChargedBondedSpecies.
~ChargedBondedInteraction() override
Destructor.
void bond()
A pair of functions which can be used to fix or unfix a pair of overlapping particles.
Defines the basic properties that a interactable object can have.
void computeAdhesionForce()
Computes the adhesive forces.
bool bonded_
A history parameter to store if the particles were in contact or not. Useful to compute adhesive forc...