An adapter class of StuntDouble which is used at constraint algorithm. More...

#include "constraints/ConstraintElem.hpp"

Public Member Functions
	ConstraintElem (StuntDouble *sd)

bool	getMoved ()

void	setMoved (bool moved)

bool	getMoving ()

void	setMoving (bool moving)

StuntDouble *	getStuntDouble ()

int	getGlobalIndex ()
	Returns the global index of this stuntRealType.

void	setGlobalIndex (int index)
	Sets the global index of this stuntRealType.

int	getLocalIndex ()
	Returns the local index of this stuntdouble.

void	setLocalIndex (int index)
	Sets the local index of this stuntdouble.

void	setSnapshotManager (SnapshotManager *sman)
	Sets the Snapshot Manager of this stuntdouble.

bool	isAtom ()
	Tests if this stuntdouble is an atom.

bool	isDirectionalAtom ()
	Tests if this stuntdouble is an directional atom.

bool	isRigidBody ()
	Tests if this stuntdouble is a rigid body.

bool	isDirectional ()
	Tests if this stuntdouble is a directional one.

Vector3d	getPrevPos ()
	Returns the previous position of this stuntdouble.

Vector3d	getPos ()
	Returns the current position of this stuntdouble.

Vector3d	getPos (int snapshotNo)
	Returns the position of this stuntdouble in specified snapshot.

void	setPrevPos (const Vector3d &pos)
	Sets the previous position of this stuntdouble.

void	setPos (const Vector3d &pos)
	Sets the current position of this stuntdouble.

void	setPos (const Vector3d &pos, int snapshotNo)
	Sets the position of this stuntdouble in specified snapshot.

Vector3d	getPrevVel ()
	Returns the previous velocity of this stuntdouble.

Vector3d	getVel ()
	Returns the current velocity of this stuntdouble.

Vector3d	getVel (int snapshotNo)
	Returns the velocity of this stuntdouble in specified snapshot.

void	setPrevVel (const Vector3d &vel)
	Sets the previous velocity of this stuntdouble.

void	setVel (const Vector3d &vel)
	Sets the current velocity of this stuntdouble.

void	setVel (const Vector3d &vel, int snapshotNo)
	Sets the velocity of this stuntdouble in specified snapshot.

RotMat3x3d	getPrevA ()
	Returns the previous rotation matrix of this stuntdouble.

RotMat3x3d	getA ()
	Returns the current rotation matrix of this stuntdouble.

RotMat3x3d	getA (int snapshotNo)
	Returns the rotation matrix of this stuntdouble in specified snapshot.

void	setPrevA (const RotMat3x3d &a)
	Sets the previous rotation matrix of this stuntdouble.

void	setA (const RotMat3x3d &a)
	Sets the current rotation matrix of this stuntdouble.

void	setA (const RotMat3x3d &a, int snapshotNo)
	Sets the rotation matrix of this stuntdouble in specified snapshot.

Vector3d	getPrevJ ()
	Returns the previous angular momentum of this stuntdouble (body-fixed).

Vector3d	getJ ()
	Returns the current angular momentum of this stuntdouble (body -fixed).

Vector3d	getJ (int snapshotNo)
	Returns the angular momentum of this stuntdouble in specified snapshot (body-fixed).

void	setPrevJ (const Vector3d &angMom)
	Sets the previous angular momentum of this stuntdouble (body-fixed).

void	setJ (const Vector3d &angMom)
	Sets the current angular momentum of this stuntdouble (body-fixed).

void	setJ (const Vector3d &angMom, int snapshotNo)
	Sets the angular momentum of this stuntdouble in specified snapshot(body-fixed).

Quat4d	getPrevQ ()
	Returns the previous quaternion of this stuntdouble.

Quat4d	getQ ()
	Returns the current quaternion of this stuntdouble.

Quat4d	getQ (int snapshotNo)
	Returns the quaternion of this stuntdouble in specified snapshot.

void	setPrevQ (const Quat4d &q)
	Sets the previous quaternion of this stuntdouble.

void	setQ (const Quat4d &q)
	Sets the current quaternion of this stuntdouble.

void	setQ (const Quat4d &q, int snapshotNo)
	Sets the quaternion of this stuntdouble in specified snapshot.

Vector3d	getPrevEuler ()
	Returns the previous euler angles of this stuntdouble.

Vector3d	getEuler ()
	Returns the current euler angles of this stuntdouble.

