81#ifndef functionObjectList_H
82#define functionObjectList_H
107class 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);
Enum is a wrapper around a list of names/values that represent particular enumeration (or int) values...
A HashTable similar to std::unordered_map.
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
A list of pointers to objects of type <T>, with allocation/deallocation management of the pointers....
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
A 1D vector of objects of type <T>, where the size of the vector is known and can be used for subscri...
bool empty() const noexcept
True if the list is empty (ie, size() is zero)
label size() const noexcept
The number of elements in the list.
friend Ostream & operator(Ostream &os, const UPtrList< T > &list)
Write UPtrList to Ostream.
Extract command arguments and options from the supplied argc and argv parameters.
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
A class for handling file names.
List of function objects with start(), execute() and end() functions that is called for each object.
static fileName findDict(const word &funcName)
void off()
Switch the function objects off.
static autoPtr< functionObjectList > New(const argList &args, const Time &runTime, dictionary &controlDict, HashSet< wordRe > &requiredFields)
Construct and return a functionObjectList for an application.
objectRegistry & storedObjects()
bool filesModified() const
Did any file get changed during execution?
void movePoints(const polyMesh &mesh)
Update for changes of mesh.
label findObjectID(const word &objName) const
Find the ID of a given function object by name, -1 if not found.
bool adjustTimeStep()
Called at the end of Time::adjustDeltaT() if adjustTime is true.
void updateMesh(const mapPolyMesh &mpm)
Update for changes of mesh.
bool start()
Called at the start of the time-loop.
void clear()
Clear the list of function objects.
void resetPropertiesDict()
Reset/read properties dictionary for current time.
functionObjects::properties & propsDict()
bool status() const
Return the execution status (on/off) of the function objects.
label triggerIndex() const
Return the current trigger index (read from the propsDict)
~functionObjectList()=default
Destructor.
bool execute()
Called at each ++ or += of the time-loop.
static bool readFunctionObject(const string &funcNameArgs0, dictionary &functionsDict, HashSet< wordRe > &requiredFields, const word ®ion=word::null)
static fileName functionObjectDictPath
bool end()
Called when Time::run() determines that the time-loop exits.
void on()
Switch the function objects on.
bool read()
Read and set the function objects if their data have changed.
Abstract base-class for Time/database function objects.
Storage for function object properties, derived from IOdictionary. Provides functionality to read/wri...
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
Registry of regIOobjects.
Mesh consisting of general polyhedral cells.
A class for handling words, derived from Foam::string.
runTime controlDict().readEntry("adjustTimeStep"
@ WARN
Issue warning and clamp value (this is a good default)
HashSet< word, Hash< word > > wordHashSet
A HashSet of words, uses string hasher.
Foam::argList args(argc, argv)