ESyS-Particle  2.3
RotElasticInteraction.h
Go to the documentation of this file.
1 // //
3 // Copyright (c) 2003-2014 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.opensource.org/licenses/osl-3.0.php //
10 // //
12 
13 #ifndef __ROTELASTICINTERACTION_H
14 #define __ROTELASTICINTERACTION_H
15 
17 #include "Model/RotParticle.h"
18 #include "Model/IGParam.h"
19 
20 
24 class CRotElasticIGP : public AIGParam
25 {
26  protected:
27  public:
29  CRotElasticIGP(const std::string &name, double kr, bool scaling);
30 
31  double m_kr;
32  bool m_scaling;
33 
34  virtual void packInto(CVarMPIBuffer*) const;
35  void setNormalSpringConst(double k){m_kr=k;};
36  double getNormalSpringConst() const{return m_kr;};
37 
38  virtual std::string getTypeString() const {return "RotElastic";}
39 
40  friend ostream& operator<<(ostream&,const CRotElasticIGP&);
41 };
42 
45 
51 {
52 public:
53  typedef double (CRotElasticInteraction::* ScalarFieldFunction)() const;
54  typedef pair<bool,double> (CRotElasticInteraction::* CheckedScalarFieldFunction)() const;
56 
57  static ScalarFieldFunction getScalarFieldFunction(const string&);
59  static VectorFieldFunction getVectorFieldFunction(const string&);
60 
61 private:
62  double m_kr;
64  double m_nForce;
67  bool m_scaling;
68 
69 public:
71 
75 
76  virtual Vec3 getPos() const {return m_cpos;}
77 
78  static string getType(){return "RotElastic";}
79 
80  virtual void calcForces();
81 
82  Vec3 getForce() const;
83  double getPotentialEnergy() const;
84 
85  friend ostream& operator<<(ostream&,const CRotElasticInteraction&);
86 
87  // save/load of restart parameters
88  virtual void saveRestartData(std::ostream &oStream);
89  virtual void loadRestartData(std::istream &iStream);
90 };
91 #endif //__ELASTICINTERACTION_H
Class for a rotational particle.
Definition: RotParticle.h:53
Elastic Interaction between free rotational particles.
Definition: RotElasticInteraction.h:50
Abstract base class interactions between 2 rotational particles.
Definition: RotPairInteraction.h:28
Vec3 m_force
caching force for E_pot
Definition: RotElasticInteraction.h:63
void setNormalSpringConst(double k)
Definition: RotElasticInteraction.h:35
virtual ~CRotElasticInteraction()
Definition: RotElasticInteraction.h:74
virtual Vec3 getPos() const
Definition: RotElasticInteraction.h:76
Vec3 m_D
initial positions of the particles
Definition: RotElasticInteraction.h:66
CRotElasticIGP()
Definition: RotElasticInteraction.cpp:21
CRotElasticInteraction()
Definition: RotElasticInteraction.cpp:32
Vec3 getForce() const
Definition: RotElasticInteraction.cpp:61
Definition: vec3.h:46
Interaction group parameters for CRotElasticInteractionGroups.
Definition: RotElasticInteraction.h:24
Abstract base class for InteractionGroup parameters.
Definition: IGParam.h:28
virtual void calcForces()
Definition: RotElasticInteraction.cpp:69
static ScalarFieldFunction getScalarFieldFunction(const string &)
Definition: RotElasticInteraction.cpp:103
pair< bool, double >(CRotElasticInteraction::* CheckedScalarFieldFunction)() const
Definition: RotElasticInteraction.h:54
CRotElasticIGP ParameterType
Definition: RotElasticInteraction.h:70
virtual void loadRestartData(std::istream &iStream)
Definition: RotElasticInteraction.cpp:174
Vec3(CRotElasticInteraction::* VectorFieldFunction)() const
Definition: RotElasticInteraction.h:55
static CheckedScalarFieldFunction getCheckedScalarFieldFunction(const string &)
Definition: RotElasticInteraction.cpp:124
virtual std::string getTypeString() const
Definition: RotElasticInteraction.h:38
static VectorFieldFunction getVectorFieldFunction(const string &)
Definition: RotElasticInteraction.cpp:140
double m_kr
spring constant
Definition: RotElasticInteraction.h:62
Abstract base class for MPI send/recv buffer.
Definition: mpibuf.h:33
friend ostream & operator<<(ostream &, const CRotElasticInteraction &)
Definition: RotElasticInteraction.cpp:184
double(CRotElasticInteraction::* ScalarFieldFunction)() const
Definition: RotElasticInteraction.h:53
Vec3 m_cpos
current position
Definition: RotElasticInteraction.h:65
MPI send/recv buffer with automagically adjusted size.
Definition: mpivbuf.h:34
double getNormalSpringConst() const
Definition: RotElasticInteraction.h:36
bool m_scaling
scaling of normal stiffness with particle size
Definition: RotElasticInteraction.h:67
double m_nForce
normal force, always >= 0
Definition: RotElasticInteraction.h:64
friend ostream & operator<<(ostream &, const CRotElasticIGP &)
Definition: RotElasticInteractionGroup.cpp:45
virtual void packInto(CVarMPIBuffer *) const
Definition: RotElasticInteractionGroup.cpp:19
static string getType()
Definition: RotElasticInteraction.h:78
bool m_scaling
Definition: RotElasticInteraction.h:32
double m_kr
Definition: RotElasticInteraction.h:31
virtual void saveRestartData(std::ostream &oStream)
Definition: RotElasticInteraction.cpp:159
double getPotentialEnergy() const
Definition: RotElasticInteraction.cpp:93
CRotElasticIGP * extractRotElasticIGP(AMPIBuffer *)
Definition: RotElasticInteractionGroup.cpp:25
CRotElasticIGP * extractRotElasticIGP_p(AMPIBuffer *)
Definition: RotElasticInteractionGroup.cpp:37