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.
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. |
Additional Inherited Members | |
![]() | |
typedef functionObject | value_type |
Type of values the PtrList contains. | |
typedef functionObject & | reference |
Type that can be used for storing into PtrList::value_type objects. | |
typedef const functionObject & | const_reference |
Type that can be used for storing into constant PtrList::value_type. | |
![]() | |
PtrList () | |
Null Constructor. | |
PtrList (const label) | |
Construct with length specified. | |
PtrList (const PtrList< functionObject > &) | |
Copy constructor. | |
PtrList (const PtrList< functionObject > &, const CloneArg &) | |
Copy constructor with additional argument for clone. | |
PtrList (const Xfer< PtrList< functionObject > > &) | |
Construct by transferring the parameter contents. | |
PtrList (PtrList< functionObject > &, bool reUse) | |
Construct as copy or re-use as specified. | |
PtrList (const SLPtrList< functionObject > &) | |
Construct as copy of SLPtrList<T> | |
PtrList (Istream &, const INew &) | |
Construct from Istream using given Istream constructor class. | |
PtrList (Istream &) | |
Construct from Istream using default Istream constructor class. | |
~PtrList () | |
label | size () const |
Return the number of elements in the PtrList. | |
bool | empty () const |
Return true if the PtrList is empty (ie, size() is zero). | |
void | setSize (const label) |
Reset size of PtrList. This can only be used to set the size. | |
void | resize (const label) |
Reset size of PtrList. This can only be used to set the size. | |
void | transfer (PtrList< functionObject > &) |
Transfer the contents of the argument PtrList into this PtrList. | |
Xfer< PtrList< functionObject > > | xfer () |
Transfer contents to the Xfer container. | |
bool | set (const label) const |
Is element set. | |
autoPtr< functionObject > | set (const label, functionObject *) |
Set element. Return old element (can be NULL). | |
autoPtr< functionObject > | set (const label, const autoPtr< functionObject > &) |
autoPtr< functionObject > | set (const label, const tmp< functionObject > &) |
void | reorder (const UList< label > &) |
Reorders elements. Ordering does not have to be done in. | |
const functionObject & | operator[] (const label) const |
Return element const reference. | |
functionObject & | operator[] (const label) |
Return element reference. | |
const functionObject * | operator() (const label) const |
Return element const pointer. | |
PtrList< functionObject > & | operator= (const PtrList< functionObject > &) |
Assignment. | |
iterator | begin () |
Return an iterator to begin traversing the PtrList. | |
void | read (Istream &, const INew &inewt) |
Read from Istream using given Istream constructor class. |
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.
|
virtual |
Definition at line 93 of file functionObjectList.C.
|
virtual |
Clear the list of function objects.
Reimplemented from PtrList< functionObject >.
Definition at line 99 of file functionObjectList.C.
References PtrList< T >::clear().
|
virtual |
Switch the function objects on.
Definition at line 108 of file functionObjectList.C.
|
virtual |
Switch the function objects off.
Definition at line 114 of file functionObjectList.C.
|
virtual |
Return the execution status (on/off) of the function objects.
Definition at line 121 of file functionObjectList.C.
|
virtual |
Called at the start of the time-loop.
Definition at line 127 of file functionObjectList.C.
|
virtual |
Called at each ++ or += of the time-loop.
Definition at line 133 of file functionObjectList.C.
References forAllIter.
|
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.
|
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(), PtrList< T >::setSize(), List< T >::setSize(), DLListBase::size(), functionObject::start(), entry::stream(), and PtrList< T >::transfer().