Vector3d	getEuler (int snapshotNo)
	Returns the euler angles of this stuntdouble in specified snapshot.

void	setPrevEuler (const Vector3d &euler)
	Sets the previous euler angles of this stuntRealType.

void	setEuler (const Vector3d &euler)
	Sets the current euler angles of this stuntdouble.

void	setEuler (const Vector3d &euler, int snapshotNo)
	Sets the euler angles of this stuntdouble in specified snapshot.

Vector3d	getPrevDipole ()
	Returns the previous dipole vector of this stuntDouble.

Vector3d	getDipole ()
	Returns the current dipole vector of this stuntDouble.

Vector3d	getDipole (int snapshotNo)
	Returns the dipole vector of this stuntDouble in specified snapshot.

Mat3x3d	getPrevQuadrupole ()
	Returns the previous quadrupole tensor of this stuntDouble.

Mat3x3d	getQuadrupole ()
	Returns the current quadrupole tensor of this stuntDouble.

Mat3x3d	getQuadrupole (int snapshotNo)
	Returns the quadrupole tensor of this stuntDouble in specified snapshot.

Vector3d	getPrevFrc ()
	Returns the previous force of this stuntdouble.

Vector3d	getFrc ()
	Returns the current force of this stuntdouble.

Vector3d	getFrc (int snapshotNo)
	Returns the force of this stuntdouble in specified snapshot.

void	setPrevFrc (const Vector3d &frc)
	Sets the previous force of this stuntdouble.

void	setFrc (const Vector3d &frc)
	Sets the current force of this stuntdouble.

void	setFrc (const Vector3d &frc, int snapshotNo)
	Sets the force of this stuntdouble in specified snapshot.

void	addPrevFrc (const Vector3d &frc)
	Adds force into the previous force of this stuntdouble.

void	addFrc (const Vector3d &frc)
	Adds force into the current force of this stuntdouble.

void	addFrc (const Vector3d &frc, int snapshotNo)
	Adds force into the force of this stuntdouble in specified snapshot.

Vector3d	getPrevTrq ()
	Returns the previous torque of this stuntdouble.

Vector3d	getTrq ()
	Returns the current torque of this stuntdouble.

Vector3d	getTrq (int snapshotNo)
	Returns the torque of this stuntdouble in specified snapshot.

void	setPrevTrq (const Vector3d &trq)
	Sets the previous torque of this stuntdouble.

void	setTrq (const Vector3d &trq)
	Sets the current torque of this stuntdouble.

void	setTrq (const Vector3d &trq, int snapshotNo)
	Sets the torque of this stuntdouble in specified snapshot.

void	addPrevTrq (const Vector3d &trq)
	Adds torque into the previous torque of this stuntdouble.

void	addTrq (const Vector3d &trq)
	Adds torque into the current torque of this stuntdouble.

void	addTrq (const Vector3d &trq, int snapshotNo)
	Adds torque into the torque of this stuntdouble in specified snapshot.

void	zeroForcesAndTorques ()
	Set the force of this stuntdouble to zero.

Mat3x3d	getI ()
	Returns the inertia tensor of this stuntdouble.

std::vector< RealType >	getGrad ()
	Returns the gradient of this stuntdouble.

bool	isLinear ()
	Tests the if this stuntdouble is a linear rigidbody.

int	linearAxis ()
	Returns the linear axis of the rigidbody, atom and directional atom will always return -1.

RealType	getMass ()
	Returns the mass of this stuntdouble.

void	setMass (RealType mass)
	Sets the mass of this stuntdoulbe.

std::string	getType ()
	Returns the name of this stuntdouble.

void	setType (const std::string &name)
	Sets the name of this stuntRealType.

Vector3d	lab2Body (const Vector3d &v)
	Converts a lab fixed vector to a body fixed vector.

Vector3d	body2Lab (const Vector3d &v)
	Converts a body fixed vector to a lab fixed vector.

void	accept (BaseVisitor *v)

void	addProperty (std::shared_ptr< GenericData > genData)
	Adds property into property map.

void	removeProperty (const std::string &propName)
	Removes property from PropertyMap by name.

std::vector< std::string >	getPropertyNames ()
	Returns all names of properties.

std::vector< std::shared_ptr< GenericData > >	getProperties ()
	Returns all of the properties in PropertyMap.

std::shared_ptr< GenericData >	getPropertyByName (const std::string &propName)
	Returns property.

Detailed Description

