Class for a basic particle. More...

#include <Particle.h>

Inheritance diagram for CParticle:

[legend]

Collaboration diagram for CParticle:

[legend]

Classes
class	exchangeType

Public Types
typedef double(CParticle::*	ScalarFieldFunction) () const

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

Public Member Functions
	CParticle ()

	CParticle (double, double, const Vec3 &, const Vec3 &, const Vec3 &, int, bool)

	CParticle (double, double, const Vec3 &, const Vec3 &, const Vec3 &, const Vec3 &, const Vec3 &, int, bool)

	CParticle (const esys::lsm::SimpleParticleData &particleData)

virtual	~CParticle ()

const Vec3 &	getInitPos () const

void	setInitPos (const Vec3 &initPos)

Vec3	getDisplacement () const

Vec3	getTotalDisplacement () const

const Vec3 &	getOldPos () const

Vec3	getVel () const

double	getAbsVel () const

void	setVel (const Vec3 &V)

void	setMass (double mass)

double	getMass () const

double	getInvMass () const

Vec3	getForce () const

virtual void	setDensity (double)

void	resetDisplacement ()

double	getIDField () const

double	getTagField () const

void	applyForce (const Vec3 &, const Vec3 &)

virtual void	integrate (double)

virtual void	integrateTherm (double)

virtual void	zeroForce ()

virtual void	zeroHeat ()

virtual void	thermExpansion ()

void	moveToRel (const Vec3 &v)

double	getKineticEnergy () const
	move relative to initial position More...

virtual void	setNonDynamic ()

virtual void	setNonDynamicLinear ()

virtual void	setNonDynamicRot ()

void	setFlag (bool b=true)

bool	isFlagged () const

void	writeAsDXLine (ostream &, int slid=0)

void	print ()

void	rescale ()

exchangeType	getExchangeValues ()

void	setExchangeValues (const exchangeType &)

void	setCircular (const Vec3 &)

double	sigma_xx_2D () const

double	sigma_xy_2D () const

double	sigma_yy_2D () const

double	sigma_d () const

virtual void	saveCheckPointData (std::ostream &oStream)

virtual void	saveSnapShotData (std::ostream &oStream)

virtual void	applyMoment (const Vec3 &)

virtual void	loadCheckPointData (std::istream &iStream)

template<typename TmplVisitor >
void	visit (TmplVisitor &visitor)

Public Member Functions inherited from CBasicParticle
	CBasicParticle ()

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

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

virtual	~CBasicParticle ()

Vec3 &	getPPos ()

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)

Vec3 &	getPPos ()

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...

Public Member Functions inherited from esys::lsm::CheckPointable
	CheckPointable ()

virtual	~CheckPointable ()

Static Public Member Functions
static ScalarFieldFunction	getScalarFieldFunction (const string &)

static VectorFieldFunction	getVectorFieldFunction (const string &)

static void	get_type ()

static void	setDo2dCalculations (bool do2dCalculations)

static bool	getDo2dCalculations ()

Protected Member Functions
void	setForce (const Vec3 &force)

Protected Attributes
Matrix3	m_sigma
	stress tensor. More...

Vec3	m_vel

Vec3	m_force

Vec3	m_oldpos
	position at the time of last neighbor search More...

Vec3	m_initpos
	position at time of construction More...

Vec3	m_circular_shift
	shift vector if particle is circular image More...

double	m_mass

double	m_div_mass

bool	flag

bool	m_is_dynamic

Protected Attributes inherited from CBasicParticle
Vec3	m_pos
	position More...

double	m_rad
	radius More...

int	m_global_id

int	m_tag

int	m_id

Static Private Attributes
static bool	s_do2Calculations = false

Friends
class	TML_PackedMessageInterface

ostream &	operator<< (ostream &, const CParticle &)

Additional Inherited Members
Static Public Attributes inherited from CBasicParticle
static const CBasicParticle	INVALID = CBasicParticle(Vec3::ZERO, 0.0, -1, -1)

Detailed Description

Class for a basic particle.

Member Typedef Documentation

◆ ScalarFieldFunction

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

◆ VectorFieldFunction

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

Constructor & Destructor Documentation

◆ CParticle() [1/4]

CParticle::CParticle ( )

◆ CParticle() [2/4]

CParticle::CParticle	(	double	rad,
		double	mass,
		const Vec3 &	pos,
		const Vec3 &	vel,
		const Vec3 &	force,
		int	id,
		bool	is_dyn
	)

