SDA Class Reference

Ship design analysis (SDA) 3DoF motion function. More...

#include <SDA.H>

Inheritance diagram for SDA:

Collaboration diagram for SDA:

Public Member Functions
	TypeName ("SDA")
	Runtime type information.
	SDA (const dictionary &SBMFCoeffs, const Time &runTime)
	Construct from components.
virtual autoPtr< solidBodyMotionFunction >	clone () const
	Construct and return a clone.
virtual	~SDA ()=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

Ship design analysis (SDA) 3DoF motion function.

Comprising sinusoidal roll (rotation about x), heave (z-translation) and sway (y-translation) motions with changing amplitude and phase.

See also

Foam::solidBodyMotionFunctions::tabulated6DoFMotion

Source files

• SDA.H
• SDA.C

Definition at line 55 of file SDA.H.

Constructor & Destructor Documentation

SDA()

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

Construct from components.

Definition at line 42 of file SDA.C.

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

Here is the call graph for this function:

~SDA()

virtual ~SDA ( )

virtualdefault

Destructor.

Member Function Documentation

TypeName()

TypeName

(

"SDA"

)

Runtime type information.

References runTime.

clone()

virtual autoPtr< solidBodyMotionFunction > clone ( ) const

inlinevirtual

Construct and return a clone.

Implements solidBodyMotionFunction.

Definition at line 152 of file SDA.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 57 of file SDA.C.

References DebugInFunction, Foam::endl(), Foam::exp(), Foam::log(), Foam::mag(), Foam::max(), Foam::constant::mathematical::pi(), Foam::constant::mathematical::piByTwo(), R, Foam::sin(), Foam::sqr(), Foam::T(), T, solidBodyMotionFunction::time_, Foam::constant::mathematical::twoPi(), 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 92 of file SDA.C.

References solidBodyMotionFunction::read(), solidBodyMotionFunction::SBMFCoeffs_, and Foam::sqrt().

Referenced by SDA().

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/SDA/SDA.H
• src/meshTools/solidBodyMotionFunctions/SDA/SDA.C