An adapter class of StuntDouble which is used at constraint algorithm.

Definition at line 61 of file ConstraintElem.hpp.

Constructor & Destructor Documentation

◆ ConstraintElem()

OpenMD::ConstraintElem::ConstraintElem ( StuntDouble * sd )

inline

Definition at line 63 of file ConstraintElem.hpp.

Member Function Documentation

◆ accept()

void OpenMD::ConstraintElem::accept ( BaseVisitor * v )

inline

The purpose of the Visitor Pattern is to encapsulate an operation that you want to perform on the elements of a data structure. In this way, you can change the operation being performed on a structure without the need of changing the classes of the elements that you are operating on. Using a Visitor pattern allows you to decouple the classes for the data structure and the algorithms used upon them

Parameters

v visitor

Definition at line 679 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::accept().

◆ addFrc() [1/2]

void OpenMD::ConstraintElem::addFrc ( const Vector3d & frc )

inline

Adds force into the current force of this stuntdouble.

Parameters

frc new force

Definition at line 522 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::addFrc().

◆ addFrc() [2/2]

void OpenMD::ConstraintElem::addFrc	(	const Vector3d &	frc,
		int	snapshotNo )

inline

Adds force into the force of this stuntdouble in specified snapshot.

Parameters

frc	force to be set
snapshotNo

See also: getFrc

Definition at line 531 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::addFrc().

◆ addPrevFrc()

void OpenMD::ConstraintElem::addPrevFrc ( const Vector3d & frc )

inline

Adds force into the previous force of this stuntdouble.

Parameters

frc new force

See also: getFrc

Definition at line 516 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::addPrevFrc().

◆ addPrevTrq()

void OpenMD::ConstraintElem::addPrevTrq ( const Vector3d & trq )

inline

Adds torque into the previous torque of this stuntdouble.

Parameters

trq	new torque

See also: getTrq

Definition at line 586 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::addPrevTrq().

◆ addProperty()

void OpenMD::ConstraintElem::addProperty ( std::shared_ptr< GenericData > genData )

inline

Adds property into property map.

Parameters

genData GenericData to be added into PropertyMap

Definition at line 686 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::addProperty().

◆ addTrq() [1/2]

void OpenMD::ConstraintElem::addTrq ( const Vector3d & trq )

inline

Adds torque into the current torque of this stuntdouble.

Parameters

trq	new torque

Definition at line 592 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::addTrq().

◆ addTrq() [2/2]

void OpenMD::ConstraintElem::addTrq	(	const Vector3d &	trq,
		int	snapshotNo )

inline

Adds torque into the torque of this stuntdouble in specified snapshot.

Parameters

trq	torque to be add
snapshotNo

See also: getTrq

Definition at line 601 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::addTrq().

◆ body2Lab()

Vector3d OpenMD::ConstraintElem::body2Lab ( const Vector3d & v )

inline

Converts a body fixed vector to a lab fixed vector.

Returns: corresponding lab fixed vector

Parameters

v	body fixed vector

Definition at line 667 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::body2Lab().

◆ getA() [1/2]

RotMat3x3d OpenMD::ConstraintElem::getA ( )

inline

Returns the current rotation matrix of this stuntdouble.

Returns: the rotation matrix of this stuntdouble

Definition at line 262 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getA().

◆ getA() [2/2]

RotMat3x3d OpenMD::ConstraintElem::getA ( int snapshotNo )

inline

Returns the rotation matrix of this stuntdouble in specified snapshot.

Returns: the rotation matrix of this stuntdouble

Parameters

snapshotNo

Definition at line 270 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getA().

◆ getDipole() [1/2]

Vector3d OpenMD::ConstraintElem::getDipole ( )

inline

Returns the current dipole vector of this stuntDouble.

Returns: the dipole vector of this stuntDouble

Definition at line 433 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getDipole().

◆ getDipole() [2/2]

Vector3d OpenMD::ConstraintElem::getDipole ( int snapshotNo )

inline

Returns the dipole vector of this stuntDouble in specified snapshot.

Returns: the dipole vector of this stuntDouble

Parameters

snapshotNo

Definition at line 441 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getDipole().

◆ getEuler() [1/2]

Vector3d OpenMD::ConstraintElem::getEuler ( )

inline

Returns the current euler angles of this stuntdouble.

Returns: the euler angles of this stuntdouble

Definition at line 389 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getEuler().

◆ getEuler() [2/2]

