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< sixDoFRigidBodyMotionConstraint > clone () const =0
 Construct and return a clone. More...
 
virtual ~sixDoFRigidBodyMotionConstraint ()
 Destructor. More...
 
const word & name () 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 dictionary & coeffDict () const
 
virtual void write (Ostream &) const
 Write. More...
 

Static Public Member Functions

static autoPtr< sixDoFRigidBodyMotionConstraint > New (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 sixDoFRigidBodyMotion & motion_
 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()

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

Construct from the sDoFRBMCDict dictionary and Time.

Definition at line 39 of file sixDoFRigidBodyMotionConstraint.C.

◆ ~sixDoFRigidBodyMotionConstraint()

~sixDoFRigidBodyMotionConstraint ( )
virtual

Destructor.

Definition at line 54 of file sixDoFRigidBodyMotionConstraint.C.

Member Function Documentation

◆ TypeName()

TypeName ( "sixDoFRigidBodyMotionConstraint"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
sixDoFRigidBodyMotionConstraint  ,
dictionary  ,
(const word &name, const dictionary &sDoFRBMCDict, const sixDoFRigidBodyMotion &motion)  ,
(name, sDoFRBMCDict, motion)   
)

◆ clone()

virtual autoPtr<sixDoFRigidBodyMotionConstraint> clone ( ) const
pure virtual

Construct and return a clone.

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

◆ New()

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 31 of file sixDoFRigidBodyMotionConstraintNew.C.

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

Referenced by sixDoFRigidBodyMotion::addConstraints().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ name()

const word& name ( ) const
inline

Return the name.

Definition at line 136 of file sixDoFRigidBodyMotionConstraint.H.

References sixDoFRigidBodyMotionConstraint::name_.

Referenced by sixDoFRigidBodyMotionConstraint::New().

Here is the caller graph for this function:

◆ setCentreOfRotation()

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.

◆ constrainTranslation()

virtual void constrainTranslation ( pointConstraint &  ) const
pure virtual

Apply and accumulate translational constraints.

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

◆ constrainRotation()

virtual void constrainRotation ( pointConstraint &  ) const
pure virtual

Apply and accumulate rotational constraints.

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

◆ read()

bool read ( const dictionary &  sDoFRBMCDict)
virtual

Update properties from given dictionary.

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

Definition at line 60 of file sixDoFRigidBodyMotionConstraint.C.

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

Here is the caller graph for this function:

◆ coeffDict()

const dictionary& coeffDict ( ) const
inline

Definition at line 157 of file sixDoFRigidBodyMotionConstraint.H.

References sixDoFRigidBodyMotionConstraint::sDoFRBMCCoeffs_.

◆ write()

void write ( Ostream &  os) const
virtual

Write.

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

Definition at line 71 of file sixDoFRigidBodyMotionConstraint.C.

Member Data Documentation

◆ name_

word name_
protected

Name of the constraint.

Definition at line 73 of file sixDoFRigidBodyMotionConstraint.H.

Referenced by sixDoFRigidBodyMotionConstraint::name().

◆ sDoFRBMCCoeffs_

dictionary sDoFRBMCCoeffs_
protected

Constraint model specific coefficient dictionary.

Definition at line 76 of file sixDoFRigidBodyMotionConstraint.H.

Referenced by sixDoFRigidBodyMotionConstraint::coeffDict().

◆ motion_

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: