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 64 of file ConstraintElem.hpp.

Constructor & Destructor Documentation

◆ ConstraintElem()

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

inline

Definition at line 66 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 682 of file ConstraintElem.hpp.

◆ 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 525 of file ConstraintElem.hpp.

◆ 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 534 of file ConstraintElem.hpp.

◆ 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 519 of file ConstraintElem.hpp.

◆ 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 589 of file ConstraintElem.hpp.

◆ 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 689 of file ConstraintElem.hpp.

◆ 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 595 of file ConstraintElem.hpp.

◆ 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 604 of file ConstraintElem.hpp.

◆ 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 670 of file ConstraintElem.hpp.

◆ 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 265 of file ConstraintElem.hpp.

◆ 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 273 of file ConstraintElem.hpp.

◆ 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 436 of file ConstraintElem.hpp.

◆ 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 444 of file ConstraintElem.hpp.

◆ 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 392 of file ConstraintElem.hpp.

◆ 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 399 of file ConstraintElem.hpp.

◆ getFrc() [1/2]

Vector3d OpenMD::ConstraintElem::getFrc ( )

inline

Returns the current force of this stuntdouble.

Returns: the force of this stuntdouble

Definition at line 478 of file ConstraintElem.hpp.

◆ 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 486 of file ConstraintElem.hpp.

◆ getGlobalIndex()

int OpenMD::ConstraintElem::getGlobalIndex ( )

inline

Returns the global index of this stuntRealType.

Returns: the global index of this stuntdouble

Definition at line 116 of file ConstraintElem.hpp.

◆ getGrad()

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

inline

Returns the gradient of this stuntdouble.

Returns: the gradient of this stuntdouble

Definition at line 620 of file ConstraintElem.hpp.

◆ getI()

Mat3x3d OpenMD::ConstraintElem::getI ( )

inline

Returns the inertia tensor of this stuntdouble.

Returns: the inertia tensor of this stuntdouble

Definition at line 614 of file ConstraintElem.hpp.

◆ 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 306 of file ConstraintElem.hpp.

◆ 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 314 of file ConstraintElem.hpp.

◆ getLocalIndex()

int OpenMD::ConstraintElem::getLocalIndex ( )

inline

Returns the local index of this stuntdouble.

Returns: the local index of this stuntdouble

Definition at line 128 of file ConstraintElem.hpp.

◆ getMass()

RealType OpenMD::ConstraintElem::getMass ( )

inline

Returns the mass of this stuntdouble.

Definition at line 644 of file ConstraintElem.hpp.

◆ getMoved()

bool OpenMD::ConstraintElem::getMoved ( )

inline

Definition at line 104 of file ConstraintElem.hpp.

◆ getMoving()

bool OpenMD::ConstraintElem::getMoving ( )

inline

Definition at line 107 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 180 of file ConstraintElem.hpp.

◆ 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 187 of file ConstraintElem.hpp.

◆ getPrevA()

RotMat3x3d OpenMD::ConstraintElem::getPrevA ( )

inline

Returns the previous rotation matrix of this stuntdouble.

Returns: the rotation matrix of this stuntdouble

Definition at line 259 of file ConstraintElem.hpp.

◆ getPrevDipole()

Vector3d OpenMD::ConstraintElem::getPrevDipole ( )

inline

Returns the previous dipole vector of this stuntDouble.

Returns: the dipole vector of this stuntDouble

Definition at line 430 of file ConstraintElem.hpp.

◆ getPrevEuler()

Vector3d OpenMD::ConstraintElem::getPrevEuler ( )

inline

Returns the previous euler angles of this stuntdouble.

Returns: the euler angles of this stuntdouble

Definition at line 386 of file ConstraintElem.hpp.

◆ getPrevFrc()

Vector3d OpenMD::ConstraintElem::getPrevFrc ( )

inline

Returns the previous force of this stuntdouble.

Returns: the force of this stuntdouble

Definition at line 472 of file ConstraintElem.hpp.

◆ 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 300 of file ConstraintElem.hpp.

◆ getPrevPos()

Vector3d OpenMD::ConstraintElem::getPrevPos ( )

inline

Returns the previous position of this stuntdouble.

Returns: the position of this stuntdouble

Definition at line 174 of file ConstraintElem.hpp.

◆ getPrevQ()

Quat4d OpenMD::ConstraintElem::getPrevQ ( )

inline

Returns the previous quaternion of this stuntdouble.

Returns: the quaternion of this stuntdouble

Definition at line 344 of file ConstraintElem.hpp.

◆ getPrevQuadrupole()

Mat3x3d OpenMD::ConstraintElem::getPrevQuadrupole ( )

inline

Returns the previous quadrupole tensor of this stuntDouble.

Returns: the quadrupole tensor of this stuntDouble

