Go to the documentation of this file.
49 #ifndef functionObjects_stateFunctionObject_H
50 #define functionObjects_stateFunctionObject_H
63 namespace functionObjects
77 static const word resultsName_;
134 bool setTrigger(
const label triggeri,
bool increaseOnly =
true);
139 const word& entryName,
146 const word& objectName,
147 const word& entryName,
155 const word& entryName,
156 const Type& defaultValue = Type(
Zero)
171 const word& objectName,
172 const word& entryName,
173 const Type& defaultValue = Type(
Zero)
180 const word& objectName,
181 const word& entryName,
189 const word& objectName,
190 const word& entryName,
201 const word& entryName,
209 const word& objectName,
210 const word& entryName,
218 const word& entryName,
219 const Type& defaultValue = Type(
Zero)
226 const word& objectName,
227 const word& entryName,
228 const Type& defaultValue = Type(
Zero)
235 const word& objectName,
236 const word& entryName,
246 const word& objectName,
247 const word& entryName
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.
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.
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.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
OBJstream os(runTime.globalPath()/outputName)
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.
word objectResultType(const word &objectName, const word &entryName) const
Return the type of result.
const word & name() const noexcept
Return the name of this functionObject.
Storage for function object properties, derived from IOdictionary. Provides functionality to read/wri...
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.
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.
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.