ESyS-Particle  2.3.4
CRotThermParticle Class Reference

#include <RotThermParticle.h>

Inheritance diagram for CRotThermParticle:
Collaboration diagram for CRotThermParticle:

Classes

class  exchangeType
 

Public Types

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

Public Member Functions

 CRotThermParticle ()
 
 CRotThermParticle (const esys::lsm::SimpleParticleData &data)
 
 CRotThermParticle (const CRotParticleVi &p)
 
 CRotThermParticle (const CParticle &p)
 
 CRotThermParticle (double rad, double mass, const Vec3 &pos, const Vec3 &vel, const Vec3 &force, int id, bool is_dyn)
 
 CRotThermParticle (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, double temperature, double temperature_ini, double Cp, double heat_frict, double heat_trans, double therm_expansion0, double therm_expansion1, double therm_expansion2)
 
 CRotThermParticle (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, double temperature, double temperature_ini, double Cp, double heat_frict, double heat_trans, double therm_expansion0, double therm_expansion1, double therm_expansion2)
 
 ~CRotThermParticle ()
 
void applyHeatTrans (const double)
 
void applyHeatFrict (const double)
 
void integrateTherm (double)
 
void zeroHeat ()
 
void thermExpansion ()
 
void integrate (double)
 
void setTemperature (double t)
 
double get_y ()
 
void setCp (double t)
 
void setThermExpansion0 (double t)
 
void setThermExpansion1 (double t)
 
void setThermExpansion2 (double t)
 
void setCircular (const Vec3 &cv)
 
Vec3 getDisplacement () const
 
void resetDisplacement ()
 
void print ()
 
CRotThermParticle::exchangeType getExchangeValues ()
 
void setExchangeValues (const CRotThermParticle::exchangeType &e)
 
template<typename TmplVisitor >
void visit (TmplVisitor &visitor)
 
- Public Member Functions inherited from CRotParticleVi
 CRotParticleVi ()
 
 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)
 
virtual ~CRotParticleVi ()
 
Vec3 getDisplacement () const
 
void resetDisplacement ()
 
const Vec3getAngVel () 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 zeroForce ()
 
void rescale ()
 
void setCircular (const Vec3 &cv)
 
double getAngularKineticEnergy () const
 
double getLinearKineticEnergy () const
 
double getKineticEnergy () const
 
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 ()
 
 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 Vec3getInitPos () const
 
void setInitPos (const Vec3 &initPos)
 
Vec3 getDisplacement () const
 
Vec3 getTotalDisplacement () const
 
const Vec3getOldPos () 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 &)
 
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
 
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 ()
 
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...
 
- Public Member Functions inherited from esys::lsm::CheckPointable
 CheckPointable ()
 
virtual ~CheckPointable ()
 
- Public Member Functions inherited from CThermParticle
 CThermParticle ()
 
 CThermParticle (double rad_ini)
 
 CThermParticle (double temperature, double m_temperature_ini, double Cp, double heat_frict, double heat_trans, double therm_expansion0, double therm_expansion1, double therm_expansion2, double rad_ini)
 
virtual ~CThermParticle ()
 
void setTemperature (double t)
 
double getTemperature () const
 
void setEquilibTemperature (double t)
 
double getEquilibTemperature () const
 
void setEquilibRadius (double r)
 
double getEquilibRadius () const
 
double getCp () const
 
void setCp (double cp)
 
double getThermExpansion0 () const
 
void setThermExpansion0 (double te0)
 
double getThermExpansion1 () const
 
void setThermExpansion1 (double te1)
 
double getThermExpansion2 () const
 
void setThermExpansion2 (double te2)
 

Static Public Member Functions

static ScalarFieldFunction getScalarFieldFunction (const string &)
 
static VectorFieldFunction getVectorFieldFunction (const string &)
 
static map< string, AField * > generateFields (ParallelParticleArray< CRotThermParticle > *)
 
static void get_type ()
 
- Static Public Member Functions inherited from CRotParticleVi
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 ScalarFieldFunction getScalarFieldFunction (const string &)
 
static VectorFieldFunction getVectorFieldFunction (const string &)
 
static void get_type ()
 
static void setDo2dCalculations (bool do2dCalculations)
 
static bool getDo2dCalculations ()
 

Friends

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

Additional Inherited Members

- Static Public Attributes inherited from CBasicParticle
static const CBasicParticle INVALID = CBasicParticle(Vec3::ZERO, 0.0, -1, -1)
 
- Protected Member Functions inherited from CParticle
void setForce (const Vec3 &force)
 
- Protected Attributes inherited from CRotParticleVi
Quaternion m_quat
 
Quaternion m_initquat
 
Vec3 m_angVel
 
Vec3 m_angVel_t
 
Vec3 m_moment
 Angular velocity at time t. More...
 
double m_inertRot
 
double m_div_inertRot
 
bool m_is_dynamic
 
- Protected Attributes inherited from CParticle
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
 
- Protected Attributes inherited from CThermParticle
double m_temperature
 
double m_temperature_ini
 
double m_Cp
 
double m_heat_frict
 
double m_heat_trans
 
double m_therm_expansion0
 
double m_therm_expansion1
 
double m_therm_expansion2
 
double m_rad_ini
 

Detailed Description

