ESyS-Particle  2.3.4
CBasicParticle Class Reference

Basic Particle class. Contains only the "geometric part" of the particle, i.e. position and radius, no forces or such. More...

#include <BasicParticle.h>

Inheritance diagram for CBasicParticle:
Collaboration diagram for CBasicParticle:

Public Member Functions

 CBasicParticle ()
 
 CBasicParticle (const Vec3 &pos, double radius, int id=-1, int tag=-1)
 
 CBasicParticle (const esys::lsm::SimpleParticleData &data)
 
virtual ~CBasicParticle ()
 
Vec3getPPos ()
 
Vec3 getPos () const
 
void setPos (const Vec3 &pos)
 
double getRad () const
 
int getID () const
 
void setID (int id)
 
void moveBy (Vec3 v)
 move relative to current position More...
 
void moveTo (Vec3 v)
 move absolute More...
 
void setRad (double r)
 
void setTag (int t)
 particle tag handling More...
 
int getTag () const
 
bool isValid () const
 
 CBasicParticle ()
 
 CBasicParticle (int, const Vec3 &, double)
 
Vec3getPPos ()
 
Vec3 getPos () const
 
double getRad () const
 
int getID () const
 
void moveBy (Vec3 v)
 
void moveTo (Vec3 v)
 move relative to current position More...
 
void setRad (double r)
 move absolute More...
 

Static Public Attributes

static const CBasicParticle INVALID = CBasicParticle(Vec3::ZERO, 0.0, -1, -1)
 

Protected Attributes

Vec3 m_pos
 position More...
 
double m_rad
 radius More...
 
int m_global_id
 
int m_tag
 
int m_id
 

Detailed Description

Basic Particle class. Contains only the "geometric part" of the particle, i.e. position and radius, no forces or such.

Basic Particle class.

Author
Steffen Abe $Revision$ $Date$

Contains only the "geometric part" of the particle, i.e. position and radius, no forces or such. – Modified for testing the new neighbortable ! —

Author
Steffen Abe $Revision$ $Date$

Constructor & Destructor Documentation

◆ CBasicParticle() [1/5]

CBasicParticle::CBasicParticle ( )

◆ CBasicParticle() [2/5]

CBasicParticle::CBasicParticle ( const Vec3 pos,
double  radius,
int  id = -1,
int  tag = -1 
)

◆ CBasicParticle() [3/5]

CBasicParticle::CBasicParticle ( const esys::lsm::SimpleParticleData data)

◆ ~CBasicParticle()

virtual CBasicParticle::~CBasicParticle ( )
inlinevirtual

◆ CBasicParticle() [4/5]

CBasicParticle::CBasicParticle ( )

◆ CBasicParticle() [5/5]

CBasicParticle::CBasicParticle ( int  id,
const Vec3 pos,
double  rad 
)

References m_id, m_pos, and m_rad.

Member Function Documentation

◆ getID() [1/2]

◆ getID() [2/2]

int CBasicParticle::getID ( ) const
inline

References m_id.

◆ getPos() [1/2]

Vec3 CBasicParticle::getPos ( ) const
inline

References m_pos.

