MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
LinearPlasticViscoelasticInteraction.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 LINEARPLASTICVISCOELASTICINTERACTION_H
27 #define LINEARPLASTICVISCOELASTICINTERACTION_H
28 
30 
32 
33 class BaseInteractable;
34 
40 {
41 public:
46 
51 
52  //used for mpi
54 
59 
67  //BaseInteraction* copy() const;
68 
72  void computeNormalForce();
73 
77  void read(std::istream& is) override;
78 
82  void write(std::ostream& os) const override;
83 
87  virtual std::string getBaseName() const;
88 
92  Mdouble getElasticEnergy() const override;
93 
98 
102  Mdouble getMaxOverlap() const;
103 
107  void setMaxOverlap(Mdouble maxOverlap);
108 
113 
114 private:
115 
116  //set in integrate, used in compute force
118 };
119 
120 #endif
virtual std::string getBaseName() const
Returns the name of the interaction.
double Mdouble
Definition: GeneralDefine.h:34
Mdouble getElasticEnergy() const override
Computes and returns the amount of elastic energy stored in the spring.
Stores information about interactions between two interactable objects; often particles but could be ...
void computeNormalForce()
Creates a copy of an object of this class. (Deep copy)
void read(std::istream &is) override
Interaction read function, which accepts an std::istream as input.
LinearPlasticViscoelasticNormalSpecies SpeciesType
An alias for the species (needed for e.g. ThermalSpecies)
void write(std::ostream &os) const override
Interaction write function, which accepts an std::ostream as input.
const LinearPlasticViscoelasticNormalSpecies * getSpecies() const
Defines the basic properties that a interactable object can have.
LinearPlasticViscoelasticNormalSpecies contains the parameters used to describe a plastic-cohesive no...
Computes normal forces in case of a linear plastic visco-elastic interaction.