ESyS-Particle  2.3.4
ARotPairInteraction Class Referenceabstract

Abstract base class interactions between 2 rotational particles. More...

#include <RotPairInteraction.h>

Inheritance diagram for ARotPairInteraction:
Collaboration diagram for ARotPairInteraction:

Public Member Functions

 ARotPairInteraction ()
 
 ARotPairInteraction (CRotParticle *, CRotParticle *)
 
virtual ~ARotPairInteraction ()
 
const CParticlefirst () const
 
const CParticlesecond () const
 
CRotParticlefirst ()
 
CRotParticlesecond ()
 
pair< int, int > getPairID () const
 
virtual Vec3 getPos () const =0
 
virtual void calcForces ()=0
 
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, Vec3getRaw2Data () const
 
virtual void calcHeatTrans ()
 
virtual void calcHeatFrict ()
 
virtual void saveRestartData (std::ostream &oStream)
 
virtual void loadRestartData (std::istream &iStream)
 
- Public Member Functions inherited from AInteraction
 AInteraction ()
 
virtual ~AInteraction ()
 
bool initialized () const
 
vector< int > getAllID () const
 
int getID ()
 
double Count () const
 

Protected Attributes

CRotParticlem_p1
 
CRotParticlem_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

Abstract base class interactions between 2 rotational particles.

Author
Steffen Abe $Revision$ $Date$

Constructor & Destructor Documentation

◆ ARotPairInteraction() [1/2]

ARotPairInteraction::ARotPairInteraction ( )

References AInteraction::m_id, m_p1, m_p2, and NULL.

◆ ARotPairInteraction() [2/2]

ARotPairInteraction::ARotPairInteraction ( CRotParticle p1,
CRotParticle p2 
)

References AInteraction::m_init, and setPP().

Here is the call graph for this function:

◆ ~ARotPairInteraction()

ARotPairInteraction::~ARotPairInteraction ( )
virtual

Member Function Documentation

◆ calcForces()

virtual void ARotPairInteraction::calcForces ( )
pure virtual

◆ calcHeatFrict()

virtual void ARotPairInteraction::calcHeatFrict ( )
inlinevirtual

Reimplemented from AInteraction.

◆ calcHeatTrans()

virtual void ARotPairInteraction::calcHeatTrans ( )
inlinevirtual

Reimplemented from AInteraction.

◆ checkIDs()

void ARotPairInteraction::checkIDs ( )

References CBasicParticle::getID(), AInteraction::m_id, m_p1, and m_p2.

Here is the call graph for this function:

◆ first() [1/2]

CRotParticle* ARotPairInteraction::first ( )
inline

References m_p1.

◆ first() [2/2]

const CParticle* ARotPairInteraction::first ( ) const
inline

References m_p1.

◆ getPairID()

pair<int,int> ARotPairInteraction::getPairID ( ) const
inline

References CBasicParticle::getID(), m_p1, and m_p2.

Here is the call graph for this function:

◆ getPos()

virtual Vec3 ARotPairInteraction::getPos ( ) const
pure virtual

Implemented in CRotFrictionInteraction, CRotElasticInteraction, and CRotBondedInteraction.

Referenced by getRaw2Data().

Here is the caller graph for this function:

◆ getPosFirst()

virtual Vec3 ARotPairInteraction::getPosFirst ( ) const
inlinevirtual

Implements AInteraction.

References CBasicParticle::getPos(), and m_p1.

Here is the call graph for this function:

◆ getPosSecond()

virtual Vec3 ARotPairInteraction::getPosSecond ( ) const
inlinevirtual

Reimplemented from AInteraction.

References CBasicParticle::getPos(), and m_p2.

Here is the call graph for this function:

◆ getRaw2Data()

esys::lsm::quintuple<Vec3,double,Vec3,double,Vec3> ARotPairInteraction::getRaw2Data ( ) const
inline

References CBasicParticle::getPos(), getPos(), CBasicParticle::getRad(), m_p1, and m_p2.

Here is the call graph for this function:

◆ hasTag()

bool ARotPairInteraction::hasTag ( int  tag,
int  mask 
) const
virtual

check if any of the particles in the interaction fits tag & mask

Parameters
tagthe tag
maskthe mask

Implements AInteraction.

References CBasicParticle::getTag(), m_p1, and m_p2.

Here is the call graph for this function:

◆ loadRestartData()

virtual void ARotPairInteraction::loadRestartData ( std::istream &  iStream)
inlinevirtual

◆ saveRestartData()

virtual void ARotPairInteraction::saveRestartData ( std::ostream &  oStream)
inlinevirtual

◆ second() [1/2]

CRotParticle* ARotPairInteraction::second ( )
inline

References m_p2.

◆ second() [2/2]

const CParticle* ARotPairInteraction::second ( ) const
inline

References m_p2.

◆ setPP() [1/2]

void ARotPairInteraction::setPP ( const vector< CRotParticle * >  pp)

References setPP().

Here is the call graph for this function:

◆ setPP() [2/2]

void ARotPairInteraction::setPP ( CRotParticle p1,
CRotParticle p2 
)

References CBasicParticle::getID(), AInteraction::m_id, m_p1, and m_p2.

Referenced by ARotPairInteraction(), and setPP().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ m_p1

◆ m_p2


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