Public Member Functions | List of all members
tabulated6DoFMotion Class Reference

Tabulated 6DoF motion function. More...

Inheritance diagram for tabulated6DoFMotion:
[legend]
Collaboration diagram for tabulated6DoFMotion:
[legend]

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 ()=default
 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 autoPtr< solidBodyMotionFunction > clone () const =0
 Construct and return a clone. More...
 
virtual ~solidBodyMotionFunction ()=default
 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...
 

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 Member Functions inherited from solidBodyMotionFunction
 solidBodyMotionFunction (const solidBodyMotionFunction &)=delete
 No copy construct. More...
 
void operator= (const solidBodyMotionFunction &)=delete
 No copy assignment. 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

Definition at line 59 of file tabulated6DoFMotion.H.

Constructor & Destructor Documentation

◆ tabulated6DoFMotion()

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

Construct from components.

Definition at line 56 of file tabulated6DoFMotion.C.

References tabulated6DoFMotion::read().

Here is the call graph for this function:

◆ ~tabulated6DoFMotion()

virtual ~tabulated6DoFMotion ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "tabulated6DoFMotion"  )

Runtime type information.

◆ clone()

virtual autoPtr< solidBodyMotionFunction > clone ( ) const
inlinevirtual

Construct and return a clone.

Implements solidBodyMotionFunction.

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

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

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

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

Referenced by tabulated6DoFMotion::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: