ESyS-Particle  4.0.1
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes
CRotLocalDamping< T > Class Template Reference

Local rotational damping of the particle motion by a damping coefficient. More...

#include <RotLocalDamping.h>

Collaboration diagram for CRotLocalDamping< T >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef CLocalDampingIGP ParameterType
typedef double(CRotLocalDamping::* ScalarFieldFunction )() const
typedef pair< bool, double >
(CRotLocalDamping::* 
CheckedScalarFieldFunction )() const
typedef Vec3(CRotLocalDamping::* VectorFieldFunction )() const

Public Member Functions

 CRotLocalDamping (T *, double, double)
 CRotLocalDamping (T *, const CLocalDampingIGP &)
 CRotLocalDamping (T *, CLocalDampingIGP *)
virtual ~CRotLocalDamping ()
void setTimeStepSize (double dt)
virtual void calcForces ()
virtual bool hasTag (int, int) const
virtual Vec3 getPosFirst () const
virtual Vec3 getPosSecond () const
virtual Vec3 getPos () const
vector< int > getAllID () const
esys::lsm::quintuple< Vec3,
double, Vec3, double, Vec3
getRaw2Data () const
double getDissipatedEnergy () const
Vec3 getForce () const

Static Public Member Functions

static ScalarFieldFunction getScalarFieldFunction (const string &)
static CheckedScalarFieldFunction getCheckedScalarFieldFunction (const string &)
static VectorFieldFunction getVectorFieldFunction (const string &)

Protected Attributes

T * m_p
 the particle
double m_visc
 damping coefficient
double m_dt
 time step
double m_E_diss
 dissipated energy
Vec3 m_force
 current force

Detailed Description

template<class T>
class CRotLocalDamping< T >

Local rotational damping of the particle motion by a damping coefficient.


Constructor & Destructor Documentation

template<class T >
CRotLocalDamping< T >::CRotLocalDamping ( T *  P,
double  visc,
double  dt 
)

Construct a local rotational damping "interaction" for a particle

Parameters:
Pthe particle
viscthe damping coefficient
dtthe time step
template<class T >
CRotLocalDamping< T >::CRotLocalDamping ( T *  P,
const CLocalDampingIGP param 
)

Construct a local rotational damping "interaction" for a particle

Parameters:
Pthe particle
paramthe parameters
template<class T >
CRotLocalDamping< T >::CRotLocalDamping ( T *  P,
CLocalDampingIGP param 
)

Construct a local rotational damping "interaction" for a particle

Parameters:
Pthe particle
parampointer to the parameters
template<class T >
CRotLocalDamping< T >::~CRotLocalDamping ( )
virtual

destructor


Member Function Documentation

template<class T >
void CRotLocalDamping< T >::calcForces ( )
virtual

Calculate the local damping moment.

template<class T >
vector< int > CRotLocalDamping< T >::getAllID ( ) const

return a vector of all particle IDs

template<class T >
CRotLocalDamping< T >::CheckedScalarFieldFunction CRotLocalDamping< T >::getCheckedScalarFieldFunction ( const string &  name)
static

Get the particle member function which returns a checked scalar field of a given name.

Parameters:
namethe name of the field
template<class T >
double CRotLocalDamping< T >::getDissipatedEnergy ( ) const

return the amount of energy dissipated during the last time step

template<class T >
CRotLocalDamping< T >::ScalarFieldFunction CRotLocalDamping< T >::getScalarFieldFunction ( const string &  name)
static

Get the particle member function which returns a scalar field of a given name.

Parameters:
namethe name of the field
template<class T >
CRotLocalDamping< T >::VectorFieldFunction CRotLocalDamping< T >::getVectorFieldFunction ( const string &  name)
static

Get the particle member function which returns a vector field of a given name.

Parameters:
namethe name of the field
template<class T >
bool CRotLocalDamping< T >::hasTag ( int  tag,
int  mask 
) const
virtual

check if any of the particles in the interaction fits tag & mask

Parameters:
tagthe tag
maskthe mask

The documentation for this class was generated from the following files: