Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
sixDoFRigidBodyMotionConstraint Class Referenceabstract

Base class for defining constraints for sixDoF motions. More...

Inheritance diagram for sixDoFRigidBodyMotionConstraint:
Inheritance graph
[legend]
Collaboration diagram for sixDoFRigidBodyMotionConstraint:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("sixDoFRigidBodyMotionConstraint")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, sixDoFRigidBodyMotionConstraint, dictionary,( const word &name, const dictionary &sDoFRBMCDict, const sixDoFRigidBodyMotion &motion ),(name, sDoFRBMCDict, motion))
 
 sixDoFRigidBodyMotionConstraint (const word &name, const dictionary &sDoFRBMCDict, const sixDoFRigidBodyMotion &motion)
 Construct from the sDoFRBMCDict dictionary and Time. More...
 
virtual autoPtr< sixDoFRigidBodyMotionConstraintclone () const =0
 Construct and return a clone. More...
 
virtual ~sixDoFRigidBodyMotionConstraint ()
 Destructor. More...
 
const wordname () const
 Return the name. More...
 
virtual void setCentreOfRotation (point &) const
 Set the centre of rotation if not the centre of mass. More...
 
virtual void constrainTranslation (pointConstraint &) const =0
 Apply and accumulate translational constraints. More...
 
virtual void constrainRotation (pointConstraint &) const =0
 Apply and accumulate rotational constraints. More...
 
virtual bool read (const dictionary &sDoFRBMCDict)
 Update properties from given dictionary. More...
 
const dictionarycoeffDict () const
 
virtual void write (Ostream &) const
 Write. More...
 

Static Public Member Functions

static autoPtr< sixDoFRigidBodyMotionConstraintNew (const word &name, const dictionary &sDoFRBMCDict, const sixDoFRigidBodyMotion &motion)
 Select constructed from the sDoFRBMCDict dictionary and Time. More...
 

Protected Attributes

word name_
 Name of the constraint. More...
 
dictionary sDoFRBMCCoeffs_
 Constraint model specific coefficient dictionary. More...
 
const sixDoFRigidBodyMotionmotion_
 Reference to the body motion. More...
 

Detailed Description

Base class for defining constraints for sixDoF motions.

Source files

Definition at line 65 of file sixDoFRigidBodyMotionConstraint.H.

Constructor & Destructor Documentation

sixDoFRigidBodyMotionConstraint ( const word name,
const dictionary sDoFRBMCDict,
const sixDoFRigidBodyMotion motion 
)

Construct from the sDoFRBMCDict dictionary and Time.

Definition at line 40 of file sixDoFRigidBodyMotionConstraint.C.

Destructor.

Definition at line 54 of file sixDoFRigidBodyMotionConstraint.C.

References sixDoFRigidBodyMotionConstraint::read().

Here is the call graph for this function:

Member Function Documentation

TypeName ( "sixDoFRigidBodyMotionConstraint"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
sixDoFRigidBodyMotionConstraint  ,
dictionary  ,
( const word &name, const dictionary &sDoFRBMCDict, const sixDoFRigidBodyMotion &motion )  ,
(name, sDoFRBMCDict, motion)   
)
virtual autoPtr<sixDoFRigidBodyMotionConstraint> clone ( ) const
pure virtual

Construct and return a clone.

Implemented in line, plane, point, axis, and orientation.

Foam::autoPtr< Foam::sixDoFRigidBodyMotionConstraint > New ( const word name,
const dictionary sDoFRBMCDict,
const sixDoFRigidBodyMotion motion 
)
static

Select constructed from the sDoFRBMCDict dictionary and Time.

Definition at line 32 of file sixDoFRigidBodyMotionConstraintNew.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, dictionary::lookup(), Foam::name(), and Foam::nl.

Referenced by sixDoFRigidBodyMotion::addConstraints().

Here is the call graph for this function:

Here is the caller graph for this function:

const word& name ( ) const
inline

Return the name.

Definition at line 136 of file sixDoFRigidBodyMotionConstraint.H.

References sixDoFRigidBodyMotionConstraint::name_.

virtual void setCentreOfRotation ( point ) const
inlinevirtual

Set the centre of rotation if not the centre of mass.

Reimplemented in point.

Definition at line 142 of file sixDoFRigidBodyMotionConstraint.H.

References sixDoFRigidBodyMotionConstraint::constrainRotation(), sixDoFRigidBodyMotionConstraint::constrainTranslation(), and sixDoFRigidBodyMotionConstraint::read().

Here is the call graph for this function:

virtual void constrainTranslation ( pointConstraint ) const
pure virtual

Apply and accumulate translational constraints.

Implemented in line, plane, point, axis, and orientation.

Referenced by sixDoFRigidBodyMotionConstraint::setCentreOfRotation().

Here is the caller graph for this function:

virtual void constrainRotation ( pointConstraint ) const
pure virtual

Apply and accumulate rotational constraints.

Implemented in line, plane, point, axis, and orientation.

Referenced by sixDoFRigidBodyMotionConstraint::setCentreOfRotation().

Here is the caller graph for this function:

bool read ( const dictionary sDoFRBMCDict)
virtual

Update properties from given dictionary.

Reimplemented in line, plane, point, axis, and orientation.

Definition at line 61 of file sixDoFRigidBodyMotionConstraint.C.

Referenced by orientation::read(), axis::read(), point::read(), line::read(), plane::read(), sixDoFRigidBodyMotionConstraint::setCentreOfRotation(), and sixDoFRigidBodyMotionConstraint::~sixDoFRigidBodyMotionConstraint().

Here is the caller graph for this function:

const dictionary& coeffDict ( ) const
inline

Definition at line 157 of file sixDoFRigidBodyMotionConstraint.H.

References sixDoFRigidBodyMotionConstraint::sDoFRBMCCoeffs_, and sixDoFRigidBodyMotionConstraint::write().

Here is the call graph for this function:

void write ( Ostream os) const
virtual

Write.

Reimplemented in line, plane, point, axis, and orientation.

Definition at line 71 of file sixDoFRigidBodyMotionConstraint.C.

Referenced by sixDoFRigidBodyMotionConstraint::coeffDict().

Here is the caller graph for this function:

Member Data Documentation

word name_
protected

Name of the constraint.

Definition at line 73 of file sixDoFRigidBodyMotionConstraint.H.

Referenced by sixDoFRigidBodyMotionConstraint::name().

dictionary sDoFRBMCCoeffs_
protected

Constraint model specific coefficient dictionary.

Definition at line 76 of file sixDoFRigidBodyMotionConstraint.H.

Referenced by sixDoFRigidBodyMotionConstraint::coeffDict().

const sixDoFRigidBodyMotion& motion_
protected

Reference to the body motion.

Definition at line 79 of file sixDoFRigidBodyMotionConstraint.H.


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