Construct particle. Old and initial position are assumed to be identical to current position.

Parameters

rad	radius
mass	mass
pos	current position
vel	current velocity
force	currently applied force
id	particle id

References flag, m_circular_shift, m_div_mass, m_force, CBasicParticle::m_global_id, m_initpos, m_is_dynamic, m_mass, m_oldpos, m_vel, and zeroVec3.

◆ CParticle() [3/4]

CParticle::CParticle	(	double	rad,
		double	mass,
		const Vec3 &	pos,
		const Vec3 &	oldpos,
		const Vec3 &	initpos,
		const Vec3 &	vel,
		const Vec3 &	force,
		int	id,
		bool	is_dyn
	)

References flag, m_circular_shift, m_div_mass, m_force, CBasicParticle::m_global_id, m_initpos, m_is_dynamic, m_mass, m_oldpos, m_vel, and zeroVec3.

◆ CParticle() [4/4]

CParticle::CParticle ( const esys::lsm::SimpleParticleData & particleData )

◆ ~CParticle()

virtual CParticle::~CParticle ( )

inlinevirtual

Member Function Documentation

◆ applyForce()

void CParticle::applyForce	(	const Vec3 &	force,
		const Vec3 &	pos
	)

Apply a force to a particle at a given position. Also updates particle stress tensor.

Parameters

force	the force
pos	the position at which the force acts on the particle

References m_force, CBasicParticle::m_pos, and m_sigma.

Here is the caller graph for this function:

◆ applyMoment()

virtual void CParticle::applyMoment ( const Vec3 & )

inlinevirtual

Reimplemented in CRotParticleVi, and CRotParticle.

◆ get_type()

static void CParticle::get_type ( )

inlinestatic

◆ getAbsVel()

double CParticle::getAbsVel ( ) const

inline

References m_vel, and Vec3::norm().

Referenced by getScalarFieldFunction(), and CRotParticle::getScalarFieldFunction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDisplacement()

Vec3 CParticle::getDisplacement ( ) const

inline

References m_oldpos, and CBasicParticle::m_pos.

Referenced by CRotParticle::getDisplacement(), CRotParticleVi::getDisplacement(), and CRotThermParticle::getDisplacement().

Here is the caller graph for this function:

◆ getDo2dCalculations()

static bool CParticle::getDo2dCalculations ( )

inlinestatic

References s_do2Calculations.

Referenced by CRotThermFrictionInteraction::calcHeatFrict(), CBondedInteraction::CBondedInteraction(), CBondedWallInteraction< T >::CBondedWallInteraction(), CElasticInteraction::CElasticInteraction(), CElasticSphereBodyInteraction< T >::CElasticSphereBodyInteraction(), CElasticWallInteraction< T >::CElasticWallInteraction(), CFrictionInteraction::CFrictionInteraction(), CLinearDashpotInteraction::CLinearDashpotInteraction(), CRotBondedInteraction::CRotBondedInteraction(), CRotElasticInteraction::CRotElasticInteraction(), CRotFrictionInteraction::CRotFrictionInteraction(), CRotParticle::CRotParticle(), CRotThermBondedInteraction::CRotThermBondedInteraction(), CRotThermElasticInteraction::CRotThermElasticInteraction(), CRotThermFrictionInteraction::CRotThermFrictionInteraction(), CSoftBondedWallInteraction< T >::CSoftBondedWallInteraction(), ECornerInteraction::ECornerInteraction(), EEdgeInteraction::EEdgeInteraction(), ETriangleInteraction::ETriangleInteraction(), integrate(), CRotParticle::integrate(), CRotParticleVi::integrate(), operator<<(), setDensity(), and CRotParticle::setDensity().

Here is the caller graph for this function:

◆ getExchangeValues()

CParticle::exchangeType CParticle::getExchangeValues ( )

get values to be exchanged, i.e. pos and vel

References m_circular_shift, m_initpos, m_is_dynamic, m_oldpos, CBasicParticle::m_pos, and m_vel.

◆ getForce()

Vec3 CParticle::getForce ( ) const

inline

References m_force.

