This function object controls the time step for classes of the type regionFaModel
. It reads regionFaMaxCo
entry from controlDict
and evaluate the time step based on the finite area Courant Number.
More...
Public Member Functions | |
TypeName ("setTimeStepFaRegion") | |
Runtime type information. More... | |
setTimeStepFaRegionsFunctionObject (const word &name, const Time &runTime, const dictionary &dict) | |
Construct from components. More... | |
virtual | ~setTimeStepFaRegionsFunctionObject ()=default |
virtual bool | adjustTimeStep () |
Called at the end of Time::adjustDeltaT() if adjustTime is true. More... | |
virtual bool | read (const dictionary &dict) |
Read and set the function object if its data have changed. More... | |
virtual bool | execute () |
Execute does nothing. More... | |
virtual bool | write () |
Write does nothing. More... | |
Public Member Functions inherited from timeFunctionObject | |
timeFunctionObject (const word &name, const Time &runTime) | |
Construct from Time. More... | |
virtual | ~timeFunctionObject ()=default |
Destructor. More... | |
const Time & | time () const |
Return time database. More... | |
objectRegistry & | storedObjects () |
Write access to the output objects ("functionObjectObjects") registered on Time. More... | |
const objectRegistry & | storedObjects () const |
Const access to the output objects ("functionObjectObjects") registered on Time. More... | |
Public Member Functions inherited from functionObject | |
declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict)) | |
functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix) | |
Construct from components. More... | |
autoPtr< functionObject > | clone () const |
Return clone. More... | |
virtual | ~functionObject ()=default |
Destructor. More... | |
virtual const word & | type () const =0 |
Runtime type information. More... | |
const word & | name () const noexcept |
Return the name of this functionObject. More... | |
bool | useNamePrefix () const noexcept |
Return the flag for adding a scoping name prefix. More... | |
bool | useNamePrefix (bool on) noexcept |
Modify the flag for adding a scoping name prefix. More... | |
virtual bool | execute (const label subIndex) |
Execute using the specified subIndex. More... | |
virtual bool | end () |
Called when Time::run() determines that the time-loop exits. More... | |
virtual bool | filesModified () const |
Did any file get changed during execution? 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 &runTime, const dictionary &dict) |
Select from dictionary, based on its "type" entry. More... | |
Public Attributes inherited from functionObject | |
bool | log |
Flag to write log into Info. More... | |
Static Public Attributes inherited from functionObject | |
static int | debug |
Flag to execute debug content. More... | |
static bool | postProcess |
Global post-processing mode switch. More... | |
static bool | defaultUseNamePrefix |
Global default for useNamePrefix. More... | |
static word | outputPrefix |
Directory prefix. More... | |
Protected Member Functions inherited from timeFunctionObject | |
void | clearOutputObjects (const wordList &objNames) |
Remove specified items from "functionObjectObjects". More... | |
timeFunctionObject (const timeFunctionObject &)=delete | |
No copy construct. More... | |
void | operator= (const timeFunctionObject &)=delete |
No copy assignment. More... | |
Protected Member Functions inherited from functionObject | |
word | scopedName (const word &name) const |
Return a scoped (prefixed) name. More... | |
Protected Attributes inherited from timeFunctionObject | |
const Time & | time_ |
Reference to the time database. More... | |
This function object controls the time step for classes of the type regionFaModel
. It reads regionFaMaxCo
entry from controlDict
and evaluate the time step based on the finite area Courant Number.
Can only be used with solvers using adjustTimeStep
control (e.g. pimpleFoam
). It makes no attempt to co-operate with other time step 'controllers', e.g. maxCo
, other functionObjects. Supports enabled
flag but none of the other options timeStart
, timeEnd
, writeControl
etc.
setTimeStep1 { // Mandatory entries type setTimeStepFaRegion; // Inherited entries ... }
where the entries mean:
Property | Description | Type | Reqd | Deflt |
---|---|---|---|---|
type | Type name: setTimeStepFaRegion | word | yes | - |
enabled | On/off switch | bool | no | yes |
The inherited entries are elaborated in:
Definition at line 104 of file setTimeStepFaRegionsFunctionObject.H.
setTimeStepFaRegionsFunctionObject | ( | const word & | name, |
const Time & | runTime, | ||
const dictionary & | dict | ||
) |
Construct from components.
Definition at line 46 of file setTimeStepFaRegionsFunctionObject.C.
References dict, and Foam::blockMeshTools::read().
|
virtualdefault |
TypeName | ( | "setTimeStepFaRegion" | ) |
Runtime type information.
|
virtual |
Called at the end of Time::adjustDeltaT() if adjustTime is true.
Reimplemented from functionObject.
Definition at line 60 of file setTimeStepFaRegionsFunctionObject.C.
References TimeState::deltaTValue(), timeFunctionObject::time_, and TimeState::timeIndex().
|
virtual |
Read and set the function object if its data have changed.
Reimplemented from functionObject.
Definition at line 84 of file setTimeStepFaRegionsFunctionObject.C.
References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::nl, and functionObject::read().
|
virtual |
Execute does nothing.
Implements functionObject.
Definition at line 138 of file setTimeStepFaRegionsFunctionObject.C.
|
virtual |
Write does nothing.
Implements functionObject.
Definition at line 144 of file setTimeStepFaRegionsFunctionObject.C.