OpenMD::ConstraintPair Class Reference

#include <ConstraintPair.hpp>

Public Member Functions
	ConstraintPair (ConstraintElem *elem1, ConstraintElem *elem2, RealType len, bool printForce)
ConstraintElem *	getConsElem1 ()
	Return the first constraint elemet.
ConstraintElem *	getConsElem2 ()
	Retunr the second constraint element.
bool	isMoved ()
RealType	getConsDistSquare ()
void	setConstraintForce (RealType frc)
void	addConstraintForce (RealType frc)
void	resetConstraintForce ()
RealType	getConstraintForce ()
bool	getPrintForce ()

Detailed Description

Todo

document

Definition at line 57 of file ConstraintPair.hpp.

Constructor & Destructor Documentation

ConstraintPair()

OpenMD::ConstraintPair::ConstraintPair ( ConstraintElem * elem1, ConstraintElem * elem2, RealType len, bool printForce )

inline

Definition at line 59 of file ConstraintPair.hpp.

~ConstraintPair()

OpenMD::ConstraintPair::~ConstraintPair ( )

inline

Definition at line 64 of file ConstraintPair.hpp.

Member Function Documentation

addConstraintForce()

void OpenMD::ConstraintPair::addConstraintForce ( RealType frc )

inline

Definition at line 77 of file ConstraintPair.hpp.

getConsDistSquare()

RealType OpenMD::ConstraintPair::getConsDistSquare ( )

inline

Definition at line 75 of file ConstraintPair.hpp.

getConsElem1()

ConstraintElem * OpenMD::ConstraintPair::getConsElem1 ( )

inline

Return the first constraint elemet.

Definition at line 69 of file ConstraintPair.hpp.

getConsElem2()

ConstraintElem * OpenMD::ConstraintPair::getConsElem2 ( )

inline

Retunr the second constraint element.

Definition at line 72 of file ConstraintPair.hpp.

getConstraintForce()

RealType OpenMD::ConstraintPair::getConstraintForce ( )

inline

Definition at line 79 of file ConstraintPair.hpp.

getPrintForce()

bool OpenMD::ConstraintPair::getPrintForce ( )

inline

Definition at line 80 of file ConstraintPair.hpp.

isMoved()

bool OpenMD::ConstraintPair::isMoved ( )

inline

Definition at line 74 of file ConstraintPair.hpp.

resetConstraintForce()

void OpenMD::ConstraintPair::resetConstraintForce ( )

inline

Definition at line 78 of file ConstraintPair.hpp.

setConstraintForce()

void OpenMD::ConstraintPair::setConstraintForce ( RealType frc )

inline

Definition at line 76 of file ConstraintPair.hpp.

---

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

• constraints/ConstraintPair.hpp