Public Member Functions | List of all members
timeControl Class Reference
Inheritance diagram for timeControl:
Inheritance graph
[legend]
Collaboration diagram for timeControl:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("timeControl")
 Runtime type information. More...
 
 timeControl (const word &name, const Time &, const dictionary &)
 Construct from components. More...
 
const Timetime () const
 Return time database. More...
 
const dictionarydict () const
 Return the input dictionary. More...
 
const Foam::timeControlexecuteControl () const
 Return the execute control object. More...
 
const Foam::timeControlwriteControl () const
 Return the write control object. More...
 
const functionObjectfilter () const
 Return the functionObject filter. More...
 
virtual bool execute ()
 Called at each ++ or += of the time-loop. More...
 
virtual bool write ()
 Called at each ++ or += of the time-loop. More...
 
virtual bool end ()
 Called when Time::run() determines that the time-loop exits. More...
 
virtual scalar timeToNextWrite ()
 Return the time to the next write. More...
 
virtual bool read (const dictionary &)
 Read and set the function object if its data have changed. More...
 
virtual void updateMesh (const mapPolyMesh &mpm)
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &mesh)
 Update for changes of mesh. More...
 
- Public Member Functions inherited from 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)
 Construct from components. More...
 
autoPtr< functionObjectclone () const
 Return clone. More...
 
virtual ~functionObject ()
 Destructor. More...
 
const wordname () const
 Return the name of this functionObject. More...
 
virtual bool setTimeStep ()
 Called by Time::setDeltaT(). Allows the function object to override. 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...
 
- Static Public Attributes inherited from functionObject
static int debug
 
static bool postProcess
 Global post-processing mode switch. More...
 

Detailed Description

Note
Since the timeIndex is used directly from Foam::Time, it is unaffected by user-time conversions. For example, Foam::engineTime might cause writeInterval to be degrees crank angle, but the functionObject execution interval would still be in timestep.
Source files

Definition at line 57 of file timeControlFunctionObject.H.

Constructor & Destructor Documentation

◆ timeControl()

timeControl ( const word name,
const Time t,
const dictionary dict 
)

Construct from components.

Definition at line 63 of file timeControlFunctionObject.C.

Member Function Documentation

◆ TypeName()

TypeName ( "timeControl"  )

Runtime type information.

◆ time()

const Foam::Time & time ( ) const
inline

Return time database.

Definition at line 28 of file timeControlFunctionObjectI.H.

◆ dict()

const Foam::dictionary & dict ( ) const
inline

Return the input dictionary.

Definition at line 34 of file timeControlFunctionObjectI.H.

◆ executeControl()

const Foam::timeControl & executeControl ( ) const
inline

Return the execute control object.

Definition at line 41 of file timeControlFunctionObjectI.H.

◆ writeControl()

const Foam::timeControl & writeControl ( ) const
inline

Return the write control object.

Definition at line 48 of file timeControlFunctionObjectI.H.

◆ filter()

const Foam::functionObject & filter ( ) const
inline

Return the functionObject filter.

Definition at line 55 of file timeControlFunctionObjectI.H.

◆ execute()

bool execute ( )
virtual

Called at each ++ or += of the time-loop.

postProcess overrides the usual executeControl behaviour and forces execution (used in post-processing mode)

Implements functionObject.

Definition at line 88 of file timeControlFunctionObject.C.

◆ write()

bool write ( )
virtual

Called at each ++ or += of the time-loop.

postProcess overrides the usual writeControl behaviour and forces writing (used in post-processing mode)

Implements functionObject.

Definition at line 99 of file timeControlFunctionObject.C.

◆ end()

bool end ( )
virtual

Called when Time::run() determines that the time-loop exits.

Reimplemented from functionObject.

Definition at line 110 of file timeControlFunctionObject.C.

◆ timeToNextWrite()

Foam::scalar timeToNextWrite ( )
virtual

Return the time to the next write.

Reimplemented from functionObject.

Definition at line 122 of file timeControlFunctionObject.C.

References timeControl::adjustableRunTime, Foam::max(), and timeControl::read().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary dict)
virtual

Read and set the function object if its data have changed.

Reimplemented from functionObject.

Definition at line 148 of file timeControlFunctionObject.C.

References dict, and timeControl::updateMesh().

Referenced by timeControl::timeToNextWrite().

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

◆ updateMesh()

void updateMesh ( const mapPolyMesh mpm)
virtual

Update for changes of mesh.

Reimplemented from functionObject.

Definition at line 170 of file timeControlFunctionObject.C.

References timeControl::movePoints().

Referenced by timeControl::read().

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

◆ movePoints()

void movePoints ( const polyMesh mesh)
virtual

Update for changes of mesh.

Reimplemented from functionObject.

Definition at line 182 of file timeControlFunctionObject.C.

Referenced by timeControl::updateMesh().

Here is the caller graph for this function:

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