MercuryDPM  Alpha
 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-2014, 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 
31 class BaseInteractable;
37 {
38 public:
58  //BaseInteraction* copy() const;
66  void computeNormalForce();
70  virtual void read(std::istream& is);
74  virtual void write(std::ostream& os) const;
78  virtual std::string getBaseName() const;
82  Mdouble getElasticEnergy() const;
90  Mdouble getMaxOverlap() const;
94  void setMaxOverlap(const Mdouble maxOverlap);
99 
100 private:
101 
102  //set in integrate, used in compute force
104 };
105 #endif
virtual std::string getBaseName() const
Returns the name of the interaction.
virtual void read(std::istream &is)
Interaction read function, which accepts an std::istream as input.
void computeLinearPlasticViscoelasticForce()
Creates a copy of an object of this class. (Deep copy)
double Mdouble
Stores information about interactions between two interactable objects; often particles but could be ...
void computeNormalForce()
Calls computeLinearPlasticViscoElasticForce().
LinearPlasticViscoelasticInteraction(BaseInteractable *P, BaseInteractable *I, Mdouble timeStamp)
Constructor.
Mdouble getElasticEnergy() const
Computes and returns the amount of elastic energy stored in the spring.
LinearPlasticViscoelasticNormalSpecies SpeciesType
An alias for the species (needed for e.g. ThermalSpecies)
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.
virtual void write(std::ostream &os) const
Interaction write function, which accepts an std::ostream as input.