Vector3d OpenMD::ConstraintElem::getEuler ( int snapshotNo )

inline

Returns the euler angles of this stuntdouble in specified snapshot.

Returns: the euler angles of this stuntdouble

Parameters

snapshotNo

Definition at line 396 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getEuler().

◆ getFrc() [1/2]

Vector3d OpenMD::ConstraintElem::getFrc ( )

inline

Returns the current force of this stuntdouble.

Returns: the force of this stuntdouble

Definition at line 475 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getFrc().

◆ getFrc() [2/2]

Vector3d OpenMD::ConstraintElem::getFrc ( int snapshotNo )

inline

Returns the force of this stuntdouble in specified snapshot.

Returns: the force of this stuntdouble

Parameters

snapshotNo

Definition at line 483 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getFrc().

◆ getGlobalIndex()

int OpenMD::ConstraintElem::getGlobalIndex ( )

inline

Returns the global index of this stuntRealType.

Returns: the global index of this stuntdouble

Definition at line 113 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getGlobalIndex().

◆ getGrad()

std::vector< RealType > OpenMD::ConstraintElem::getGrad ( )

inline

Returns the gradient of this stuntdouble.

Returns: the gradient of this stuntdouble

Definition at line 617 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getGrad().

◆ getI()

Mat3x3d OpenMD::ConstraintElem::getI ( )

inline

Returns the inertia tensor of this stuntdouble.

Returns: the inertia tensor of this stuntdouble

Definition at line 611 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getI().

◆ getJ() [1/2]

Vector3d OpenMD::ConstraintElem::getJ ( )

inline

Returns the current angular momentum of this stuntdouble (body -fixed).

Returns: the angular momentum of this stuntdouble

Definition at line 303 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getJ().

◆ getJ() [2/2]

Vector3d OpenMD::ConstraintElem::getJ ( int snapshotNo )

inline

Returns the angular momentum of this stuntdouble in specified snapshot (body-fixed).

Returns: the angular momentum of this stuntdouble

Parameters

snapshotNo

Definition at line 311 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getJ().

◆ getLocalIndex()

int OpenMD::ConstraintElem::getLocalIndex ( )

inline

Returns the local index of this stuntdouble.

Returns: the local index of this stuntdouble

Definition at line 125 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getLocalIndex().

◆ getMass()

RealType OpenMD::ConstraintElem::getMass ( )

inline

Returns the mass of this stuntdouble.

Definition at line 641 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getMass().

◆ getMoved()

bool OpenMD::ConstraintElem::getMoved ( )

inline

Definition at line 101 of file ConstraintElem.hpp.

◆ getMoving()

bool OpenMD::ConstraintElem::getMoving ( )

inline

Definition at line 104 of file ConstraintElem.hpp.

◆ getPos() [1/2]

Vector3d OpenMD::ConstraintElem::getPos ( )

inline

Returns the current position of this stuntdouble.

Returns: the position of this stuntdouble

Definition at line 177 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getPos().

◆ getPos() [2/2]

Vector3d OpenMD::ConstraintElem::getPos ( int snapshotNo )

inline

Returns the position of this stuntdouble in specified snapshot.

Returns: the position of this stuntdouble

Parameters

snapshotNo

Definition at line 184 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getPos().

◆ getPrevA()

RotMat3x3d OpenMD::ConstraintElem::getPrevA ( )

inline

Returns the previous rotation matrix of this stuntdouble.

Returns: the rotation matrix of this stuntdouble

Definition at line 256 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getPrevA().

◆ getPrevDipole()

Vector3d OpenMD::ConstraintElem::getPrevDipole ( )

inline

Returns the previous dipole vector of this stuntDouble.

Returns: the dipole vector of this stuntDouble

Definition at line 427 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getPrevDipole().

◆ getPrevEuler()

Vector3d OpenMD::ConstraintElem::getPrevEuler ( )

inline

Returns the previous euler angles of this stuntdouble.

Returns: the euler angles of this stuntdouble

Definition at line 383 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getPrevEuler().

◆ getPrevFrc()

Vector3d OpenMD::ConstraintElem::getPrevFrc ( )

inline

Returns the previous force of this stuntdouble.

Returns: the force of this stuntdouble

Definition at line 469 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getPrevFrc().

◆ getPrevJ()

Vector3d OpenMD::ConstraintElem::getPrevJ ( )

inline

Returns the previous angular momentum of this stuntdouble (body-fixed).