Definition at line 450 of file ConstraintElem.hpp.

◆ getPrevTrq()

Vector3d OpenMD::ConstraintElem::getPrevTrq ( )

inline

Returns the previous torque of this stuntdouble.

Returns: the torque of this stuntdouble

Definition at line 542 of file ConstraintElem.hpp.

◆ getPrevVel()

Vector3d OpenMD::ConstraintElem::getPrevVel ( )

inline

Returns the previous velocity of this stuntdouble.

Returns: the velocity of this stuntdouble

Definition at line 216 of file ConstraintElem.hpp.

◆ 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 713 of file ConstraintElem.hpp.

◆ 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 723 of file ConstraintElem.hpp.

◆ getPropertyNames()

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

inline

Returns all names of properties.

Returns: all names of properties

Definition at line 705 of file ConstraintElem.hpp.

◆ getQ() [1/2]

Quat4d OpenMD::ConstraintElem::getQ ( )

inline

Returns the current quaternion of this stuntdouble.

Returns: the quaternion of this stuntdouble

Definition at line 350 of file ConstraintElem.hpp.

◆ 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 357 of file ConstraintElem.hpp.

◆ 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 456 of file ConstraintElem.hpp.

◆ 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 464 of file ConstraintElem.hpp.

◆ getStuntDouble()

StuntDouble * OpenMD::ConstraintElem::getStuntDouble ( )

inline

Definition at line 110 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 548 of file ConstraintElem.hpp.

◆ 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 556 of file ConstraintElem.hpp.

◆ getType()

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

inline

Returns the name of this stuntdouble.

Definition at line 653 of file ConstraintElem.hpp.

◆ getVel() [1/2]

Vector3d OpenMD::ConstraintElem::getVel ( )

inline

Returns the current velocity of this stuntdouble.

Returns: the velocity of this stuntdouble

Definition at line 222 of file ConstraintElem.hpp.

◆ 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 230 of file ConstraintElem.hpp.

◆ 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 148 of file ConstraintElem.hpp.

◆ 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 168 of file ConstraintElem.hpp.

◆ 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 155 of file ConstraintElem.hpp.

◆ 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 631 of file ConstraintElem.hpp.

◆ 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 161 of file ConstraintElem.hpp.

◆ 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 663 of file ConstraintElem.hpp.

◆ 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 641 of file ConstraintElem.hpp.

◆ 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 697 of file ConstraintElem.hpp.

◆ 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 286 of file ConstraintElem.hpp.

◆ 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 294 of file ConstraintElem.hpp.

◆ 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 413 of file ConstraintElem.hpp.

◆ 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 422 of file ConstraintElem.hpp.

◆ 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 500 of file ConstraintElem.hpp.

◆ 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 509 of file ConstraintElem.hpp.

◆ 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 122 of file ConstraintElem.hpp.

◆ 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 327 of file ConstraintElem.hpp.

◆ 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 336 of file ConstraintElem.hpp.

◆ 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 134 of file ConstraintElem.hpp.

◆ setMass()

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

inline

Sets the mass of this stuntdoulbe.

Parameters

mass	the mass to be set

Definition at line 650 of file ConstraintElem.hpp.

◆ setMoved()

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

inline

Definition at line 105 of file ConstraintElem.hpp.

◆ setMoving()

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

inline

Definition at line 108 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 200 of file ConstraintElem.hpp.

◆ 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 208 of file ConstraintElem.hpp.

◆ 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 280 of file ConstraintElem.hpp.

◆ 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 407 of file ConstraintElem.hpp.

◆ 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 494 of file ConstraintElem.hpp.

◆ 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 321 of file ConstraintElem.hpp.

◆ 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 194 of file ConstraintElem.hpp.

◆ 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 364 of file ConstraintElem.hpp.

◆ 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 564 of file ConstraintElem.hpp.

◆ 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 237 of file ConstraintElem.hpp.

◆ 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 371 of file ConstraintElem.hpp.

◆ 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 380 of file ConstraintElem.hpp.

◆ setSnapshotManager()

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

inline

Sets the Snapshot Manager of this stuntdouble.

Definition at line 139 of file ConstraintElem.hpp.

◆ 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 570 of file ConstraintElem.hpp.

◆ 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 579 of file ConstraintElem.hpp.

◆ setType()

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

inline

Sets the name of this stuntRealType.

Definition at line 656 of file ConstraintElem.hpp.

◆ 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 243 of file ConstraintElem.hpp.

◆ 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 251 of file ConstraintElem.hpp.

◆ zeroForcesAndTorques()

void OpenMD::ConstraintElem::zeroForcesAndTorques ( )

inline

Set the force of this stuntdouble to zero.

Definition at line 609 of file ConstraintElem.hpp.

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()