JKRAdhesiveInteraction.h
Go to the documentation of this file.
1 // This file is part of the MercuryDPM project (https://www.mercurydpm.org).
2 // Copyright (c), The MercuryDPM Developers Team. All rights reserved.
3 // License: BSD 3-Clause License; see the LICENSE file in the root directory.
4 
5 #ifndef LINEARJKRADHESIVEINTERACTION_H
6 #define LINEARJKRADHESIVEINTERACTION_H
7 
9 #include "Math/Vector.h"
10 
11 class BaseParticle;
12 
13 class JKRAdhesiveSpecies;
14 
15 class BaseInteractable;
16 
22 {
23 public:
28 
33 
34  //used for mpi
36 
41 
45  ~JKRAdhesiveInteraction() override;
46 
50  void computeAdhesionForce();
51 
55  void read(std::istream& is) override;
56 
60  void write(std::ostream& os) const override;
68  Mdouble getElasticEnergy() const override;
69 
74  const JKRAdhesiveSpecies* getSpecies() const;
75 
79  std::string getBaseName() const;
80 };
81 
82 #endif
float * p
Definition: Tutorial_Map_using.cpp:9
Defines the basic properties that a interactable object can have.
Definition: BaseInteractable.h:34
Stores information about interactions between two interactable objects; often particles but could be ...
Definition: BaseInteraction.h:39
Definition: BaseParticle.h:33
Definition: JKRAdhesiveInteraction.h:22
void write(std::ostream &os) const override
Interaction print function, which accepts an std::ostream as input.
Definition: JKRAdhesiveInteraction.cc:60
JKRAdhesiveInteraction()
Definition: JKRAdhesiveInteraction.cc:28
~JKRAdhesiveInteraction() override
Destructor.
Definition: JKRAdhesiveInteraction.cc:50
const JKRAdhesiveSpecies * getSpecies() const
A dynamic_cast of BaseSpecies pointer type to a pointer to an object of type JKRAdhesiveSpecies.
Definition: JKRAdhesiveInteraction.cc:97
std::string getBaseName() const
Returns the name of the interaction, see Interaction.h.
Definition: JKRAdhesiveInteraction.cc:105
Mdouble getElasticEnergy() const override
Returns the amount of Elastic energy involved in an interaction. Basically used in case you want to w...
Definition: JKRAdhesiveInteraction.cc:89
JKRAdhesiveSpecies SpeciesType
Setting an alias name for JKRAdhesiveSpecies.
Definition: JKRAdhesiveInteraction.h:27
void read(std::istream &is) override
Interaction read function, which accepts an std::istream as input.
Definition: JKRAdhesiveInteraction.cc:66
void computeAdhesionForce()
Computes the adhesive forces.
Definition: JKRAdhesiveInteraction.cc:72
JKRAdhesiveSpecies contains the parameters used to describe a linear reversible short-range force.
Definition: JKRAdhesiveSpecies.h:17
#define I
Definition: main.h:127
double P
Uniform pressure.
Definition: TwenteMeshGluing.cpp:77
std::string string(const unsigned &i)
Definition: oomph_definitions.cc:286