Returns: the angular momentum of this stuntdouble

Definition at line 297 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getPrevJ().

◆ getPrevPos()

Vector3d OpenMD::ConstraintElem::getPrevPos ( )

inline

Returns the previous position of this stuntdouble.

Returns: the position of this stuntdouble

Definition at line 171 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getPrevPos().

◆ getPrevQ()

Quat4d OpenMD::ConstraintElem::getPrevQ ( )

inline

Returns the previous quaternion of this stuntdouble.

Returns: the quaternion of this stuntdouble

Definition at line 341 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getPrevQ().

◆ getPrevQuadrupole()

Mat3x3d OpenMD::ConstraintElem::getPrevQuadrupole ( )

inline

Returns the previous quadrupole tensor of this stuntDouble.

Returns: the quadrupole tensor of this stuntDouble

Definition at line 447 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getPrevQuadrupole().

◆ getPrevTrq()

Vector3d OpenMD::ConstraintElem::getPrevTrq ( )

inline

Returns the previous torque of this stuntdouble.

Returns: the torque of this stuntdouble

Definition at line 539 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getPrevTrq().

◆ getPrevVel()

Vector3d OpenMD::ConstraintElem::getPrevVel ( )

inline

Returns the previous velocity of this stuntdouble.

Returns: the velocity of this stuntdouble

Definition at line 213 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getPrevVel().

◆ getProperties()

std::vector< std::shared_ptr< GenericData > > OpenMD::ConstraintElem::getProperties ( )

inline

Returns all of the properties in PropertyMap.

Returns: all of the properties in PropertyMap

Definition at line 710 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getProperties().

◆ getPropertyByName()

std::shared_ptr< GenericData > OpenMD::ConstraintElem::getPropertyByName ( const std::string & propName )

inline

Returns property.

Parameters

propName name of property

Returns: a pointer point to property with propName. If no property named propName exists, return NULL

Definition at line 720 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getPropertyByName().

◆ getPropertyNames()

std::vector< std::string > OpenMD::ConstraintElem::getPropertyNames ( )

inline

Returns all names of properties.

Returns: all names of properties

Definition at line 702 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getPropertyNames().

◆ getQ() [1/2]

Quat4d OpenMD::ConstraintElem::getQ ( )

inline

Returns the current quaternion of this stuntdouble.

Returns: the quaternion of this stuntdouble

Definition at line 347 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getQ().

◆ getQ() [2/2]

Quat4d OpenMD::ConstraintElem::getQ ( int snapshotNo )

inline

Returns the quaternion of this stuntdouble in specified snapshot.

Returns: the quaternion of this stuntdouble

Parameters

snapshotNo

Definition at line 354 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getQ().

◆ getQuadrupole() [1/2]

Mat3x3d OpenMD::ConstraintElem::getQuadrupole ( )

inline

Returns the current quadrupole tensor of this stuntDouble.

Returns: the quadrupole tensor of this stuntDouble

Definition at line 453 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getQuadrupole().

◆ getQuadrupole() [2/2]

Mat3x3d OpenMD::ConstraintElem::getQuadrupole ( int snapshotNo )

inline

Returns the quadrupole tensor of this stuntDouble in specified snapshot.

Returns: the quadrupole tensor of this stuntDouble

Parameters

snapshotNo

Definition at line 461 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getQuadrupole().

◆ getStuntDouble()

StuntDouble * OpenMD::ConstraintElem::getStuntDouble ( )

inline

Definition at line 107 of file ConstraintElem.hpp.

◆ getTrq() [1/2]

Vector3d OpenMD::ConstraintElem::getTrq ( )

inline

Returns the current torque of this stuntdouble.

Returns: the torque of this stuntdouble

Definition at line 545 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getTrq().

◆ getTrq() [2/2]

Vector3d OpenMD::ConstraintElem::getTrq ( int snapshotNo )

inline

Returns the torque of this stuntdouble in specified snapshot.

Returns: the torque of this stuntdouble

Parameters

snapshotNo

Definition at line 553 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getTrq().

◆ getType()

std::string OpenMD::ConstraintElem::getType ( )

inline

Returns the name of this stuntdouble.

Definition at line 650 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getType().

◆ getVel() [1/2]

Vector3d OpenMD::ConstraintElem::getVel ( )

inline

Returns the current velocity of this stuntdouble.

Returns: the velocity of this stuntdouble

Definition at line 219 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getVel().

