timeControl Class Reference

General time control for functionObjects. More...

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 wordList fields () const
 Return the list of fields required. 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 timeToNextAction ()
 Return the time to the next execute or write. More...
 
virtual bool read (const dictionary &)
 Read and set the function object if its data have changed. 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 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, 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 scalar maxDeltaT () const
 Return the maximum time-step for stable operation. 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...
 
- Protected Attributes inherited from functionObject
const Timetime_
 Reference to time. More...
 

Detailed Description

General time control for functionObjects.

Source files

Definition at line 52 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 62 of file timeControlFunctionObject.C.

References dict, and timeControl::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.

◆ fields()

Foam::wordList fields ( ) const
virtual

Return the list of fields required.

Implements functionObject.

Definition at line 85 of file timeControlFunctionObject.C.

◆ executeAtStart()

bool executeAtStart ( ) const
virtual

Return true if the functionObject should be executed.

at the start

Reimplemented from functionObject.

Definition at line 91 of file timeControlFunctionObject.C.

◆ execute()

bool execute ( )
virtual

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

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

Implements functionObject.

Definition at line 97 of file timeControlFunctionObject.C.

◆ write()

bool write ( )
virtual

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

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

Implements functionObject.

Definition at line 116 of file timeControlFunctionObject.C.

◆ end()

bool end ( )
virtual

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

Reimplemented from functionObject.

Definition at line 135 of file timeControlFunctionObject.C.

◆ timeToNextAction()

Foam::scalar timeToNextAction ( )
virtual

Return the time to the next execute or write.

if time requires adjustment

Reimplemented from functionObject.

Definition at line 146 of file timeControlFunctionObject.C.

References Foam::min().

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

References dict.

◆ movePoints()

void movePoints ( const polyMesh mesh)
virtual

Update topology using the given map.

Reimplemented from functionObject.

Definition at line 172 of file timeControlFunctionObject.C.

◆ topoChange()

void topoChange ( const polyTopoChangeMap map)
virtual

Update topology using the given map.

Reimplemented from functionObject.

Definition at line 181 of file timeControlFunctionObject.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap map)
virtual

Update from another mesh using the given map.

Reimplemented from functionObject.

Definition at line 193 of file timeControlFunctionObject.C.

◆ distribute()

void distribute ( const polyDistributionMap map)
virtual

Redistribute or update using the given distribution map.

Reimplemented from functionObject.

Definition at line 205 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: