functionObjectList Class Reference

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

Inheritance diagram for functionObjectList:

[legend]

Collaboration diagram for functionObjectList:

[legend]

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.

---

Detailed Description

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

See also:

Foam::functionObject and Foam::OutputFilterFunctionObject

Source files

• functionObjectList.H
• functionObjectList.C

Definition at line 51 of file functionObjectList.H.

---

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 51 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 67 of file functionObjectList.C.

~functionObjectList

(

)

[virtual]

Definition at line 85 of file functionObjectList.C.

---

Member Function Documentation

void clear

(

)

[virtual]

Clear the list of function objects.

Reimplemented from PtrList< functionObject >.

Definition at line 91 of file functionObjectList.C.

Referenced by functionObjectList::on(), and Time::timeName().

Here is the caller graph for this function:

void on

(

)

[virtual]

Switch the function objects on.

Definition at line 100 of file functionObjectList.C.

References List< T >::clear(), HashTable< T, Key, Hash >::clear(), and functionObjectList::clear().

Here is the call graph for this function:

void off

(

)

[virtual]

Switch the function objects off.

Definition at line 106 of file functionObjectList.C.

bool status

(

)

const [virtual]

Return the execution status (on/off) of the function objects.

Definition at line 113 of file functionObjectList.C.

bool start

(

)

[virtual]

Called at the start of the time-loop.

Definition at line 119 of file functionObjectList.C.

bool execute

(

)

[virtual]

Called at each ++ or += of the time-loop.

Definition at line 125 of file functionObjectList.C.

bool end

(

)

[virtual]

Called when Time::run() determines that the time-loop exits.

Reimplemented from PtrList< functionObject >.

Definition at line 151 of file functionObjectList.C.

bool read

(

)

[virtual]

Read and set the function objects if their data have changed.

Definition at line 177 of file functionObjectList.C.

---

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

• src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.H
• src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.C