CRotParticleVi Class Reference

#include <RotParticleVi.h>

Inheritance diagram for CRotParticleVi:

Collaboration diagram for CRotParticleVi:

List of all members.

Classes
class	exchangeType

Public Types
typedef double(CRotParticleVi::*	ScalarFieldFunction )() const
typedef Vec3(CRotParticleVi::*	VectorFieldFunction )() const
Public Types inherited from CParticle

Public Member Functions
	CRotParticleVi (const esys::lsm::SimpleParticleData &particleData)
	CRotParticleVi (double rad, double mass, const Vec3 &pos, const Vec3 &vel, const Vec3 &force, int id, bool is_dyn)
	CRotParticleVi (double rad, double mass, const Vec3 &pos, const Vec3 &vel, const Vec3 &force, int id, Quaternion &quat, double inertRot, const Vec3 &moment, const Vec3 &angvel, const Vec3 &angvel_t)
	CRotParticleVi (double rad, double mass, const Vec3 &pos, const Vec3 &oldpos, const Vec3 &initpos, const Vec3 &vel, const Vec3 &force, int id, const Quaternion &quat, const Quaternion &initquat, double inertRot, const Vec3 &moment, const Vec3 &angvel, const Vec3 &angvel_t)
	CRotParticleVi (const CParticle &p)
Vec3	getDisplacement () const
void	resetDisplacement ()
const Vec3 &	getAngVel () const
const Vec3	getAngVel_t () const
void	setAngVel_t (const Vec3 &v)
Vec3	getAngVelNR () const
void	setAngVel (const Vec3 &V)
Quaternion	getInitQuat () const
Quaternion	getQuat () const
void	setQuat (const Quaternion &q)
double	getInertRot () const
void	setInertRot (double inertRot)
double	getInvInertRot () const
Vec3	getMoment () const
void	setMoment (const Vec3 &moment)
Vec3	getAngVector () const
void	applyMoment (const Vec3 &)
void	integrate (double)
void	zeroForce ()
virtual void	zeroHeat ()
virtual void	integrateTherm (double)
virtual void	setTemperature (double)
virtual void	setCp (double)
virtual void	setThermExpansion0 (double)
virtual void	setThermExpansion1 (double)
virtual void	setThermExpansion2 (double)
virtual void	thermExpansion ()
virtual double	get_y ()
void	rescale ()
void	setCircular (const Vec3 &cv)
double	getAngularKineticEnergy () const
double	getLinearKineticEnergy () const
double	getKineticEnergy () const
	move relative to initial position
void	writeAsDXLine (ostream &, int slid=0)
virtual void	setNonRot ()
Quaternion	getQuatFromRotVec (const Vec3 &vec) const
void	rotateBy (const Vec3 &vec)
void	rotateTo (const Vec3 &vec)
void	print ()
virtual void	saveSnapShotData (std::ostream &oStream)
virtual void	saveCheckPointData (std::ostream &oStream)
virtual void	loadCheckPointData (std::istream &iStream)
CRotParticleVi::exchangeType	getExchangeValues ()
void	setExchangeValues (const CRotParticleVi::exchangeType &e)
double	sigma_xx_2D () const
double	sigma_xy_2D () const
double	sigma_yy_2D () const
template<typename TmplVisitor >
void	visit (TmplVisitor &visitor)
Public Member Functions inherited from 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)
const Vec3 &	getInitPos () const
void	setInitPos (const Vec3 &initPos)
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)
double	getIDField () const
double	getTagField () const
void	applyForce (const Vec3 &, const Vec3 &)
void	moveToRel (const Vec3 &v)
virtual void	setNonDynamic ()
virtual void	setNonDynamicLinear ()
virtual void	setNonDynamicRot ()
void	setFlag (bool b=true)
bool	isFlagged () const
void	setExchangeValues (const exchangeType &)
double	sigma_d () const
Public Member Functions inherited from CBasicParticle
	CBasicParticle (const Vec3 &pos, double radius, int id=-1, int tag=-1)
	CBasicParticle (const esys::lsm::SimpleParticleData &data)
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
void	moveTo (Vec3 v)
	move absolute
void	setRad (double r)
void	setTag (int t)
	particle tag handling
