General time control for functionObjects. More...


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 | 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 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, const Time &runTime) | |
| Construct from components. More... | |
| functionObject (const word &name, const Time &runTime, const dictionary &dict) | |
| Construct from dictionary. 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... | |
| 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< 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 execute at start time. More... | |
Static Public Attributes inherited from functionObject | |
| static bool | postProcess |
| Global post-processing mode switch. More... | |
Protected Attributes inherited from functionObject | |
| const Time & | time_ |
| Reference to time. More... | |
General time control for functionObjects.
Definition at line 52 of file timeControlFunctionObject.H.
| timeControl | ( | const word & | name, |
| const Time & | t, | ||
| const dictionary & | dict | ||
| ) |
Construct from components.
Definition at line 53 of file timeControlFunctionObject.C.
References dict, and timeControl::read().

|
delete |
Disallow default bitwise copy construction.
| TypeName | ( | "timeControl" | ) |
Runtime type information.
|
inline |
Return time database.
Definition at line 28 of file timeControlFunctionObjectI.H.
|
inline |
Return the execute control object.
Definition at line 35 of file timeControlFunctionObjectI.H.
|
inline |
Return the write control object.
Definition at line 42 of file timeControlFunctionObjectI.H.
|
inline |
Return the functionObject filter.
Definition at line 49 of file timeControlFunctionObjectI.H.
|
virtual |
Return the list of fields required.
Implements functionObject.
Definition at line 73 of file timeControlFunctionObject.C.
|
virtual |
Return true if the functionObject should be executed.
at the start
Reimplemented from functionObject.
Definition at line 79 of file timeControlFunctionObject.C.
|
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 85 of file timeControlFunctionObject.C.
|
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 104 of file timeControlFunctionObject.C.
|
virtual |
Called when Time::run() determines that the time-loop exits.
Reimplemented from functionObject.
Definition at line 123 of file timeControlFunctionObject.C.
|
virtual |
Return the time to the next execute or write.
if time requires adjustment
Reimplemented from functionObject.
Definition at line 134 of file timeControlFunctionObject.C.
References Foam::min().

|
virtual |
Read and set the function object if its data have changed.
Reimplemented from functionObject.
Definition at line 144 of file timeControlFunctionObject.C.
References dict.
|
virtual |
Update topology using the given map.
Reimplemented from functionObject.
Definition at line 158 of file timeControlFunctionObject.C.
References mesh.
|
virtual |
Update topology using the given map.
Reimplemented from functionObject.
Definition at line 167 of file timeControlFunctionObject.C.
|
virtual |
Update from another mesh using the given map.
Reimplemented from functionObject.
Definition at line 179 of file timeControlFunctionObject.C.
|
virtual |
Redistribute or update using the given distribution map.
Reimplemented from functionObject.
Definition at line 191 of file timeControlFunctionObject.C.
|
delete |
Disallow default bitwise assignment.