solidBodyMotionFunction Class Reference

Base class for defining solid-body motions. More...

Inheritance diagram for solidBodyMotionFunction:

Collaboration diagram for solidBodyMotionFunction:

Public Member Functions
	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...

Static Public Member Functions
static autoPtr< solidBodyMotionFunction >	New (const dictionary &SBMFCoeffs, const Time &runTime)
	Select constructed from the SBMFCoeffs dictionary and Time. More...

Protected Member Functions
	solidBodyMotionFunction (const solidBodyMotionFunction &)=delete
	No copy construct. More...
void	operator= (const solidBodyMotionFunction &)=delete
	No copy assignment. More...

Protected Attributes
dictionary	SBMFCoeffs_
const Time &	time_

Detailed Description

Base class for defining solid-body motions.

Source files

• solidBodyMotionFunction.H
• solidBodyMotionFunction.C
• dynamicFvMeshNew.C

Definition at line 63 of file solidBodyMotionFunction.H.

Constructor & Destructor Documentation

solidBodyMotionFunction() [1/2]

solidBodyMotionFunction ( const solidBodyMotionFunction &  )

protecteddelete

No copy construct.

solidBodyMotionFunction() [2/2]

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

Construct from the SBMFCoeffs dictionary and Time.

Definition at line 41 of file solidBodyMotionFunction.C.

~solidBodyMotionFunction()

virtual ~solidBodyMotionFunction ( )

virtualdefault

Destructor.

Member Function Documentation

operator=()

void operator= ( const solidBodyMotionFunction &  )

protecteddelete

No copy assignment.

TypeName()

TypeName

(

"solidBodyMotionFunction"

)

Runtime type information.

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		solidBodyMotionFunction	,
		dictionary	,
		(const dictionary &SBMFCoeffs, const Time &runTime)	,
		(SBMFCoeffs, runTime)
	)

clone()

virtual autoPtr< solidBodyMotionFunction > clone ( ) const

pure virtual

Construct and return a clone.

Implemented in axisRotationMotion, drivenLinearMotion, linearMotion, multiMotion, oscillatingLinearMotion, oscillatingRotatingMotion, rotatingMotion, SDA, and tabulated6DoFMotion.

New()

Foam::autoPtr< Foam::solidBodyMotionFunction > New ( const dictionary &  SBMFCoeffs, const Time &  runTime  )

static

Select constructed from the SBMFCoeffs dictionary and Time.

Definition at line 33 of file solidBodyMotionFunctionNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, dictionary::get(), Foam::Info, and runTime.

Here is the call graph for this function:

transformation()

virtual septernion transformation ( ) const

pure virtual

Return the solid-body motion transformation septernion.

Implemented in axisRotationMotion, drivenLinearMotion, linearMotion, multiMotion, oscillatingLinearMotion, oscillatingRotatingMotion, rotatingMotion, SDA, and tabulated6DoFMotion.

read()

bool read ( const dictionary &  SBMFCoeffs )

pure virtual

Update properties from given dictionary.

Implemented in axisRotationMotion, drivenLinearMotion, linearMotion, multiMotion, oscillatingLinearMotion, oscillatingRotatingMotion, rotatingMotion, SDA, and tabulated6DoFMotion.

Definition at line 60 of file solidBodyMotionFunction.C.

References dictionary::optionalSubDict(), and Foam::type().

Here is the call graph for this function:

writeData()

void writeData ( Ostream &  os ) const

virtual

Write in dictionary format.

Definition at line 68 of file solidBodyMotionFunction.C.

References os(), and solidBodyMotionFunction::writeData().

Referenced by solidBodyMotionFunction::writeData().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

SBMFCoeffs_

dictionary SBMFCoeffs_

protected

Definition at line 69 of file solidBodyMotionFunction.H.

Referenced by axisRotationMotion::clone(), drivenLinearMotion::clone(), linearMotion::clone(), multiMotion::clone(), oscillatingLinearMotion::clone(), oscillatingRotatingMotion::clone(), rotatingMotion::clone(), SDA::clone(), and tabulated6DoFMotion::clone().

time_

const Time& time_

protected

Definition at line 71 of file solidBodyMotionFunction.H.

Referenced by axisRotationMotion::clone(), drivenLinearMotion::clone(), linearMotion::clone(), multiMotion::clone(), oscillatingLinearMotion::clone(), oscillatingRotatingMotion::clone(), rotatingMotion::clone(), SDA::clone(), and tabulated6DoFMotion::clone().

---

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

• src/dynamicMesh/motionSolvers/displacement/solidBody/solidBodyMotionFunctions/solidBodyMotionFunction/solidBodyMotionFunction.H
• src/dynamicMesh/motionSolvers/displacement/solidBody/solidBodyMotionFunctions/solidBodyMotionFunction/solidBodyMotionFunction.C
• src/dynamicMesh/motionSolvers/displacement/solidBody/solidBodyMotionFunctions/solidBodyMotionFunction/solidBodyMotionFunctionNew.C