solidBodyMotionFunction Class Reference

Base class for defining solid-body motions. More...

Inheritance diagram for solidBodyMotionFunction:

Collaboration diagram for solidBodyMotionFunction:

Public Member Functions
	TypeName ("solidBodyMotionFunction")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, solidBodyMotionFunction, dictionary,(const dictionary &SBMFCoeffs, const Time &runTime),(SBMFCoeffs, runTime))
	solidBodyMotionFunction (const dictionary &SBMFCoeffs, const Time &runTime)
	Construct from the SBMFCoeffs dictionary and Time. More...
virtual autoPtr< solidBodyMotionFunction >	clone () const =0
	Construct and return a clone. More...
virtual	~solidBodyMotionFunction ()
	Destructor. More...
virtual septernion	transformation () const =0
	Return the solid-body motion transformation septernion. More...
virtual bool	read (const dictionary &SBMFCoeffs)=0
	Update properties from given dictionary. More...
virtual void	writeData (Ostream &) const
	Write in dictionary format. More...

Static Public Member Functions
static autoPtr< solidBodyMotionFunction >	New (const dictionary &SBMFCoeffs, const Time &runTime)
	Select constructed from the SBMFCoeffs dictionary and Time. More...

Protected Attributes
dictionary	SBMFCoeffs_
const Time &	time_

Detailed Description

Base class for defining solid-body motions.

Source files

• solidBodyMotionFunction.H
• solidBodyMotionFunction.C
• dynamicFvMeshNew.C

Definition at line 60 of file solidBodyMotionFunction.H.

Constructor & Destructor Documentation

solidBodyMotionFunction	(	const dictionary &	SBMFCoeffs,
		const Time &	runTime
	)

Construct from the SBMFCoeffs dictionary and Time.

Definition at line 40 of file solidBodyMotionFunction.C.

~solidBodyMotionFunction ( )

virtual

Destructor.

Definition at line 58 of file solidBodyMotionFunction.C.

Member Function Documentation

TypeName

(

"solidBodyMotionFunction"

)

Runtime type information.

declareRunTimeSelectionTable	(	autoPtr	,
		solidBodyMotionFunction	,
		dictionary	,
		(const dictionary &SBMFCoeffs, const Time &runTime)	,
		(SBMFCoeffs, runTime)
	)

virtual autoPtr<solidBodyMotionFunction> clone ( ) const

pure virtual

Construct and return a clone.

Implemented in SDA, tabulated6DoFMotion, rotatingMotion, oscillatingRotatingMotion, axisRotationMotion, oscillatingLinearMotion, linearMotion, and multiMotion.

Foam::autoPtr< Foam::solidBodyMotionFunction > New ( const dictionary &  SBMFCoeffs, const Time &  runTime  )

static

Select constructed from the SBMFCoeffs dictionary and Time.

Definition at line 31 of file solidBodyMotionFunctionNew.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, dictionary::lookup(), and Foam::nl.

Referenced by multiSolidBodyMotionFvMesh::multiSolidBodyMotionFvMesh(), and multiMotion::read().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual septernion transformation ( ) const

pure virtual

Return the solid-body motion transformation septernion.

Implemented in SDA, tabulated6DoFMotion, rotatingMotion, oscillatingRotatingMotion, axisRotationMotion, oscillatingLinearMotion, linearMotion, and multiMotion.

bool read ( const dictionary &  SBMFCoeffs )

pure virtual

Update properties from given dictionary.

Implemented in SDA, tabulated6DoFMotion, rotatingMotion, oscillatingRotatingMotion, axisRotationMotion, oscillatingLinearMotion, linearMotion, and multiMotion.

Definition at line 64 of file solidBodyMotionFunction.C.

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

Referenced by linearMotion::read(), multiMotion::read(), oscillatingLinearMotion::read(), axisRotationMotion::read(), oscillatingRotatingMotion::read(), rotatingMotion::read(), tabulated6DoFMotion::read(), and SDA::read().

Here is the call graph for this function:

Here is the caller graph for this function:

void writeData ( Ostream &  os ) const

virtual

Write in dictionary format.

Definition at line 72 of file solidBodyMotionFunction.C.

Member Data Documentation

dictionary SBMFCoeffs_

protected

Definition at line 66 of file solidBodyMotionFunction.H.

Referenced by linearMotion::clone(), multiMotion::clone(), oscillatingLinearMotion::clone(), axisRotationMotion::clone(), oscillatingRotatingMotion::clone(), rotatingMotion::clone(), tabulated6DoFMotion::clone(), and SDA::clone().

const Time& time_

protected

Definition at line 67 of file solidBodyMotionFunction.H.

Referenced by linearMotion::clone(), multiMotion::clone(), oscillatingLinearMotion::clone(), axisRotationMotion::clone(), oscillatingRotatingMotion::clone(), rotatingMotion::clone(), tabulated6DoFMotion::clone(), and SDA::clone().

---

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

• src/dynamicFvMesh/solidBodyMotionFvMesh/solidBodyMotionFunctions/solidBodyMotionFunction/solidBodyMotionFunction.H
• src/dynamicFvMesh/solidBodyMotionFvMesh/solidBodyMotionFunctions/solidBodyMotionFunction/solidBodyMotionFunction.C
• src/dynamicFvMesh/solidBodyMotionFvMesh/solidBodyMotionFunctions/solidBodyMotionFunction/solidBodyMotionFunctionNew.C