MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
EmptyAdhesiveInteraction.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 EMPTYADHESIVEINTERACTION_H
27 #define EMPTYADHESIVEINTERACTION_H
28 
30 #include "Math/Vector.h"
31 
32 class BaseParticle;
33 
35 
36 class BaseInteractable;
37 
45 {
46 public:
51 
56 
57  //used for mpi
59 
64 
68  ~EmptyAdhesiveInteraction() override;
69 
73  void computeAdhesionForce();
74 
76 
80  void read(std::istream& is) override;
81 
85  void write(std::ostream& os) const override;
86 
91  Mdouble getElasticEnergy() const override;
92 
96  const EmptyAdhesiveSpecies* getSpecies() const;
97 
101  std::string getBaseName() const;
102 };
103 
104 #endif
double Mdouble
Definition: GeneralDefine.h:34
EmptyAdhesiveSpecies is used to create a force law without a short-range adhesive force...
Stores information about interactions between two interactable objects; often particles but could be ...
void read(std::istream &is) override
Interaction read function, which accepts an std::istream as input.
std::string getBaseName() const
Returns the name of the interaction, see Interaction.h.
~EmptyAdhesiveInteraction() override
Destructor.
void write(std::ostream &os) const override
Interaction print function, which accepts an std::ostream as input.
In case one doesn't want to have an adhesive (short range non contact) interaction between the intera...
const EmptyAdhesiveSpecies * getSpecies() const
Returns a pointer to the adhesive force species EmptyAdhesiveSpecies.
void computeAdhesionForce()
Computes nothing as it is an Empty Adhesive interaction.
EmptyAdhesiveSpecies SpeciesType
An alias name for EmptyAdhesiveSpecies data type.
Defines the basic properties that a interactable object can have.
Mdouble getElasticEnergy() const override
Returns the amount of Elastic energy involved in an interaction. Basically used in case you want to w...