sixDoFRigidBodyState Class Reference

Writes the 6-DoF motion state. More...

Inheritance diagram for sixDoFRigidBodyState:
Collaboration diagram for sixDoFRigidBodyState:

Public Member Functions

 TypeName ("sixDoFRigidBodyState")
 Runtime type information. More...
 
 sixDoFRigidBodyState (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
 sixDoFRigidBodyState (const sixDoFRigidBodyState &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~sixDoFRigidBodyState ()
 Destructor. More...
 
vector velocity () const
 Return the current body velocity. More...
 
vector angularVelocity () const
 Return the current body angular velocity. More...
 
const unitConversionangularVelocityUnits () const
 Return the units in which to write the angular velocities. More...
 
virtual bool read (const dictionary &)
 Read the sixDoFRigidBodyState data. More...
 
virtual wordList fields () const
 Return the list of fields required. More...
 
virtual bool execute ()
 Execute, currently does nothing. More...
 
virtual bool write ()
 Write the sixDoFRigidBodyState. More...
 
void operator= (const sixDoFRigidBodyState &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from fvMeshFunctionObject
 TypeName ("fvMeshFunctionObject")
 Runtime type information. More...
 
 fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
 fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 Construct from the region objectRegistry and dictionary. More...
 
 fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~fvMeshFunctionObject ()
 Destructor. More...
 
void operator= (const fvMeshFunctionObject &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from regionFunctionObject
 TypeName ("regionFunctionObject")
 Runtime type information. More...
 
 regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
 regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 Construct from the region objectRegistry and dictionary. More...
 
 regionFunctionObject (const regionFunctionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~regionFunctionObject ()
 Destructor. More...
 
void operator= (const regionFunctionObject &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from functionObject
 ClassName ("functionObject")
 
virtual const wordtype () const =0
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))
 
 functionObject (const word &name, const Time &runTime)
 Construct from components. More...
 
autoPtr< functionObjectclone () const
 Return clone. More...
 
 functionObject (const functionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~functionObject ()
 Destructor. More...
 
const wordname () const
 Return the name of this functionObject. More...
 
virtual bool executeAtStart () const
 Return true if the functionObject should be executed at the start. More...
 
virtual bool end ()
 Called when Time::run() determines that the time-loop exits. More...
 
virtual scalar timeToNextAction ()
 Called by Time::adjustTimeStep(). Allows the functionObject to. More...
 
virtual scalar maxDeltaT () const
 Return the maximum time-step for stable operation. More...
 
virtual void movePoints (const polyMesh &mesh)
 Update topology using the given map. More...
 
virtual void topoChange (const polyTopoChangeMap &map)
 Update topology using the given map. More...
 
virtual void mapMesh (const polyMeshMap &)
 Update from another mesh using the given map. More...
 
virtual void distribute (const polyDistributionMap &)
 Redistribute or update using the given distribution map. More...
 
void operator= (const functionObject &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from logFiles
 logFiles (const objectRegistry &obr, const word &prefix)
 Construct from objectRegistry and prefix. More...
 
 logFiles (const logFiles &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~logFiles ()
 Destructor. More...
 
const wordListtoc () const
 Return the list of log file names. More...
 
const wordListnames () const
 Return the list of log file names. More...
 
PtrList< OFstream > & files ()
 Return access to the files. More...
 
OFstreamfile ()
 Return access to the file (if only 1) More...
 
OFstreamfile (const label i)
 Return file 'i'. More...
 
void operator= (const logFiles &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from writeFile
 writeFile (const objectRegistry &obr, const word &prefix)
 Construct from objectRegistry and prefix. More...
 
 writeFile (const writeFile &)=delete
 Disallow default bitwise copy construction. More...
 
 ~writeFile ()
 Destructor. More...
 
void initStream (Ostream &os) const
 Initialise the output stream for writing. More...
 
fileName baseFileDir () const
 Return the base directory for output. More...
 
fileName baseTimeDir () const
 Return the base directory for the current time value. More...
 
Omanip< int > valueWidth (const label offset=0) const
 Return the value width when writing to stream with optional offset. More...
 
void writeCommented (Ostream &os, const string &str) const
 Write a commented string to stream. More...
 
void writeTabbed (Ostream &os, const string &str) const
 Write a tabbed string to stream. More...
 
void writeHeader (Ostream &os, const string &str) const
 Write a commented header to stream. More...
 
void writeTime (Ostream &os) const
 Write the current time to stream. More...
 
template<class Type >
void writeHeaderValue (Ostream &os, const string &property, const Type &value) const
 Write a (commented) header property and value pair. More...
 
label charWidth () const
 Return width of character stream output. More...
 
void operator= (const writeFile &)=delete
 Disallow default bitwise assignment. More...
 

Protected Member Functions

virtual void writeFileHeader (const label i=0)
 overloaded writeFileHeader from writeFile More...
 
- Protected Member Functions inherited from fvMeshFunctionObject
labelHashSet patchSet (const dictionary &, const bool optional=false) const
 Return the patch set corresponding to the patch selection entries. More...
 
- Protected Member Functions inherited from regionFunctionObject
template<class ObjectType >
bool foundObject (const word &fieldName) const
 Find field in the objectRegistry. More...
 
template<class ObjectType >
void cannotFindObject (const word &fieldName)
 Prints a warning message that fieldName cannot be found. More...
 
void cannotFindObject (const word &fieldName)
 Prints a warning message that fieldName cannot be found. More...
 
void cannotFindObjects (const wordList &fieldNames)
 Prints a warning message that fieldNames cannot be found. More...
 
template<class ObjectType >
const ObjectType & lookupObject (const word &fieldName) const
 Lookup object from the objectRegistry. More...
 
template<class ObjectType >
ObjectType & lookupObjectRef (const word &fieldName)
 Lookup non-const object reference from the objectRegistry. More...
 
template<class ObjectType >
bool store (const tmp< ObjectType > &tfield)
 Store the given field in the objectRegistry. More...
 
template<class ObjectType >
bool store (const word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
 Store the given field in the objectRegistry under the given name. More...
 
bool writeObject (const word &fieldName)
 Write field if present in objectRegistry. More...
 
bool clearObject (const word &fieldName)
 Clear field from the objectRegistry if present. More...
 
- Protected Member Functions inherited from logFiles
virtual void createFiles ()
 Create the output file. More...
 
virtual void resetNames (const wordList &names)
 Reset the list of names from a wordList. More...
 
virtual void resetName (const word &name)
 Reset the list of names to a single name entry. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (const word &name, const Time &, const dictionary &)
 Select from dictionary, based on its "type" entry. More...
 
- Public Attributes inherited from functionObject
Switch log
 Switch write log to Info. More...
 
Switch executeAtStart_
 Switch write log to Info. More...
 
- Static Public Attributes inherited from functionObject
static bool postProcess
 Global post-processing mode switch. More...
 
- Static Public Attributes inherited from writeFile
static const word outputPrefix
 Directory prefix. More...
 
static label addChars = 8
 Additional characters for writing. More...
 
- Protected Attributes inherited from fvMeshFunctionObject
const fvMeshmesh_
 Reference to the fvMesh. More...
 
- Protected Attributes inherited from regionFunctionObject
const objectRegistryobr_
 Reference to the region objectRegistry. More...
 
- Protected Attributes inherited from functionObject
const Timetime_
 Reference to time. More...
 
- Protected Attributes inherited from logFiles
wordList names_
 File names. More...
 
PtrList< OFstreamfilePtrs_
 File pointer. More...
 
- Protected Attributes inherited from writeFile
const objectRegistryfileObr_
 Reference to the region objectRegistry. More...
 
const word prefix_
 Prefix. More...
 

Detailed Description

Writes the 6-DoF motion state.

Usage
Property Description Required Default value
type type name: sixDoFRigidBodyState yes
angleUnits units in which angles are written no [rad]
angularVelocityUnits units in which angular velocities are written no [rad/s]

Example of function object specification:

    sixDoFRigidBodyState
    {
        type           sixDoFRigidBodyState;
        libs           ("libsixDoFRigidBodyState.so");
        angleUnits     [deg];
        angularVelocityUnits [rpm];
    }
See also
Foam::functionObjects::fvMeshFunctionObject Foam::functionObjects::logFiles
Source files

Definition at line 96 of file sixDoFRigidBodyState.H.

Constructor & Destructor Documentation

◆ sixDoFRigidBodyState() [1/2]

sixDoFRigidBodyState ( const word name,
const Time runTime,
const dictionary dict 
)

Construct from Time and dictionary.

Definition at line 53 of file sixDoFRigidBodyState.C.

References dict, and sixDoFRigidBodyState::read().

Here is the call graph for this function:

◆ sixDoFRigidBodyState() [2/2]

Disallow default bitwise copy construction.

◆ ~sixDoFRigidBodyState()

~sixDoFRigidBodyState ( )
virtual

Destructor.

Definition at line 71 of file sixDoFRigidBodyState.C.

Member Function Documentation

◆ writeFileHeader()

void writeFileHeader ( const label  i = 0)
protectedvirtual

overloaded writeFileHeader from writeFile

Implements logFiles.

Definition at line 90 of file sixDoFRigidBodyState.C.

References Foam::endl(), Foam::file, Foam::tab, and Foam::vtkWriteOps::writeHeader().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "sixDoFRigidBodyState"  )

Runtime type information.

◆ velocity()

Foam::vector velocity ( ) const

Return the current body velocity.

Definition at line 124 of file sixDoFRigidBodyState.C.

◆ angularVelocity()

Foam::vector angularVelocity ( ) const

Return the current body angular velocity.

Definition at line 131 of file sixDoFRigidBodyState.C.

◆ angularVelocityUnits()

const Foam::unitConversion & angularVelocityUnits ( ) const

Return the units in which to write the angular velocities.

Definition at line 138 of file sixDoFRigidBodyState.C.

◆ read()

bool read ( const dictionary dict)
virtual

Read the sixDoFRigidBodyState data.

Reimplemented from regionFunctionObject.

Reimplemented in sixDoFRigidBodyControl.

Definition at line 77 of file sixDoFRigidBodyState.C.

References dict, and regionFunctionObject::read().

Referenced by sixDoFRigidBodyControl::read(), and sixDoFRigidBodyState::sixDoFRigidBodyState().

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

◆ fields()

virtual wordList fields ( ) const
inlinevirtual

Return the list of fields required.

Implements functionObject.

Definition at line 162 of file sixDoFRigidBodyState.H.

References List< word >::null().

Here is the call graph for this function:

◆ execute()

bool execute ( )
virtual

Execute, currently does nothing.

Implements functionObject.

Reimplemented in sixDoFRigidBodyControl.

Definition at line 108 of file sixDoFRigidBodyState.C.

◆ write()

◆ operator=()

void operator= ( const sixDoFRigidBodyState )
delete

Disallow default bitwise assignment.


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