Public Member Functions | List of all members
timeControl Class Reference

General time control for functionObjects. More...

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...
 
 timeControl (const timeControl &)=delete
 Disallow default bitwise copy construction. More...
 
const Time & time () const
 Return time database. More...
 
const Foam::timeControl & executeControl () const
 Return the execute control object. More...
 
const Foam::timeControl & writeControl () const
 Return the write control object. More...
 
const functionObject & filter () 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 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 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...
 
void operator= (const timeControl &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from functionObject
 ClassName ("functionObject")
 
virtual const word & type () 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< functionObject > clone () const
 Return clone. More...
 
 functionObject (const functionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~functionObject ()
 Destructor. More...
 
const word & name () 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< functionObject > New (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

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 72 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.

◆ fields()

Foam::wordList fields ( ) const
virtual

Return the list of fields required.

Implements functionObject.

Definition at line 99 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 105 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 111 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 130 of file timeControlFunctionObject.C.

◆ end()

bool end ( )
virtual

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

Reimplemented from functionObject.

Definition at line 149 of file timeControlFunctionObject.C.

◆ timeToNextWrite()

Foam::scalar timeToNextWrite ( )
virtual

Return the time to the next write.

Reimplemented from functionObject.

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

◆ movePoints()

void movePoints ( const polyMesh &  mesh)
virtual

Update topology using the given map.

Reimplemented from functionObject.

Definition at line 201 of file timeControlFunctionObject.C.

References timeControl::topoChange().

Here is the call graph for this function:

◆ topoChange()

void topoChange ( const polyTopoChangeMap &  map)
virtual

Update topology using the given map.

Reimplemented from functionObject.

Definition at line 211 of file timeControlFunctionObject.C.

References timeControl::mapMesh().

Referenced by timeControl::movePoints().

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

◆ mapMesh()

void mapMesh ( const polyMeshMap &  map)
virtual

Update from another mesh using the given map.

Reimplemented from functionObject.

Definition at line 223 of file timeControlFunctionObject.C.

Referenced by timeControl::topoChange().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const timeControl &  )
delete

Disallow default bitwise assignment.

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