49#ifndef functionObjects_stateFunctionObject_H
50#define functionObjects_stateFunctionObject_H
63namespace functionObjects
77 static const word resultsName_;
134 const word& entryName,
141 const word& objectName,
142 const word& entryName,
150 const word& entryName,
151 const Type& defaultValue = Type(
Zero)
166 const word& objectName,
167 const word& entryName,
168 const Type& defaultValue = Type(
Zero)
175 const word& objectName,
176 const word& entryName,
184 const word& objectName,
185 const word& entryName,
196 const word& entryName,
204 const word& objectName,
205 const word& entryName,
213 const word& entryName,
214 const Type& defaultValue = Type(
Zero)
221 const word& objectName,
222 const word& entryName,
223 const Type& defaultValue = Type(
Zero)
230 const word& objectName,
231 const word& entryName,
241 const word& objectName,
242 const word& entryName
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
const word & name() const noexcept
Return the name of this functionObject.
Storage for function object properties, derived from IOdictionary. Provides functionality to read/wri...
Base class for function objects, adding functionality to read/write state information (data required ...
bool getObjectDict(const word &objectName, const word &entryName, dictionary &dict) const
Set dictionary from named object, return true if set.
void setObjectResult(const word &objectName, const word &entryName, const Type &value)
Add result from named object.
void setResult(const word &entryName, const Type &value)
Add result.
Type getObjectProperty(const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
Retrieve generic property from named object.
bool getDict(const word &entryName, dictionary &dict) const
Set dictionary, return true if set.
bool setTrigger(const label triggeri)
Set new trigger index.
word objectResultType(const word &objectName, const word &entryName) const
Return the type of result.
bool foundProperty(const word &entryName) const
Return true if the property exists.
void setProperty(const word &entryName, const Type &value)
Add generic property.
void writeAllResultEntries(Ostream &os) const
Write the results entries for all objects to stream.
void setObjectProperty(const word &objectName, const word &entryName, const Type &value)
Add generic property from named object.
stateFunctionObject(const stateFunctionObject &)=delete
No copy construct.
Type getProperty(const word &entryName, const Type &defaultValue=Type(Zero)) const
Retrieve generic property.
virtual ~stateFunctionObject()=default
Destructor.
void writeResultEntries(Ostream &os) const
Write the results entries for all objects to stream.
void operator=(const stateFunctionObject &)=delete
No copy assignment.
void clearTrigger()
Remove the trigger index from the properties.
Type getResult(const word &entryName, const Type &defaultValue=Type(Zero)) const
Retrieve result.
const functionObjects::properties & stateDict() const
Return a const reference to the state dictionary.
label getTrigger() const
Get the current trigger index.
dictionary & propertyDict()
Return access to the property dictionary.
wordList objectResultEntries() const
Retrieve the result entries.
Type getObjectResult(const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
Retrieve result from named object.
word resultType(const word &entryName) const
Retrieve the result type.
Virtual base class for function objects with a reference to Time.
A class for handling words, derived from Foam::string.
OBJstream os(runTime.globalPath()/outputName)
static constexpr const zero Zero
Global zero (0)