ESyS-Particle  4.0.1
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
CRotBondedInteraction Class Reference

Elastic interaction between bonded particles between rotational particles. More...

#include <RotBondedInteraction.h>

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

Public Types

typedef CRotBondedIGP ParameterType
typedef BondedInteractionCpData CheckPointable
typedef double(CRotBondedInteraction::* ScalarFieldFunction )() const
typedef pair< bool, double >
(CRotBondedInteraction::* 
CheckedScalarFieldFunction )() const
typedef Vec3(CRotBondedInteraction::* VectorFieldFunction )() const

Public Member Functions

 CRotBondedInteraction (CRotParticle *, CRotParticle *, const CRotBondedIGP &)
int getTag () const
void setTag (int tag)
void calcForces ()
bool broken ()
double getPotentialEnergy () const
double getNormalPotentialEnergy () const
double getShearPotentialEnergy () const
double getTwistPotentialEnergy () const
double getBendPotentialEnergy () const
double getCriterion () const
Vec3 getForce () const
virtual Vec3 getPos () const
Vec3 getCentrePtDiff () const
Vec3 getInitialCentrePtDiff () const
Vec3 getInitialMidPoint () const
Vec3 getP2ShearForcePt () const
Vec3 getP1ShearForcePt () const
Vec3 getContactPoint () const
Vec3 getShearDiff () const
virtual void saveCheckPointData (std::ostream &oStream)
virtual void loadCheckPointData (std::istream &iStream)
virtual void saveRestartData (std::ostream &oStream)
virtual void loadRestartData (std::istream &iStream)
- Public Member Functions inherited from ARotPairInteraction
 ARotPairInteraction (CRotParticle *, CRotParticle *)
const CParticlefirst () const
const CParticlesecond () const
CRotParticlefirst ()
CRotParticlesecond ()
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

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

Additional Inherited Members

- Protected Attributes inherited from ARotPairInteraction
CRotParticlem_p1
CRotParticlem_p2

Detailed Description

Elastic interaction between bonded particles between rotational particles.

Author
Shane Latham, Steffen Abe $Revision$ $Date$

Member Typedef Documentation

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

Member Function Documentation

bool CRotBondedInteraction::broken ( )

Check if the fracture criterion has been exceeded. If so, flag the particles (for the rebuilding of the other interactions) and return "true", so the update of this interaction group can remove the interaction.

CRotBondedInteraction::CheckedScalarFieldFunction CRotBondedInteraction::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
CRotBondedInteraction::ScalarFieldFunction CRotBondedInteraction::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
CRotBondedInteraction::VectorFieldFunction CRotBondedInteraction::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
void CRotBondedInteraction::loadRestartData ( std::istream &  iStream)
virtual

load restart data from stream

Parameters
iStreamthe input stream

Reimplemented from ARotPairInteraction.

void CRotBondedInteraction::saveRestartData ( std::ostream &  oStream)
virtual

save restart data to ostream

Parameters
oStreamthe output stream

Reimplemented from ARotPairInteraction.


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