Public Member Functions | Static Public 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 word &name, const dictionary &SBMFCoeffs, const Time &runTime),(name, SBMFCoeffs, runTime))
 
 solidBodyMotionFunction (const word &name, const dictionary &dict, const Time &runTime)
 Construct from the SBMFCoeffs dictionary and Time. More...
 
 solidBodyMotionFunction (const solidBodyMotionFunction &)=delete
 Disallow default bitwise copy construction. More...
 
virtual autoPtr< solidBodyMotionFunction > clone () const =0
 Construct and return a clone. More...
 
virtual ~solidBodyMotionFunction ()
 Destructor. More...
 
const word & name () const
 
virtual septernion transformation () const =0
 Return the solid-body motion transformation septernion. More...
 
virtual bool read (const dictionary &dict)=0
 Update properties from given dictionary. More...
 
virtual void writeData (Ostream &) const
 Write in dictionary format. More...
 
void operator= (const solidBodyMotionFunction &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Member Functions

static autoPtr< solidBodyMotionFunction > New (const dictionary &SBMFCoeffs, const Time &runTime, const word &name="solidBodyMotionFunction")
 Select constructed from the SBMFCoeffs dictionary and Time. More...
 

Protected Attributes

const word name_
 
dictionary SBMFCoeffs_
 
const Time & time_
 

Detailed Description

Base class for defining solid-body motions.

Source files

Definition at line 59 of file solidBodyMotionFunction.H.

Constructor & Destructor Documentation

◆ solidBodyMotionFunction() [1/2]

solidBodyMotionFunction ( const word &  name,
const dictionary &  dict,
const Time &  runTime 
)

Construct from the SBMFCoeffs dictionary and Time.

Definition at line 39 of file solidBodyMotionFunction.C.

◆ solidBodyMotionFunction() [2/2]

solidBodyMotionFunction ( const solidBodyMotionFunction &  )
delete

Disallow default bitwise copy construction.

◆ ~solidBodyMotionFunction()

~solidBodyMotionFunction ( )
virtual

Destructor.

Definition at line 54 of file solidBodyMotionFunction.C.

Member Function Documentation

◆ TypeName()

TypeName ( "solidBodyMotionFunction"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ clone()

virtual autoPtr<solidBodyMotionFunction> clone ( ) const
pure virtual

Construct and return a clone.

Implemented in sixDoFMotion, SDA, rotatingMotion, oscillatingRotatingMotion, oscillatingLinearMotion, none, multiMotion, linearMotion, axisRotationMotion, multiValveEngineValveMotion, and multiValveEnginePistonMotion.

◆ New()

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

Select constructed from the SBMFCoeffs dictionary and Time.

Definition at line 30 of file solidBodyMotionFunctionNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::indentOrNl(), Foam::Info, dictionary::lookup(), solidBodyMotionFunction::name(), and Foam::nl.

Referenced by functionalRigidBody::functionalRigidBody(), multiSolidBody::multiSolidBody(), and multiMotion::read().

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

◆ name()

const word& name ( ) const
inline

Definition at line 126 of file solidBodyMotionFunction.H.

References solidBodyMotionFunction::name_.

Referenced by solidBodyMotionFunction::New().

Here is the caller graph for this function:

◆ transformation()

virtual septernion transformation ( ) const
pure virtual

Return the solid-body motion transformation septernion.

Implemented in sixDoFMotion, SDA, rotatingMotion, oscillatingRotatingMotion, oscillatingLinearMotion, none, multiMotion, linearMotion, axisRotationMotion, multiValveEngineValveMotion, and multiValveEnginePistonMotion.

◆ read()

bool read ( const dictionary &  dict)
pure virtual

Update properties from given dictionary.

Implemented in sixDoFMotion, SDA, rotatingMotion, oscillatingRotatingMotion, oscillatingLinearMotion, multiMotion, linearMotion, axisRotationMotion, multiValveEngineValveMotion, multiValveEnginePistonMotion, and none.

Definition at line 60 of file solidBodyMotionFunction.C.

References dict, dictionary::isDict(), and dictionary::subDict().

Referenced by multiValveEnginePistonMotion::read(), multiValveEngineValveMotion::read(), axisRotationMotion::read(), linearMotion::read(), multiMotion::read(), oscillatingLinearMotion::read(), oscillatingRotatingMotion::read(), rotatingMotion::read(), SDA::read(), and sixDoFMotion::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.

Reimplemented in none.

Definition at line 71 of file solidBodyMotionFunction.C.

◆ operator=()

void operator= ( const solidBodyMotionFunction &  )
delete

Disallow default bitwise assignment.

Member Data Documentation

◆ name_

const word name_
protected

Definition at line 65 of file solidBodyMotionFunction.H.

Referenced by multiValveEnginePistonMotion::clone(), multiValveEngineValveMotion::clone(), axisRotationMotion::clone(), linearMotion::clone(), multiMotion::clone(), none::clone(), oscillatingLinearMotion::clone(), oscillatingRotatingMotion::clone(), rotatingMotion::clone(), SDA::clone(), sixDoFMotion::clone(), and solidBodyMotionFunction::name().

◆ SBMFCoeffs_

dictionary SBMFCoeffs_
protected

Definition at line 66 of file solidBodyMotionFunction.H.

Referenced by multiValveEnginePistonMotion::clone(), multiValveEngineValveMotion::clone(), axisRotationMotion::clone(), linearMotion::clone(), multiMotion::clone(), oscillatingLinearMotion::clone(), oscillatingRotatingMotion::clone(), rotatingMotion::clone(), SDA::clone(), and sixDoFMotion::clone().

◆ time_

const Time& time_
protected

Definition at line 67 of file solidBodyMotionFunction.H.

Referenced by multiValveEnginePistonMotion::clone(), multiValveEngineValveMotion::clone(), axisRotationMotion::clone(), linearMotion::clone(), multiMotion::clone(), none::clone(), oscillatingLinearMotion::clone(), oscillatingRotatingMotion::clone(), rotatingMotion::clone(), SDA::clone(), and sixDoFMotion::clone().

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