Base class for defining constraints for sixDoF motions. More...
#include <forces/sixDoFRigidBodyMotionConstraint.H>
Base class for defining constraints for sixDoF motions.
Definition at line 64 of file sixDoFRigidBodyMotionConstraint.H.
Public Member Functions | |
TypeName ("sixDoFRigidBodyMotionConstraint") | |
Runtime type information. | |
declareRunTimeSelectionTable (autoPtr, sixDoFRigidBodyMotionConstraint, dictionary,(const dictionary &sDoFRBMCDict),(sDoFRBMCDict)) | |
sixDoFRigidBodyMotionConstraint (const dictionary &sDoFRBMCDict) | |
Construct from the sDoFRBMCDict dictionary and Time. | |
virtual autoPtr < sixDoFRigidBodyMotionConstraint > | clone () const =0 |
Construct and return a clone. | |
virtual | ~sixDoFRigidBodyMotionConstraint () |
virtual bool | constrain (const sixDoFRigidBodyMotion &motion, const vector &existingConstraintForce, const vector &existingConstraintMoment, scalar deltaT, vector &constraintPosition, vector &constraintForceIncrement, vector &constraintMomentIncrement) const =0 |
Calculate the constraint position, force and moment. | |
virtual bool | read (const dictionary &sDoFRBMCDict) |
Update properties from given dictionary. | |
const dictionary & | coeffDict () const |
scalar | tolerance () const |
Return access to the tolerance. | |
scalar | relaxationFactor () const |
Return access to the relaxationFactor. | |
virtual void | write (Ostream &) const |
Write. |
Static Public Member Functions | |
static autoPtr < sixDoFRigidBodyMotionConstraint > | New (const dictionary &sDoFRBMCDict) |
Select constructed from the sDoFRBMCDict dictionary and Time. |
Protected Attributes | |
dictionary | sDoFRBMCCoeffs_ |
Constraint model specific coefficient dictionary. | |
scalar | tolerance_ |
Solution tolerance. Meaning depends on model, usually an. | |
scalar | relaxationFactor_ |
Relaxation factor for solution, default to one. |
sixDoFRigidBodyMotionConstraint | ( | const dictionary & | sDoFRBMCDict | ) |
Construct from the sDoFRBMCDict dictionary and Time.
Definition at line 37 of file sixDoFRigidBodyMotionConstraint.C.
|
virtual |
Definition at line 59 of file sixDoFRigidBodyMotionConstraint.C.
TypeName | ( | "sixDoFRigidBodyMotionConstraint" | ) |
Runtime type information.
declareRunTimeSelectionTable | ( | autoPtr | , |
sixDoFRigidBodyMotionConstraint | , | ||
dictionary | , | ||
(const dictionary &sDoFRBMCDict) | , | ||
(sDoFRBMCDict) | |||
) |
|
pure virtual |
Construct and return a clone.
Implemented in fixedLine, fixedAxis, fixedPoint, fixedPlane, and fixedOrientation.
|
static |
Select constructed from the sDoFRBMCDict dictionary and Time.
Definition at line 31 of file newSixDoFRigidBodyMotionConstraint.C.
References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, and dictionary::lookup().
Referenced by sixDoFRigidBodyMotion::addConstraints().
|
pure virtual |
Calculate the constraint position, force and moment.
Global reference frame vectors. Returns boolean stating whether the constraint been converged to tolerance.
Implemented in fixedLine, fixedAxis, fixedPoint, fixedPlane, and fixedOrientation.
|
virtual |
Update properties from given dictionary.
Reimplemented in fixedLine, fixedAxis, fixedPoint, fixedPlane, and fixedOrientation.
Definition at line 66 of file sixDoFRigidBodyMotionConstraint.C.
References dictionary::lookup(), dictionary::lookupOrDefault(), Foam::readScalar(), dictionary::subDict(), and Foam::type().
Referenced by fixedOrientation::read(), fixedPlane::read(), fixedPoint::read(), fixedAxis::read(), and fixedLine::read().
|
inline |
Definition at line 148 of file sixDoFRigidBodyMotionConstraint.H.
References sixDoFRigidBodyMotionConstraint::sDoFRBMCCoeffs_.
|
inline |
Return access to the tolerance.
Definition at line 154 of file sixDoFRigidBodyMotionConstraint.H.
References sixDoFRigidBodyMotionConstraint::tolerance_.
|
inline |
Return access to the relaxationFactor.
Definition at line 160 of file sixDoFRigidBodyMotionConstraint.H.
References sixDoFRigidBodyMotionConstraint::relaxationFactor_.
|
virtual |
Write.
Reimplemented in fixedLine, fixedAxis, fixedPoint, fixedPlane, and fixedOrientation.
Definition at line 84 of file sixDoFRigidBodyMotionConstraint.C.
References token::END_STATEMENT, Foam::nl, and Ostream::writeKeyword().
|
protected |
Constraint model specific coefficient dictionary.
Definition at line 72 of file sixDoFRigidBodyMotionConstraint.H.
Referenced by sixDoFRigidBodyMotionConstraint::coeffDict().
|
protected |
Solution tolerance. Meaning depends on model, usually an.
absolute distance or angle.
Definition at line 76 of file sixDoFRigidBodyMotionConstraint.H.
Referenced by sixDoFRigidBodyMotionConstraint::tolerance().
|
protected |
Relaxation factor for solution, default to one.
Definition at line 79 of file sixDoFRigidBodyMotionConstraint.H.
Referenced by sixDoFRigidBodyMotionConstraint::relaxationFactor().