Base class for function objects, adding functionality to read/write state information (data required for smooth restart behaviour) and results to/from the state dictionary. More...
Public Member Functions | |
stateFunctionObject (const word &name, const Time &runTime) | |
Construct from components. More... | |
virtual | ~stateFunctionObject ()=default |
Destructor. More... | |
dictionary & | propertyDict () |
Return access to the property dictionary. More... | |
bool | foundProperty (const word &entryName) const |
Return true if the property exists. More... | |
label | getTrigger () const |
Get the current trigger index. More... | |
bool | setTrigger (const label triggeri) |
Set the current trigger index. More... | |
bool | getDict (const word &entryName, dictionary &dict) const |
Set dictionary, return true if set. More... | |
bool | getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const |
Set dictionary from named object, return true if set. More... | |
template<class Type > | |
Type | getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const |
Retrieve generic property. More... | |
template<class Type > | |
bool | getProperty (const word &entryName, Type &value) const |
Set generic property, return true if set. More... | |
template<class Type > | |
void | setProperty (const word &entryName, const Type &value) |
Add generic property. More... | |
template<class Type > | |
Type | getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const |
Retrieve generic property from named object. More... | |
template<class Type > | |
bool | getObjectProperty (const word &objectName, const word &entryName, Type &value) const |
Set generic property from named object, return true if set. More... | |
template<class Type > | |
void | setObjectProperty (const word &objectName, const word &entryName, const Type &value) |
Add generic property from named object. More... | |
template<class Type > | |
void | setResult (const word &entryName, const Type &value) |
Add result. More... | |
template<class Type > | |
void | setObjectResult (const word &objectName, const word &entryName, const Type &value) |
Add result from named object. More... | |
template<class Type > | |
Type | getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const |
Retrieve result. More... | |
template<class Type > | |
Type | getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const |
Retrieve result from named object. More... | |
template<class Type > | |
bool | getObjectResult (const word &objectName, const word &entryName, Type &value) const |
Set result from named object, return true if set. More... | |
word | resultType (const word &entryName) const |
Retrieve the result type. More... | |
word | objectResultType (const word &objectName, const word &entryName) const |
Return the type of result. More... | |
List< word > | objectResultEntries () const |
Retrieve the result entries. More... | |
List< word > | objectResultEntries (const word &objectName) const |
Return result entries for named object. More... | |
void | writeResultEntries (Ostream &os) const |
Write the results entries for all objects to stream. More... | |
void | writeResultEntries (const word &objectName, Ostream &os) const |
Write the results entries for named object to stream. More... | |
void | writeAllResultEntries (Ostream &os) const |
Write the results entries for all objects to stream. 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 () |
const objectRegistry & | storedObjects () const |
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 ()=default |
Destructor. More... | |
const word & | name () const |
Return the name of this functionObject. More... | |
virtual bool | read (const dictionary &dict) |
Read and set the function object if its data have changed. More... | |
virtual bool | execute ()=0 |
Called at each ++ or += of the time-loop. More... | |
virtual bool | execute (const label subIndex) |
Execute using the specified subIndex. More... | |
virtual bool | write ()=0 |
Called at each ++ or += of the time-loop. More... | |
virtual bool | end () |
Called when Time::run() determines that the time-loop exits. More... | |
virtual bool | adjustTimeStep () |
Called at the end of Time::adjustDeltaT() if adjustTime is true. 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... | |
Protected Member Functions | |
const IOdictionary & | stateDict () const |
Return a const reference to the state dictionary. More... | |
IOdictionary & | stateDict () |
Return non-const access to the state dictionary. More... | |
stateFunctionObject (const stateFunctionObject &)=delete | |
No copy construct. More... | |
void | operator= (const stateFunctionObject &)=delete |
No copy assignment. 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 name, e.g. used to construct local field names. 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 word | outputPrefix |
Directory prefix. More... | |
Protected Attributes inherited from timeFunctionObject | |
const Time & | time_ |
Reference to the time database. More... | |
Base class for function objects, adding functionality to read/write state information (data required for smooth restart behaviour) and results to/from the state dictionary.
Note: cannot access the state dictionary until after construction of the function objects, since the owner container functionObjectList is owned by time, and time owns the state dictionary i.e. need to wait for time to be fully constructed.
Definition at line 67 of file stateFunctionObject.H.
|
protecteddelete |
No copy construct.
stateFunctionObject | ( | const word & | name, |
const Time & | runTime | ||
) |
Construct from components.
Definition at line 56 of file stateFunctionObject.C.
|
virtualdefault |
Destructor.
|
protected |
Return a const reference to the state dictionary.
Definition at line 41 of file stateFunctionObject.C.
References Time::functionObjects(), functionObjectList::stateDict(), and timeFunctionObject::time_.
|
protected |
Return non-const access to the state dictionary.
Definition at line 47 of file stateFunctionObject.C.
|
protecteddelete |
No copy assignment.
Foam::dictionary & propertyDict | ( | ) |
Return access to the property dictionary.
Definition at line 67 of file stateFunctionObject.C.
References dictionary::add(), dictionary::found(), Foam::name(), and dictionary::subDict().
Referenced by runTimeCondition::setConditionDict().
Return true if the property exists.
Definition at line 109 of file stateFunctionObject.C.
References dictionary::found(), Foam::name(), and dictionary::subDict().
Foam::label getTrigger | ( | ) | const |
Get the current trigger index.
Definition at line 100 of file stateFunctionObject.C.
References dictionary::getOrDefault(), and Foam::labelMin.
bool setTrigger | ( | const label | triggeri | ) |
Set the current trigger index.
Definition at line 81 of file stateFunctionObject.C.
References dictionary::getOrDefault(), Foam::labelMin, and dictionary::set().
Referenced by runTimeControl::execute().
bool getDict | ( | const word & | entryName, |
dictionary & | dict | ||
) | const |
Set dictionary, return true if set.
Definition at line 126 of file stateFunctionObject.C.
References dict, and Foam::name().
bool getObjectDict | ( | const word & | objectName, |
const word & | entryName, | ||
dictionary & | dict | ||
) | const |
Set dictionary from named object, return true if set.
Definition at line 136 of file stateFunctionObject.C.
References dict, dictionary::found(), dictionary::isDict(), and dictionary::subDict().
Retrieve generic property.
Definition at line 35 of file stateFunctionObjectTemplates.C.
Set generic property, return true if set.
Definition at line 48 of file stateFunctionObjectTemplates.C.
References Foam::name().
void setProperty | ( | const word & | entryName, |
const Type & | value | ||
) |
Add generic property.
Definition at line 59 of file stateFunctionObjectTemplates.C.
References Foam::name().
Referenced by runTimeControl::execute().
Type getObjectProperty | ( | const word & | objectName, |
const word & | entryName, | ||
const Type & | defaultValue = Type(Zero) |
||
) | const |
Retrieve generic property from named object.
Definition at line 70 of file stateFunctionObjectTemplates.C.
Set generic property from named object, return true if set.
Definition at line 84 of file stateFunctionObjectTemplates.C.
References dictionary::found(), dictionary::readIfPresent(), and dictionary::subDict().
Add generic property from named object.
Definition at line 104 of file stateFunctionObjectTemplates.C.
References dictionary::add(), dictionary::found(), and dictionary::subDict().
void setResult | ( | const word & | entryName, |
const Type & | value | ||
) |
Add result.
Definition at line 124 of file stateFunctionObjectTemplates.C.
References Foam::name().
Referenced by solverInfo::updateSolverInfo().
Add result from named object.
Definition at line 135 of file stateFunctionObjectTemplates.C.
References dictionary::add(), dictionary::found(), Foam::name(), and dictionary::subDict().
Retrieve result.
Definition at line 172 of file stateFunctionObjectTemplates.C.
References Foam::name().
Type getObjectResult | ( | const word & | objectName, |
const word & | entryName, | ||
const Type & | defaultValue = Type(Zero) |
||
) | const |
Retrieve result from named object.
Definition at line 183 of file stateFunctionObjectTemplates.C.
Set result from named object, return true if set.
Definition at line 197 of file stateFunctionObjectTemplates.C.
References dictionary::found(), dictionary::readIfPresent(), and dictionary::subDict().
Foam::word resultType | ( | const word & | entryName | ) | const |
Retrieve the result type.
Definition at line 159 of file stateFunctionObject.C.
References Foam::name().
Foam::word objectResultType | ( | const word & | objectName, |
const word & | entryName | ||
) | const |
Return the type of result.
Definition at line 168 of file stateFunctionObject.C.
References dict, dictionary::found(), word::null, and dictionary::subDict().
Referenced by minMaxCondition::apply(), and fieldValueDelta::write().
Foam::List< Foam::word > objectResultEntries | ( | ) | const |
Retrieve the result entries.
Definition at line 201 of file stateFunctionObject.C.
References Foam::name().
Referenced by fieldValueDelta::write().
Foam::List< Foam::word > objectResultEntries | ( | const word & | objectName | ) | const |
Return result entries for named object.
Definition at line 209 of file stateFunctionObject.C.
References DynamicList< T, SizeMin >::append(), dict, dictionary::found(), dictionary::subDict(), and List< T >::transfer().
void writeResultEntries | ( | Ostream & | os | ) | const |
Write the results entries for all objects to stream.
Definition at line 241 of file stateFunctionObject.C.
References Foam::name(), and stateFunctionObject::writeResultEntries().
Referenced by stateFunctionObject::writeResultEntries().
Write the results entries for named object to stream.
Definition at line 250 of file stateFunctionObject.C.
References dictionary::found(), Foam::nl, dictionary::sortedToc(), and dictionary::subDict().
void writeAllResultEntries | ( | Ostream & | os | ) | const |
Write the results entries for all objects to stream.
Definition at line 282 of file stateFunctionObject.C.
References Foam::endl(), dictionary::found(), dictionary::sortedToc(), and dictionary::subDict().