Thermal Particle class.

Member Typedef Documentation

◆ ScalarFieldFunction

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

◆ VectorFieldFunction

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

Constructor & Destructor Documentation

◆ CRotThermParticle() [1/7]

CRotThermParticle::CRotThermParticle ( )

◆ CRotThermParticle() [2/7]

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

◆ CRotThermParticle() [3/7]

CRotThermParticle::CRotThermParticle ( const CRotParticleVi p)

◆ CRotThermParticle() [4/7]

CRotThermParticle::CRotThermParticle ( const CParticle p)

◆ CRotThermParticle() [5/7]

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

◆ CRotThermParticle() [6/7]

CRotThermParticle::CRotThermParticle ( 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,
double  temperature,
double  temperature_ini,
double  Cp,
double  heat_frict,
double  heat_trans,
double  therm_expansion0,
double  therm_expansion1,
double  therm_expansion2 
)

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

Parameters
radradius
massmass
poscurrent position
velcurrent velocity
forcecurrently applied force
idparticle id
quatparticel quaternion
inertRotinert of rotation
momentcurrently applied tarque
angvelcurrent angular velocity

◆ CRotThermParticle() [7/7]

CRotThermParticle::CRotThermParticle ( 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,
double  temperature,
double  temperature_ini,
double  Cp,
double  heat_frict,
double  heat_trans,
double  therm_expansion0,
double  therm_expansion1,
double  therm_expansion2 
)

◆ ~CRotThermParticle()

CRotThermParticle::~CRotThermParticle ( )
inline

Member Function Documentation

◆ applyHeatFrict()

void CRotThermParticle::applyHeatFrict ( const double  heat_frict)

References CThermParticle::m_heat_frict.

Referenced by CRotThermFrictionInteraction::calcHeatFrict().

Here is the caller graph for this function:

◆ applyHeatTrans()

void CRotThermParticle::applyHeatTrans ( const double  heat_trans)

◆ generateFields()

map< string, AField * > CRotThermParticle::generateFields ( ParallelParticleArray< CRotThermParticle > *  particles)
static

◆ get_type()

static void CRotThermParticle::get_type ( )
inlinestatic

◆ get_y()

double CRotThermParticle::get_y ( )
inlinevirtual

Reimplemented from CRotParticleVi.

References CBasicParticle::m_pos, and Vec3::Y().

Here is the call graph for this function:

◆ getDisplacement()

Vec3 CRotThermParticle::getDisplacement ( ) const
inline

References CParticle::getDisplacement().

Here is the call graph for this function:

◆ getExchangeValues()

◆ getScalarFieldFunction()

◆ getVectorFieldFunction()

CRotThermParticle::VectorFieldFunction CRotThermParticle::getVectorFieldFunction ( const string &  name)
static

◆ integrate()

void CRotThermParticle::integrate ( double  dt)
virtual

Do the time integration for the particle.

Parameters
dtthe time step

Reimplemented from CRotParticleVi.

References CRotParticleVi::integrate().

Here is the call graph for this function:

◆ integrateTherm()

void CRotThermParticle::integrateTherm ( double  dt)
virtual

◆ print()

void CRotThermParticle::print ( )
inline

◆ resetDisplacement()

void CRotThermParticle::resetDisplacement ( )
inline

References CParticle::resetDisplacement().

Here is the call graph for this function:

◆ setCircular()

void CRotThermParticle::setCircular ( const Vec3 cv)

set circular shift vector

Parameters
cvthe circular shift vector

References CRotParticleVi::setCircular().

Here is the call graph for this function:

◆ setCp()

void CRotThermParticle::setCp ( double  t)
inlinevirtual

Reimplemented from CRotParticleVi.

References CThermParticle::m_Cp.

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

Here is the caller graph for this function:

◆ setExchangeValues()

◆ setTemperature()

void CRotThermParticle::setTemperature ( double  t)
inlinevirtual

◆ setThermExpansion0()

void CRotThermParticle::setThermExpansion0 ( double  t)
inlinevirtual

Reimplemented from CRotParticleVi.

References CThermParticle::m_therm_expansion0.

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

Here is the caller graph for this function:

◆ setThermExpansion1()

void CRotThermParticle::setThermExpansion1 ( double  t)
inlinevirtual

Reimplemented from CRotParticleVi.

References CThermParticle::m_therm_expansion1.

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

Here is the caller graph for this function:

◆ setThermExpansion2()

void CRotThermParticle::setThermExpansion2 ( double  t)
inlinevirtual

Reimplemented from CRotParticleVi.

References CThermParticle::m_therm_expansion2.

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

Here is the caller graph for this function:

◆ thermExpansion()

◆ visit()

template<typename TmplVisitor >
void CRotThermParticle::visit ( TmplVisitor &  visitor)
inline

◆ zeroHeat()

void CRotThermParticle::zeroHeat ( )
virtual

Save check-point data.

Reimplemented from CRotParticleVi.

References CThermParticle::m_heat_frict, and CThermParticle::m_heat_trans.

Friends And Related Function Documentation

◆ operator<<

ostream& operator<< ( ostream &  ost,
const CRotThermParticle CP 
)
friend

◆ TML_PackedMessageInterface

friend class TML_PackedMessageInterface
friend

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