Go to the documentation of this file.
81 #ifndef functionObjectList_H
82 #define functionObjectList_H
107 class functionObjectList
109 private PtrList<functionObject>
114 enum class errorHandlingType : uint8_t
123 static const Enum<errorHandlingType> errorHandlingNames_;
129 List<errorHandlingType> errorHandling_;
171 void createPropertiesDict()
const;
174 void createOutputRegistry()
const;
179 autoPtr<functionObject> remove(
const word&
key, label& oldIndex);
183 static void listDir(
const fileName& dir,
wordHashSet& available);
190 errorHandlingType getOrDefaultErrorHandling
193 const dictionary&
dict,
194 const errorHandlingType deflt
199 functionObjectList(
const functionObjectList&) =
delete;
202 void operator=(
const functionObjectList&) =
delete;
221 const bool execution=
true
235 const bool execution=
true
330 const string& funcNameArgs0,
359 bool execute(
const label subIndex);
void movePoints(const polyMesh &mesh)
Update for changes of mesh.
bool status() const
Return the execution status (on/off) of the function objects.
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
bool adjustTimeStep()
Called at the end of Time::adjustDeltaT() if adjustTime is true.
static fileName findDict(const word &funcName)
A class for handling words, derived from Foam::string.
A class for handling file names.
void on()
Switch the function objects on.
auto key(const Type &t) -> typename std::enable_if< std::is_enum< Type >::value, typename std::underlying_type< Type >::type >::type
void updateMesh(const mapPolyMesh &mpm)
Update for changes of mesh.
Extract command arguments and options from the supplied argc and argv parameters.
bool execute()
Called at each ++ or += of the time-loop.
List of function objects with start(), execute() and end() functions that is called for each object.
bool start()
Called at the start of the time-loop.
Mesh consisting of general polyhedral cells.
void clear()
Clear the list of function objects.
Registry of regIOobjects.
void off()
Switch the function objects off.
label triggerIndex() const
Return the current trigger index (read from the propsDict)
runTime controlDict().readEntry("adjustTimeStep"
label findObjectID(const word &objName) const
Find the ID of a given function object by name, -1 if not found.
static fileName functionObjectDictPath
A list of pointers to objects of type <T>, with allocation/deallocation management of the pointers....
void resetPropertiesDict()
Reset/read properties dictionary for current time.
~functionObjectList()=default
Destructor.
functionObjects::properties & propsDict()
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
static autoPtr< functionObjectList > New(const argList &args, const Time &runTime, dictionary &controlDict, HashSet< wordRe > &requiredFields)
Construct and return a functionObjectList for an application.
Issue warning and clamp value (this is a good default)
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
static bool readFunctionObject(const string &funcNameArgs0, dictionary &functionsDict, HashSet< wordRe > &requiredFields, const word ®ion=word::null)
Storage for function object properties, derived from IOdictionary. Provides functionality to read/wri...
A 1D vector of objects of type <T>, where the size of the vector is known and can be used for subscri...
static const word null
An empty word.
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
HashSet< word, Hash< word > > wordHashSet
A HashSet of words, uses string hasher.
bool read()
Read and set the function objects if their data have changed.
Foam::argList args(argc, argv)
bool end()
Called when Time::run() determines that the time-loop exits.
objectRegistry & storedObjects()
bool filesModified() const
Did any file get changed during execution?