solidBodyMotionFunction Class Reference

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

#include <dynamicFvMesh/solidBodyMotionFunction.H>

---

Detailed Description

Base class for defining solid-body motions.

Source files

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

Definition at line 60 of file solidBodyMotionFunction.H.

Inheritance diagram for solidBodyMotionFunction:

Collaboration diagram for solidBodyMotionFunction:

List of all members.

Public Member Functions
	TypeName ("solidBodyMotionFunction")
	Runtime type information.
	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.
virtual	~solidBodyMotionFunction ()
virtual septernion	transformation () const =0
	Return the solid-body motion transformation septernion.
virtual bool	read (const dictionary &SBMFCoeffs)=0
	Update properties from given dictionary.
Static Public Member Functions
static autoPtr < solidBodyMotionFunction >	New (const dictionary &SBMFCoeffs, const Time &runTime)
	Select constructed from the SBMFCoeffs dictionary and Time.
Protected Attributes
dictionary	SBMFCoeffs_
const Time &	time_

---

Constructor & Destructor Documentation

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

Construct from the SBMFCoeffs dictionary and Time.

Definition at line 37 of file solidBodyMotionFunction.C.

~solidBodyMotionFunction

(

)

[virtual]

Definition at line 55 of file solidBodyMotionFunction.C.

---

Member Function Documentation

TypeName

(

"solidBodyMotionFunction"

)

Runtime type information.

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

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 newSolidBodyMotionFunction.C.

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

virtual septernion transformation

(

)

const [pure virtual]

Return the solid-body motion transformation septernion.

Implemented in SDA, and SKA.

bool read

(

const dictionary &

SBMFCoeffs  )

[pure virtual]

Update properties from given dictionary.

Implemented in SDA, and SKA.

Definition at line 61 of file solidBodyMotionFunction.C.

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

Referenced by SKA::read(), and SDA::read().

---

Member Data Documentation

dictionary SBMFCoeffs_ [protected]

Definition at line 66 of file solidBodyMotionFunction.H.

const Time& time_ [protected]

Definition at line 67 of file solidBodyMotionFunction.H.

---

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

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