Referenced by esys::lsm::RotParticlePy::getAcceleration(), esys::lsm::RotParticleViPy::getAcceleration(), esys::lsm::RotParticlePy::getLinearAcceleration(), esys::lsm::RotParticleViPy::getLinearAcceleration(), esys::lsm::RotThermalParticlePy::getLinearAcceleration(), getVectorFieldFunction(), CRotParticle::getVectorFieldFunction(), CRotParticleVi::getVectorFieldFunction(), CRotThermParticle::getVectorFieldFunction(), saveCheckPointData(), and saveSnapShotData().

Here is the caller graph for this function:

◆ getIDField()

double CParticle::getIDField ( ) const

inline

References CBasicParticle::m_global_id.

Referenced by getScalarFieldFunction(), CRotParticle::getScalarFieldFunction(), CRotParticleVi::getScalarFieldFunction(), and CRotThermParticle::getScalarFieldFunction().

Here is the caller graph for this function:

◆ getInitPos()

const Vec3& CParticle::getInitPos ( ) const

inline

References m_initpos.

Referenced by CRotThermBondedInteraction::calcForces(), CRotBondedInteraction::getInitialCentrePtDiff(), CRotThermBondedInteraction::getInitialCentrePtDiff(), CRotBondedInteraction::getInitialMidPoint(), esys::lsm::ParticlePy::getInitialPosn(), esys::lsm::RotParticlePy::getInitialPosn(), esys::lsm::RotParticleViPy::getInitialPosn(), esys::lsm::RotThermalParticlePy::getInitialPosn(), CRotBondedInteraction::getP1ShearForcePt(), CRotBondedInteraction::getP2ShearForcePt(), CRotThermBondedInteraction::getShearDiff(), saveCheckPointData(), and saveSnapShotData().

Here is the caller graph for this function:

◆ getInvMass()

double CParticle::getInvMass ( ) const

inline

References m_div_mass.

Referenced by esys::lsm::ParticlePy::getAcceleration(), esys::lsm::RotParticlePy::getAcceleration(), esys::lsm::RotParticleViPy::getAcceleration(), esys::lsm::RotParticlePy::getLinearAcceleration(), esys::lsm::RotParticleViPy::getLinearAcceleration(), and esys::lsm::RotThermalParticlePy::getLinearAcceleration().

Here is the caller graph for this function:

◆ getKineticEnergy()

double CParticle::getKineticEnergy ( ) const

inline

move relative to initial position

References m_mass, and m_vel.

Referenced by getScalarFieldFunction().

Here is the caller graph for this function:

◆ getMass()

double CParticle::getMass ( ) const

inline

References m_mass.

Referenced by CHertzMindlinViscoInteraction::calcForces(), CRotParticle::CRotParticle(), CRotParticleVi::CRotParticleVi(), esys::lsm::exportParticle(), esys::lsm::exportRotParticle(), esys::lsm::exportRotParticleVi(), esys::lsm::exportRotThermalParticle(), CHertzMindlinViscoInteraction::getAbsMuFN(), CHertzMindlinViscoInteraction::getMaxFricStress(), esys::lsm::RotParticleViPy::PickleSuite::getstate(), esys::lsm::RotThermalParticlePy::PickleSuite::getstate(), CRotThermParticle::integrateTherm(), saveCheckPointData(), saveSnapShotData(), esys::lsm::ParticlePy::setAcceleration(), esys::lsm::RotParticlePy::setLinearAcceleration(), esys::lsm::RotParticleViPy::setLinearAcceleration(), and esys::lsm::RotThermalParticlePy::setLinearAcceleration().

Here is the caller graph for this function:

◆ getOldPos()

const Vec3& CParticle::getOldPos ( ) const

inline

References m_oldpos.

Referenced by saveCheckPointData(), and saveSnapShotData().

Here is the caller graph for this function:

◆ getScalarFieldFunction()

CParticle::ScalarFieldFunction CParticle::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 getAbsVel(), getIDField(), getKineticEnergy(), CBasicParticle::getRad(), getTagField(), NULL, sigma_d(), sigma_xx_2D(), sigma_xy_2D(), and sigma_yy_2D().

Here is the call graph for this function:

◆ getTagField()

double CParticle::getTagField ( ) const

inline

References CBasicParticle::getTag().

Referenced by getScalarFieldFunction(), and CRotParticle::getScalarFieldFunction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTotalDisplacement()

Vec3 CParticle::getTotalDisplacement ( ) const

inline

References m_initpos, and CBasicParticle::m_pos.

Referenced by getVectorFieldFunction(), CRotParticle::getVectorFieldFunction(), CRotParticleVi::getVectorFieldFunction(), and CRotThermParticle::getVectorFieldFunction().