Referenced by BCorner2DInteraction::BCorner2DInteraction(), BEdge2DInteraction::BEdge2DInteraction(), CRotThermBondedInteraction::broken(), BTriangleInteraction::BTriangleInteraction(), CAdhesiveFriction::calcForces(), BCorner2DInteraction::calcForces(), BEdge2DInteraction::calcForces(), CBondedInteraction::calcForces(), BTriangleInteraction::calcForces(), CCappedBondedInteraction::calcForces(), ECorner2DInteraction::calcForces(), ECornerInteraction::calcForces(), EEdge2DInteraction::calcForces(), EEdgeInteraction::calcForces(), CElasticInteraction::calcForces(), ETriangleInteraction::calcForces(), CFrictionInteraction::calcForces(), CHertzianElasticInteraction::calcForces(), CHertzianViscoElasticFrictionInteraction::calcForces(), CHertzianViscoElasticInteraction::calcForces(), CHertzMindlinInteraction::calcForces(), CHertzMindlinViscoInteraction::calcForces(), CLinearDashpotInteraction::calcForces(), CRotBondedInteraction::calcForces(), CRotElasticInteraction::calcForces(), CRotThermBondedInteraction::calcForces(), CRotThermElasticInteraction::calcForces(), CRotThermFrictionInteraction::calcForces(), CVWFriction::calcForces(), CRotThermBondedInteraction::calcHeatTrans(), CRotThermElasticInteraction::calcHeatTrans(), CRotThermFrictionInteraction::calcHeatTrans(), CRotFrictionInteraction::calcNormalForce(), CRotThermFrictionInteraction::calcNormalForce(), CRotFrictionInteraction::calcRigidBodyForces(), CRotFrictionInteraction::calcSimpleForces(), CBondedInteraction::CBondedInteraction(), CCappedBondedInteraction::CCappedBondedInteraction(), CFractalFriction::CFractalFriction(), CFrictionInteraction::CFrictionInteraction(), CHertzianViscoElasticFrictionInteraction::CHertzianViscoElasticFrictionInteraction(), CHertzMindlinInteraction::CHertzMindlinInteraction(), CHertzMindlinViscoInteraction::CHertzMindlinViscoInteraction(), CRotBondedInteraction::CRotBondedInteraction(), CRotElasticInteraction::CRotElasticInteraction(), CRotFrictionInteraction::CRotFrictionInteraction(), CRotThermBondedInteraction::CRotThermBondedInteraction(), CRotThermElasticInteraction::CRotThermElasticInteraction(), CRotThermFrictionInteraction::CRotThermFrictionInteraction(), CShortBondedInteraction::CShortBondedInteraction(), CFrictionInteraction::getAbsFrictionalForce(), CHertzianViscoElasticFrictionInteraction::getAbsFrictionalForce(), CHertzMindlinInteraction::getAbsFrictionalForce(), CHertzMindlinViscoInteraction::getAbsFrictionalForce(), CFrictionInteraction::getAbsFrictionalStress(), CHertzianViscoElasticFrictionInteraction::getAbsFrictionalStress(), CHertzMindlinInteraction::getAbsFrictionalStress(), CHertzMindlinViscoInteraction::getAbsFrictionalStress(), CFrictionInteraction::getAbsMuFN(), CHertzianViscoElasticFrictionInteraction::getAbsMuFN(), CHertzMindlinInteraction::getAbsMuFN(), CHertzMindlinViscoInteraction::getAbsMuFN(), CRotFrictionInteraction::getAbsSlip(), CRotThermBondedInteraction::getBondedVector1(), CRotThermBondedInteraction::getBondedVector2(), CRotBondedInteraction::getCentrePtDiff(), CRotThermBondedInteraction::getCentrePtDiff(), CRotBondedInteraction::getContactPoint(), CVWFriction::getCurrentMu(), CFrictionInteraction::getMaxFricStress(), CHertzianViscoElasticFrictionInteraction::getMaxFricStress(), CHertzMindlinInteraction::getMaxFricStress(), CHertzMindlinViscoInteraction::getMaxFricStress(), CFrictionInteraction::getMuEff(), CHertzianViscoElasticFrictionInteraction::getMuEff(), CHertzMindlinInteraction::getMuEff(), CHertzMindlinViscoInteraction::getMuEff(), CRotBondedInteraction::getNormalForce(), CRotBondedInteraction::getP1ShearForcePt(), CRotBondedInteraction::getP2ShearForcePt(), BCorner2DInteraction::getPos(), BEdge2DInteraction::getPos(), BTriangleInteraction::getPos(), APairInteraction::getPosFirst(), ARotPairInteraction::getPosFirst(), ARotThermPairInteraction::getPosFirst(), esys::lsm::ParticlePy::getPosn(), esys::lsm::RotParticlePy::getPosn(), esys::lsm::RotParticleViPy::getPosn(), esys::lsm::RotThermalParticlePy::getPosn(), APairInteraction::getPosSecond(), ARotPairInteraction::getPosSecond(), ARotThermPairInteraction::getPosSecond(), APairInteraction::getRaw2Data(), ARotPairInteraction::getRaw2Data(), ARotThermPairInteraction::getRaw2Data(), CRotBondedInteraction::getShearDiff(), CRotThermBondedInteraction::getShearDiff(), CFrictionInteraction::getSlipVelocity(), CHertzianViscoElasticFrictionInteraction::getSlipVelocity(), CHertzMindlinInteraction::getSlipVelocity(), CHertzMindlinViscoInteraction::getSlipVelocity(), CParticle::getVectorFieldFunction(), CRotParticle::getVectorFieldFunction(), CRotParticleVi::getVectorFieldFunction(), CRotThermParticle::getVectorFieldFunction(), CFrictionInteraction::isPersistent(), CHertzianViscoElasticFrictionInteraction::isPersistent(), CHertzMindlinInteraction::isPersistent(), CHertzMindlinViscoInteraction::isPersistent(), CRotFrictionInteraction::isPersistent(), CRotThermFrictionInteraction::isPersistent(), main(), operator<<(), TML_PackedMessageInterface::pack(), CParticle::saveCheckPointData(), and CParticle::saveSnapShotData().

