Loading...
Searching...
No Matches
sixDoFRigidBodyMotionConstraint Class Referenceabstract

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

#include <sixDoFRigidBodyMotionConstraint.H>

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

Public Member Functions

 TypeName ("sixDoFRigidBodyMotionConstraint")
 Runtime type information.
 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.
virtual autoPtr< sixDoFRigidBodyMotionConstraint > clone () const =0
 Construct and return a clone.
virtual ~sixDoFRigidBodyMotionConstraint ()
 Destructor.
const word & name () const
 Return the name.
virtual void setCentreOfRotation (point &) const
 Set the centre of rotation if not the centre of mass.
virtual void constrainTranslation (pointConstraint &) const =0
 Apply and accumulate translational constraints.
virtual void constrainRotation (pointConstraint &) const =0
 Apply and accumulate rotational constraints.
virtual bool read (const dictionary &sDoFRBMCDict)
 Update properties from given dictionary.
const dictionary & coeffDict () const
const sixDoFRigidBodyMotion & motion () const noexcept
 Return const access to motion.
virtual void write (Ostream &) const
 Write.

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.

Protected Attributes

word name_
 Name of the constraint.
dictionary sDoFRBMCCoeffs_
 Constraint model specific coefficient dictionary.
const sixDoFRigidBodyMotion & motion_
 Reference to the body motion.

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 34 of file sixDoFRigidBodyMotionConstraint.C.

References motion(), motion_, name(), name_, and sDoFRBMCCoeffs_.

Referenced by axis::axis(), declareRunTimeSelectionTable(), line::line(), axis::operator=(), orientation::orientation(), plane::plane(), and point::point().

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

◆ ~sixDoFRigidBodyMotionConstraint()

~sixDoFRigidBodyMotionConstraint ( )
virtual

Destructor.

Definition at line 49 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)  )

References motion(), name(), and sixDoFRigidBodyMotionConstraint().

Here is the call graph for this function:

◆ clone()

virtual autoPtr< sixDoFRigidBodyMotionConstraint > clone ( ) const
pure virtual

Construct and return a clone.

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

References motion(), and name().

Here is the call graph for this function:

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

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, motion(), and name().

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 154 of file sixDoFRigidBodyMotionConstraint.H.

References name_.

Referenced by axis::axis(), clone(), declareRunTimeSelectionTable(), line::line(), New(), orientation::orientation(), plane::plane(), point::point(), sixDoFRigidBodyMotionConstraint(), axis::TypeName(), line::TypeName(), orientation::TypeName(), plane::TypeName(), and point::TypeName().

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 162 of file sixDoFRigidBodyMotionConstraint.H.

◆ constrainTranslation()

virtual void constrainTranslation ( pointConstraint & ) const
pure virtual

Apply and accumulate translational constraints.

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

◆ constrainRotation()

virtual void constrainRotation ( pointConstraint & ) const
pure virtual

Apply and accumulate rotational constraints.

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

◆ read()

bool read ( const dictionary & sDoFRBMCDict)
virtual

Update properties from given dictionary.

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

Definition at line 55 of file sixDoFRigidBodyMotionConstraint.C.

References sDoFRBMCCoeffs_.

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 183 of file sixDoFRigidBodyMotionConstraint.H.

References sDoFRBMCCoeffs_.

◆ motion()

const sixDoFRigidBodyMotion & motion ( ) const
inlinenoexcept

Return const access to motion.

Definition at line 191 of file sixDoFRigidBodyMotionConstraint.H.

References motion_, and Foam::noexcept.

Referenced by axis::axis(), clone(), axis::constrainRotation(), declareRunTimeSelectionTable(), line::line(), New(), orientation::orientation(), plane::plane(), point::point(), axis::read(), sixDoFRigidBodyMotionConstraint(), axis::TypeName(), line::TypeName(), orientation::TypeName(), plane::TypeName(), and point::TypeName().

Here is the caller graph for this function:

◆ write()

void write ( Ostream & os) const
virtual

Write.

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

Definition at line 66 of file sixDoFRigidBodyMotionConstraint.C.

References os().

Here is the call graph for this function:

Member Data Documentation

◆ name_

word name_
protected

Name of the constraint.

Definition at line 75 of file sixDoFRigidBodyMotionConstraint.H.

Referenced by name(), and sixDoFRigidBodyMotionConstraint().

◆ sDoFRBMCCoeffs_

dictionary sDoFRBMCCoeffs_
protected

Constraint model specific coefficient dictionary.

Definition at line 80 of file sixDoFRigidBodyMotionConstraint.H.

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

◆ motion_

const sixDoFRigidBodyMotion& motion_
protected

Reference to the body motion.

Definition at line 85 of file sixDoFRigidBodyMotionConstraint.H.

Referenced by motion(), line::read(), plane::read(), point::read(), and sixDoFRigidBodyMotionConstraint().

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