All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
timeControl Class Reference
Inheritance diagram for timeControl:
Collaboration diagram for timeControl:

Public Member Functions

 TypeName ("timeControl")
 Runtime type information. More...
 
 timeControl (const word &name, const Time &, const dictionary &)
 Construct from components. More...
 
 timeControl (const timeControl &)=delete
 Disallow default bitwise copy construction. More...
 
const Timetime () const
 Return time database. 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 executeAtStart () const
 Return true if the functionObject should be executed. 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...
 
void operator= (const timeControl &)=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)
 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...
 
void operator= (const functionObject &)=delete
 Disallow default bitwise assignment. 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...
 

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() [1/2]

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

Construct from components.

Definition at line 71 of file timeControlFunctionObject.C.

References functionObject::read().

Here is the call graph for this function:

◆ timeControl() [2/2]

timeControl ( const timeControl )
delete

Disallow default bitwise copy construction.

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.

◆ executeControl()

const Foam::timeControl & executeControl ( ) const
inline

Return the execute control object.

Definition at line 35 of file timeControlFunctionObjectI.H.

◆ writeControl()

const Foam::timeControl & writeControl ( ) const
inline

Return the write control object.

Definition at line 42 of file timeControlFunctionObjectI.H.

◆ filter()

const Foam::functionObject & filter ( ) const
inline

Return the functionObject filter.

Definition at line 49 of file timeControlFunctionObjectI.H.

◆ executeAtStart()

bool executeAtStart ( ) const
virtual

Return true if the functionObject should be executed.

at the start

Reimplemented from functionObject.

Definition at line 98 of file timeControlFunctionObject.C.

◆ 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 104 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 123 of file timeControlFunctionObject.C.

◆ end()

bool end ( )
virtual

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

Reimplemented from functionObject.

Definition at line 142 of file timeControlFunctionObject.C.

◆ timeToNextWrite()

Foam::scalar timeToNextWrite ( )
virtual

Return the time to the next write.

Reimplemented from functionObject.

Definition at line 154 of file timeControlFunctionObject.C.

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

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 179 of file timeControlFunctionObject.C.

◆ updateMesh()

void updateMesh ( const mapPolyMesh mpm)
virtual

Update for changes of mesh.

Reimplemented from functionObject.

Definition at line 195 of file timeControlFunctionObject.C.

◆ movePoints()

void movePoints ( const polyMesh mesh)
virtual

Update for changes of mesh.

Reimplemented from functionObject.

Definition at line 204 of file timeControlFunctionObject.C.

◆ operator=()

void operator= ( const timeControl )
delete

Disallow default bitwise assignment.


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