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();
94 return stateDict().setTrigger(triggeri);
100 const word& entryName
103 return stateDict().foundObjectProperty(
name(), entryName);
109 const word& entryName,
113 return stateDict().getObjectDict(
name(), entryName,
dict);
119 const word& objectName,
120 const word& entryName,
124 return stateDict().getObjectDict(objectName, entryName,
dict);
130 const word& objectName,
134 return stateDict().getObjectResultDict(objectName,
dict);
140 const word& entryName
143 return stateDict().objectResultType(
name(), entryName);
149 const word& objectName,
150 const word& entryName
153 return stateDict().objectResultType(objectName, entryName);
160 return stateDict().objectResultEntries(
name());
167 const word& objectName
170 return stateDict().objectResultEntries(objectName);
179 return stateDict().writeResultEntries(
name(),
os);
185 const word& objectName,
189 return stateDict().writeResultEntries(objectName,
os);
198 return stateDict().writeAllResultEntries(
os);
wordList objectResultEntries() const
Retrieve the result entries.
word objectResultType(const word &objectName, const word &entryName) const
Return the type of result.
void writeAllResultEntries(Ostream &os) const
Write the results entries for all objects to stream.
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Storage for function object properties, derived from IOdictionary. Provides functionality to read/wri...
bool getDict(const word &entryName, dictionary &dict) const
Set dictionary, return true if set.
functionObjects::properties & propsDict()
Write access to the properties dictionary ("functionObjectProperties") registered on Time...
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
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.
bool setTrigger(const label triggeri)
Set new trigger index.
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for expressions::valueTypeCode::INVALID.
stateFunctionObject(const stateFunctionObject &)=delete
No copy construct.
const functionObjectList & functionObjects() const noexcept
Return the list of function objects.
A class for handling words, derived from Foam::string.
word resultType(const word &entryName) const
Retrieve the result type.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
label getTrigger() const
Get the current trigger index.
OBJstream os(runTime.globalPath()/outputName)
dictionary & propertyDict()
Return access to the property dictionary.
bool getObjectDict(const word &objectName, const word &entryName, dictionary &dict) const
Set dictionary from named object, return true if set.
void clearTrigger()
Remove the trigger index from the properties.
bool getObjectResultDict(const word &objectName, dictionary &dict) const
bool foundProperty(const word &entryName) const
Return true if the property exists.
Virtual base class for function objects with a reference to Time.
const Time & time_
Reference to the time database.