MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
EmptyFrictionInteraction.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 EMPTYTANGENTIALINTERACTION_H
27 #define EMPTYTANGENTIALINTERACTION_H
28 
30 #include "Math/Vector.h"
31 
32 class BaseParticle;
33 
35 
36 class BaseInteractable;
37 
46 {
47 public:
52 
57 
58  //used for mpi
60 
65 
69  ~EmptyFrictionInteraction() override;
70 
74  void computeFrictionForce();
75 
77 
81  void read(std::istream& is) override;
82 
86  void write(std::ostream& os) const override;
87 
91  Mdouble getElasticEnergy() const override;
92 
96  const EmptyFrictionSpecies* getSpecies() const;
97 
101  std::string getBaseName() const;
102 
103 // specific for tangential forces
107  void integrate(Mdouble timeStep) override;
108 
112  Mdouble getTangentialOverlap() const override;
113 
117  const Vec3D getTangentialForce() const override;
118 };
119 
120 #endif
void computeFrictionForce()
Computes nothing, it is an empty function.
Mdouble getTangentialOverlap() const override
Returns zero overlap.
double Mdouble
Definition: GeneralDefine.h:34
~EmptyFrictionInteraction() override
Destructor.
EmptyFrictionSpecies SpeciesType
An alias name for EmptyFrictionSpecies.
EmptyFrictionSpecies is used to create a force law without frictional forces.
In case one wants to have a frictionless interaction between the interactables (particles or walls)...
Stores information about interactions between two interactable objects; often particles but could be ...
void write(std::ostream &os) const override
Interaction write function, which accepts an std::ostream as input.
void read(std::istream &is) override
Interaction read function, which accepts an std::istream as input.
const EmptyFrictionSpecies * getSpecies() const
Returns a const pointer of type EmptyFrictionSpecies*.
void integrate(Mdouble timeStep) override
Does nothing as there is no force.
Defines the basic properties that a interactable object can have.
Definition: Vector.h:49
std::string getBaseName() const
Returns interaction name/type.
const Vec3D getTangentialForce() const override
Returns zero tangential force.
Mdouble getElasticEnergy() const override
Returns zero as it is an frictionless interaction.