sixDoFRigidBodyMotionRestraint Class Reference

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

Inheritance diagram for sixDoFRigidBodyMotionRestraint:

Collaboration diagram for sixDoFRigidBodyMotionRestraint:

Public Member Functions
	TypeName ("sixDoFRigidBodyMotionRestraint")
	declareRunTimeSelectionTable (autoPtr, sixDoFRigidBodyMotionRestraint, dictionary,(const word &name, const dictionary &sDoFRBMRDict),(name, sDoFRBMRDict))
	sixDoFRigidBodyMotionRestraint (const word &name, const dictionary &sDoFRBMRDict)
virtual autoPtr< sixDoFRigidBodyMotionRestraint >	clone () const =0
virtual	~sixDoFRigidBodyMotionRestraint ()
const word &	name () const
virtual void	restrain (const sixDoFRigidBodyMotion &motion, vector &restraintPosition, vector &restraintForce, vector &restraintMoment) const =0
virtual bool	read (const dictionary &sDoFRBMRDict)
const dictionary &	coeffDict () const
virtual void	write (Ostream &) const =0

Static Public Member Functions
static autoPtr< sixDoFRigidBodyMotionRestraint >	New (const word &name, const dictionary &sDoFRBMRDict)

Protected Attributes
word	name_
dictionary	sDoFRBMRCoeffs_

Detailed Description

Base class for defining restraints for sixDoF motions.

Source files

• sixDoFRigidBodyMotionRestraint.H
• sixDoFRigidBodyMotionRestraint.C
• sixDoFRigidBodyMotionRestraintNew.C

Definition at line 63 of file sixDoFRigidBodyMotionRestraint.H.

Constructor & Destructor Documentation

sixDoFRigidBodyMotionRestraint()

sixDoFRigidBodyMotionRestraint	(	const word &	name,
		const dictionary &	sDoFRBMRDict
	)

Definition at line 35 of file sixDoFRigidBodyMotionRestraint.C.

~sixDoFRigidBodyMotionRestraint()

~sixDoFRigidBodyMotionRestraint ( )

virtual

Definition at line 47 of file sixDoFRigidBodyMotionRestraint.C.

Member Function Documentation

TypeName()

TypeName

(

"sixDoFRigidBodyMotionRestraint"

)

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		sixDoFRigidBodyMotionRestraint	,
		dictionary	,
		(const word &name, const dictionary &sDoFRBMRDict)	,
		(name, sDoFRBMRDict)
	)

clone()

virtual autoPtr<sixDoFRigidBodyMotionRestraint> clone ( ) const

pure virtual

Implemented in linearSpringDamper, tabulatedAxialAngularSpring, linearSpring, linearAxialAngularSpring, sphericalAngularSpring, linearDamper, and sphericalAngularDamper.

New()

Foam::autoPtr< Foam::sixDoFRigidBodyMotionRestraint > New ( const word &  name, const dictionary &  sDoFRBMRDict  )

static

Definition at line 28 of file sixDoFRigidBodyMotionRestraintNew.C.

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

Referenced by sixDoFRigidBodyMotion::addRestraints().

Here is the call graph for this function:

Here is the caller graph for this function:

name()

const word& name ( ) const

inline

Definition at line 125 of file sixDoFRigidBodyMotionRestraint.H.

References sixDoFRigidBodyMotionRestraint::name_.

restrain()

virtual void restrain ( const sixDoFRigidBodyMotion &  motion, vector &  restraintPosition, vector &  restraintForce, vector &  restraintMoment  ) const

pure virtual

Implemented in linearSpringDamper, tabulatedAxialAngularSpring, linearSpring, linearAxialAngularSpring, sphericalAngularSpring, linearDamper, and sphericalAngularDamper.

read()

bool read ( const dictionary &  sDoFRBMRDict )

virtual

Reimplemented in linearSpringDamper, tabulatedAxialAngularSpring, linearSpring, linearAxialAngularSpring, sphericalAngularSpring, linearDamper, and sphericalAngularDamper.

Definition at line 54 of file sixDoFRigidBodyMotionRestraint.C.

Referenced by sphericalAngularDamper::read(), linearDamper::read(), sphericalAngularSpring::read(), linearAxialAngularSpring::read(), linearSpring::read(), tabulatedAxialAngularSpring::read(), and linearSpringDamper::read().

Here is the caller graph for this function:

coeffDict()

const dictionary& coeffDict ( ) const

inline

Definition at line 146 of file sixDoFRigidBodyMotionRestraint.H.

References sixDoFRigidBodyMotionRestraint::sDoFRBMRCoeffs_.

write()

virtual void write ( Ostream &  ) const

pure virtual

Implemented in linearSpringDamper, tabulatedAxialAngularSpring, linearSpring, linearAxialAngularSpring, sphericalAngularSpring, linearDamper, and sphericalAngularDamper.

Member Data Documentation

name_

word name_

protected

Definition at line 71 of file sixDoFRigidBodyMotionRestraint.H.

Referenced by sixDoFRigidBodyMotionRestraint::name().

sDoFRBMRCoeffs_

dictionary sDoFRBMRCoeffs_

protected

Definition at line 74 of file sixDoFRigidBodyMotionRestraint.H.

Referenced by sixDoFRigidBodyMotionRestraint::coeffDict().

---

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

• src/sixDoFRigidBodyMotion/sixDoFRigidBodyMotion/restraints/sixDoFRigidBodyMotionRestraint/sixDoFRigidBodyMotionRestraint.H
• src/sixDoFRigidBodyMotion/sixDoFRigidBodyMotion/restraints/sixDoFRigidBodyMotionRestraint/sixDoFRigidBodyMotionRestraint.C
• src/sixDoFRigidBodyMotion/sixDoFRigidBodyMotion/restraints/sixDoFRigidBodyMotionRestraint/sixDoFRigidBodyMotionRestraintNew.C