Loading...
Searching...
No Matches
solidBodyMotionFunction Class Referenceabstract

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

#include <solidBodyMotionFunction.H>

Inheritance diagram for solidBodyMotionFunction:
Inheritance graph
[legend]
Collaboration diagram for solidBodyMotionFunction:
Collaboration graph
[legend]

Public Member Functions

 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 autoPtr< solidBodyMotionFunction > clone () const =0
 Construct and return a clone.
virtual ~solidBodyMotionFunction ()=default
 Destructor.
virtual septernion transformation () const =0
 Return the solid-body motion transformation septernion.
virtual bool read (const dictionary &SBMFCoeffs)=0
 Update properties from given dictionary.
virtual void writeData (Ostream &) const
 Write in dictionary format.

Static Public Member Functions

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

 solidBodyMotionFunction (const solidBodyMotionFunction &)=delete
 No copy construct.
void operator= (const solidBodyMotionFunction &)=delete
 No copy assignment.

Protected Attributes

dictionary SBMFCoeffs_
const Time & time_

Detailed Description

Base class for defining solid-body motions.

Source files

Definition at line 60 of file solidBodyMotionFunction.H.

Constructor & Destructor Documentation

◆ solidBodyMotionFunction() [1/2]

solidBodyMotionFunction ( const solidBodyMotionFunction & )
protecteddelete

No copy construct.

References solidBodyMotionFunction().

Referenced by axisRotationMotion::axisRotationMotion(), declareRunTimeSelectionTable(), drivenLinearMotion::drivenLinearMotion(), linearMotion::linearMotion(), multiMotion::multiMotion(), operator=(), oscillatingRotatingMotion::oscillatingRotatingMotion(), rotatingMotion::rotatingMotion(), SDA::SDA(), solidBodyMotionFunction(), and tabulated6DoFMotion::tabulated6DoFMotion().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ solidBodyMotionFunction() [2/2]

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

Construct from the coefficients dictionary and Time.

Definition at line 35 of file solidBodyMotionFunction.C.

References dict, found, runTime, SBMFCoeffs_, and time_.

◆ ~solidBodyMotionFunction()

virtual ~solidBodyMotionFunction ( )
virtualdefault

Destructor.

Member Function Documentation

◆ operator=()

void operator= ( const solidBodyMotionFunction & )
protecteddelete

No copy assignment.

References solidBodyMotionFunction().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "solidBodyMotionFunction" )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

References runTime, and solidBodyMotionFunction().

Here is the call graph for this function:

◆ clone()

virtual autoPtr< solidBodyMotionFunction > clone ( ) const
pure virtual

Construct and return a clone.

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

References dict, and runTime.

◆ New() [1/2]

Foam::autoPtr< Foam::solidBodyMotionFunction > New ( const word & motionType,
const dictionary & dict,
const Time & runTime )
static

Construct and dispatch motionType with dictionary and Time.

Returns nullptr if motionType is empty

Definition at line 27 of file solidBodyMotionFunctionNew.C.

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

Referenced by multiSolidBodyMotionSolver::multiSolidBodyMotionSolver(), multiMotion::read(), and rotatingMotion::rotatingMotion().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ New() [2/2]

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

Select "solidBodyMotionFunction" type from dictionary and create with Time.

Definition at line 59 of file solidBodyMotionFunctionNew.C.

References dict, keyType::LITERAL, Foam::New(), and runTime.

Here is the call graph for this function:

◆ NewIfPresent()

Foam::autoPtr< Foam::solidBodyMotionFunction > NewIfPresent ( const dictionary & dict,
const Time & runTime )
static

Select "solidBodyMotionFunction" type (if present) from dictionary and create with Time.

Definition at line 75 of file solidBodyMotionFunctionNew.C.

References dict, keyType::LITERAL, Foam::New(), 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, oscillatingRotatingMotion, rotatingMotion, SDA, and tabulated6DoFMotion.

◆ read()

bool read ( const dictionary & SBMFCoeffs)
pure virtual

Update properties from given dictionary.

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

Definition at line 56 of file solidBodyMotionFunction.C.

References dict, SBMFCoeffs_, and Foam::type().

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ writeData()

void writeData ( Ostream & os) const
virtual

Write in dictionary format.

Definition at line 64 of file solidBodyMotionFunction.C.

References os(), and SBMFCoeffs_.

Here is the call graph for this function:

Member Data Documentation

◆ SBMFCoeffs_

dictionary SBMFCoeffs_
protected

Definition at line 66 of file solidBodyMotionFunction.H.

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

◆ time_

const Time& time_
protected

Definition at line 68 of file solidBodyMotionFunction.H.

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

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