functionObject Class Reference

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

Inheritance diagram for functionObject:

Collaboration diagram for functionObject:

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

Public Member Functions
virtual const word &	type () 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< functionObject >	clone () const
	Return clone. More...
virtual	~functionObject ()
	Destructor. More...
virtual const word &	name () 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< functionObject >	New (const word &name, const Time &, const dictionary &)
	Select from dictionary, based on its "type" entry. More...

Static Public Attributes
static int	debug

Private Member Functions
	functionObject (const functionObject &)
	Disallow default bitwise copy construct. More...
void	operator= (const functionObject &)
	Disallow default bitwise assignment. More...

Private Attributes
const word	name_
	Name. More...

Detailed Description

Abstract base-class for Time/database function objects.

See also

Foam::OutputFilterFunctionObject

Source files

• functionObject.H
• functionObject.C

Definition at line 58 of file functionObject.H.

Constructor & Destructor Documentation

functionObject() [1/2]

functionObject ( const functionObject &  )

private

Disallow default bitwise copy construct.

functionObject() [2/2]

functionObject

(

const word &

name

)

Construct from components.

Definition at line 42 of file functionObject.C.

~functionObject()

~functionObject ( )

virtual

Destructor.

Definition at line 99 of file functionObject.C.

Member Function Documentation

operator=()

void operator= ( const functionObject &  )

private

Disallow default bitwise assignment.

type()

virtual const word& type ( ) const

pure virtual

Runtime type information.

declareRunTimeSelectionTable()

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

clone()

autoPtr<functionObject> clone ( ) const

inline

Return clone.

Definition at line 101 of file functionObject.H.

References NotImplemented.

New()

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 Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, dictionary::lookup(), Foam::name(), and Foam::nl.

Referenced by functionObject::iNew::operator()(), 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

virtual

Name.

Definition at line 105 of file functionObject.C.

start()

virtual bool start ( )

pure virtual

Called at the start of the time-loop.

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

Referenced by functionObjectList::read().

Here is the caller graph for this function:

execute()

virtual bool execute ( const bool  forceWrite )

pure virtual

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

outputControl behaviour.

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

end()

bool end ( )

virtual

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

By default it simply calls execute().

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

Definition at line 111 of file functionObject.C.

timeSet()

bool timeSet ( )

virtual

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

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

Definition at line 117 of file functionObject.C.

adjustTimeStep()

bool adjustTimeStep ( )

virtual

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

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

Definition at line 123 of file functionObject.C.

read()

virtual bool read ( const dictionary &  )

pure virtual

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

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

Referenced by functionObjectList::read().

Here is the caller graph for this function:

updateMesh()

virtual void updateMesh ( const mapPolyMesh &  mpm )

pure virtual

Update for changes of mesh.

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

movePoints()

virtual void movePoints ( const polyMesh &  mesh )

pure virtual

Update for changes of mesh.

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

Field Documentation

name_

const word name_

private

Name.

Definition at line 63 of file functionObject.H.

debug

int debug

static

Definition at line 80 of file functionObject.H.

---

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

• src/OpenFOAM/db/functionObjects/functionObject/functionObject.H
• src/OpenFOAM/db/functionObjects/functionObject/functionObject.C