HertzianViscoelasticInteraction.h
Go to the documentation of this file.
1 //Copyright (c) 2013-2023, 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 HERTZIANVISCOELASTICINTERACTION_H
27 #define HERTZIANVISCOELASTICINTERACTION_H
28 
30 
31 class BaseInteractable;
32 
34 
40 {
41 public:
46 
51 
52  //used for mpi
54 
59 
64  //
65  // HertzianViscoelasticInteraction* copy() const;
66  //
70  void computeNormalForce();
71 
73  {
74 
75  }
76 
80  void read(std::istream& is) override;
81 
85  void write(std::ostream& os) const override;
86 
90  std::string getBaseName() const;
91 
95  Mdouble getElasticEnergy() const override;
96 
101 
102  Mdouble getElasticEnergyAtEquilibrium(Mdouble adhesiveForce) const override;
103 };
104 
105 #endif
double Mdouble
Definition: GeneralDefine.h:34
Defines the basic properties that a interactable object can have.
Definition: BaseInteractable.h:55
Stores information about interactions between two interactable objects; often particles but could be ...
Definition: BaseInteraction.h:60
Computes normal forces for a Herztian visco-elastic interaction.
Definition: HertzianViscoelasticInteraction.h:40
const HertzianViscoelasticNormalSpecies * getSpecies() const
Returns a const pointer of type HerztianViscoelasticNormalSpecies (static-cast).
Definition: HertzianViscoelasticInteraction.cc:164
Mdouble getElasticEnergyAtEquilibrium(Mdouble adhesiveForce) const override
Definition: HertzianViscoelasticInteraction.cc:176
void computeNormalForce()
Computes the amount of normal force due to an Hertzian visco-elastic interaction.
Definition: HertzianViscoelasticInteraction.cc:106
HertzianViscoelasticInteraction(const BaseInteraction &p)
Definition: HertzianViscoelasticInteraction.h:72
HertzianViscoelasticNormalSpecies SpeciesType
An alias for HertzianViscoelasticNormalSpecies.
Definition: HertzianViscoelasticInteraction.h:45
Mdouble getElasticEnergy() const override
Computes and returns the amount of elastic energy stored in the spring.
Definition: HertzianViscoelasticInteraction.cc:148
void read(std::istream &is) override
Interaction read function, which accepts an std::istream as input.
Definition: HertzianViscoelasticInteraction.cc:83
std::string getBaseName() const
Returns the name of the interaction.
Definition: HertzianViscoelasticInteraction.cc:91
void write(std::ostream &os) const override
Interaction write function, which accepts an std::ostream as input.
Definition: HertzianViscoelasticInteraction.cc:75
~HertzianViscoelasticInteraction() override
Destructor.
Definition: HertzianViscoelasticInteraction.cc:65
HertzianViscoelasticNormalSpecies contains the parameters used to describe a Hertzian normal force (T...
Definition: HertzianViscoelasticNormalSpecies.h:38
double P
Uniform pressure.
Definition: TwenteMeshGluing.cpp:73