List of function objects with start(), execute() and end() functions that is called for each object. More...
#include <OpenFOAM/functionObjectList.H>
List of function objects with start(), execute() and end() functions that is called for each object.
Definition at line 56 of file functionObjectList.H.
Inheritance diagram for functionObjectList: Collaboration diagram for functionObjectList:Public Member Functions | |
| functionObjectList (const Time &, const bool execution=true) | |
| Construct from Time and the execution setting.
| |
| functionObjectList (const Time &, const dictionary &parentDict, const bool execution=true) | |
| Construct from Time, a dictionary with "functions" entry.
| |
| virtual | ~functionObjectList () |
| virtual void | clear () |
| Clear the list of function objects.
| |
| virtual void | on () |
| Switch the function objects on.
| |
| virtual void | off () |
| Switch the function objects off.
| |
| virtual bool | status () const |
| Return the execution status (on/off) of the function objects.
| |
| virtual bool | start () |
| Called at the start of the time-loop.
| |
| virtual bool | execute () |
| Called at each ++ or += of the time-loop.
| |
| virtual bool | end () |
| Called when Time::run() determines that the time-loop exits.
| |
| virtual bool | read () |
| Read and set the function objects if their data have changed.
| |
| functionObjectList | ( | const Time & | t, |
| const bool | execution = true
|
||
| ) |
Construct from Time and the execution setting.
The functionObject specifications are read from the controlDict
Definition at line 59 of file functionObjectList.C.
| functionObjectList | ( | const Time & | t, |
| const dictionary & | parentDict, | ||
| const bool | execution = true
|
||
| ) |
Construct from Time, a dictionary with "functions" entry.
and the execution setting.
| [in] | parentDict | - the parent dictionary containing a "functions" entry, which can either be a list or a dictionary of functionObject specifications. |
Definition at line 75 of file functionObjectList.C.
| ~functionObjectList | ( | ) | [virtual]
|
Definition at line 93 of file functionObjectList.C.
| void clear | ( | ) | [virtual]
|
Clear the list of function objects.
Reimplemented from PtrList< functionObject >.
Definition at line 99 of file functionObjectList.C.
References PtrList< T >::clear().
| void on | ( | ) | [virtual]
|
Switch the function objects on.
Definition at line 108 of file functionObjectList.C.
| void off | ( | ) | [virtual]
|
Switch the function objects off.
Definition at line 114 of file functionObjectList.C.
| bool status | ( | ) | const [virtual]
|
Return the execution status (on/off) of the function objects.
Definition at line 121 of file functionObjectList.C.
| bool start | ( | ) | [virtual]
|
Called at the start of the time-loop.
Definition at line 127 of file functionObjectList.C.
| bool execute | ( | ) | [virtual]
|
Called at each ++ or += of the time-loop.
Definition at line 133 of file functionObjectList.C.
References forAllIter.
| bool end | ( | ) | [virtual]
|
Called when Time::run() determines that the time-loop exits.
Reimplemented from PtrList< functionObject >.
Definition at line 159 of file functionObjectList.C.
References forAllIter.
| bool read | ( | ) | [virtual]
|
Read and set the function objects if their data have changed.
Definition at line 185 of file functionObjectList.C.
References PtrList< T >::clear(), entry::dict(), dictionary::digest(), forAllConstIter, forAllIter, HashTable< T, Key, Hash >::insert(), entry::isDict(), functionObject::New(), functionObject::read(), PtrList< T >::set(), List< T >::setSize(), PtrList< T >::setSize(), DLListBase::size(), functionObject::start(), entry::stream(), and PtrList< T >::transfer().
