ESyS-Particle  4.0.1
Public Types | Public Member Functions | Static Public Member Functions | Friends
CShortBondedInteraction Class Reference

class for a "short" bonded interaction More...

#include <ShortBondedInteraction.h>

Inheritance diagram for CShortBondedInteraction:
Inheritance graph
[legend]
Collaboration diagram for CShortBondedInteraction:
Collaboration graph
[legend]

List of all members.

Public Types

typedef CBondedIGP ParameterType
typedef
ShortBondedInteractionCpData 
CheckPointable
typedef double(CShortBondedInteraction::* ScalarFieldFunction )() const
typedef pair< bool, double >
(CShortBondedInteraction::* 
CheckedScalarFieldFunction )() const
typedef Vec3(CShortBondedInteraction::* VectorFieldFunction )() const

Public Member Functions

 CShortBondedInteraction (CParticle *, CParticle *, const CBondedIGP &)
double getEquiDist () const
void saveCheckPointData (std::ostream &oStream)
void loadCheckPointData (std::istream &iStream)

Static Public Member Functions

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

Friends

class TML_PackedMessageInterface
ostream & operator<< (ostream &, const CBondedInteraction &)

Detailed Description

class for a "short" bonded interaction

A bonded interaction where the euilibrium distance is not determined by the radii of the particles but by the initial distance, i.e. it allows for overlapping particles. Uses the same parameter class as "normal" bonded interactions


Member Typedef Documentation

Used by PIS to save/load check-point data for objects of this type.

Reimplemented from CBondedInteraction.


Constructor & Destructor Documentation

CShortBondedInteraction::CShortBondedInteraction ( CParticle p1,
CParticle p2,
const CBondedIGP param 
)

Construct valid short bonded interaction. The equilibrium distance is calculated from the initial distance of the two particles.

Parameters:
p1pointer to 1st particle
p2pointer to 2nd particles
paramthe interaction parameters

References CBondedIGP::k, CBondedInteraction::m_break, CBondedInteraction::m_dist, CBondedInteraction::m_force, CBondedInteraction::m_k, CBondedInteraction::m_r0, CBondedInteraction::m_tag, and CBondedIGP::rbreak.


Member Function Documentation

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

Reimplemented from CBondedInteraction.

CShortBondedInteraction::ScalarFieldFunction CShortBondedInteraction::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

Reimplemented from CBondedInteraction.

References CBondedInteraction::getPotentialEnergy(), and CBondedInteraction::getStrain().

Here is the call graph for this function:

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

Reimplemented from CBondedInteraction.

References CBondedInteraction::getForce().

Here is the call graph for this function:

void CShortBondedInteraction::saveCheckPointData ( std::ostream &  oStream) [virtual]

Save snapshot data (non-restartable, viz/postprocessing only) to an output stream.

Parameters:
oStreamthe output stream

Reimplemented from CBondedInteraction.

References ShortBondedInteractionCpData::saveCheckPointData().

Here is the call graph for this function:


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