◆ getPos() [2/2]

Vec3 CBasicParticle::getPos ( ) const
inline

References m_pos.

◆ getPPos() [1/2]

Vec3& CBasicParticle::getPPos ( )
inline

References m_pos.

◆ getPPos() [2/2]

Vec3& CBasicParticle::getPPos ( )
inline

References m_pos.

◆ getRad() [1/2]

double CBasicParticle::getRad ( ) const
inline

References m_rad.

Referenced by BCorner2DInteraction::BCorner2DInteraction(), BEdge2DInteraction::BEdge2DInteraction(), BTriangleInteraction::BTriangleInteraction(), CAdhesiveFriction::CAdhesiveFriction(), CAdhesiveFriction::calcForces(), CBondedInteraction::calcForces(), CCappedBondedInteraction::calcForces(), ECorner2DInteraction::calcForces(), ECornerInteraction::calcForces(), EEdge2DInteraction::calcForces(), EEdgeInteraction::calcForces(), CElasticInteraction::calcForces(), ETriangleInteraction::calcForces(), CFrictionInteraction::calcForces(), CHertzianElasticInteraction::calcForces(), CHertzianViscoElasticFrictionInteraction::calcForces(), CHertzianViscoElasticInteraction::calcForces(), CHertzMindlinInteraction::calcForces(), CHertzMindlinViscoInteraction::calcForces(), CLinearDashpotInteraction::calcForces(), CRotBondedInteraction::calcForces(), CRotElasticInteraction::calcForces(), CRotThermBondedInteraction::calcForces(), CRotThermElasticInteraction::calcForces(), CRotThermFrictionInteraction::calcForces(), CVWFriction::calcForces(), CRotThermFrictionInteraction::calcHeatFrict(), CRotFrictionInteraction::calcNormalForce(), CRotThermFrictionInteraction::calcNormalForce(), CRotFrictionInteraction::calcRigidBodyForces(), CRotFrictionInteraction::calcSimpleForces(), CBondedInteraction::CBondedInteraction(), CCappedBondedInteraction::CCappedBondedInteraction(), CElasticInteraction::CElasticInteraction(), CFractalFriction::CFractalFriction(), CFrictionInteraction::CFrictionInteraction(), CHertzianViscoElasticFrictionInteraction::CHertzianViscoElasticFrictionInteraction(), CHertzMindlinInteraction::CHertzMindlinInteraction(), CHertzMindlinViscoInteraction::CHertzMindlinViscoInteraction(), CLinearDashpotInteraction::CLinearDashpotInteraction(), CRotBondedInteraction::CRotBondedInteraction(), CRotElasticInteraction::CRotElasticInteraction(), CRotFrictionInteraction::CRotFrictionInteraction(), CRotParticle::CRotParticle(), CRotParticleVi::CRotParticleVi(), CRotThermBondedInteraction::CRotThermBondedInteraction(), CRotThermElasticInteraction::CRotThermElasticInteraction(), CRotThermFrictionInteraction::CRotThermFrictionInteraction(), ECornerInteraction::ECornerInteraction(), EEdgeInteraction::EEdgeInteraction(), ETriangleInteraction::ETriangleInteraction(), esys::lsm::exportParticle(), esys::lsm::exportRotParticle(), esys::lsm::exportRotParticleVi(), esys::lsm::exportRotThermalParticle(), CFrictionInteraction::getAbsFrictionalForce(), CHertzianViscoElasticFrictionInteraction::getAbsFrictionalForce(), CHertzMindlinInteraction::getAbsFrictionalForce(), CHertzMindlinViscoInteraction::getAbsFrictionalForce(), CFrictionInteraction::getAbsFrictionalStress(), CHertzianViscoElasticFrictionInteraction::getAbsFrictionalStress(), CHertzMindlinInteraction::getAbsFrictionalStress(), CHertzMindlinViscoInteraction::getAbsFrictionalStress(), CFrictionInteraction::getAbsMuFN(), CHertzianViscoElasticFrictionInteraction::getAbsMuFN(), CHertzMindlinInteraction::getAbsMuFN(), CHertzMindlinViscoInteraction::getAbsMuFN(), CRotParticleVi::getAngVector(), CRotThermBondedInteraction::getBondedVector1(), CRotThermBondedInteraction::getBondedVector2(), CRotBondedInteraction::getContactPoint(), CVWFriction::getCurrentMu(), CRotBondedInteraction::getInitialMidPoint(), CRotThermBondedInteraction::getInitialMidPoint(), CFrictionInteraction::getMaxFricStress(), CHertzianViscoElasticFrictionInteraction::getMaxFricStress(), CHertzMindlinInteraction::getMaxFricStress(), CHertzMindlinViscoInteraction::getMaxFricStress(), CFrictionInteraction::getMuEff(), CHertzianViscoElasticFrictionInteraction::getMuEff(), CHertzMindlinInteraction::getMuEff(), CHertzMindlinViscoInteraction::getMuEff(), CFrictionInteraction::getNormalStress(), CHertzianViscoElasticFrictionInteraction::getNormalStress(), CHertzMindlinInteraction::getNormalStress(), CHertzMindlinViscoInteraction::getNormalStress(), APairInteraction::getRaw2Data(), ARotPairInteraction::getRaw2Data(), ARotThermPairInteraction::getRaw2Data(), CParticle::getScalarFieldFunction(), CRotParticle::getScalarFieldFunction(), CRotParticleVi::getScalarFieldFunction(), CRotThermParticle::getScalarFieldFunction(), CFrictionInteraction::getSlipVelocity(), CHertzianViscoElasticFrictionInteraction::getSlipVelocity(), CHertzMindlinInteraction::getSlipVelocity(), CHertzMindlinViscoInteraction::getSlipVelocity(), esys::lsm::RotParticleViPy::PickleSuite::getstate(), esys::lsm::RotThermalParticlePy::PickleSuite::getstate(), CFrictionInteraction::isPersistent(), CHertzianViscoElasticFrictionInteraction::isPersistent(), CHertzMindlinInteraction::isPersistent(), CHertzMindlinViscoInteraction::isPersistent(), CRotFrictionInteraction::isPersistent(), CRotThermFrictionInteraction::isPersistent(), operator<<(), TML_PackedMessageInterface::pack(), CParticle::saveCheckPointData(), CParticle::saveSnapShotData(), and CBondedInteraction::setBreak().

