Classes | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
functionObject Class Referenceabstract

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

Inheritance diagram for functionObject:
Inheritance graph
[legend]

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. 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...
 
virtual bool start ()=0
 Called at the start of the time-loop. More...
 
virtual bool execute (const bool forceWrite)=0
 Called at each ++ or += of the time-loop. forceWrite overrides the. 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 &)=0
 Read and set the function object if its data have changed. More...
 
virtual void updateMesh (const mapPolyMesh &mpm)=0
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &mesh)=0
 Update for changes of mesh. More...
 

Static Public Member Functions

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

Static Public Attributes

static int debug
 

Detailed Description

Abstract base-class for Time/database function objects.

See also
Foam::OutputFilterFunctionObject
Source files

Definition at line 58 of file functionObject.H.

Constructor & Destructor Documentation

functionObject ( const word name)

Construct from components.

Definition at line 42 of file functionObject.C.

References functionObject::New().

Here is the call graph for this function:

~functionObject ( )
virtual

Destructor.

Definition at line 105 of file functionObject.C.

Referenced by functionObject::iNew::iNew().

Here is the caller graph for this function:

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 101 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 51 of file functionObject.C.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

const Foam::word & name ( ) const
virtual

Name.

Definition at line 111 of file functionObject.C.

Referenced by functionObject::iNew::iNew(), and functionObject::New().

Here is the caller graph for this function:

virtual bool start ( )
pure virtual

Called at the start of the time-loop.

Implemented in OutputFilterFunctionObject< OutputFilter >, codedFunctionObject, and setTimeStepFunctionObject.

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

Here is the caller graph for this function:

virtual bool execute ( const bool  forceWrite)
pure virtual

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

outputControl behaviour.

Implemented in OutputFilterFunctionObject< OutputFilter >, codedFunctionObject, and setTimeStepFunctionObject.

Referenced by functionObject::end(), functionObjectList::execute(), and functionObject::iNew::iNew().

Here is the caller graph for this function:

bool end ( )
virtual

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

By default it simply calls execute().

Reimplemented in OutputFilterFunctionObject< OutputFilter >, codedFunctionObject, and setTimeStepFunctionObject.

Definition at line 117 of file functionObject.C.

References functionObject::execute().

Referenced by functionObjectList::end(), and functionObject::iNew::iNew().

Here is the call graph for this function:

Here is the caller graph for this function:

bool timeSet ( )
virtual

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

Reimplemented in OutputFilterFunctionObject< OutputFilter >, codedFunctionObject, and setTimeStepFunctionObject.

Definition at line 123 of file functionObject.C.

Referenced by functionObject::iNew::iNew(), and functionObjectList::timeSet().

Here is the caller graph for this function:

bool adjustTimeStep ( )
virtual

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

Reimplemented in OutputFilterFunctionObject< OutputFilter >, and setTimeStepFunctionObject.

Definition at line 129 of file functionObject.C.

Referenced by functionObjectList::adjustTimeStep(), and functionObject::iNew::iNew().

Here is the caller graph for this function:

virtual bool read ( const dictionary )
pure virtual

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

Implemented in OutputFilterFunctionObject< OutputFilter >, codedFunctionObject, and setTimeStepFunctionObject.

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

Here is the caller graph for this function:

virtual void updateMesh ( const mapPolyMesh mpm)
pure virtual

Update for changes of mesh.

Implemented in OutputFilterFunctionObject< OutputFilter >, codedFunctionObject, and setTimeStepFunctionObject.

Referenced by functionObject::iNew::iNew(), and functionObjectList::updateMesh().

Here is the caller graph for this function:

virtual void movePoints ( const polyMesh mesh)
pure virtual

Update for changes of mesh.

Implemented in OutputFilterFunctionObject< OutputFilter >, codedFunctionObject, and setTimeStepFunctionObject.

Referenced by functionObject::iNew::iNew(), and functionObjectList::movePoints().

Here is the caller graph for this function:

Member Data Documentation

int debug
static

Definition at line 80 of file functionObject.H.

Referenced by functionObject::New().


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