ESyS-Particle  2.3.4
RotLocalDamping.h
Go to the documentation of this file.
1 // //
3 // Copyright (c) 2003-2017 by The University of Queensland //
4 // Centre for Geoscience Computing //
5 // http://earth.uq.edu.au/centre-geoscience-computing //
6 // //
7 // Primary Business: Brisbane, Queensland, Australia //
8 // Licensed under the Open Software License version 3.0 //
9 // http://www.apache.org/licenses/LICENSE-2.0 //
10 // //
12 
13 #ifndef MODEL_ROTLOCALDAMPING_H
14 #define MODEL_ROTLOCALDAMPING_H
15 
16 // -- project includes --
17 #include "Model/LocalDampingIGP.h"
18 #include "Foundation/vec3.h"
19 #include "Foundation/quintuple.h"
20 
21 class CVarMPIBuffer;
22 class AMPIBuffer;
23 
28 template <class T>
30 {
31 protected:
32  T *m_p;
33  double m_visc;
34  double m_dt;
35  double m_E_diss;
37 
38 public:
40 
41  typedef double (CRotLocalDamping::* ScalarFieldFunction)() const;
42  typedef pair<bool,double> (CRotLocalDamping::* CheckedScalarFieldFunction)() const;
44 
45  static ScalarFieldFunction getScalarFieldFunction(const string&);
47  static VectorFieldFunction getVectorFieldFunction(const string&);
48 
49  CRotLocalDamping(T*,double,double); // to be obsoleted
52  virtual ~CRotLocalDamping();
53 
54  void setTimeStepSize(double dt);
55  virtual void calcForces();
56 
57  virtual bool hasTag(int,int) const;
58  virtual Vec3 getPosFirst() const {return m_p->getPos();};
59  virtual Vec3 getPosSecond() const {return Vec3(0.0,0.0,0.0);};
60  virtual Vec3 getPos() const {return m_p->getPos();};
61  vector<int> getAllID() const;
62 
64  {
65  return
67  m_p->getPos(),
68  m_p->getRad(),
69  Vec3::ZERO,
70  0,
71  getPos()
72  );
73  }
74 
75  double getDissipatedEnergy() const;
76  Vec3 getForce() const;
77 };
78 
80 
81 #endif //__ROTLOCALDAMPING_H
CRotLocalDamping::m_p
T * m_p
the particle
Definition: RotLocalDamping.h:32
CRotLocalDamping::m_dt
double m_dt
time step
Definition: RotLocalDamping.h:34
CRotLocalDamping::getCheckedScalarFieldFunction
static CheckedScalarFieldFunction getCheckedScalarFieldFunction(const string &)
Definition: RotLocalDamping.hpp:145
CRotLocalDamping::getRaw2Data
esys::lsm::quintuple< Vec3, double, Vec3, double, Vec3 > getRaw2Data() const
Definition: RotLocalDamping.h:63
CVarMPIBuffer
MPI send/recv buffer with automagically adjusted size.
Definition: mpivbuf.h:35
CRotLocalDamping::CheckedScalarFieldFunction
pair< bool, double >(CRotLocalDamping::* CheckedScalarFieldFunction)() const
Definition: RotLocalDamping.h:42
CRotLocalDamping
Local rotational damping of the particle motion by a damping coefficient.
Definition: RotLocalDamping.h:30
CRotLocalDamping::hasTag
virtual bool hasTag(int, int) const
Definition: RotLocalDamping.hpp:198
LocalDampingIGP.h
CRotLocalDamping::ParameterType
CLocalDampingIGP ParameterType
Definition: RotLocalDamping.h:39
CRotLocalDamping::m_visc
double m_visc
damping coefficient
Definition: RotLocalDamping.h:33
AMPIBuffer
Abstract base class for MPI send/recv buffer.
Definition: mpibuf.h:34
quintuple.h
CRotLocalDamping::getPos
virtual Vec3 getPos() const
Definition: RotLocalDamping.h:60
CRotLocalDamping::getDissipatedEnergy
double getDissipatedEnergy() const
Definition: RotLocalDamping.hpp:180
CRotLocalDamping::getAllID
vector< int > getAllID() const
Definition: RotLocalDamping.hpp:209
CRotLocalDamping::m_E_diss
double m_E_diss
dissipated energy
Definition: RotLocalDamping.h:35
CRotLocalDamping::m_force
Vec3 m_force
current force
Definition: RotLocalDamping.h:36
CRotLocalDamping::setTimeStepSize
void setTimeStepSize(double dt)
Definition: RotLocalDamping.hpp:73
CRotLocalDamping::ScalarFieldFunction
double(CRotLocalDamping::* ScalarFieldFunction)() const
Definition: RotLocalDamping.h:41
Vec3
Definition: vec3.h:47
CRotLocalDamping::getVectorFieldFunction
static VectorFieldFunction getVectorFieldFunction(const string &)
Definition: RotLocalDamping.hpp:162
CRotLocalDamping::getPosFirst
virtual Vec3 getPosFirst() const
Definition: RotLocalDamping.h:58
vec3.h
Vec3::ZERO
static const Vec3 ZERO
Definition: vec3.h:52
CLocalDampingIGP
Interaction group parameters for CLocalDampingGroup.
Definition: LocalDampingIGP.h:28
CRotLocalDamping::getPosSecond
virtual Vec3 getPosSecond() const
Definition: RotLocalDamping.h:59
CRotLocalDamping::getScalarFieldFunction
static ScalarFieldFunction getScalarFieldFunction(const string &)
Definition: RotLocalDamping.hpp:125
CRotLocalDamping::~CRotLocalDamping
virtual ~CRotLocalDamping()
Definition: RotLocalDamping.hpp:69
CRotLocalDamping::CRotLocalDamping
CRotLocalDamping(T *, double, double)
Definition: RotLocalDamping.hpp:27
RotLocalDamping.hpp
esys::lsm::quintuple
Definition: quintuple.h:25
CRotLocalDamping::VectorFieldFunction
Vec3(CRotLocalDamping::* VectorFieldFunction)() const
Definition: RotLocalDamping.h:43
CRotLocalDamping::calcForces
virtual void calcForces()
Definition: RotLocalDamping.hpp:82
CRotLocalDamping::getForce
Vec3 getForce() const
Definition: RotLocalDamping.hpp:186