Here is the caller graph for this function:

◆ getVectorFieldFunction()

CParticle::VectorFieldFunction CParticle::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 getForce(), CBasicParticle::getPos(), getTotalDisplacement(), getVel(), and NULL.

Here is the call graph for this function:

◆ getVel()

Vec3 CParticle::getVel ( ) const

inline

References m_vel.

Referenced by CFrictionInteraction::calcForces(), CHertzianViscoElasticFrictionInteraction::calcForces(), CHertzianViscoElasticInteraction::calcForces(), CHertzMindlinInteraction::calcForces(), CHertzMindlinViscoInteraction::calcForces(), CLinearDashpotInteraction::calcForces(), CRotThermFrictionInteraction::calcForces(), CVWFriction::calcForces(), CRotFrictionInteraction::calcRigidBodyForces(), CRotFrictionInteraction::calcSimpleForces(), CHertzianViscoElasticFrictionInteraction::getAbsMuFN(), CHertzMindlinViscoInteraction::getAbsMuFN(), CRotFrictionInteraction::getAbsSlip(), CVWFriction::getCurrentMu(), esys::lsm::RotParticlePy::getLinearVelocity(), esys::lsm::RotParticleViPy::getLinearVelocity(), esys::lsm::RotThermalParticlePy::getLinearVelocity(), CHertzianViscoElasticFrictionInteraction::getMaxFricStress(), CHertzMindlinViscoInteraction::getMaxFricStress(), CFrictionInteraction::getMuEff(), CHertzianViscoElasticFrictionInteraction::getMuEff(), CHertzMindlinInteraction::getMuEff(), CHertzMindlinViscoInteraction::getMuEff(), CFrictionInteraction::getSlipVelocity(), CHertzianViscoElasticFrictionInteraction::getSlipVelocity(), CHertzMindlinInteraction::getSlipVelocity(), CHertzMindlinViscoInteraction::getSlipVelocity(), getVectorFieldFunction(), CRotParticle::getVectorFieldFunction(), CRotParticleVi::getVectorFieldFunction(), CRotThermParticle::getVectorFieldFunction(), esys::lsm::ParticlePy::getVelocity(), esys::lsm::RotParticlePy::getVelocity(), esys::lsm::RotParticleViPy::getVelocity(), saveCheckPointData(), and saveSnapShotData().

Here is the caller graph for this function:

◆ integrate()

void CParticle::integrate ( double dt )

virtual

Do the time integration for the particle by 1st order method.

Parameters

dt	the time step

Reimplemented in CRotThermParticle, CRotParticleVi, and CRotParticle.

References getDo2dCalculations(), m_div_mass, m_force, m_is_dynamic, CBasicParticle::m_pos, m_vel, Vec3::X(), and Vec3::Y().

Referenced by CRotParticle::integrate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ integrateTherm()

virtual void CParticle::integrateTherm ( double )

inlinevirtual

Reimplemented in CRotThermParticle, CRotParticleVi, and CRotParticle.

◆ isFlagged()

bool CParticle::isFlagged ( ) const

inline

References flag.

◆ loadCheckPointData()

void CParticle::loadCheckPointData ( std::istream & iStream )

virtual

load checkpoint data saved with CParticle::saveCheckPointData

Implements esys::lsm::CheckPointable.

Reimplemented in CRotParticleVi, and CRotParticle.

References CBasicParticle::setTag().

Referenced by CRotParticle::loadCheckPointData(), CRotParticleVi::loadCheckPointData(), and esys::lsm::CheckPointLoader::ParticleData::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ moveToRel()

void CParticle::moveToRel ( const Vec3 & v )

inline

References m_initpos, and CBasicParticle::m_pos.

◆ print()

void CParticle::print ( )

inline

◆ rescale()

void CParticle::rescale ( )

inline

◆ resetDisplacement()

void CParticle::resetDisplacement ( )

inline

References m_oldpos, and CBasicParticle::m_pos.

Referenced by CRotParticle::resetDisplacement(), CRotParticleVi::resetDisplacement(), and CRotThermParticle::resetDisplacement().

Here is the caller graph for this function:

◆ saveCheckPointData()

void CParticle::saveCheckPointData ( std::ostream & oStream )

virtual

save checkpoint data, sufficient for restart

Implements esys::lsm::CheckPointable.

