47 #ifndef functionObjects_properties_H 48 #define functionObjects_properties_H 56 namespace functionObjects
70 static const word resultsName_;
116 const word& objectName,
117 const word& entryName
133 const word& objectName,
134 const word& entryName,
142 const word& objectName,
143 const word& entryName,
144 const Type& defaultValue = Type(
Zero)
151 const word& objectName,
152 const word& entryName,
160 const word& objectName,
161 const word& entryName,
171 const word& objectName,
179 const word& objectName,
180 const word& entryName,
188 const word& objectName,
189 const word& entryName,
190 const Type& defaultValue = Type(
Zero)
197 const word& objectName,
198 const word& entryName,
212 const word& objectName,
213 const word& entryName
219 const word& objectName,
220 const word& entryName
properties(const properties &)=delete
No copy construct.
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...
dictionary & getObjectDict(const word &objectName)
Get dictionary for named object. Creates one if required.
wordList objectNames() const
Return list of object names.
label getTrigger() const
Get the current trigger index.
void writeAllResultEntries(Ostream &os) const
Write the results entries for all objects to stream.
wordList objectResultEntries(const word &objectName) const
Return result entries for named object.
bool foundObjectProperty(const word &objectName, const word &entryName) const
Return true if the property exists.
bool setTrigger(const label triggeri)
Set new trigger index.
void setObjectResult(const word &objectName, const word &entryName, const Type &value)
Add result from named object.
Type getObjectResult(const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
Retrieve result from named object.
wordList objectResultNames() const
Return list of objects with results.
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
virtual ~properties()=default
Destructor.
void writeResultEntries(Ostream &os) const
Write the results entries for all objects to stream.
bool hasResultObjectEntry(const word &objectName, const word &entryName) const
Return true if the object with objectName exists and has entryName in its results.
void setObjectProperty(const word &objectName, const word &entryName, const Type &value)
Add generic property from named object.
void clearTrigger()
Remove the trigger index from the properties.
A class for handling words, derived from Foam::string.
dictionary & propertyDict(const word &objectName)
Return access to the property dictionary.
bool hasObjectDict(const word &objectName) const
Return true if the object with objectName exists.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
bool hasResultObject(const word &objectName) const
Return true if the object with objectName exists in results.
OBJstream os(runTime.globalPath()/outputName)
void operator=(const properties &)=delete
No copy assignment.
Type getObjectProperty(const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
Retrieve generic property from named object.
word objectResultType(const word &objectName, const word &entryName) const
Return the type of result.
IOobject io("surfaceFilmProperties", mesh.time().constant(), mesh, IOobject::READ_IF_PRESENT, IOobject::NO_WRITE, IOobject::NO_REGISTER)
bool getObjectResultDict(const word &objectName, dictionary &dict) const
Get dictionary of object results, return true if set.
Defines the attributes of an object for which implicit objectRegistry management is supported...
static constexpr const zero Zero
Global zero (0)