OutputFilterFunctionObject< OutputFilter > Class Template Reference

A functionObject wrapper around OutputFilter to allow them to be created via the functions list within controlDict. More...

#include <OpenFOAM/OutputFilterFunctionObject.H>

---

Detailed Description

template<class OutputFilter>
class Foam::OutputFilterFunctionObject< OutputFilter >

A functionObject wrapper around OutputFilter to allow them to be created via the functions list within controlDict.

Note:

Since the timeIndex is used directly from Foam::Time, it is unaffected by user-time conversions. For example, Foam::engineTime might cause writeInterval to be degrees crank angle, but the functionObject execution interval would still be in timestep.

Source files

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

Definition at line 59 of file OutputFilterFunctionObject.H.

Inheritance diagram for OutputFilterFunctionObject< OutputFilter >:

Collaboration diagram for OutputFilterFunctionObject< OutputFilter >:

List of all members.

Public Member Functions
	TypeName (OutputFilter::typeName_())
	Runtime type information.
	OutputFilterFunctionObject (const word &name, const Time &, const dictionary &)
	Construct from components.
virtual const Time &	time () const
	Return time database.
virtual const dictionary &	dict () const
	Return the input dictionary.
virtual const word &	regionName () const
	Return the region name.
virtual const word &	dictName () const
	Return the optional dictionary name.
virtual bool	enabled () const
	Return the enabled flag.
virtual const outputFilterOutputControl &	outputControl () const
	Return the output control object.
virtual const OutputFilter &	outputFilter () const
	Return the output filter.
virtual void	on ()
	Switch the function object on.
virtual void	off ()
	Switch the function object off.
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 (const dictionary &)
	Read and set the function object if its data have changed.

---

Constructor & Destructor Documentation

OutputFilterFunctionObject	(	const word &	name,
		const Time &	t,
		const dictionary &	dict
	)

Construct from components.

Definition at line 81 of file OutputFilterFunctionObject.C.

---

Member Function Documentation

TypeName

(

OutputFilter::

typeName_()  )

Runtime type information.

virtual const Time& time

(

)

const [inline, virtual]

Return time database.

Definition at line 131 of file OutputFilterFunctionObject.H.

virtual const dictionary& dict

(

)

const [inline, virtual]

Return the input dictionary.

Definition at line 137 of file OutputFilterFunctionObject.H.

virtual const word& regionName

(

)

const [inline, virtual]

Return the region name.

Definition at line 143 of file OutputFilterFunctionObject.H.

virtual const word& dictName

(

)

const [inline, virtual]

Return the optional dictionary name.

Definition at line 149 of file OutputFilterFunctionObject.H.

virtual bool enabled

(

)

const [inline, virtual]

Return the enabled flag.

Definition at line 155 of file OutputFilterFunctionObject.H.

virtual const outputFilterOutputControl& outputControl

(

)

const [inline, virtual]

Return the output control object.

Definition at line 161 of file OutputFilterFunctionObject.H.

virtual const OutputFilter& outputFilter

(

)

const [inline, virtual]

Return the output filter.

Definition at line 167 of file OutputFilterFunctionObject.H.

void on

(

)

[virtual]

Switch the function object on.

Definition at line 103 of file OutputFilterFunctionObject.C.

void off

(

)

[virtual]

Switch the function object off.

Definition at line 110 of file OutputFilterFunctionObject.C.

bool start

(

)

[virtual]

Called at the start of the time-loop.

Implements functionObject.

Definition at line 117 of file OutputFilterFunctionObject.C.

bool execute

(

)

[virtual]

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

Implements functionObject.

Definition at line 131 of file OutputFilterFunctionObject.C.

bool end

(

)

[virtual]

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

Reimplemented from functionObject.

Definition at line 158 of file OutputFilterFunctionObject.C.

bool read

(

const dictionary &

dict  )

[virtual]

Read and set the function object if its data have changed.

Implements functionObject.

Definition at line 186 of file OutputFilterFunctionObject.C.

References dictionary::read().

---

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

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