SDA Class Reference

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

Inheritance diagram for SDA:

Collaboration diagram for SDA:

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

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 56 of file SDA.H.

Constructor & Destructor Documentation

SDA() [1/2]

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

Construct from components.

Definition at line 47 of file SDA.C.

References Foam::read().

Referenced by SDA::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

SDA() [2/2]

SDA

(

const SDA &

)

Disallow default bitwise copy construction.

~SDA()

~SDA ( )

virtual

Destructor.

Definition at line 61 of file SDA.C.

Referenced by SDA::clone().

Here is the caller graph for this function:

Member Function Documentation

TypeName()

TypeName

(

"SDA"

)

Runtime type information.

clone()

virtual autoPtr<solidBodyMotionFunction> clone ( ) const

inlinevirtual

Construct and return a clone.

Implements solidBodyMotionFunction.

Definition at line 116 of file SDA.H.

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

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 67 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(), Foam::constant::mathematical::twoPi(), and quaternion::XYZ.

Referenced by SDA::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 102 of file SDA.C.

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

Referenced by SDA::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

void operator= ( const SDA &  )

delete

Disallow default bitwise assignment.

Referenced by SDA::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/SDA/SDA.H
• src/dynamicMesh/motionSolvers/displacement/solidBody/solidBodyMotionFunctions/SDA/SDA.C