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... | |
void | clearTrigger () |
Remove the trigger index from the properties. More... | |
label | getTrigger () const |
Get the current trigger index. More... | |
bool | setTrigger (const label triggeri) |
Set new 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... | |
bool | getObjectResultDict (const word &objectName, dictionary &dict) const |
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... | |
wordList | objectResultEntries () const |
Retrieve the result entries. More... | |
wordList | 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 () |
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 | 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 functionObjects::properties & | stateDict () const |
Return a const reference to the state dictionary. More... | |
functionObjects::properties & | 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 (prefixed) name. 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 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 65 of file stateFunctionObject.H.
|
protecteddelete |
No copy construct.
stateFunctionObject | ( | const word & | name, |
const Time & | runTime | ||
) |
Construct from components.
Definition at line 53 of file stateFunctionObject.C.
|
virtualdefault |
Destructor.
|
protected |
Return a const reference to the state dictionary.
Definition at line 34 of file stateFunctionObject.C.
References Time::functionObjects(), functionObjectList::propsDict(), and timeFunctionObject::time_.
|
protected |
Return non-const access to the state dictionary.
Definition at line 41 of file stateFunctionObject.C.
|
protecteddelete |
No copy assignment.
Foam::dictionary & propertyDict | ( | ) |
Return access to the property dictionary.
Definition at line 64 of file stateFunctionObject.C.
References Foam::name().
Referenced by runTimeCondition::setConditionDict().
bool foundProperty | ( | const word & | entryName | ) | const |
Return true if the property exists.
Definition at line 92 of file stateFunctionObject.C.
References Foam::name().
void clearTrigger | ( | ) |
Remove the trigger index from the properties.
Definition at line 70 of file stateFunctionObject.C.
Foam::label getTrigger | ( | ) | const |
Get the current trigger index.
Definition at line 76 of file stateFunctionObject.C.
bool setTrigger | ( | const label | triggeri | ) |
Set new trigger index.
Definition at line 83 of file stateFunctionObject.C.
Referenced by runTimeControl::execute().
bool getDict | ( | const word & | entryName, |
dictionary & | dict | ||
) | const |
Set dictionary, return true if set.
Definition at line 101 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 111 of file stateFunctionObject.C.
References dict.
Retrieve generic property.
Definition at line 28 of file stateFunctionObjectTemplates.C.
bool getProperty | ( | const word & | entryName, |
Type & | value | ||
) | const |
Set generic property, return true if set.
Definition at line 41 of file stateFunctionObjectTemplates.C.
References Foam::name().
void setProperty | ( | const word & | entryName, |
const Type & | value | ||
) |
Add generic property.
Definition at line 52 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 63 of file stateFunctionObjectTemplates.C.
Set generic property from named object, return true if set.
Definition at line 77 of file stateFunctionObjectTemplates.C.
Add generic property from named object.
Definition at line 89 of file stateFunctionObjectTemplates.C.
bool getObjectResultDict | ( | const word & | objectName, |
dictionary & | dict | ||
) | const |
Definition at line 122 of file stateFunctionObject.C.
References dict.
void setResult | ( | const word & | entryName, |
const Type & | value | ||
) |
Add result.
Definition at line 101 of file stateFunctionObjectTemplates.C.
References Foam::name().
Referenced by solverInfo::updateSolverInfo().
Add result from named object.
Definition at line 112 of file stateFunctionObjectTemplates.C.
Retrieve result.
Definition at line 124 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 135 of file stateFunctionObjectTemplates.C.
Set result from named object, return true if set.
Definition at line 149 of file stateFunctionObjectTemplates.C.
Foam::word resultType | ( | const word & | entryName | ) | const |
Retrieve the result type.
Definition at line 132 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 141 of file stateFunctionObject.C.
Referenced by minMaxCondition::apply(), and multiFieldValue::write().
Foam::wordList objectResultEntries | ( | ) | const |
Retrieve the result entries.
Definition at line 151 of file stateFunctionObject.C.
References Foam::name().
Referenced by multiFieldValue::write().
Foam::wordList objectResultEntries | ( | const word & | objectName | ) | const |
Return result entries for named object.
Definition at line 159 of file stateFunctionObject.C.
void writeResultEntries | ( | Ostream & | os | ) | const |
Write the results entries for all objects to stream.
Definition at line 168 of file stateFunctionObject.C.
References Foam::name(), and os().
Write the results entries for named object to stream.
Definition at line 177 of file stateFunctionObject.C.
References os().
void writeAllResultEntries | ( | Ostream & | os | ) | const |
Write the results entries for all objects to stream.
Definition at line 187 of file stateFunctionObject.C.
References os().