int	getTag () const
bool	isValid () const

Static Public Member Functions
static int	getPackSize ()
static ScalarFieldFunction	getScalarFieldFunction (const string &)
static VectorFieldFunction	getVectorFieldFunction (const string &)
static map< string, AField * >	generateFields (ParallelParticleArray< CRotParticleVi > *)
static void	get_type ()
Static Public Member Functions inherited from CParticle
static void	setDo2dCalculations (bool do2dCalculations)
static bool	getDo2dCalculations ()

Protected Attributes
Quaternion	m_quat
Quaternion	m_initquat
Vec3	m_angVel
Vec3	m_angVel_t
Vec3	m_moment
	Angular velocity at time t.
double	m_inertRot
double	m_div_inertRot
bool	m_is_dynamic
Protected Attributes inherited from CParticle
Matrix3	m_sigma
	stress tensor.
Vec3	m_vel
Vec3	m_force
Vec3	m_oldpos
	position at the time of last neighbor search
Vec3	m_initpos
	position at time of construction
Vec3	m_circular_shift
	shift vector if particle is circular image
double	m_mass
double	m_div_mass
bool	flag
Protected Attributes inherited from CBasicParticle
Vec3	m_pos
	position
double	m_rad
	radius
int	m_global_id
int	m_tag

Friends
class	TML_PackedMessageInterface
ostream &	operator<< (ostream &, const CRotParticleVi &)

Additional Inherited Members
Protected Member Functions inherited from CParticle
void	setForce (const Vec3 &force)

---

Detailed Description

Class for a rotational particle, Verlet integration

---

Constructor & Destructor Documentation

CRotParticleVi::CRotParticleVi	(	double	rad,
		double	mass,
		const Vec3 &	pos,
		const Vec3 &	vel,
		const Vec3 &	force,
		int	id,
		Quaternion &	quat,
		double	inertRot,
		const Vec3 &	moment,
		const Vec3 &	angvel,
		const Vec3 &	angvel_t
	)

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
quat	particel quaternion
inertRot	inert of rotation
moment	currently applied tarque
angvel	current angular velocity

References CParticle::m_circular_shift, and m_moment.

---

Member Function Documentation

void CRotParticleVi::applyMoment ( const Vec3 &  moment )

virtual

Apply a moment to a particle at a given position.

Parameters:

moment

tarque

Reimplemented from CParticle.

References m_moment.

Referenced by CRotThermFrictionInteraction::calcForces().

Here is the caller graph for this function:

CRotParticleVi::exchangeType CRotParticleVi::getExchangeValues

(

)

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

Reimplemented from CParticle.

Reimplemented in CRotThermParticle.

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

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

Reimplemented from CParticle.

Reimplemented in CRotThermParticle.

References getKineticEnergy(), and CParticle::sigma_d().

Here is the call graph for this function:

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

Reimplemented from CParticle.

Reimplemented in CRotThermParticle.

void CRotParticleVi::integrate ( double  dt )

virtual

Do the time integration for the particle.

Parameters:

dt	the time step

Reimplemented from CParticle.

Reimplemented in CRotThermParticle.

References m_moment, and CBasicParticle::m_pos.

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

virtual

load checkpoint data saved with CParticle::saveCheckPointData

Reimplemented from CParticle.

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

virtual

Save check-point data.

Reimplemented from CParticle.

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

virtual

Save snapshot data - not neccesarily sufficient for restart

Reimplemented from CParticle.

void CRotParticleVi::setCircular

(

const Vec3 &

cv

)

set circular shift vector

Parameters:

cv	the circular shift vector

Reimplemented from CParticle.

Reimplemented in CRotThermParticle.

void CRotParticleVi::setExchangeValues

(

const CRotParticleVi::exchangeType &

e

)

Set pos, vel and angular vel from exchangeType

Parameters:

E	the exchanged values

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

void CRotParticleVi::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

Reimplemented from CParticle.

void CRotParticleVi::zeroForce ( )

virtual

zero forces on particle

Reimplemented from CParticle.

References m_moment, and CParticle::m_sigma.

---

Friends And Related Function Documentation

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

friend

get deviatoric stress

---

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

• RotParticleVi.h
• RotParticleVi.cpp