timeFunctionObject Class Reference

Virtual base class for function objects with a reference to Time. More...

Inheritance diagram for timeFunctionObject:
[legend]
Collaboration diagram for timeFunctionObject:
[legend]

Public Member Functions

 timeFunctionObject (const word &name, const Time &runTime)
 Construct from Time. More...
 
virtual ~timeFunctionObject ()=default
 Destructor. More...
 
const Timetime () const
 Return time database. More...
 
objectRegistrystoredObjects ()
 
const objectRegistrystoredObjects () const
 
- Public Member Functions inherited from functionObject
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 ()=default
 Destructor. More...
 
const wordname () const
 Return the name of this functionObject. More...
 
virtual bool read (const dictionary &dict)
 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 execute (const label subIndex)
 Execute using the specified subIndex. 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 bool filesModified () const
 Did any file get changed during execution? 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...
 

Protected Member Functions

void clearOutputObjects (const wordList &objNames)
 Remove specified items from "functionObjectObjects". More...
 
 timeFunctionObject (const timeFunctionObject &)=delete
 No copy construct. More...
 
void operator= (const timeFunctionObject &)=delete
 No copy assignment. More...
 
- Protected Member Functions inherited from functionObject
word scopedName (const word &name) const
 Return a scoped name, e.g. used to construct local field names. More...
 

Protected Attributes

const Timetime_
 Reference to the time database. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (const word &name, const Time &runTime, const dictionary &dict)
 Select from dictionary, based on its "type" entry. More...
 
- Public Attributes inherited from functionObject
bool log
 Flag to write log into Info. More...
 
- Static Public Attributes inherited from functionObject
static int debug
 Flag to execute debug content. More...
 
static bool postProcess
 Global post-processing mode switch. More...
 
static word outputPrefix
 Directory prefix. More...
 

Detailed Description

Virtual base class for function objects with a reference to Time.

See also
Foam::functionObject
Source files

Definition at line 56 of file timeFunctionObject.H.

Constructor & Destructor Documentation

◆ timeFunctionObject() [1/2]

timeFunctionObject ( const timeFunctionObject )
protecteddelete

No copy construct.

◆ timeFunctionObject() [2/2]

timeFunctionObject ( const word name,
const Time runTime 
)

Construct from Time.

Definition at line 34 of file timeFunctionObject.C.

◆ ~timeFunctionObject()

virtual ~timeFunctionObject ( )
virtualdefault

Destructor.

Member Function Documentation

◆ clearOutputObjects()

void clearOutputObjects ( const wordList objNames)
protected

Remove specified items from "functionObjectObjects".

Definition at line 47 of file timeFunctionObject.C.

References objectRegistry::checkOut().

Here is the call graph for this function:

◆ operator=()

void operator= ( const timeFunctionObject )
protecteddelete

No copy assignment.

◆ time()

const Time& time ( ) const
inline

Return time database.

Definition at line 96 of file timeFunctionObject.H.

References timeFunctionObject::time_.

Referenced by runTimeControl::execute().

Here is the caller graph for this function:

◆ storedObjects() [1/2]

Foam::objectRegistry & storedObjects ( )

Write access to the output objects ("functionObjectObjects") registered on Time

Definition at line 63 of file timeFunctionObject.C.

References timeFunctionObject::time_.

Referenced by regionFunctionObject::obr(), and surfaceFieldValue::obr().

Here is the caller graph for this function:

◆ storedObjects() [2/2]

const Foam::objectRegistry & storedObjects ( ) const

Const access to the output objects ("functionObjectObjects") registered on Time

Definition at line 70 of file timeFunctionObject.C.

Member Data Documentation

◆ time_


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