FreeFOAM The Cross-Platform CFD Toolkit
functionObject Class Reference

Abstract base-class for Time/database function objects. More...

#include <OpenFOAM/functionObject.H>


Detailed Description

+ Inheritance diagram for functionObject:

List of all members.

Classes

class  iNew
 Return a pointer to a new functionObject created on freestore. More...

Public Member Functions

virtual const wordtype () const =0
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &t, const dictionary &dict),(name, t, dict))
 functionObject (const word &name)
 Construct from components.
autoPtr< functionObjectclone () const
 Return clone.
virtual ~functionObject ()
virtual const wordname () const
 Name.
virtual bool start ()=0
 Called at the start of the time-loop.
virtual bool execute ()=0
 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 &)=0
 Read and set the function object if its data have changed.

Static Public Member Functions

static autoPtr< functionObjectNew (const word &name, const Time &, const dictionary &)
 Select from dictionary, based on its "type" entry.

Static Public Attributes

static int debug

Constructor & Destructor Documentation

functionObject ( const word name)

Construct from components.

Definition at line 38 of file functionObject.C.

~functionObject ( )
virtual

Definition at line 101 of file functionObject.C.


Member Function Documentation

virtual const word& type ( ) const
pure virtual

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
functionObject  ,
dictionary  ,
(const word &name, const Time &t, const dictionary &dict)  ,
(name, t, dict)   
)
autoPtr<functionObject> clone ( ) const
inline

Return clone.

Definition at line 100 of file functionObject.H.

References notImplemented.

Foam::autoPtr< Foam::functionObject > New ( const word name,
const Time t,
const dictionary functionDict 
)
static

Select from dictionary, based on its "type" entry.

Definition at line 47 of file functionObject.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, dictionary::lookup(), Foam::name(), Foam::nl, and dlLibraryTable::open().

Referenced by functionObject::iNew::operator()(), and functionObjectList::read().

const Foam::word & name ( ) const
virtual

Name.

Definition at line 107 of file functionObject.C.

virtual bool start ( )
pure virtual

Called at the start of the time-loop.

Implemented in OutputFilterFunctionObject< OutputFilter >.

Referenced by functionObjectList::read().

virtual bool execute ( )
pure virtual

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

Implemented in OutputFilterFunctionObject< OutputFilter >.

bool end ( )
virtual

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

By default it simply calls execute().

Reimplemented in OutputFilterFunctionObject< OutputFilter >.

Definition at line 113 of file functionObject.C.

virtual bool read ( const dictionary )
pure virtual

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

Implemented in OutputFilterFunctionObject< OutputFilter >.

Referenced by functionObjectList::read().


Member Data Documentation

int debug
static

Definition at line 79 of file functionObject.H.


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