Public Member Functions | List of all members
line Class Reference

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

Inheritance diagram for line:
[legend]
Collaboration diagram for line:
[legend]

Public Member Functions

 TypeName ("line")
 Runtime type information. More...
 
 line (const word &name, const dictionary &sDoFRBMCDict, const sixDoFRigidBodyMotion &motion)
 Construct from components. More...
 
virtual autoPtr< sixDoFRigidBodyMotionConstraint > clone () const
 Construct and return a clone. More...
 
virtual ~line ()
 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 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from sixDoFRigidBodyMotionConstraint
static autoPtr< sixDoFRigidBodyMotionConstraint > New (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 sixDoFRigidBodyMotion & motion_
 Reference to the body motion. More...
 

Detailed Description

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

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

Source files

Definition at line 57 of file sixDoFRigidBodyMotionLineConstraint.H.

Constructor & Destructor Documentation

◆ line()

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

Construct from components.

Definition at line 53 of file sixDoFRigidBodyMotionLineConstraint.C.

References Foam::name(), and line::read().

Here is the call graph for this function:

◆ ~line()

~line ( )
virtual

Destructor.

Definition at line 68 of file sixDoFRigidBodyMotionLineConstraint.C.

Member Function Documentation

◆ TypeName()

TypeName ( "line"  )

Runtime type information.

◆ clone()

virtual autoPtr< sixDoFRigidBodyMotionConstraint > clone ( ) const
inlinevirtual

Construct and return a clone.

Implements sixDoFRigidBodyMotionConstraint.

Definition at line 87 of file sixDoFRigidBodyMotionLineConstraint.H.

◆ setCentreOfRotation()

void setCentreOfRotation ( point &  CofR) const
virtual

Set the centre of rotation to the projection of the.

centre of mass onto the line

Definition at line 74 of file sixDoFRigidBodyMotionLineConstraint.C.

◆ constrainTranslation()

void constrainTranslation ( pointConstraint &  pc) const
virtual

Apply and accumulate translational constraints.

Implements sixDoFRigidBodyMotionConstraint.

Definition at line 83 of file sixDoFRigidBodyMotionLineConstraint.C.

References pointConstraint::combine().

Here is the call graph for this function:

◆ constrainRotation()

void constrainRotation ( pointConstraint &  pc) const
virtual

Apply and accumulate rotational constraints.

Implements sixDoFRigidBodyMotionConstraint.

Definition at line 92 of file sixDoFRigidBodyMotionLineConstraint.C.

◆ read()

bool read ( const dictionary &  sDoFRBMCCoeff)
virtual

Update properties from given dictionary.

Reimplemented from sixDoFRigidBodyMotionConstraint.

Definition at line 99 of file sixDoFRigidBodyMotionLineConstraint.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::mag(), and kEpsilonLopesdaCosta< BasicTurbulenceModel >::read().

Referenced by line::line().

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 131 of file sixDoFRigidBodyMotionLineConstraint.C.

References os().

Here is the call graph for this function:
The documentation for this class was generated from the following files: