MercuryDPM  Alpha
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
LinearViscoelasticInteraction.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 LINEARVISCOELASTICINTERACTION_H
27 #define LINEARVISCOELASTICINTERACTION_H
28 
30 class BaseInteractable;
32 
38 {
39 public:
59  //LinearViscoelasticInteraction* copy() const;
63  void computeNormalForce();
67  void read(std::istream& is);
71  void write(std::ostream& os) const;
75  std::string getBaseName() const;
79  Mdouble getElasticEnergy() const;
84 
85  Mdouble getElasticEnergyAtEquilibrium(Mdouble adhesiveForce) const;
86 
87 };
88 #endif
void write(std::ostream &os) const
Interaction write function, which accepts an std::ostream as input.
LinearViscoelasticNormalSpecies SpeciesType
An alias for LinearViscoelasticNormalSpecies.
virtual ~LinearViscoelasticInteraction()
Destructor.
double Mdouble
void computeNormalForce()
Creates a copy of an object of this class. (Deep copy)
Mdouble getElasticEnergyAtEquilibrium(Mdouble adhesiveForce) const
Stores information about interactions between two interactable objects; often particles but could be ...
Enables one to compute normal forces in case of a linear visco-elastic interaction.
LinearViscoelasticInteraction(BaseInteractable *P, BaseInteractable *I, Mdouble timeStamp)
Constructor.
LinearViscoelasticNormalSpecies contains the parameters used to describe a linear elastic-dissipative...
const LinearViscoelasticNormalSpecies * getSpecies() const
Returns a const pointer of type LinearViscoelasticNormalSpecies*.
std::string getBaseName() const
Returns the type/name of interaction (linear visco-elastic interaction).
Defines the basic properties that a interactable object can have.
Mdouble getElasticEnergy() const
Returns the amount of energy stored in the spring due to head on collision.
void read(std::istream &is)
Interaction read function, which accepts an std::istream as input.