Overrides the timeStep. Can only be used with solvers with adjustTimeStep control (e.g. pimpleFoam). Makes no attempt to cooperate with other timeStep 'controllers' (maxCo, other functionObjects). Supports 'enabled' flag but none of the other ones 'timeStart', 'timeEnd', 'writeControl' etc. More...
Public Member Functions | |
TypeName ("setTimeStep") | |
Runtime type information. More... | |
setTimeStepFunctionObject (const word &name, const Time &runTime, const dictionary &dict) | |
Construct from components. More... | |
virtual | ~setTimeStepFunctionObject () |
const Time & | time () const |
Return time database. More... | |
virtual bool | setTimeStep () |
Override the time-step value. More... | |
virtual bool | read (const dictionary &) |
Read and set the function object if its data have changed. 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... | |
Public Member Functions inherited from 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... | |
virtual | ~functionObject () |
Destructor. More... | |
const word & | name () const |
Return the name of this functionObject. More... | |
virtual bool | end () |
Called when Time::run() determines that the time-loop exits. More... | |
virtual scalar | timeToNextWrite () |
Called by Time::adjustTimeStep(). Allows the function object to. 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... | |
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... | |
Static Public Attributes inherited from functionObject | |
static int | debug |
static bool | postProcess |
Global post-processing mode switch. More... | |
Overrides the timeStep. Can only be used with solvers with adjustTimeStep control (e.g. pimpleFoam). Makes no attempt to cooperate with other timeStep 'controllers' (maxCo, other functionObjects). Supports 'enabled' flag but none of the other ones 'timeStart', 'timeEnd', 'writeControl' etc.
Definition at line 55 of file setTimeStepFunctionObject.H.
setTimeStepFunctionObject | ( | const word & | name, |
const Time & | runTime, | ||
const dictionary & | dict | ||
) |
Construct from components.
Definition at line 50 of file setTimeStepFunctionObject.C.
References Foam::read().
|
virtual |
Definition at line 65 of file setTimeStepFunctionObject.C.
TypeName | ( | "setTimeStep" | ) |
Runtime type information.
const Foam::Time & time | ( | ) | const |
Return time database.
Definition at line 72 of file setTimeStepFunctionObject.C.
|
virtual |
Override the time-step value.
Reimplemented from functionObject.
Definition at line 78 of file setTimeStepFunctionObject.C.
References setTimeStepFunctionObject::read().
|
virtual |
Read and set the function object if its data have changed.
Reimplemented from functionObject.
Definition at line 90 of file setTimeStepFunctionObject.C.
References Function1< Type >::New().
Referenced by setTimeStepFunctionObject::setTimeStep().
|
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 100 of file setTimeStepFunctionObject.C.
References adjustTimeStep.
|
virtual |
Called at each ++ or += of the time-loop.
postProcess overrides the usual writeControl behaviour and forces writing always (used in post-processing mode)
Implements functionObject.
Definition at line 114 of file setTimeStepFunctionObject.C.