Reimplemented in CRotParticleVi, and CRotParticle.

References getForce(), CBasicParticle::getID(), getInitPos(), getMass(), getOldPos(), CBasicParticle::getPos(), CBasicParticle::getRad(), CBasicParticle::getTag(), getVel(), m_circular_shift, and m_is_dynamic.

Referenced by CRotParticle::saveCheckPointData(), and CRotParticleVi::saveCheckPointData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveSnapShotData()

void CParticle::saveSnapShotData ( std::ostream & oStream )

virtual

save snapshot data not neccesarily sufficient for restart

Reimplemented from esys::lsm::CheckPointable.

Reimplemented in CRotParticleVi, and CRotParticle.

References getForce(), CBasicParticle::getID(), getInitPos(), getMass(), getOldPos(), CBasicParticle::getPos(), CBasicParticle::getRad(), CBasicParticle::getTag(), getVel(), and m_circular_shift.

Referenced by CRotParticle::saveSnapShotData(), and CRotParticleVi::saveSnapShotData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCircular()

void CParticle::setCircular ( const Vec3 & cv )

set circular shift vector

Parameters

cv	the circular shift vector

References m_circular_shift, m_initpos, m_oldpos, and CBasicParticle::m_pos.

Referenced by CRotParticle::setCircular(), and CRotParticleVi::setCircular().

Here is the caller graph for this function:

◆ setDensity()

void CParticle::setDensity ( double rho )

virtual

set the density of the particle

Reimplemented in CRotParticle.

References getDo2dCalculations(), m_div_mass, m_mass, and CBasicParticle::m_rad.

Here is the call graph for this function:

◆ setDo2dCalculations()

static void CParticle::setDo2dCalculations ( bool do2dCalculations )

inlinestatic

References s_do2Calculations.

◆ setExchangeValues()

void CParticle::setExchangeValues ( const exchangeType & E )

set pos and vel from exchangeType

Parameters

E	the exchanged values, i.e. a pair of pos and vel

References m_circular_shift, CParticle::exchangeType::m_initPos, m_initpos, CParticle::exchangeType::m_is_dynamic, m_is_dynamic, CParticle::exchangeType::m_oldPos, m_oldpos, CBasicParticle::m_pos, CParticle::exchangeType::m_pos, CParticle::exchangeType::m_vel, and m_vel.

◆ setFlag()

void CParticle::setFlag ( bool b = true )

inline

References flag.

Referenced by CBondedInteraction::broken(), CRotBondedInteraction::broken(), and CRotThermBondedInteraction::broken().

Here is the caller graph for this function:

◆ setForce()

void CParticle::setForce ( const Vec3 & force )

inlineprotected

References m_force.

Referenced by esys::lsm::RotParticlePy::setLinearAcceleration(), esys::lsm::RotParticleViPy::setLinearAcceleration(), esys::lsm::RotThermalParticlePy::setLinearAcceleration(), esys::lsm::RotParticlePy::setLinearForce(), esys::lsm::RotParticleViPy::setLinearForce(), and esys::lsm::RotThermalParticlePy::setLinearForce().

Here is the caller graph for this function:

◆ setInitPos()

void CParticle::setInitPos ( const Vec3 & initPos )

inline

References m_initpos.

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

Here is the caller graph for this function:

◆ setMass()

void CParticle::setMass ( double mass )

inline

References m_div_mass, and m_mass.

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

Here is the caller graph for this function:

◆ setNonDynamic()

virtual void CParticle::setNonDynamic ( )

inlinevirtual

Reimplemented in CRotParticle.

References m_is_dynamic.

◆ setNonDynamicLinear()

virtual void CParticle::setNonDynamicLinear ( )

inlinevirtual

Reimplemented in CRotParticle.

References m_is_dynamic.

◆ setNonDynamicRot()

virtual void CParticle::setNonDynamicRot ( )

inlinevirtual

Reimplemented in CRotParticle.

◆ setVel()

void CParticle::setVel ( const Vec3 & V )

inline

References m_vel.

Referenced by esys::lsm::RotParticlePy::setLinearVelocity(), esys::lsm::RotParticleViPy::setLinearVelocity(), esys::lsm::RotThermalParticlePy::setLinearVelocity(), and esys::lsm::ParticlePy::setVelocity().

Here is the caller graph for this function:

◆ sigma_d()

double CParticle::sigma_d ( ) const

get deviatoric stress

