tabulated6DoFMotion Class Reference

Tabulated 6DoF motion function. More...

#include <tabulated6DoFMotion.H>

Inheritance diagram for tabulated6DoFMotion:

Collaboration diagram for tabulated6DoFMotion:

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

Additional Inherited Members
Static Public Member Functions inherited from solidBodyMotionFunction
static autoPtr< solidBodyMotionFunction >	New (const word &motionType, const dictionary &dict, const Time &runTime)
	Construct and dispatch motionType with dictionary and Time.
static autoPtr< solidBodyMotionFunction >	New (const dictionary &dict, const Time &runTime)
	Select "solidBodyMotionFunction" type from dictionary and create with Time.
static autoPtr< solidBodyMotionFunction >	NewIfPresent (const dictionary &dict, const Time &runTime)
	Select "solidBodyMotionFunction" type (if present) from dictionary and create with Time.
Protected Member Functions inherited from solidBodyMotionFunction
	solidBodyMotionFunction (const solidBodyMotionFunction &)=delete
	No copy construct.
void	operator= (const solidBodyMotionFunction &)=delete
	No copy assignment.
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 55 of file tabulated6DoFMotion.H.

Constructor & Destructor Documentation

tabulated6DoFMotion()

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

Construct from components.

Definition at line 61 of file tabulated6DoFMotion.C.

References read(), runTime, and solidBodyMotionFunction::solidBodyMotionFunction().

Here is the call graph for this function:

~tabulated6DoFMotion()

virtual ~tabulated6DoFMotion ( )

virtualdefault

Destructor.

Member Function Documentation

TypeName()

TypeName

(

"tabulated6DoFMotion"

)

Runtime type information.

References runTime.

clone()

virtual autoPtr< solidBodyMotionFunction > clone ( ) const

inlinevirtual

Construct and return a clone.

Implements solidBodyMotionFunction.

Definition at line 144 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 76 of file tabulated6DoFMotion.C.

References DebugInFunction, Foam::degToRad(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::interpolateSplineXY(), Foam::interpolateXY(), R, solidBodyMotionFunction::time_, quaternion::XYZ, and Foam::Zero.

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 133 of file tabulated6DoFMotion.C.

References Foam::exit(), string::expand(), Foam::FatalError, FatalErrorInFunction, UList< T >::first(), forAll, IOstream::good(), solidBodyMotionFunction::read(), solidBodyMotionFunction::SBMFCoeffs_, and UList< T >::size().

Referenced by tabulated6DoFMotion().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• src/meshTools/solidBodyMotionFunctions/tabulated6DoFMotion/tabulated6DoFMotion.H
• src/meshTools/solidBodyMotionFunctions/tabulated6DoFMotion/tabulated6DoFMotion.C