tabulated6DoFMotion Class Reference

Tabulated 6DoF motion function. More...

Inheritance diagram for tabulated6DoFMotion:

Collaboration diagram for tabulated6DoFMotion:

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

Private Types
typedef Vector2D< vector >	translationRotationVectors
	Type used to read in the translation and rotation "vectors". More...

Private Member Functions
	tabulated6DoFMotion (const tabulated6DoFMotion &)
	Disallow copy construct. More...
void	operator= (const tabulated6DoFMotion &)
	Disallow default bitwise assignment. More...

Private Attributes
fileName	timeDataFileName_
	Time data file name read from dictionary. More...
vector	CofG_
	Center of gravity read from dictionary. More...
scalarField	times_
	Field of times. More...
Field< translationRotationVectors >	values_
	Field of translation and rotation "vectors". More...

Additional Inherited Members
Static Public Member Functions inherited from solidBodyMotionFunction
static autoPtr< solidBodyMotionFunction >	New (const dictionary &SBMFCoeffs, const Time &runTime)
	Select constructed from the SBMFCoeffs dictionary and Time. More...
Protected Attributes inherited from solidBodyMotionFunction
dictionary	SBMFCoeffs_
const Time &	time_

Detailed Description

Tabulated 6DoF motion function.

Obtained by interpolating tabulated data for surge (x-translation), sway (y-translation), heave (z-translation), roll (rotation about x), pitch (rotation about y) and yaw (rotation about z).

Source files

• tabulated6DoFMotion.H
• tabulated6DoFMotion.C

Definition at line 56 of file tabulated6DoFMotion.H.

Member Typedef Documentation

translationRotationVectors

typedef Vector2D<vector> translationRotationVectors

private

Type used to read in the translation and rotation "vectors".

Definition at line 69 of file tabulated6DoFMotion.H.

Constructor & Destructor Documentation

tabulated6DoFMotion() [1/2]

tabulated6DoFMotion ( const tabulated6DoFMotion &  )

private

Disallow copy construct.

tabulated6DoFMotion() [2/2]

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

Construct from components.

Definition at line 55 of file tabulated6DoFMotion.C.

References Foam::read().

Here is the call graph for this function:

~tabulated6DoFMotion()

~tabulated6DoFMotion ( )

virtual

Destructor.

Definition at line 68 of file tabulated6DoFMotion.C.

Member Function Documentation

operator=()

void operator= ( const tabulated6DoFMotion &  )

private

Disallow default bitwise assignment.

TypeName()

TypeName

(

"tabulated6DoFMotion"

)

Runtime type information.

clone()

virtual autoPtr<solidBodyMotionFunction> clone ( ) const

inlinevirtual

Construct and return a clone.

Implements solidBodyMotionFunction.

Definition at line 103 of file tabulated6DoFMotion.H.

References solidBodyMotionFunction::SBMFCoeffs_, and solidBodyMotionFunction::time_.

transformation()

Foam::septernion transformation ( ) const

virtual

Return the solid-body motion transformation septernion.

Implements solidBodyMotionFunction.

Definition at line 75 of file tabulated6DoFMotion.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, Foam::interpolateSplineXY(), Foam::constant::mathematical::pi(), R, x, and y.

Here is the call graph for this function:

read()

bool read ( const dictionary &  SBMFCoeffs )

virtual

Update properties from given dictionary.

Implements solidBodyMotionFunction.

Definition at line 118 of file tabulated6DoFMotion.C.

References Foam::exit(), string::expand(), Foam::FatalError, FatalErrorInFunction, forAll, IOstream::good(), solidBodyMotionFunction::read(), and List::size().

Here is the call graph for this function:

Field Documentation

timeDataFileName_

fileName timeDataFileName_

private

Time data file name read from dictionary.

Definition at line 63 of file tabulated6DoFMotion.H.

CofG_

vector CofG_

private

Center of gravity read from dictionary.

Definition at line 66 of file tabulated6DoFMotion.H.

times_

scalarField times_

private

Field of times.

Definition at line 72 of file tabulated6DoFMotion.H.

values_

Field<translationRotationVectors> values_

private

Field of translation and rotation "vectors".

Definition at line 75 of file tabulated6DoFMotion.H.

---

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

• src/dynamicFvMesh/solidBodyMotionFvMesh/solidBodyMotionFunctions/tabulated6DoFMotion/tabulated6DoFMotion.H
• src/dynamicFvMesh/solidBodyMotionFvMesh/solidBodyMotionFunctions/tabulated6DoFMotion/tabulated6DoFMotion.C