sixDoFRigidBodyMotionRestraint Class Reference

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

#include <forces/sixDoFRigidBodyMotionRestraint.H>

---

Detailed Description

Base class for defining restraints for sixDoF motions.

Source files

• src/postProcessing/functionObjects/forces/pointPatchFields/derived/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionRestraint/sixDoFRigidBodyMotionRestraint/sixDoFRigidBodyMotionRestraint.H
• src/postProcessing/functionObjects/forces/pointPatchFields/derived/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionRestraint/sixDoFRigidBodyMotionRestraint/sixDoFRigidBodyMotionRestraint.C
• src/postProcessing/functionObjects/forces/pointPatchFields/derived/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionRestraint/sixDoFRigidBodyMotionRestraint/newDynamicFvMesh.C

Definition at line 64 of file sixDoFRigidBodyMotionRestraint.H.

Inheritance diagram for sixDoFRigidBodyMotionRestraint:

Collaboration diagram for sixDoFRigidBodyMotionRestraint:

List of all members.

Public Member Functions
	TypeName ("sixDoFRigidBodyMotionRestraint")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, sixDoFRigidBodyMotionRestraint, dictionary,(const dictionary &sDoFRBMRDict),(sDoFRBMRDict))
	sixDoFRigidBodyMotionRestraint (const dictionary &sDoFRBMRDict)
	Construct from the sDoFRBMRDict dictionary and Time.
virtual autoPtr < sixDoFRigidBodyMotionRestraint >	clone () const =0
	Construct and return a clone.
virtual	~sixDoFRigidBodyMotionRestraint ()
virtual void	restrain (const sixDoFRigidBodyMotion &motion, vector &restraintPosition, vector &restraintForce, vector &restraintMoment) const =0
	Calculate the restraint position, force and moment.
virtual bool	read (const dictionary &sDoFRBMRDict)
	Update properties from given dictionary.
const dictionary &	coeffDict () const
virtual void	write (Ostream &) const =0
	Write.
Static Public Member Functions
static autoPtr < sixDoFRigidBodyMotionRestraint >	New (const dictionary &sDoFRBMRDict)
	Select constructed from the sDoFRBMRDict dictionary and Time.
Protected Attributes
dictionary	sDoFRBMRCoeffs_
	Restraint model specific coefficient dictionary.

---

Constructor & Destructor Documentation

sixDoFRigidBodyMotionRestraint

(

const dictionary &

sDoFRBMRDict  )

Construct from the sDoFRBMRDict dictionary and Time.

Definition at line 37 of file sixDoFRigidBodyMotionRestraint.C.

~sixDoFRigidBodyMotionRestraint

(

)

[virtual]

Definition at line 54 of file sixDoFRigidBodyMotionRestraint.C.

---

Member Function Documentation

TypeName

(

"sixDoFRigidBodyMotionRestraint"

)

Runtime type information.

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

virtual autoPtr<sixDoFRigidBodyMotionRestraint> clone

(

)

const [pure virtual]

Construct and return a clone.

Implemented in linearAxialAngularSpring, linearSpring, sphericalAngularSpring, and tabulatedAxialAngularSpring.

Foam::autoPtr< Foam::sixDoFRigidBodyMotionRestraint > New

(

const dictionary &

sDoFRBMRDict  )

[static]

Select constructed from the sDoFRBMRDict dictionary and Time.

Definition at line 31 of file newSixDoFRigidBodyMotionRestraint.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, and dictionary::lookup().

Referenced by sixDoFRigidBodyMotion::addRestraints().

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

Calculate the restraint position, force and moment.

Global reference frame vectors.

Implemented in linearAxialAngularSpring, linearSpring, sphericalAngularSpring, and tabulatedAxialAngularSpring.

bool read

(

const dictionary &

sDoFRBMRDict  )

[virtual]

Update properties from given dictionary.

Reimplemented in linearAxialAngularSpring, linearSpring, sphericalAngularSpring, and tabulatedAxialAngularSpring.

Definition at line 61 of file sixDoFRigidBodyMotionRestraint.C.

References dictionary::subDict(), and Foam::type().

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

const dictionary& coeffDict

(

)

const [inline]

Definition at line 137 of file sixDoFRigidBodyMotionRestraint.H.

References sixDoFRigidBodyMotionRestraint::sDoFRBMRCoeffs_.

virtual void write

(

Ostream &

)

const [pure virtual]

Write.

Implemented in linearAxialAngularSpring, linearSpring, sphericalAngularSpring, and tabulatedAxialAngularSpring.

---

Member Data Documentation

dictionary sDoFRBMRCoeffs_ [protected]

Restraint model specific coefficient dictionary.

Definition at line 72 of file sixDoFRigidBodyMotionRestraint.H.

Referenced by sixDoFRigidBodyMotionRestraint::coeffDict().

---

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

• src/postProcessing/functionObjects/forces/pointPatchFields/derived/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionRestraint/sixDoFRigidBodyMotionRestraint/sixDoFRigidBodyMotionRestraint.H
• src/postProcessing/functionObjects/forces/pointPatchFields/derived/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionRestraint/sixDoFRigidBodyMotionRestraint/newSixDoFRigidBodyMotionRestraint.C
• src/postProcessing/functionObjects/forces/pointPatchFields/derived/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionRestraint/sixDoFRigidBodyMotionRestraint/sixDoFRigidBodyMotionRestraint.C