◆ getRad() [2/2]

double CBasicParticle::getRad ( ) const
inline

References m_rad.

◆ getTag()

◆ isValid()

bool CBasicParticle::isValid ( ) const
inline

References getID().

Here is the call graph for this function:

◆ moveBy() [1/2]

void CBasicParticle::moveBy ( Vec3  v)
inline

move relative to current position

References m_pos.

◆ moveBy() [2/2]

void CBasicParticle::moveBy ( Vec3  v)
inline

References m_pos.

◆ moveTo() [1/2]

void CBasicParticle::moveTo ( Vec3  v)
inline

move absolute

References m_pos.

◆ moveTo() [2/2]

void CBasicParticle::moveTo ( Vec3  v)
inline

move relative to current position

References m_pos.

◆ setID()

void CBasicParticle::setID ( int  id)
inline

References m_global_id.

Referenced by esys::lsm::RotParticleViPy::PickleSuite::setstate(), and esys::lsm::RotThermalParticlePy::PickleSuite::setstate().

Here is the caller graph for this function:

◆ setPos()

void CBasicParticle::setPos ( const Vec3 pos)
inline

◆ setRad() [1/2]

void CBasicParticle::setRad ( double  r)
inline

References m_rad.

Referenced by main(), esys::lsm::RotParticleViPy::PickleSuite::setstate(), and esys::lsm::RotThermalParticlePy::PickleSuite::setstate().

Here is the caller graph for this function:

◆ setRad() [2/2]

void CBasicParticle::setRad ( double  r)
inline

move absolute

References m_rad.

◆ setTag()

Member Data Documentation

◆ INVALID

const CBasicParticle CBasicParticle::INVALID = CBasicParticle(Vec3::ZERO, 0.0, -1, -1)
static

◆ m_global_id

◆ m_id

int CBasicParticle::m_id
protected

Referenced by CBasicParticle(), and getID().

◆ m_pos

◆ m_rad

◆ m_tag

int CBasicParticle::m_tag
protected

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