Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
solidBodyMotionFunction Class Referenceabstract

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

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

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

Definition at line 60 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 36 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 SDA, tabulated6DoFMotion, rotatingMotion, oscillatingRotatingMotion, drivenLinearMotion, axisRotationMotion, linearMotion, and multiMotion.

◆ New()

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

Select constructed from the SBMFCoeffs dictionary and Time.

Definition at line 27 of file solidBodyMotionFunctionNew.C.

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

Referenced by multiMotion::read().

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

◆ transformation()

virtual septernion transformation ( ) const
pure virtual

Return the solid-body motion transformation septernion.

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

◆ read()

bool read ( const dictionary &  SBMFCoeffs)
pure virtual

Update properties from given dictionary.

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

Definition at line 56 of file solidBodyMotionFunction.C.

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

Referenced by linearMotion::read(), multiMotion::read(), axisRotationMotion::read(), drivenLinearMotion::read(), oscillatingRotatingMotion::read(), rotatingMotion::read(), tabulated6DoFMotion::read(), and SDA::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().

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 linearMotion::clone(), multiMotion::clone(), axisRotationMotion::clone(), drivenLinearMotion::clone(), oscillatingRotatingMotion::clone(), rotatingMotion::clone(), tabulated6DoFMotion::clone(), SDA::clone(), and solidBodyMotionFunction::read().

◆ time_

const Time& time_
protected

Definition at line 68 of file solidBodyMotionFunction.H.

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

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