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

Inheritance diagram for functionObject:

[legend]

Collaboration diagram for functionObject:

Public Member Functions
virtual const word &	type () 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< functionObject >	clone () const
	Return clone. More...

virtual	~functionObject ()
	Destructor. More...

const word &	name () 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	setTimeStep ()
	Called by Time::setDeltaT(). Allows the function object to override. More...

virtual scalar	timeToNextWrite ()
	Called by Time::adjustTimeStep(). Allows the function object to. 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< functionObject >	New (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

Return clone.

Definition at line 272 of file functionObject.H.

References functionObject::end(), functionObject::execute(), mesh, functionObject::movePoints(), functionObject::name(), functionObject::New(), NotImplemented, functionObject::read(), functionObject::setTimeStep(), functionObject::timeToNextWrite(), functionObject::updateMesh(), functionObject::write(), and functionObject::~functionObject().

Here is the call graph for this function:

◆ 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(), Foam::nl, and runTime.

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

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

Reimplemented in surfaceFieldValue, forces, pressure, volFieldValue, fieldAverage, streamLine, regionSizeDistribution, sizeDistribution, sampledSets, turbulenceFields, probes, forceCoeffs, nearWallFields, sampledSurfaces, codedFunctionObject, wallHeatTransferCoeff, fieldMinMax, fieldValueDelta, writeObjects, histogram, wallShearStress, systemCall, icoUncoupledKinematicCloud, phaseForces, fieldValue, wallHeatFlux, interfaceHeight, surfaceInterpolate, fieldCoordinateSystemTransform, readFields, timeControl, patchProbes, regionFunctionObject, cloudInfo, scalarTransport, yPlus, turbulenceIntensity, writeVTK, residuals, sixDoFRigidBodyState, removeRegisteredObject, timeActivatedFileUpdate, fieldsExpression, time, abort, moleFractions< ThermoType >, writeDictionary, processorField, fieldExpression, setTimeStepFunctionObject, CourantNo, specieReactionRates< ChemistryModelType >, blendingFactor, scale, randomise, and dsmcFields.

Definition at line 126 of file functionObject.C.

References functionObject::log, dictionary::lookupOrDefault(), and functionObject::postProcess.

Referenced by functionObject::clone(), time::read(), regionFunctionObject::read(), writeObjects::read(), and functionObjectList::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ execute()

virtual bool execute ( )

pure virtual

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

postProcess overrides the usual executeControl behaviour and forces execution (used in post-processing mode)

Implemented in forces, fieldAverage, streamLine, regionSizeDistribution, sizeDistribution, sampledSets, turbulenceFields, probes, forceCoeffs, nearWallFields, sampledSurfaces, wallHeatTransferCoeff, fieldMinMax, fieldValueDelta, codedFunctionObject, writeObjects, histogram, wallShearStress, systemCall, icoUncoupledKinematicCloud, phaseForces, fieldValue, wallHeatFlux, interfaceHeight, surfaceInterpolate, fieldCoordinateSystemTransform, readFields, cloudInfo, timeControl, scalarTransport, yPlus, turbulenceIntensity, writeVTK, residuals, sixDoFRigidBodyState, removeRegisteredObject, timeActivatedFileUpdate, fieldsExpression, time, abort, moleFractions< ThermoType >, writeDictionary, processorField, fieldExpression, writeCellCentres, XiReactionRate, writeCellVolumes, setTimeStepFunctionObject, specieReactionRates< ChemistryModelType >, and dsmcFields.

Referenced by functionObject::clone().

Here is the caller graph for this function:

◆ write()

virtual bool write ( )

pure virtual

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

postProcess overrides the usual writeControl behaviour and forces writing always (used in post-processing mode)

Implemented in surfaceFieldValue, forces, volFieldValue, fieldAverage, streamLine, regionSizeDistribution, sizeDistribution, sampledSets, turbulenceFields, probes, forceCoeffs, nearWallFields, sampledSurfaces, wallHeatTransferCoeff, fieldMinMax, codedFunctionObject, fieldValueDelta, writeObjects, histogram, wallShearStress, systemCall, icoUncoupledKinematicCloud, phaseForces, interfaceHeight, fieldValue, wallHeatFlux, surfaceInterpolate, fieldCoordinateSystemTransform, readFields, patchProbes, timeControl, cloudInfo, scalarTransport, yPlus, turbulenceIntensity, writeVTK, residuals, sixDoFRigidBodyState, removeRegisteredObject, timeActivatedFileUpdate, fieldsExpression, time, abort, moleFractions< ThermoType >, writeDictionary, processorField, fieldExpression, writeCellCentres, XiReactionRate, writeCellVolumes, setTimeStepFunctionObject, specieReactionRates< ChemistryModelType >, components, and dsmcFields.

Referenced by functionObject::clone().

Here is the caller graph for this function:

◆ 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:

◆ setTimeStep()

bool setTimeStep ( )

virtual

Called by Time::setDeltaT(). Allows the function object to override.

the time-step value. Returns whether or not the value was overridden.

Reimplemented in setTimeStepFunctionObject.

Definition at line 143 of file functionObject.C.

Referenced by functionObject::clone().

Here is the caller graph for this function:

◆ timeToNextWrite()

Foam::scalar timeToNextWrite ( )

virtual

Called by Time::adjustTimeStep(). Allows the function object to.

insert a write time earlier than that already in use by the run time. Returns the write time, or vGreat.

Reimplemented in timeControl.

Definition at line 149 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 155 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 159 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 arcUniform::arcUniform(), boundaryPoints::boundaryPoints(), boundaryRandom::boundaryRandom(), boxUniform::boxUniform(), circleRandom::circleRandom(), lineCell::lineCell(), lineCellFace::lineCellFace(), lineFace::lineFace(), lineUniform::lineUniform(), functionObject::New(), points::points(), sampledSets::sphereRandom::sphereRandom(), and sampledSets::triSurfaceMeshSampledSet::triSurfaceMeshSampledSet().

◆ 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:

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

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ functionObject()

◆ ~functionObject()

Member Function Documentation

◆ type()

◆ declareRunTimeSelectionTable()

◆ clone()

◆ New()

◆ name()

◆ read()

◆ execute()

◆ write()

◆ end()

◆ setTimeStep()

◆ timeToNextWrite()

◆ updateMesh()

◆ movePoints()

Member Data Documentation

◆ debug

◆ postProcess

◆ log