◆ getVel() [2/2]

Vector3d OpenMD::ConstraintElem::getVel ( int snapshotNo )

inline

Returns the velocity of this stuntdouble in specified snapshot.

Returns: the velocity of this stuntdouble

Parameters

snapshotNo

Definition at line 227 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::getVel().

◆ isAtom()

bool OpenMD::ConstraintElem::isAtom ( )

inline

Tests if this stuntdouble is an atom.

Returns: true is this stuntdouble is an atom(or a directional atom), return false otherwise

Definition at line 145 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::isAtom().

◆ isDirectional()

bool OpenMD::ConstraintElem::isDirectional ( )

inline

Tests if this stuntdouble is a directional one.

Returns: true is this stuntdouble is a directional atom or a rigid body, return false otherwise

Definition at line 165 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::isDirectional().

◆ isDirectionalAtom()

bool OpenMD::ConstraintElem::isDirectionalAtom ( )

inline

Tests if this stuntdouble is an directional atom.

Returns: true if this stuntdouble is an directional atom, return false otherwise

Definition at line 152 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::isDirectional().

◆ isLinear()

bool OpenMD::ConstraintElem::isLinear ( )

inline

Tests the if this stuntdouble is a linear rigidbody.

Returns: true if this stuntdouble is a linear rigidbody, otherwise return false

Note: atom and directional atom will always return false

See also: linearAxis

Definition at line 628 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::isLinear().

◆ isRigidBody()

bool OpenMD::ConstraintElem::isRigidBody ( )

inline

Tests if this stuntdouble is a rigid body.

Returns: true if this stuntdouble is a rigid body, otherwise return false

Definition at line 158 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::isRigidBody().

◆ lab2Body()

Vector3d OpenMD::ConstraintElem::lab2Body ( const Vector3d & v )

inline

Converts a lab fixed vector to a body fixed vector.

Returns: body fixed vector

Parameters

v	lab fixed vector

Definition at line 660 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::lab2Body().

◆ linearAxis()

int OpenMD::ConstraintElem::linearAxis ( )

inline

Returns the linear axis of the rigidbody, atom and directional atom will always return -1.

Returns: the linear axis of the rigidbody

See also: isLinear

Definition at line 638 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::linearAxis().

◆ removeProperty()

void OpenMD::ConstraintElem::removeProperty ( const std::string & propName )

inline

Removes property from PropertyMap by name.

Parameters

propName the name of property to be removed

Definition at line 694 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::removeProperty().

◆ setA() [1/2]

void OpenMD::ConstraintElem::setA ( const RotMat3x3d & a )

inline

Sets the current rotation matrix of this stuntdouble.

Parameters

a	new rotation matrix

Definition at line 283 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setA().

◆ setA() [2/2]

void OpenMD::ConstraintElem::setA	(	const RotMat3x3d &	a,
		int	snapshotNo )

inline

Sets the rotation matrix of this stuntdouble in specified snapshot.

Parameters

a	rotation matrix to be set
snapshotNo

See also: getA

Definition at line 291 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setA().

◆ setEuler() [1/2]

void OpenMD::ConstraintElem::setEuler ( const Vector3d & euler )

inline

Sets the current euler angles of this stuntdouble.

Parameters

euler new euler angles

Definition at line 410 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setEuler().

◆ setEuler() [2/2]

void OpenMD::ConstraintElem::setEuler	(	const Vector3d &	euler,
		int	snapshotNo )

inline

Sets the euler angles of this stuntdouble in specified snapshot.

Parameters

euler	euler angles to be set
snapshotNo

Note: actual storage data is rotation matrix

Definition at line 419 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setEuler().

◆ setFrc() [1/2]

void OpenMD::ConstraintElem::setFrc ( const Vector3d & frc )

inline

Sets the current force of this stuntdouble.

Parameters

frc new force

Definition at line 497 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setFrc().

◆ setFrc() [2/2]

void OpenMD::ConstraintElem::setFrc	(	const Vector3d &	frc,
		int	snapshotNo )

inline

Sets the force of this stuntdouble in specified snapshot.

Parameters

frc	force to be set
snapshotNo

See also: getFrc

Definition at line 506 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setFrc().

◆ setGlobalIndex()

void OpenMD::ConstraintElem::setGlobalIndex ( int index )

inline

Sets the global index of this stuntRealType.

Parameters

index new global index to be set

Definition at line 119 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setGlobalIndex().

