Public Member Functions | List of all members
OutputFilterFunctionObject< OutputFilter > Class Template Reference

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

Inheritance diagram for OutputFilterFunctionObject< OutputFilter >:
Inheritance graph
[legend]
Collaboration diagram for OutputFilterFunctionObject< OutputFilter >:
Collaboration graph
[legend]

Public Member Functions

 TypeName (OutputFilter::typeName_())
 Runtime type information. More...
 
 OutputFilterFunctionObject (const word &name, const Time &, const dictionary &)
 Construct from components. More...
 
virtual const Timetime () const
 Return time database. More...
 
virtual const dictionarydict () const
 Return the input dictionary. More...
 
virtual const wordregionName () const
 Return the region name. More...
 
virtual const worddictName () const
 Return the optional dictionary name. More...
 
virtual bool enabled () const
 Return the enabled flag. More...
 
virtual const outputFilterOutputControloutputControl () const
 Return the output control object. More...
 
virtual const OutputFilter & outputFilter () const
 Return the output filter. More...
 
virtual void on ()
 Switch the function object on. More...
 
virtual void off ()
 Switch the function object off. More...
 
virtual bool start ()
 Called at the start of the time-loop. More...
 
virtual bool execute (const bool forceWrite)
 Called at each ++ or += of the time-loop. More...
 
virtual bool end ()
 Called when Time::run() determines that the time-loop exits. More...
 
virtual bool timeSet ()
 Called when time was set at the end of the Time::operator++. More...
 
virtual bool adjustTimeStep ()
 Called at the end of Time::adjustDeltaT() if adjustTime is true. More...
 
virtual bool read (const dictionary &)
 Read and set the function object if its data have changed. More...
 
virtual void updateMesh (const mapPolyMesh &mpm)
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &mesh)
 Update for changes of mesh. More...
 
- Public Member Functions inherited from functionObject
virtual const wordtype () const =0
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &t, const dictionary &dict),(name, t, dict))
 
 functionObject (const word &name)
 Construct from components. More...
 
autoPtr< functionObjectclone () const
 Return clone. More...
 
virtual ~functionObject ()
 Destructor. More...
 
virtual const wordname () const
 Name. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (const word &name, const Time &, const dictionary &)
 Select from dictionary, based on its "type" entry. More...
 
- Static Public Attributes inherited from functionObject
static int debug
 

Detailed Description

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

A functionObject wrapper around OutputFilter to allow them to be created via the functions entry 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

Definition at line 58 of file OutputFilterFunctionObject.H.

Constructor & Destructor Documentation

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

Construct from components.

Definition at line 98 of file OutputFilterFunctionObject.C.

Member Function Documentation

TypeName ( OutputFilter::typeName_()  )

Runtime type information.

virtual const Time& time ( ) const
inlinevirtual

Return time database.

Definition at line 150 of file OutputFilterFunctionObject.H.

virtual const dictionary& dict ( ) const
inlinevirtual

Return the input dictionary.

Definition at line 156 of file OutputFilterFunctionObject.H.

virtual const word& regionName ( ) const
inlinevirtual

Return the region name.

Definition at line 162 of file OutputFilterFunctionObject.H.

virtual const word& dictName ( ) const
inlinevirtual

Return the optional dictionary name.

Definition at line 168 of file OutputFilterFunctionObject.H.

virtual bool enabled ( ) const
inlinevirtual

Return the enabled flag.

Definition at line 174 of file OutputFilterFunctionObject.H.

virtual const outputFilterOutputControl& outputControl ( ) const
inlinevirtual

Return the output control object.

Definition at line 180 of file OutputFilterFunctionObject.H.

virtual const OutputFilter& outputFilter ( ) const
inlinevirtual
void on ( )
virtual

Switch the function object on.

Definition at line 127 of file OutputFilterFunctionObject.C.

Referenced by OutputFilterFunctionObject< OutputFilter >::outputFilter().

Here is the caller graph for this function:

void off ( )
virtual

Switch the function object off.

Definition at line 134 of file OutputFilterFunctionObject.C.

Referenced by OutputFilterFunctionObject< OutputFilter >::outputFilter().

Here is the caller graph for this function:

bool start ( )
virtual

Called at the start of the time-loop.

Implements functionObject.

Definition at line 141 of file OutputFilterFunctionObject.C.

References OutputFilterFunctionObject< OutputFilter >::execute().

Referenced by OutputFilterFunctionObject< OutputFilter >::outputFilter().

Here is the call graph for this function:

Here is the caller graph for this function:

bool execute ( const bool  forceWrite)
virtual

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

Implements functionObject.

Definition at line 156 of file OutputFilterFunctionObject.C.

Referenced by OutputFilterFunctionObject< OutputFilter >::outputFilter(), and OutputFilterFunctionObject< OutputFilter >::start().

Here is the caller graph for this function:

bool end ( )
virtual

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

Reimplemented from functionObject.

Definition at line 188 of file OutputFilterFunctionObject.C.

Referenced by OutputFilterFunctionObject< OutputFilter >::outputFilter().

Here is the caller graph for this function:

bool timeSet ( )
virtual

Called when time was set at the end of the Time::operator++.

Reimplemented from functionObject.

Definition at line 215 of file OutputFilterFunctionObject.C.

Referenced by OutputFilterFunctionObject< OutputFilter >::outputFilter().

Here is the caller graph for this function:

bool adjustTimeStep ( )
virtual

Called at the end of Time::adjustDeltaT() if adjustTime is true.

Reimplemented from functionObject.

Definition at line 227 of file OutputFilterFunctionObject.C.

References Foam::max(), and OutputFilterFunctionObject< OutputFilter >::read().

Referenced by OutputFilterFunctionObject< OutputFilter >::outputFilter().

Here is the call graph for this function:

Here is the caller graph for this function:

bool read ( const dictionary dict)
virtual

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

Implements functionObject.

Definition at line 274 of file OutputFilterFunctionObject.C.

References dict, and OutputFilterFunctionObject< OutputFilter >::updateMesh().

Referenced by OutputFilterFunctionObject< OutputFilter >::adjustTimeStep(), and OutputFilterFunctionObject< OutputFilter >::outputFilter().

Here is the call graph for this function:

Here is the caller graph for this function:

void updateMesh ( const mapPolyMesh mpm)
virtual

Update for changes of mesh.

Implements functionObject.

Definition at line 294 of file OutputFilterFunctionObject.C.

References mapPolyMesh::mesh(), OutputFilterFunctionObject< OutputFilter >::movePoints(), and IOobject::name().

Referenced by OutputFilterFunctionObject< OutputFilter >::outputFilter(), and OutputFilterFunctionObject< OutputFilter >::read().

Here is the call graph for this function:

Here is the caller graph for this function:

void movePoints ( const polyMesh mesh)
virtual

Update for changes of mesh.

Implements functionObject.

Definition at line 307 of file OutputFilterFunctionObject.C.

References IOobject::name().

Referenced by OutputFilterFunctionObject< OutputFilter >::outputFilter(), and OutputFilterFunctionObject< OutputFilter >::updateMesh().

Here is the call graph for this function:

Here is the caller graph for this function:


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