Public Member Functions | Static Public Member Functions | Public Attributes | 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]
Collaboration diagram for functionObject:
Collaboration graph
[legend]

Public Member Functions

virtual const wordtype () const =0
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))
 
 functionObject (const word &name)
 Construct from components. More...
 
autoPtr< functionObjectclone () const
 Return clone. More...
 
virtual ~functionObject ()
 Destructor. More...
 
const wordname () const
 Return the name of this functionObject. More...
 
virtual bool read (const dictionary &)
 Read and set the function object if its data have changed. More...
 
virtual bool execute ()=0
 Called at each ++ or += of the time-loop. More...
 
virtual bool write ()=0
 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 adjustTimeStep ()
 Called at the end of Time::adjustDeltaT() if adjustTime is true. 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...
 

Static Public Member Functions

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

Public Attributes

Switch log
 Switch write log to Info. More...
 

Static Public Attributes

static int debug
 
static bool postProcess
 Global post-processing mode switch. More...
 

Detailed Description

Abstract base-class for Time/database function objects.

See also
Foam::functionObjectList Foam::functionObjects::timeControl
Source files

Definition at line 223 of file functionObject.H.

Constructor & Destructor Documentation

◆ functionObject()

functionObject ( const word name)

Construct from components.

Definition at line 44 of file functionObject.C.

References functionObject::New().

Here is the call graph for this function:

◆ ~functionObject()

~functionObject ( )
virtual

Destructor.

Definition at line 114 of file functionObject.C.

Referenced by functionObject::clone().

Here is the caller graph for this function:

Member Function Documentation

◆ type()

virtual const word& type ( ) const
pure virtual

Runtime type information.

Referenced by probes::classifyFields().

Here is the caller graph for this function:

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
functionObject  ,
dictionary  ,
(const word &name, const Time &runTime, const dictionary &dict ,
(name, runTime, dict  
)

◆ clone()

autoPtr<functionObject> clone ( ) const
inline

◆ New()

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

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

Definition at line 54 of file functionObject.C.

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

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ name()

const Foam::word & name ( ) const

Return the name of this functionObject.

Definition at line 120 of file functionObject.C.

Referenced by functionObject::clone(), functionObject::New(), and surfaceFieldValue::outputDir().

Here is the caller graph for this function:

◆ read()

bool read ( const dictionary dict)
virtual

◆ execute()

virtual bool execute ( )
pure virtual

◆ write()

virtual bool write ( )
pure virtual

◆ end()

bool end ( )
virtual

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

By default it simply calls execute().

Reimplemented in codedFunctionObject, systemCall, interfaceHeight, timeControl, and abort.

Definition at line 137 of file functionObject.C.

Referenced by functionObject::clone().

Here is the caller graph for this function:

◆ adjustTimeStep()

bool adjustTimeStep ( )
virtual

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

Reimplemented in timeControl, and setTimeStepFunctionObject.

Definition at line 143 of file functionObject.C.

Referenced by functionObject::clone().

Here is the caller graph for this function:

◆ updateMesh()

void updateMesh ( const mapPolyMesh mpm)
virtual

Update for changes of mesh.

Reimplemented in streamLine, sampledSets, probes, sampledSurfaces, and timeControl.

Definition at line 149 of file functionObject.C.

Referenced by functionObject::clone().

Here is the caller graph for this function:

◆ movePoints()

void movePoints ( const polyMesh mesh)
virtual

Update for changes of mesh.

Reimplemented in streamLine, sampledSets, probes, sampledSurfaces, and timeControl.

Definition at line 153 of file functionObject.C.

Referenced by functionObject::clone().

Here is the caller graph for this function:

Member Data Documentation

◆ debug

int debug
static

Definition at line 245 of file functionObject.H.

Referenced by functionObject::New().

◆ postProcess

bool postProcess
static

Global post-processing mode switch.

Definition at line 248 of file functionObject.H.

Referenced by functionObject::read().

◆ log

Switch log

Switch write log to Info.

Definition at line 251 of file functionObject.H.

Referenced by functionObject::read().


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