References m_sigma, Matrix3::trace(), and Matrix3::Unit().

Referenced by getScalarFieldFunction(), CRotParticle::getScalarFieldFunction(), CRotParticleVi::getScalarFieldFunction(), and CRotThermParticle::getScalarFieldFunction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sigma_xx_2D()

double CParticle::sigma_xx_2D ( ) const

inline

References CBasicParticle::m_rad, and m_sigma.

Referenced by getScalarFieldFunction().

Here is the caller graph for this function:

◆ sigma_xy_2D()

double CParticle::sigma_xy_2D ( ) const

inline

References CBasicParticle::m_rad, and m_sigma.

Referenced by getScalarFieldFunction().

Here is the caller graph for this function:

◆ sigma_yy_2D()

double CParticle::sigma_yy_2D ( ) const

inline

References CBasicParticle::m_rad, and m_sigma.

Referenced by getScalarFieldFunction().

Here is the caller graph for this function:

◆ thermExpansion()

virtual void CParticle::thermExpansion ( )

inlinevirtual

Reimplemented in CRotThermParticle, CRotParticleVi, and CRotParticle.

◆ visit()

template<typename TmplVisitor >

void CParticle::visit ( TmplVisitor & visitor )

inline

◆ writeAsDXLine()

void CParticle::writeAsDXLine	(	ostream &	ost,
		int	slid = `0`
	)

write particle data as a line in openDX format into a stream(file)

Parameters

ost	the output stream
slid	from which sublattice the particle is coming

References m_initpos, m_mass, CBasicParticle::m_pos, CBasicParticle::m_rad, m_vel, Vec3::X(), Vec3::Y(), and Vec3::Z().

Here is the call graph for this function:

◆ zeroForce()

void CParticle::zeroForce ( )

virtual

zero forces on particle

Reimplemented in CRotParticleVi, and CRotParticle.

References m_force, and m_sigma.

◆ zeroHeat()

virtual void CParticle::zeroHeat ( )

inlinevirtual

Reimplemented in CRotThermParticle, CRotParticleVi, and CRotParticle.

Friends And Related Function Documentation

◆ operator<<

ostream& operator<<	(	ostream &	ost,
		const CParticle &	CP
	)

friend

◆ TML_PackedMessageInterface

friend class TML_PackedMessageInterface

friend

Member Data Documentation

◆ flag

bool CParticle::flag

protected

Referenced by CParticle(), CRotParticle::CRotParticle(), CRotParticleVi::CRotParticleVi(), isFlagged(), and setFlag().

◆ m_circular_shift

Vec3 CParticle::m_circular_shift

protected

shift vector if particle is circular image

Referenced by CParticle(), CRotParticle::CRotParticle(), CRotParticleVi::CRotParticleVi(), getExchangeValues(), CRotParticle::getExchangeValues(), CRotParticleVi::getExchangeValues(), CRotThermParticle::getExchangeValues(), TML_PackedMessageInterface::pack(), saveCheckPointData(), saveSnapShotData(), setCircular(), CRotParticle::setExchangeValues(), CRotParticleVi::setExchangeValues(), CRotThermParticle::setExchangeValues(), setExchangeValues(), and TML_PackedMessageInterface::unpack().

◆ m_div_mass

double CParticle::m_div_mass

protected

Referenced by CParticle(), getInvMass(), integrate(), CRotParticleVi::integrate(), setDensity(), CRotParticle::setDensity(), setMass(), and TML_PackedMessageInterface::unpack().

◆ m_force

Vec3 CParticle::m_force

protected

Referenced by applyForce(), CParticle(), getForce(), esys::lsm::RotParticlePy::getLinearForce(), esys::lsm::RotParticleViPy::getLinearForce(), esys::lsm::RotThermalParticlePy::getLinearForce(), integrate(), CRotParticle::integrate(), CRotParticleVi::integrate(), operator<<(), TML_PackedMessageInterface::pack(), setForce(), TML_PackedMessageInterface::unpack(), zeroForce(), CRotParticle::zeroForce(), and CRotParticleVi::zeroForce().

◆ m_initpos

Vec3 CParticle::m_initpos

protected

position at time of construction

