sixDoFMotion Class Reference

Tabulated 6DoF motion function. More...

Inheritance diagram for sixDoFMotion:

Collaboration diagram for sixDoFMotion:

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

Public Member Functions
	TypeName ("sixDoFMotion")
	Runtime type information. More...
	sixDoFMotion (const dictionary &SBMFCoeffs, const Time &runTime)
	Construct from components. More...
	sixDoFMotion (const sixDoFMotion &)
	Disallow default bitwise copy construction. More...
virtual autoPtr< solidBodyMotionFunction >	clone () const
	Construct and return a clone. More...
virtual	~sixDoFMotion ()
	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...
void	operator= (const sixDoFMotion &)=delete
	Disallow default bitwise assignment. 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...
	solidBodyMotionFunction (const solidBodyMotionFunction &)=delete
	Disallow default bitwise copy construction. More...
virtual	~solidBodyMotionFunction ()
	Destructor. More...
virtual void	writeData (Ostream &) const
	Write in dictionary format. More...
void	operator= (const solidBodyMotionFunction &)=delete
	Disallow default bitwise assignment. 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

• sixDoFMotion.H
• sixDoFMotion.C

Definition at line 57 of file sixDoFMotion.H.

Member Typedef Documentation

translationRotationVectors

typedef Vector2D<vector> translationRotationVectors

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

Definition at line 64 of file sixDoFMotion.H.

Constructor & Destructor Documentation

sixDoFMotion() [1/2]

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

Construct from components.

Definition at line 116 of file sixDoFMotion.C.

References Foam::read().

Referenced by sixDoFMotion::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

sixDoFMotion() [2/2]

sixDoFMotion

(

const sixDoFMotion &

)

Disallow default bitwise copy construction.

~sixDoFMotion()

~sixDoFMotion ( )

virtual

Destructor.

Definition at line 129 of file sixDoFMotion.C.

Referenced by sixDoFMotion::clone().

Here is the caller graph for this function:

Member Function Documentation

TypeName()

TypeName

(

"sixDoFMotion"

)

Runtime type information.

clone()

virtual autoPtr<solidBodyMotionFunction> clone ( ) const

inlinevirtual

Construct and return a clone.

Implements solidBodyMotionFunction.

Definition at line 98 of file sixDoFMotion.H.

References sixDoFMotion::operator=(), sixDoFMotion::read(), solidBodyMotionFunction::SBMFCoeffs_, sixDoFMotion::sixDoFMotion(), solidBodyMotionFunction::time_, sixDoFMotion::transformation(), and sixDoFMotion::~sixDoFMotion().

Here is the call graph for this function:

transformation()

Foam::septernion transformation ( ) const

virtual

Return the solid-body motion transformation septernion.

Implements solidBodyMotionFunction.

Definition at line 136 of file sixDoFMotion.C.

References DebugInFunction, Foam::endl(), Foam::constant::mathematical::pi(), R, sixDoFMotion::read(), and quaternion::XYZ.

Referenced by sixDoFMotion::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

read()

bool read ( const dictionary &  SBMFCoeffs )

virtual

Update properties from given dictionary.

Implements solidBodyMotionFunction.

Definition at line 155 of file sixDoFMotion.C.

References Function1< Type >::New(), and solidBodyMotionFunction::read().

Referenced by sixDoFMotion::clone(), and sixDoFMotion::transformation().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

void operator= ( const sixDoFMotion &  )

delete

Disallow default bitwise assignment.

Referenced by sixDoFMotion::clone().

Here is the caller graph for this function:

---

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

• src/dynamicMesh/motionSolvers/displacement/solidBody/solidBodyMotionFunctions/sixDoFMotion/sixDoFMotion.H
• src/dynamicMesh/motionSolvers/displacement/solidBody/solidBodyMotionFunctions/sixDoFMotion/sixDoFMotion.C