Go to the documentation of this file.
49 #ifndef functionObjects_stateFunctionObject_H
50 #define functionObjects_stateFunctionObject_H
61 namespace functionObjects
75 static const word resultsName_;
128 const word& entryName,
135 const word& objectName,
136 const word& entryName,
144 const word& entryName,
145 const Type& defaultValue = Type(
Zero)
160 const word& objectName,
161 const word& entryName,
162 const Type& defaultValue = Type(
Zero)
169 const word& objectName,
170 const word& entryName,
178 const word& objectName,
179 const word& entryName,
190 const word& entryName,
198 const word& objectName,
199 const word& entryName,
207 const word& entryName,
208 const Type& defaultValue = Type(
Zero)
215 const word& objectName,
216 const word& entryName,
217 const Type& defaultValue = Type(
Zero)
224 const word& objectName,
225 const word& entryName,
235 const word& objectName,
236 const word& entryName
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
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.
static constexpr const zero Zero
Global zero (0)
Base class for function objects, adding functionality to read/write state information (data required ...
Virtual base class for function objects with a reference to Time.
bool setTrigger(const label triggeri)
Set the current trigger index.
word resultType(const word &entryName) const
Retrieve the result type.
stateFunctionObject(const stateFunctionObject &)=delete
No copy construct.
Type getProperty(const word &entryName, const Type &defaultValue=Type(Zero)) const
Retrieve generic property.
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.
bool foundProperty(const word &entryName) const
Return true if the property exists.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
void operator=(const stateFunctionObject &)=delete
No copy assignment.
bool getDict(const word &entryName, dictionary &dict) const
Set dictionary, return true if set.
virtual ~stateFunctionObject()=default
Destructor.
const IOdictionary & stateDict() const
Return a const reference to the state dictionary.
word objectResultType(const word &objectName, const word &entryName) const
Return the type of result.
List< word > objectResultEntries() const
Retrieve the result entries.
const word & name() const
Return the name of this functionObject.
Type getObjectResult(const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
Retrieve result from named object.
void setObjectResult(const word &objectName, const word &entryName, const Type &value)
Add result from named object.
void setObjectProperty(const word &objectName, const word &entryName, const Type &value)
Add generic property from named object.
void writeResultEntries(Ostream &os) const
Write the results entries for all objects to stream.
void setResult(const word &entryName, const Type &value)
Add result.
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
void setProperty(const word &entryName, const Type &value)
Add generic property.
Type getResult(const word &entryName, const Type &defaultValue=Type(Zero)) const
Retrieve result.
Type getObjectProperty(const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
Retrieve generic property from named object.