FreeFOAM The Cross-Platform CFD Toolkit
functionObjectList Class Reference

List of function objects with start(), execute() and end() functions that is called for each object. More...

#include <OpenFOAM/functionObjectList.H>


Detailed Description

+ Inheritance diagram for functionObjectList:
+ Collaboration diagram for functionObjectList:

List of all members.

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

- Private Types inherited from PtrList< functionObject >
typedef functionObject value_type
 Type of values the PtrList contains.
typedef functionObjectreference
 Type that can be used for storing into PtrList::value_type objects.
typedef const functionObjectconst_reference
 Type that can be used for storing into constant PtrList::value_type.
- Private Member Functions inherited from PtrList< functionObject >
 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< functionObjectset (const label, functionObject *)
 Set element. Return old element (can be NULL).
autoPtr< functionObjectset (const label, const autoPtr< functionObject > &)
autoPtr< functionObjectset (const label, const tmp< functionObject > &)
void reorder (const UList< label > &)
 Reorders elements. Ordering does not have to be done in.
const functionObjectoperator[] (const label) const
 Return element const reference.
functionObjectoperator[] (const label)
 Return element reference.
const functionObjectoperator() (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.

Constructor & Destructor Documentation

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.

Parameters:
[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.


Member Function Documentation

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.


The documentation for this class was generated from the following files: