plane Class Reference

Translation constraint on the centre of rotation: may only move on a plane. More...

Inheritance diagram for plane:
Collaboration diagram for plane:

Public Member Functions

 TypeName ("plane")
 Runtime type information. More...
 
 plane (const word &name, const dictionary &sDoFRBMCDict, const sixDoFRigidBodyMotion &motion)
 Construct from components. More...
 
virtual autoPtr< sixDoFRigidBodyMotionConstraintclone () const
 Construct and return a clone. More...
 
virtual ~plane ()
 Destructor. More...
 
virtual void setCentreOfRotation (point &) const
 Set the centre of rotation to the projection of the. More...
 
virtual void constrainTranslation (pointConstraint &) const
 Apply and accumulate translational constraints. More...
 
virtual void constrainRotation (pointConstraint &) const
 Apply and accumulate rotational constraints. More...
 
virtual bool read (const dictionary &sDoFRBMCCoeff)
 Update properties from given dictionary. More...
 
virtual void write (Ostream &) const
 Write. More...
 
- Public Member Functions inherited from sixDoFRigidBodyMotionConstraint
 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 ~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...
 
const dictionarycoeffDict () const
 

Additional Inherited Members

- Static Public Member Functions inherited from sixDoFRigidBodyMotionConstraint
static autoPtr< sixDoFRigidBodyMotionConstraintNew (const word &name, const dictionary &sDoFRBMCDict, const sixDoFRigidBodyMotion &motion)
 Select constructed from the sDoFRBMCDict dictionary and Time. More...
 
- Protected Attributes inherited from sixDoFRigidBodyMotionConstraint
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

Translation constraint on the centre of rotation: may only move on a plane.

If 'centreOfRotation' is not provided in the dictionary the centre of mass is used.

Source files

Definition at line 55 of file sixDoFRigidBodyMotionPlaneConstraint.H.

Constructor & Destructor Documentation

◆ plane()

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

Construct from components.

Definition at line 51 of file sixDoFRigidBodyMotionPlaneConstraint.C.

References Foam::read().

Referenced by plane::clone().

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

◆ ~plane()

~plane ( )
virtual

Destructor.

Definition at line 65 of file sixDoFRigidBodyMotionPlaneConstraint.C.

References plane::setCentreOfRotation().

Referenced by plane::clone().

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

Member Function Documentation

◆ TypeName()

TypeName ( "plane"  )

Runtime type information.

◆ clone()

virtual autoPtr<sixDoFRigidBodyMotionConstraint> clone ( ) const
inlinevirtual

Construct and return a clone.

Implements sixDoFRigidBodyMotionConstraint.

Definition at line 85 of file sixDoFRigidBodyMotionPlaneConstraint.H.

References plane::constrainRotation(), plane::constrainTranslation(), plane::plane(), plane::read(), plane::setCentreOfRotation(), plane::write(), and plane::~plane().

Here is the call graph for this function:

◆ setCentreOfRotation()

void setCentreOfRotation ( point CofR) const
virtual

Set the centre of rotation to the projection of the.

centre of mass onto the plane

Definition at line 72 of file sixDoFRigidBodyMotionPlaneConstraint.C.

References plane::constrainTranslation().

Referenced by plane::clone(), and plane::~plane().

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

◆ constrainTranslation()

void constrainTranslation ( pointConstraint pc) const
virtual

Apply and accumulate translational constraints.

Implements sixDoFRigidBodyMotionConstraint.

Definition at line 81 of file sixDoFRigidBodyMotionPlaneConstraint.C.

References pointConstraint::applyConstraint(), and plane::constrainRotation().

Referenced by plane::clone(), and plane::setCentreOfRotation().

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

◆ constrainRotation()

void constrainRotation ( pointConstraint pc) const
virtual

Apply and accumulate rotational constraints.

Implements sixDoFRigidBodyMotionConstraint.

Definition at line 90 of file sixDoFRigidBodyMotionPlaneConstraint.C.

References plane::read().

Referenced by plane::clone(), and plane::constrainTranslation().

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

◆ read()

bool read ( const dictionary sDoFRBMCCoeff)
virtual

Update properties from given dictionary.

Reimplemented from sixDoFRigidBodyMotionConstraint.

Definition at line 97 of file sixDoFRigidBodyMotionPlaneConstraint.C.

References sixDoFRigidBodyMotionConstraint::read(), and plane::write().

Referenced by plane::clone(), and plane::constrainRotation().

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

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented from sixDoFRigidBodyMotionConstraint.

Definition at line 116 of file sixDoFRigidBodyMotionPlaneConstraint.C.

References Foam::writeEntry().

Referenced by plane::clone(), and plane::read().

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

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