Referenced by CParticle(), getExchangeValues(), CRotParticle::getExchangeValues(), CRotParticleVi::getExchangeValues(), CRotThermParticle::getExchangeValues(), getInitPos(), getTotalDisplacement(), moveToRel(), TML_PackedMessageInterface::pack(), setCircular(), CRotParticle::setExchangeValues(), CRotParticleVi::setExchangeValues(), CRotThermParticle::setExchangeValues(), setExchangeValues(), setInitPos(), TML_PackedMessageInterface::unpack(), and writeAsDXLine().

◆ m_is_dynamic

bool CParticle::m_is_dynamic

protected

Referenced by CParticle(), getExchangeValues(), CRotParticle::getExchangeValues(), integrate(), TML_PackedMessageInterface::pack(), saveCheckPointData(), CRotParticle::setExchangeValues(), setExchangeValues(), setNonDynamic(), CRotParticle::setNonDynamic(), setNonDynamicLinear(), CRotParticle::setNonDynamicLinear(), and TML_PackedMessageInterface::unpack().

◆ m_mass

double CParticle::m_mass

protected

Referenced by CParticle(), CRotParticleVi::getAngularKineticEnergy(), getKineticEnergy(), CRotParticle::getLinearKineticEnergy(), CRotParticleVi::getLinearKineticEnergy(), getMass(), operator<<(), TML_PackedMessageInterface::pack(), setDensity(), CRotParticle::setDensity(), setMass(), TML_PackedMessageInterface::unpack(), and writeAsDXLine().

◆ m_oldpos

Vec3 CParticle::m_oldpos

protected

position at the time of last neighbor search

Referenced by CParticle(), getDisplacement(), getExchangeValues(), getOldPos(), TML_PackedMessageInterface::pack(), resetDisplacement(), setCircular(), setExchangeValues(), and TML_PackedMessageInterface::unpack().

◆ m_sigma

Matrix3 CParticle::m_sigma

protected

stress tensor.

Warning: Warning: this is unscaled, i.e. without the 1/V term

Referenced by applyForce(), sigma_d(), sigma_xx_2D(), CRotParticle::sigma_xx_2D(), CRotParticleVi::sigma_xx_2D(), sigma_xy_2D(), CRotParticle::sigma_xy_2D(), CRotParticleVi::sigma_xy_2D(), sigma_yy_2D(), CRotParticle::sigma_yy_2D(), CRotParticleVi::sigma_yy_2D(), zeroForce(), CRotParticle::zeroForce(), and CRotParticleVi::zeroForce().

◆ m_vel

◆ s_do2Calculations

bool CParticle::s_do2Calculations = false

staticprivate

Referenced by getDo2dCalculations(), and setDo2dCalculations().

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

Model/Particle.h
Model/Particle.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ScalarFieldFunction

◆ VectorFieldFunction

Constructor & Destructor Documentation

◆ CParticle() [1/4]

◆ CParticle() [2/4]

◆ CParticle() [3/4]

◆ CParticle() [4/4]

◆ ~CParticle()

Member Function Documentation

◆ applyForce()

◆ applyMoment()

◆ get_type()

◆ getAbsVel()

◆ getDisplacement()

◆ getDo2dCalculations()

◆ getExchangeValues()

◆ getForce()

◆ getIDField()

◆ getInitPos()

◆ getInvMass()

◆ getKineticEnergy()

◆ getMass()

◆ getOldPos()

◆ getScalarFieldFunction()

◆ getTagField()

◆ getTotalDisplacement()

◆ getVectorFieldFunction()

◆ getVel()

◆ integrate()

◆ integrateTherm()

◆ isFlagged()

◆ loadCheckPointData()

◆ moveToRel()

◆ print()

◆ rescale()

◆ resetDisplacement()

◆ saveCheckPointData()

◆ saveSnapShotData()

◆ setCircular()

◆ setDensity()

◆ setDo2dCalculations()

◆ setExchangeValues()

◆ setFlag()

◆ setForce()

◆ setInitPos()

◆ setMass()

◆ setNonDynamic()

◆ setNonDynamicLinear()

◆ setNonDynamicRot()

◆ setVel()

◆ sigma_d()

◆ sigma_xx_2D()

◆ sigma_xy_2D()

◆ sigma_yy_2D()

◆ thermExpansion()

◆ visit()

◆ writeAsDXLine()

◆ zeroForce()

◆ zeroHeat()

Friends And Related Function Documentation

◆ operator<<

◆ TML_PackedMessageInterface

Member Data Documentation

◆ flag

◆ m_circular_shift

◆ m_div_mass

◆ m_force

◆ m_initpos

◆ m_is_dynamic