Go to the documentation of this file.
34 const Foam::word Foam::functionObjects::stateFunctionObject::resultsName_ =
52 time_.functionObjects().propsDict()
73 return stateDict().getObjectDict(
name());
79 return stateDict().clearTrigger();
85 return stateDict().getTrigger();
95 return stateDict().setTrigger(triggeri, increaseOnly);
101 const word& entryName
104 return stateDict().foundObjectProperty(
name(), entryName);
110 const word& entryName,
114 return stateDict().getObjectDict(
name(), entryName,
dict);
120 const word& objectName,
121 const word& entryName,
125 return stateDict().getObjectDict(objectName, entryName,
dict);
131 const word& entryName
134 return stateDict().objectResultType(
name(), entryName);
140 const word& objectName,
141 const word& entryName
144 return stateDict().objectResultType(objectName, entryName);
151 return stateDict().objectResultEntries(
name());
158 const word& objectName
161 return stateDict().objectResultEntries(objectName);
170 return stateDict().writeResultEntries(
name(),
os);
176 const word& objectName,
180 return stateDict().writeResultEntries(objectName,
os);
189 return stateDict().writeAllResultEntries(
os);
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
dictionary & propertyDict()
Return access to the property dictionary.
A class for handling words, derived from Foam::string.
const Time & time_
Reference to the time database.
Virtual base class for function objects with a reference to Time.
const functionObjectList & functionObjects() const
Return the list of function objects.
word resultType(const word &entryName) const
Retrieve the result type.
stateFunctionObject(const stateFunctionObject &)=delete
No copy construct.
label getTrigger() const
Get the current trigger index.
bool getObjectDict(const word &objectName, const word &entryName, dictionary &dict) const
Set dictionary from named object, return true if set.
void writeAllResultEntries(Ostream &os) const
Write the results entries for all objects to stream.
wordList objectResultEntries() const
Retrieve the result entries.
void clearTrigger()
Remove the trigger index from the properties.
bool foundProperty(const word &entryName) const
Return true if the property exists.
bool setTrigger(const label triggeri, bool increaseOnly=true)
Set the trigger index. Normally only if greater than current.
functionObjects::properties & propsDict()
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
OBJstream os(runTime.globalPath()/outputName)
bool getDict(const word &entryName, dictionary &dict) const
Set dictionary, return true if set.
word objectResultType(const word &objectName, const word &entryName) const
Return the type of result.
Storage for function object properties, derived from IOdictionary. Provides functionality to read/wri...
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
const functionObjects::properties & stateDict() const
Return a const reference to the state dictionary.
void writeResultEntries(Ostream &os) const
Write the results entries for all objects to stream.
An Ostream is an abstract base class for all output systems (streams, files, token lists,...