SPHNormalSpecies.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 SPHNormalSpecies_H
27 #define SPHNormalSpecies_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 
96  void mix(SPHNormalSpecies* SBase, SPHNormalSpecies* TBase);
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
#define MERCURYDPM_DEPRECATED
Definition: GeneralDefine.h:37
Definition: BaseNormalForce.h:32
Definition: BaseParticle.h:54
Enables the use of SPH particles within MercuryDPM.
Definition: SPHInteraction.h:40
SPHNormalSpecies contains the parameters used to describe a SPH model.
Definition: SPHNormalSpecies.h:39
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: SPHNormalSpecies.cc:176
~SPHNormalSpecies()
The default destructor.
Definition: SPHNormalSpecies.cc:58
Mdouble getStiffness() const
Allows the spring constant to be accessed.
Definition: SPHNormalSpecies.cc:105
std::string getBaseName() const
Used in Species::getName to obtain a unique name for each Species.
Definition: SPHNormalSpecies.cc:87
Mdouble dissipation_
(normal) viscosity
Definition: SPHNormalSpecies.h:117
SPHInteraction InteractionType
The correct Interaction type for this FrictionForceSpecies.
Definition: SPHNormalSpecies.h:42
void setDissipation(Mdouble dissipation)
Allows the normal dissipation to be changed.
Definition: SPHNormalSpecies.cc:118
void read(std::istream &is)
Reads the species properties from an input stream.
Definition: SPHNormalSpecies.cc:77
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: SPHNormalSpecies.cc:211
void setStiffness(Mdouble new_k)
Allows the spring constant to be changed.
Definition: SPHNormalSpecies.cc:93
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: SPHNormalSpecies.cc:187
SPHNormalSpecies()
The default constructor.
Definition: SPHNormalSpecies.cc:35
Mdouble stiffness_
(normal) spring constant
Definition: SPHNormalSpecies.h:116
Mdouble getRestitutionCoefficient(Mdouble mass) const
Calculates restitution coefficient for two copies of given disp, k, mass.
Definition: SPHNormalSpecies.cc:170
Mdouble getDissipation() const
Allows the normal dissipation to be accessed.
Definition: SPHNormalSpecies.cc:132
Mdouble getCollisionTime(Mdouble mass) const
Calculates collision time for two copies of a particle of given disp, k, mass.
Definition: SPHNormalSpecies.cc:139
void write(std::ostream &os) const
Writes the species properties to an output stream.
Definition: SPHNormalSpecies.cc:68
MERCURYDPM_DEPRECATED void setStiffnessAndDissipation(helpers::KAndDisp new_)
Allows the spring and dissipation constants to be changed simultaneously.
Definition: SPHNormalSpecies.cc:111
void mix(SPHNormalSpecies *SBase, SPHNormalSpecies *TBase)
creates default values for mixed species
Definition: SPHNormalSpecies.cc:262
void setRestitutionCoefficient(double eps, Mdouble mass)
Sets disp to obtain a restitution coefficient eps for a collision of two particles of mass m.
Definition: SPHNormalSpecies.cc:199
return type specifically for fuctions returning k and disp at once
Definition: FormulaHelpers.h:38