revision: v0.14
LinearViscoelasticNormalSpecies.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 LinearViscoelasticNormalSpecies_H
27 #define LinearViscoelasticNormalSpecies_H
28 
30 #include "Math/ExtendedMath.h"
32 #include "Math/Helpers.h"
33 
39 {
40 public:
43 
46 
49 
52 
54  void read(std::istream& is);
55 
57  void write(std::ostream& os) const;
58 
60  std::string getBaseName() const;
61 
62 // Species-specific functions
63 
65  Mdouble getMaximumVelocity(Mdouble radius, Mdouble mass) const;
66 
69 
71  void setRestitutionCoefficient(double eps, Mdouble mass);
72 
75 
78 
82  void setCollisionTimeAndRestitutionCoefficient(Mdouble collisionTime, Mdouble restitutionCoefficient, Mdouble mass1,
83  Mdouble mass2);
84 
88  Mdouble getCollisionTime(Mdouble mass) const;
89 
94 
97 
98 //setters and getters
99 
101  void setStiffness(Mdouble new_k);
102 
104  Mdouble getStiffness() const;
105 
106  void setDissipation(Mdouble dissipation);
107 
109  Mdouble getDissipation() const;
110 
114 
115 private:
118 };
119 
120 #endif
LinearViscoelasticInteraction.h
mathsFunc::square
T square(const T val)
squares a number
Definition: ExtendedMath.h:106
BaseInteractable::getSpecies
const ParticleSpecies * getSpecies() const
Returns a pointer to the species of this BaseInteractable.
Definition: BaseInteractable.h:108
LinearViscoelasticNormalSpecies::setStiffness
void setStiffness(Mdouble new_k)
Allows the spring constant to be changed.
Definition: LinearViscoelasticNormalSpecies.cc:93
constants::pi
const Mdouble pi
Definition: ExtendedMath.h:45
LinearViscoelasticNormalSpecies::read
void read(std::istream &is)
Reads the species properties from an input stream.
Definition: LinearViscoelasticNormalSpecies.cc:77
LinearViscoelasticNormalSpecies::setDissipation
void setDissipation(Mdouble dissipation)
Allows the normal dissipation to be changed.
Definition: LinearViscoelasticNormalSpecies.cc:117
LinearViscoelasticNormalSpecies::InteractionType
LinearViscoelasticInteraction InteractionType
The correct Interaction type for this FrictionForceSpecies.
Definition: LinearViscoelasticNormalSpecies.h:42
constants::sqr_pi
const Mdouble sqr_pi
Definition: ExtendedMath.h:47
LinearViscoelasticNormalSpecies::LinearViscoelasticNormalSpecies
LinearViscoelasticNormalSpecies()
The default constructor.
Definition: LinearViscoelasticNormalSpecies.cc:35
logger
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here.
LinearViscoelasticInteraction
Enables one to compute normal forces in case of a linear visco-elastic interaction.
Definition: LinearViscoelasticInteraction.h:40
mathsFunc::exp
Mdouble exp(Mdouble Exponent)
Definition: ExtendedMath.cc:84
LinearViscoelasticNormalSpecies::setCollisionTimeAndRestitutionCoefficient
void setCollisionTimeAndRestitutionCoefficient(Mdouble tc, Mdouble eps, BaseParticle *p)
Sets k, disp such that it matches a given tc and eps for a collision of two copies of particle p.
Definition: LinearViscoelasticNormalSpecies.cc:212
LinearViscoelasticNormalSpecies::write
void write(std::ostream &os) const
Writes the species properties to an output stream.
Definition: LinearViscoelasticNormalSpecies.cc:68
LinearViscoelasticNormalSpecies::getMaximumVelocity
Mdouble getMaximumVelocity(Mdouble radius, Mdouble mass) const
Calculates the maximum velocity allowed for a collision of two copies of P (for higher velocities par...
Definition: LinearViscoelasticNormalSpecies.cc:175
LinearViscoelasticNormalSpecies::setStiffnessAndRestitutionCoefficient
void setStiffnessAndRestitutionCoefficient(Mdouble k_, Mdouble eps, Mdouble mass)
Sets k, disp such that it matches a given tc and eps for a collision of two copies of P.
Definition: LinearViscoelasticNormalSpecies.cc:186
BaseNormalForce
Definition: BaseNormalForce.h:31
INFO
LL< Log::INFO > INFO
Info log level.
Definition: Logger.cc:55
BaseInteractable
Defines the basic properties that a interactable object can have.
Definition: BaseInteractable.h:55
mathsFunc::log
Mdouble log(Mdouble Power)
Definition: ExtendedMath.cc:104
helpers::KAndDisp::disp
Mdouble disp
Definition: Helpers.h:49
BaseParticle::getVolume
virtual Mdouble getVolume() const
Get Particle volume function, which required a reference to the Species vector. It returns the volume...
Definition: BaseParticle.cc:141
ParticleSpecies::getDensity
Mdouble getDensity() const
Allows density_ to be accessed.
Definition: ParticleSpecies.cc:117
LinearViscoelasticNormalSpecies::getDissipation
Mdouble getDissipation() const
Allows the normal dissipation to be accessed.
Definition: LinearViscoelasticNormalSpecies.cc:130
Helpers.h
LinearViscoelasticNormalSpecies::setStiffnessAndDissipation
MERCURY_DEPRECATED void setStiffnessAndDissipation(helpers::KAndDisp new_)
Allows the spring and dissipation constants to be changed simultaneously.
Definition: LinearViscoelasticNormalSpecies.cc:110
LinearViscoelasticNormalSpecies.h
double
ERROR
LL< Log::ERROR > ERROR
Error log level.
Definition: Logger.cc:53
Logger.h
MERCURY_DEPRECATED
#define MERCURY_DEPRECATED
Definition: GeneralDefine.h:37
BaseSpecies::average
static Mdouble average(Mdouble a, Mdouble b)
Returns the harmonic mean of two variables.
Definition: BaseSpecies.cc:110
LinearViscoelasticNormalSpecies::dissipation_
Mdouble dissipation_
(normal) viscosity
Definition: LinearViscoelasticNormalSpecies.h:117
BaseInteraction.h
LinearViscoelasticNormalSpecies::getRestitutionCoefficient
Mdouble getRestitutionCoefficient(Mdouble mass) const
Calculates restitution coefficient for two copies of given disp, k, mass.
Definition: LinearViscoelasticNormalSpecies.cc:168
LinearViscoelasticNormalSpecies::getBaseName
std::string getBaseName() const
Used in Species::getName to obtain a unique name for each Species.
Definition: LinearViscoelasticNormalSpecies.cc:87
BaseNormalForce::getConstantRestitution
bool getConstantRestitution() const
Definition: BaseNormalForce.h:45
BaseParticle
Definition: BaseParticle.h:54
helpers::KAndDisp::k
Mdouble k
Definition: Helpers.h:48
LinearViscoelasticNormalSpecies::getCollisionTime
Mdouble getCollisionTime(Mdouble mass) const
Calculates collision time for two copies of a particle of given disp, k, mass.
Definition: LinearViscoelasticNormalSpecies.cc:137
helpers::KAndDisp
return type specifically for fuctions returning k and disp at once
Definition: Helpers.h:46
LinearViscoelasticNormalSpecies::mix
void mix(LinearViscoelasticNormalSpecies *SBase, LinearViscoelasticNormalSpecies *TBase)
creates default values for mixed species
Definition: LinearViscoelasticNormalSpecies.cc:264
ExtendedMath.h
LinearViscoelasticNormalSpecies
LinearViscoelasticNormalSpecies contains the parameters used to describe a linear elastic-dissipative...
Definition: LinearViscoelasticNormalSpecies.h:39
LinearViscoelasticNormalSpecies::stiffness_
Mdouble stiffness_
(normal) spring constant
Definition: LinearViscoelasticNormalSpecies.h:116
BaseParticle.h
LinearViscoelasticNormalSpecies::setRestitutionCoefficient
void setRestitutionCoefficient(double eps, Mdouble mass)
Sets disp to obtain a restitution coefficient eps for a collision of two particles of mass m.
Definition: LinearViscoelasticNormalSpecies.cc:199
LinearViscoelasticNormalSpecies::~LinearViscoelasticNormalSpecies
~LinearViscoelasticNormalSpecies()
The default destructor.
Definition: LinearViscoelasticNormalSpecies.cc:58
LinearViscoelasticNormalSpecies::getStiffness
Mdouble getStiffness() const
Allows the spring constant to be accessed.
Definition: LinearViscoelasticNormalSpecies.cc:104
BaseNormalForce.h