CRotElasticInteraction Class Reference

Elastic Interaction between free rotational particles. More...

#include <RotElasticInteraction.h>

Inheritance diagram for CRotElasticInteraction:

Collaboration diagram for CRotElasticInteraction:

List of all members.

Public Types
typedef double(CRotElasticInteraction::*	ScalarFieldFunction )() const
typedef pair< bool, double > (CRotElasticInteraction::*	CheckedScalarFieldFunction )() const
typedef Vec3(CRotElasticInteraction::*	VectorFieldFunction )() const
typedef CRotElasticIGP	ParameterType

Public Member Functions
	CRotElasticInteraction (CRotParticle *, CRotParticle *, const CRotElasticIGP &)
virtual Vec3	getPos () const
virtual void	calcForces ()
Vec3	getForce () const
double	getPotentialEnergy () const
virtual void	saveRestartData (std::ostream &oStream)
virtual void	loadRestartData (std::istream &iStream)
Public Member Functions inherited from ARotPairInteraction
	ARotPairInteraction (CRotParticle *, CRotParticle *)
const CParticle *	first () const
const CParticle *	second () const
CRotParticle *	first ()
CRotParticle *	second ()
pair< int, int >	getPairID () const
void	checkIDs ()
virtual bool	hasTag (int, int) const
virtual Vec3	getPosFirst () const
virtual Vec3	getPosSecond () const
void	setPP (CRotParticle *, CRotParticle *)
void	setPP (const vector< CRotParticle * >)
esys::lsm::quintuple< Vec3, double, Vec3, double, Vec3 >	getRaw2Data () const
virtual void	calcHeatTrans ()
virtual void	calcHeatFrict ()
Public Member Functions inherited from AInteraction
bool	initialized () const
vector< int >	getAllID () const
int	getID ()
double	Count () const

Static Public Member Functions
static ScalarFieldFunction	getScalarFieldFunction (const string &)
static CheckedScalarFieldFunction	getCheckedScalarFieldFunction (const string &)
static VectorFieldFunction	getVectorFieldFunction (const string &)
static string	getType ()

Friends
ostream &	operator<< (ostream &, const CRotElasticInteraction &)

Additional Inherited Members
Protected Attributes inherited from ARotPairInteraction
CRotParticle *	m_p1
CRotParticle *	m_p2
Protected Attributes inherited from AInteraction
vector< int >	m_id
	id's of the particles involved
int	m_iid
	interaction id
bool	m_init

---

Detailed Description

Elastic Interaction between free rotational particles.

---

Member Function Documentation

void CRotElasticInteraction::calcForces ( )

virtual

Calculate free elastic forces.

Implements ARotPairInteraction.

References CParticle::applyForce().

Here is the call graph for this function:

CRotElasticInteraction::CheckedScalarFieldFunction CRotElasticInteraction::getCheckedScalarFieldFunction ( const string &  name )

static

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

Parameters:

name	the name of the field

double CRotElasticInteraction::getPotentialEnergy

(

)

const

Get the potential energy stored in the interaction.

Referenced by getScalarFieldFunction().

Here is the caller graph for this function:

CRotElasticInteraction::ScalarFieldFunction CRotElasticInteraction::getScalarFieldFunction ( const string &  name )

static

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

Parameters:

name	the name of the field

References getPotentialEnergy().

Here is the call graph for this function:

CRotElasticInteraction::VectorFieldFunction CRotElasticInteraction::getVectorFieldFunction ( const string &  name )

static

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

Parameters:

name	the name of the field

void CRotElasticInteraction::loadRestartData ( std::istream &  iStream )

virtual

load restart data from stream

Parameters:

iStream

the input stream

Reimplemented from ARotPairInteraction.

References AInteraction::m_id.

void CRotElasticInteraction::saveRestartData ( std::ostream &  oStream )

virtual

save restart data to ostream

Parameters:

oStream

the output stream

Reimplemented from ARotPairInteraction.

References AInteraction::m_id.

---

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

• RotElasticInteraction.h
• RotElasticInteraction.cpp