CCappedBondedInteraction Class Reference

Elastic interaction with force limit between bonded particles. More...

#include <CappedBondedInteraction.h>

Inheritance diagram for CCappedBondedInteraction:

Collaboration diagram for CCappedBondedInteraction:

Public Types
typedef CCappedBondedIGP	ParameterType
typedef double(CCappedBondedInteraction::*	ScalarFieldFunction) () const
typedef pair< bool, double >(CCappedBondedInteraction::*	CheckedScalarFieldFunction) () const
typedef Vec3(CCappedBondedInteraction::*	VectorFieldFunction) () const
Public Types inherited from CBondedInteraction
typedef CBondedIGP	ParameterType
typedef BondedInteractionCpData	CheckPointable
typedef double(CBondedInteraction::*	ScalarFieldFunction) () const
typedef pair< bool, double >(CBondedInteraction::*	CheckedScalarFieldFunction) () const
typedef Vec3(CBondedInteraction::*	VectorFieldFunction) () const

Public Member Functions
	CCappedBondedInteraction ()
	CCappedBondedInteraction (CParticle *particle1, CParticle *particle2, const CCappedBondedIGP &params)
virtual	~CCappedBondedInteraction ()
virtual void	calcForces ()
Public Member Functions inherited from CBondedInteraction
	CBondedInteraction ()
	CBondedInteraction (CParticle *particle1, CParticle *particle2, const CBondedIGP &params)
virtual	~CBondedInteraction ()
void	setBreak (double)
bool	broken ()
int	getTag () const
void	setTag (int tag)
double	getCriterion () const
double	getPotentialEnergy () const
double	getStrain () const
Vec3	getForce () const
virtual Vec3	getPos () const
virtual void	saveCheckPointData (std::ostream &oStream)
virtual void	saveRestartData (std::ostream &oStream)
virtual void	loadRestartData (std::istream &iStream)
Public Member Functions inherited from APairInteraction
	APairInteraction ()
	APairInteraction (CParticle *, CParticle *)
virtual	~APairInteraction ()
const CParticle *	first () const
const CParticle *	second () const
CParticle *	first ()
CParticle *	second ()
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)
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 CheckedScalarFieldFunction	getCheckedScalarFieldFunction (const string &)
static VectorFieldFunction	getVectorFieldFunction (const string &)
static string	getType ()
Static Public Member Functions inherited from CBondedInteraction
static ScalarFieldFunction	getScalarFieldFunction (const string &)
static CheckedScalarFieldFunction	getCheckedScalarFieldFunction (const string &)
static VectorFieldFunction	getVectorFieldFunction (const string &)
static string	getType ()

Protected Member Functions
	CCappedBondedInteraction (CParticle *, CParticle *)
Protected Member Functions inherited from CBondedInteraction
	CBondedInteraction (CParticle *, CParticle *)

Protected Attributes
double	m_force_limit
	maximum allowed force More...
Protected Attributes inherited from CBondedInteraction
double	m_k
	spring constant More...
double	m_r0
	equilibrium distance More...
double	m_dist
	current distance, cached from last calcForces() More...
double	m_break
	breaking distance More...
Vec3	m_force
	current force, cached for E_pot calculation More...
Vec3	m_cpos
int	m_tag
	Interaction tag;. More...
bool	m_scaling
	scaling k with particle radius More...
Protected Attributes inherited from APairInteraction
CParticle *	m_p1
CParticle *	m_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

Friends
class	TML_PackedMessageInterface

Detailed Description

Elastic interaction with force limit between bonded particles.

Author

Steffen Abe

Revision

894

Date

2006-01-19 10:58:58 +0000 (Thu, 19 Jan 2006)

Member Typedef Documentation

CheckedScalarFieldFunction

typedef pair<bool,double>(CCappedBondedInteraction::* CCappedBondedInteraction::CheckedScalarFieldFunction) () const

ParameterType

typedef CCappedBondedIGP CCappedBondedInteraction::ParameterType

ScalarFieldFunction

typedef double(CCappedBondedInteraction::* CCappedBondedInteraction::ScalarFieldFunction) () const

VectorFieldFunction

typedef Vec3(CCappedBondedInteraction::* CCappedBondedInteraction::VectorFieldFunction) () const

Constructor & Destructor Documentation

CCappedBondedInteraction() [1/3]

CCappedBondedInteraction::CCappedBondedInteraction ( CParticle *  p1, CParticle *  p2  )

protected

just do the APairInteraction part of the constructor - not to be used directly, only by derived class -> therefore protected

CCappedBondedInteraction() [2/3]

CCappedBondedInteraction::CCappedBondedInteraction

(

)

References m_force_limit.

CCappedBondedInteraction() [3/3]

CCappedBondedInteraction::CCappedBondedInteraction	(	CParticle *	particle1,
		CParticle *	particle2,
		const CCappedBondedIGP &	params
	)

References CBasicParticle::getPos(), CBasicParticle::getRad(), CBondedIGP::k, CBondedInteraction::m_break, CBondedInteraction::m_dist, CBondedInteraction::m_force, CCappedBondedIGP::m_force_limit, m_force_limit, CBondedInteraction::m_k, APairInteraction::m_p1, APairInteraction::m_p2, CBondedInteraction::m_r0, CBondedInteraction::m_tag, CBondedIGP::rbreak, and CBondedIGP::tag.

Here is the call graph for this function:

~CCappedBondedInteraction()

CCappedBondedInteraction::~CCappedBondedInteraction ( )

virtual

Member Function Documentation

calcForces()

void CCappedBondedInteraction::calcForces ( )

virtual

Calculate bonded elastic forces. 21 Flops

Reimplemented from CBondedInteraction.

References CParticle::applyForce(), CBasicParticle::getPos(), CBasicParticle::getRad(), CBondedInteraction::m_cpos, CBondedInteraction::m_dist, CBondedInteraction::m_force, m_force_limit, CBondedInteraction::m_k, APairInteraction::m_p1, APairInteraction::m_p2, and CBondedInteraction::m_r0.

Here is the call graph for this function:

getCheckedScalarFieldFunction()

CCappedBondedInteraction::CheckedScalarFieldFunction CCappedBondedInteraction::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

References NULL.

getScalarFieldFunction()

CCappedBondedInteraction::ScalarFieldFunction CCappedBondedInteraction::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 AInteraction::Count(), CBondedInteraction::getPotentialEnergy(), CBondedInteraction::getStrain(), and NULL.

Here is the call graph for this function:

getType()

static string CCappedBondedInteraction::getType ( )

inlinestatic

getVectorFieldFunction()

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

References CBondedInteraction::getForce(), and NULL.

Here is the call graph for this function:

Friends And Related Function Documentation

TML_PackedMessageInterface

friend class TML_PackedMessageInterface

friend

Member Data Documentation

m_force_limit

double CCappedBondedInteraction::m_force_limit

protected

maximum allowed force

Referenced by calcForces(), CCappedBondedInteraction(), TML_PackedMessageInterface::pack(), and TML_PackedMessageInterface::unpack().

---

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

• Model/CappedBondedInteraction.h
• Model/CappedBondedInteraction.cpp