◆ setJ() [1/2]

void OpenMD::ConstraintElem::setJ ( const Vector3d & angMom )

inline

Sets the current angular momentum of this stuntdouble (body-fixed).

Parameters

angMom new angular momentum

Definition at line 324 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setJ().

◆ setJ() [2/2]

void OpenMD::ConstraintElem::setJ	(	const Vector3d &	angMom,
		int	snapshotNo )

inline

Sets the angular momentum of this stuntdouble in specified snapshot(body-fixed).

Parameters

angMom	angular momentum to be set
snapshotNo

See also: getJ

Definition at line 333 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setJ().

◆ setLocalIndex()

void OpenMD::ConstraintElem::setLocalIndex ( int index )

inline

Sets the local index of this stuntdouble.

Parameters

index new index to be set

Definition at line 131 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setLocalIndex().

◆ setMass()

void OpenMD::ConstraintElem::setMass ( RealType mass )

inline

Sets the mass of this stuntdoulbe.

Parameters

mass	the mass to be set

Definition at line 647 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setMass().

◆ setMoved()

void OpenMD::ConstraintElem::setMoved ( bool moved )

inline

Definition at line 102 of file ConstraintElem.hpp.

◆ setMoving()

void OpenMD::ConstraintElem::setMoving ( bool moving )

inline

Definition at line 105 of file ConstraintElem.hpp.

◆ setPos() [1/2]

void OpenMD::ConstraintElem::setPos ( const Vector3d & pos )

inline

Sets the current position of this stuntdouble.

Parameters

pos	new position

Definition at line 197 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setPos().

◆ setPos() [2/2]

void OpenMD::ConstraintElem::setPos	(	const Vector3d &	pos,
		int	snapshotNo )

inline

Sets the position of this stuntdouble in specified snapshot.

Parameters

pos	position to be set
snapshotNo

See also: getPos

Definition at line 205 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setPos().

◆ setPrevA()

void OpenMD::ConstraintElem::setPrevA ( const RotMat3x3d & a )

inline

Sets the previous rotation matrix of this stuntdouble.

Parameters

a	new rotation matrix

See also: getA

Definition at line 277 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setPrevA().

◆ setPrevEuler()

void OpenMD::ConstraintElem::setPrevEuler ( const Vector3d & euler )

inline

Sets the previous euler angles of this stuntRealType.

Parameters

euler new euler angles

See also: getEuler

Note: actual storage data is rotation matrix

Definition at line 404 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setPrevEuler().

◆ setPrevFrc()

void OpenMD::ConstraintElem::setPrevFrc ( const Vector3d & frc )

inline

Sets the previous force of this stuntdouble.

Parameters

frc new force

See also: getFrc

Definition at line 491 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setPrevFrc().

◆ setPrevJ()

void OpenMD::ConstraintElem::setPrevJ ( const Vector3d & angMom )

inline

Sets the previous angular momentum of this stuntdouble (body-fixed).

Parameters

angMom new angular momentum

See also: getJ

Definition at line 318 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setPrevJ().

◆ setPrevPos()

void OpenMD::ConstraintElem::setPrevPos ( const Vector3d & pos )

inline

Sets the previous position of this stuntdouble.

Parameters

pos	new position

See also: getPos

Definition at line 191 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setPrevPos().

◆ setPrevQ()

void OpenMD::ConstraintElem::setPrevQ ( const Quat4d & q )

inline

Sets the previous quaternion of this stuntdouble.

Parameters

q	new quaternion

Note: actual storage data is rotation matrix

Definition at line 361 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setPrevQ().

◆ setPrevTrq()

void OpenMD::ConstraintElem::setPrevTrq ( const Vector3d & trq )

inline

Sets the previous torque of this stuntdouble.

Parameters

trq	new torque

See also: getTrq

Definition at line 561 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setPrevTrq().

◆ setPrevVel()

void OpenMD::ConstraintElem::setPrevVel ( const Vector3d & vel )

inline

Sets the previous velocity of this stuntdouble.

Parameters

vel	new velocity

See also: getVel

Definition at line 234 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setPrevVel().

◆ setQ() [1/2]

void OpenMD::ConstraintElem::setQ ( const Quat4d & q )

inline

Sets the current quaternion of this stuntdouble.

Parameters

q	new quaternion

Note: actual storage data is rotation matrix

Definition at line 368 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setQ().

◆ setQ() [2/2]

