Adjusts the time step to match bulk reaction time scales. This allows the solver to temporally resolve chemical changes, in order to better couple the chemistry and transport, or to improve the time-accuracy of post-processing. More...
Public Member Functions | |
TypeName ("adjustTimeStepToCombustion") | |
Runtime type information. More... | |
adjustTimeStepToCombustion (const word &name, const Time &runTime, const dictionary &dict) | |
Construct from components. More... | |
adjustTimeStepToCombustion (const adjustTimeStepToCombustion &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~adjustTimeStepToCombustion () |
virtual bool | read (const dictionary &) |
Read and reset the timeStep Function1. More... | |
virtual wordList | fields () const |
Return the list of fields required. More... | |
virtual bool | execute () |
Reset the timeStep from the Function1 of time. More... | |
virtual bool | write () |
Do nothing. More... | |
void | operator= (const adjustTimeStepToCombustion &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from regionFunctionObject | |
TypeName ("regionFunctionObject") | |
Runtime type information. More... | |
regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict) | |
Construct from Time and dictionary. More... | |
regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict) | |
Construct from the region objectRegistry and dictionary. More... | |
regionFunctionObject (const regionFunctionObject &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~regionFunctionObject () |
Destructor. More... | |
void | operator= (const regionFunctionObject &)=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... | |
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 bool | executeAtStart () const |
Return true if the functionObject should be executed at the start. More... | |
virtual bool | end () |
Called when Time::run() determines that the time-loop exits. More... | |
virtual scalar | timeToNextAction () |
Called by Time::adjustTimeStep(). Allows the functionObject to. 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 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... | |
Protected Member Functions inherited from regionFunctionObject | |
template<class ObjectType > | |
bool | foundObject (const word &fieldName) const |
Find field in the objectRegistry. More... | |
template<class ObjectType > | |
void | cannotFindObject (const word &fieldName) |
Prints a warning message that fieldName cannot be found. More... | |
void | cannotFindObject (const word &fieldName) |
Prints a warning message that fieldName cannot be found. More... | |
template<class ObjectType > | |
const ObjectType & | lookupObject (const word &fieldName) const |
Lookup object from the objectRegistry. More... | |
template<class ObjectType > | |
ObjectType & | lookupObjectRef (const word &fieldName) |
Lookup non-const object reference from the objectRegistry. More... | |
template<class ObjectType > | |
bool | store (const tmp< ObjectType > &tfield) |
Store the given field in the objectRegistry. More... | |
template<class ObjectType > | |
bool | store (const word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false) |
Store the given field in the objectRegistry under the given name. More... | |
bool | writeObject (const word &fieldName) |
Write field if present in objectRegistry. More... | |
bool | clearObject (const word &fieldName) |
Clear field from the objectRegistry if present. More... | |
Protected Attributes inherited from regionFunctionObject | |
const objectRegistry & | obr_ |
Reference to the region objectRegistry. More... | |
Protected Attributes inherited from functionObject | |
const Time & | time_ |
Reference to time. More... | |
Adjusts the time step to match bulk reaction time scales. This allows the solver to temporally resolve chemical changes, in order to better couple the chemistry and transport, or to improve the time-accuracy of post-processing.
Note that this function only does anything if time step adjustment is enabled in the controlDict.
Example of function object specification:
adjustTimeStepToCombustion1 { type adjustTimeStepToCombustion; libs ("libcombustionModels.so"); maxCo 0.1; extrapolate no; }
Property | Description | Required | Default value |
---|---|---|---|
type | type name: adjustTimeStepToCombustion | yes | |
phase | name of the reacting phase | no | |
maxCo | maximum combustion "Courant" number | no | 1 |
extrapolate | try to extrapolate decreases | no | false |
Definition at line 102 of file adjustTimeStepToCombustion.H.
adjustTimeStepToCombustion | ( | const word & | name, |
const Time & | runTime, | ||
const dictionary & | dict | ||
) |
Construct from components.
Definition at line 72 of file adjustTimeStepToCombustion.C.
References dict, and adjustTimeStepToCombustion::read().
|
delete |
Disallow default bitwise copy construction.
|
virtual |
Definition at line 92 of file adjustTimeStepToCombustion.C.
TypeName | ( | "adjustTimeStepToCombustion" | ) |
Runtime type information.
|
virtual |
Read and reset the timeStep Function1.
Reimplemented from regionFunctionObject.
Definition at line 98 of file adjustTimeStepToCombustion.C.
References dict, IOobject::MUST_READ_IF_MODIFIED, word::null, and propsDict().
Referenced by adjustTimeStepToCombustion::adjustTimeStepToCombustion().
|
inlinevirtual |
Return the list of fields required.
Implements functionObject.
Definition at line 165 of file adjustTimeStepToCombustion.H.
References List< word >::null().
|
virtual |
Reset the timeStep from the Function1 of time.
Implements functionObject.
Definition at line 128 of file adjustTimeStepToCombustion.C.
References combustionModel::combustionPropertiesName, solver::deltaTFactor, Foam::dimless, Foam::dimTime, f(), forAll, Foam::gMax(), IOobject::groupName(), Foam::mag(), Foam::max(), combustionModel::mesh(), Foam::min(), DimensionedField< Type, GeoMesh >::New(), combustionModel::R(), Foam::sqr(), Foam::sqrt(), thermo, combustionModel::thermo(), and x.
|
virtual |
Do nothing.
Implements functionObject.
Definition at line 202 of file adjustTimeStepToCombustion.C.
References IOobject::NO_READ, and propsDict().
|
delete |
Disallow default bitwise assignment.