ESyS-Particle  2.2.2
CLinearDashpotInteraction Class Reference

Linear Dashpot Interaction between free or bonded particles (to be used in addition to an elastic or bonded Interaction, not exclusively) More...

#include <LinearDashpotInteraction.h>

Inheritance diagram for CLinearDashpotInteraction:
Collaboration diagram for CLinearDashpotInteraction:

Public Types

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

Public Member Functions

 CLinearDashpotInteraction (CParticle *, CParticle *, const CLinearDashpotIGP &)
 
virtual ~CLinearDashpotInteraction ()
 
virtual Vec3 getPos () const
 
double getPotentialEnergy () const
 
virtual void calcForces ()
 
Vec3 getForce () const
 
- Public Member Functions inherited from APairInteraction
 APairInteraction ()
 
 APairInteraction (CParticle *, CParticle *)
 
virtual ~APairInteraction ()
 
const CParticlefirst () const
 
const CParticlesecond () const
 
CParticlefirst ()
 
CParticlesecond ()
 
pair< int, int > getPairID () const
 
void setPP (CParticle *, CParticle *)
 
void checkIDs ()
 
virtual bool hasTag (int, int) const
 
virtual Vec3 getPosFirst () const
 
virtual Vec3 getPosSecond () const
 
esys::lsm::quintuple< Vec3,
double, Vec3, double, Vec3
getRaw2Data () const
 
template<class TmplParticle >
void setPP (const vector< TmplParticle * > &pp)
 
virtual void saveRestartData (std::ostream &)
 
virtual void loadRestartData (std::istream &)
 
- Public Member Functions inherited from AInteraction
 AInteraction ()
 
virtual ~AInteraction ()
 
bool initialized () const
 
virtual void calcHeatTrans ()
 
virtual void calcHeatFrict ()
 
vector< int > getAllID () const
 
int getID ()
 
double Count () const
 

Static Public Member Functions

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

Private Attributes

double m_damp
 spring constant More...
 
double m_cutoff
 interaction distance cutoff, relative to particle radii More...
 
double m_cross_section
 cross section of dashpot, calculated from particle radii More...
 
Vec3 m_force
 
Vec3 m_cpos
 

Additional Inherited Members

- Protected Attributes inherited from APairInteraction
CParticlem_p1
 
CParticlem_p2
 
- Protected Attributes inherited from AInteraction
vector< int > m_id
 id's of the particles involved More...
 
int m_iid
 interaction id More...
 
bool m_init
 

Detailed Description

Linear Dashpot Interaction between free or bonded particles (to be used in addition to an elastic or bonded Interaction, not exclusively)

Author
Steffen Abe
Revision:
1201
Date:
2009-07-31 12:25:45 +0200 (Fri, 31 Jul 2009)

Member Typedef Documentation

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

Constructor & Destructor Documentation

CLinearDashpotInteraction::CLinearDashpotInteraction ( CParticle p1,
CParticle p2,
const CLinearDashpotIGP param 
)
virtual CLinearDashpotInteraction::~CLinearDashpotInteraction ( )
inlinevirtual

Member Function Documentation

void CLinearDashpotInteraction::calcForces ( )
virtual
CLinearDashpotInteraction::CheckedScalarFieldFunction CLinearDashpotInteraction::getCheckedScalarFieldFunction ( const string &  name)
static

dummy

References NULL.

Vec3 CLinearDashpotInteraction::getForce ( ) const

"field function" returning force currently exerted by interaction

References m_force.

Referenced by getVectorFieldFunction().

Here is the caller graph for this function:

virtual Vec3 CLinearDashpotInteraction::getPos ( ) const
inlinevirtual

Implements APairInteraction.

References m_cpos.

double CLinearDashpotInteraction::getPotentialEnergy ( ) const
CLinearDashpotInteraction::ScalarFieldFunction CLinearDashpotInteraction::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

References AInteraction::Count(), and NULL.

Here is the call graph for this function:

CLinearDashpotInteraction::VectorFieldFunction CLinearDashpotInteraction::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

References getForce(), and NULL.

Here is the call graph for this function:

Member Data Documentation

Vec3 CLinearDashpotInteraction::m_cpos
private

Referenced by calcForces(), and getPos().

double CLinearDashpotInteraction::m_cross_section
private

cross section of dashpot, calculated from particle radii

Referenced by calcForces(), and CLinearDashpotInteraction().

double CLinearDashpotInteraction::m_cutoff
private

interaction distance cutoff, relative to particle radii

Referenced by calcForces(), and CLinearDashpotInteraction().

double CLinearDashpotInteraction::m_damp
private

spring constant

Referenced by calcForces(), and CLinearDashpotInteraction().

Vec3 CLinearDashpotInteraction::m_force
private

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