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")
	plane (const word &name, const dictionary &sDoFRBMCDict, const sixDoFRigidBodyMotion &motion)
virtual autoPtr< sixDoFRigidBodyMotionConstraint >	clone () const
virtual	~plane ()
virtual void	setCentreOfRotation (point &) const
virtual void	constrainTranslation (pointConstraint &) const
virtual void	constrainRotation (pointConstraint &) const
virtual bool	read (const dictionary &sDoFRBMCCoeff)
virtual void	write (Ostream &) const
Public Member Functions inherited from sixDoFRigidBodyMotionConstraint
	TypeName ("sixDoFRigidBodyMotionConstraint")
	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)
virtual	~sixDoFRigidBodyMotionConstraint ()
const word &	name () const
virtual void	setCentreOfRotation (point &) const
const dictionary &	coeffDict () const

Additional Inherited Members
Static Public Member Functions inherited from sixDoFRigidBodyMotionConstraint
static autoPtr< sixDoFRigidBodyMotionConstraint >	New (const word &name, const dictionary &sDoFRBMCDict, const sixDoFRigidBodyMotion &motion)
Protected Attributes inherited from sixDoFRigidBodyMotionConstraint
word	name_
dictionary	sDoFRBMCCoeffs_
const sixDoFRigidBodyMotion &	motion_

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

• sixDoFRigidBodyMotionPlaneConstraint.H
• sixDoFRigidBodyMotionPlaneConstraint.C

Definition at line 53 of file sixDoFRigidBodyMotionPlaneConstraint.H.

Constructor & Destructor Documentation

plane()

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

Definition at line 47 of file sixDoFRigidBodyMotionPlaneConstraint.C.

References Foam::blockMeshTools::read().

Referenced by plane::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

~plane()

~plane ( )

virtual

Definition at line 61 of file sixDoFRigidBodyMotionPlaneConstraint.C.

Member Function Documentation

TypeName()

TypeName

(

"plane"

)

clone()

virtual autoPtr<sixDoFRigidBodyMotionConstraint> clone ( ) const

inlinevirtual

Implements sixDoFRigidBodyMotionConstraint.

Definition at line 83 of file sixDoFRigidBodyMotionPlaneConstraint.H.

References plane::plane().

Here is the call graph for this function:

setCentreOfRotation()

void setCentreOfRotation ( point &  CofR ) const

virtual

Definition at line 68 of file sixDoFRigidBodyMotionPlaneConstraint.C.

constrainTranslation()

void constrainTranslation ( pointConstraint &  pc ) const

virtual

Implements sixDoFRigidBodyMotionConstraint.

Definition at line 77 of file sixDoFRigidBodyMotionPlaneConstraint.C.

References pointConstraint::applyConstraint().

Here is the call graph for this function:

constrainRotation()

void constrainRotation ( pointConstraint &  pc ) const

virtual

Implements sixDoFRigidBodyMotionConstraint.

Definition at line 86 of file sixDoFRigidBodyMotionPlaneConstraint.C.

read()

bool read ( const dictionary &  sDoFRBMCCoeff )

virtual

Reimplemented from sixDoFRigidBodyMotionConstraint.

Definition at line 93 of file sixDoFRigidBodyMotionPlaneConstraint.C.

References sixDoFRigidBodyMotionConstraint::read().

Here is the call graph for this function:

write()

void write ( Ostream &  os ) const

virtual

Reimplemented from sixDoFRigidBodyMotionConstraint.

Definition at line 112 of file sixDoFRigidBodyMotionPlaneConstraint.C.

References os().

Here is the call graph for this function:

---

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

• src/sixDoFRigidBodyMotion/sixDoFRigidBodyMotion/constraints/plane/sixDoFRigidBodyMotionPlaneConstraint.H
• src/sixDoFRigidBodyMotion/sixDoFRigidBodyMotion/constraints/plane/sixDoFRigidBodyMotionPlaneConstraint.C