void OpenMD::ConstraintElem::setQ	(	const Quat4d &	q,
		int	snapshotNo )

inline

Sets the quaternion of this stuntdouble in specified snapshot.

Parameters

q	quaternion to be set
snapshotNo

Note: actual storage data is rotation matrix

Definition at line 377 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setQ().

◆ setSnapshotManager()

void OpenMD::ConstraintElem::setSnapshotManager ( SnapshotManager * sman )

inline

Sets the Snapshot Manager of this stuntdouble.

Definition at line 136 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setSnapshotManager().

◆ setTrq() [1/2]

void OpenMD::ConstraintElem::setTrq ( const Vector3d & trq )

inline

Sets the current torque of this stuntdouble.

Parameters

trq	new torque

Definition at line 567 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setTrq().

◆ setTrq() [2/2]

void OpenMD::ConstraintElem::setTrq	(	const Vector3d &	trq,
		int	snapshotNo )

inline

Sets the torque of this stuntdouble in specified snapshot.

Parameters

trq	torque to be set
snapshotNo

See also: getTrq

Definition at line 576 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setTrq().

◆ setType()

void OpenMD::ConstraintElem::setType ( const std::string & name )

inline

Sets the name of this stuntRealType.

Definition at line 653 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setType().

◆ setVel() [1/2]

void OpenMD::ConstraintElem::setVel ( const Vector3d & vel )

inline

Sets the current velocity of this stuntdouble.

Parameters

vel	new velocity

Definition at line 240 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setVel().

◆ setVel() [2/2]

void OpenMD::ConstraintElem::setVel	(	const Vector3d &	vel,
		int	snapshotNo )

inline

Sets the velocity of this stuntdouble in specified snapshot.

Parameters

vel	velocity to be set
snapshotNo

See also: getVel

Definition at line 248 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::setVel().

◆ zeroForcesAndTorques()

void OpenMD::ConstraintElem::zeroForcesAndTorques ( )

inline

Set the force of this stuntdouble to zero.

Definition at line 606 of file ConstraintElem.hpp.

References OpenMD::StuntDouble::zeroForcesAndTorques().

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

constraints/ConstraintElem.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ConstraintElem()

Member Function Documentation

◆ accept()

◆ addFrc() [1/2]

◆ addFrc() [2/2]

◆ addPrevFrc()

◆ addPrevTrq()

◆ addProperty()

◆ addTrq() [1/2]

◆ addTrq() [2/2]

◆ body2Lab()

◆ getA() [1/2]

◆ getA() [2/2]

◆ getDipole() [1/2]

◆ getDipole() [2/2]

◆ getEuler() [1/2]

◆ getEuler() [2/2]

◆ getFrc() [1/2]

◆ getFrc() [2/2]

◆ getGlobalIndex()

◆ getGrad()

◆ getI()

◆ getJ() [1/2]

◆ getJ() [2/2]

◆ getLocalIndex()

◆ getMass()

◆ getMoved()

◆ getMoving()

◆ getPos() [1/2]

◆ getPos() [2/2]

◆ getPrevA()

◆ getPrevDipole()

◆ getPrevEuler()

◆ getPrevFrc()

◆ getPrevJ()

◆ getPrevPos()

◆ getPrevQ()

◆ getPrevQuadrupole()

◆ getPrevTrq()

◆ getPrevVel()

◆ getProperties()

◆ getPropertyByName()

◆ getPropertyNames()

◆ getQ() [1/2]

◆ getQ() [2/2]

◆ getQuadrupole() [1/2]

◆ getQuadrupole() [2/2]

◆ getStuntDouble()

◆ getTrq() [1/2]

◆ getTrq() [2/2]

◆ getType()

◆ getVel() [1/2]

◆ getVel() [2/2]

◆ isAtom()

◆ isDirectional()

◆ isDirectionalAtom()

◆ isLinear()

◆ isRigidBody()

◆ lab2Body()

◆ linearAxis()

◆ removeProperty()

◆ setA() [1/2]

◆ setA() [2/2]

◆ setEuler() [1/2]

◆ setEuler() [2/2]

◆ setFrc() [1/2]

◆ setFrc() [2/2]

◆ setGlobalIndex()

◆ setJ() [1/2]

◆ setJ() [2/2]

◆ setLocalIndex()

◆ setMass()

◆ setMoved()

◆ setMoving()

◆ setPos() [1/2]

◆ setPos() [2/2]

◆ setPrevA()