Abstract base-class for Time/database functionObjects. More...

Inheritance diagram for functionObject:

[legend]

Collaboration diagram for functionObject:

Public Member Functions
	ClassName ("functionObject")

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...

	functionObject (const functionObject &)=delete
	Disallow default bitwise copy construction. 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 functionObject if its data have changed. More...

virtual wordList	fields () const =0
	Return the list of fields required. More...

virtual bool	executeAtStart () const
	Return true if the functionObject should be executed at the start. 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 scalar	timeToNextWrite ()
	Called by Time::adjustTimeStep(). Allows the functionObject to. More...

virtual void	movePoints (const polyMesh &mesh)
	Update topology using the given map. More...

virtual void	topoChange (const polyTopoChangeMap &map)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

void	operator= (const functionObject &)=delete
	Disallow default bitwise assignment. 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...

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

Static Public Attributes
static bool	postProcess
	Global post-processing mode switch. More...

Detailed Description

Abstract base-class for Time/database functionObjects.

See also: Foam::functionObjectList Foam::functionObjects::timeControl

Source files

Definition at line 230 of file functionObject.H.

Constructor & Destructor Documentation

◆ functionObject() [1/2]

functionObject ( const word & name )

Construct from components.

Definition at line 44 of file functionObject.C.

References functionObject::New().

Referenced by functionObject::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ functionObject() [2/2]

functionObject ( const functionObject & )

delete

Disallow default bitwise copy construction.

◆ ~functionObject()

~functionObject ( )

virtual

Destructor.

Definition at line 115 of file functionObject.C.

Referenced by functionObject::clone().

Here is the caller graph for this function:

Member Function Documentation

◆ ClassName()

ClassName ( "functionObject" )

◆ 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 273 of file functionObject.H.

References functionObject::end(), functionObject::execute(), functionObject::executeAtStart(), functionObject::fields(), functionObject::functionObject(), functionObject::mapMesh(), mesh, functionObject::movePoints(), functionObject::name(), functionObject::New(), NotImplemented, functionObject::operator=(), functionObject::read(), functionObject::timeToNextWrite(), functionObject::topoChange(), functionObject::write(), and functionObject::~functionObject().

Referenced by fieldsExpression::foldAB().

Here is the call graph for this function:

Here is the caller 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 55 of file functionObject.C.

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

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

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

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

Here is the caller graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read and set the functionObject if its data have changed.

Reimplemented in surfaceFieldValue, volFieldValue, forces, fieldAverage, pressure, streamlines, regionSizeDistribution, populationBalanceSizeDistribution, comfort, turbulenceFields, sampledSurfaces, populationBalanceMoments, phaseScalarTransport, forceCoeffs, probes, nearWallFields, layerAverage, scalarTransport, fieldValueDelta, codedFunctionObject, writeObjects, age, wallHeatTransferCoeff, wallShearStress, interfaceHeight, fieldValue, systemCall, fieldsExpression, histogram, fieldCoordinateSystemTransform, sampledSets, particles, sixDoFRigidBodyControl, wallHeatFlux, readFields, stopAtFile, timeControl, yPlus, regionFunctionObject, log, sixDoFRigidBodyState, patchProbes, phaseForces, stopAtClockTime, cloudInfo, turbulenceIntensity, rigidBodyState, writeVTK, residuals, timeActivatedFileUpdate, removeRegisteredObject, time, moleFractions< ThermoType >, stopAt, setWriteIntervalFunctionObject, timeStep, processorField, writeDictionary, CourantNo, specieReactionRates, setTimeStepFunctionObject, blendingFactor, scale, uniform, randomise, shearStress, totalEnthalpy, meshToMeshAdjustTimeStepFunctionObject, Qdot, and dsmcFields.

Definition at line 127 of file functionObject.C.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fields()

virtual wordList fields ( ) const

pure virtual

Return the list of fields required.

Implemented in forces, fieldAverage, streamlines, regionSizeDistribution, populationBalanceSizeDistribution, comfort, turbulenceFields, sampledSurfaces, populationBalanceMoments, phaseScalarTransport, nearWallFields, layerAverage, scalarTransport, probes, fieldValueDelta, writeObjects, age, wallHeatTransferCoeff, wallShearStress, codedFunctionObject, interfaceHeight, systemCall, fieldsExpression, histogram, fieldCoordinateSystemTransform, sampledSets, particles, fieldValue, wallHeatFlux, readFields, yPlus, sixDoFRigidBodyState, phaseForces, cloudInfo, turbulenceIntensity, rigidBodyState, writeVTK, residuals, timeActivatedFileUpdate, removeRegisteredObject, timeControl, time, moleFractions< ThermoType >, stopAt, phaseMap, setWriteIntervalFunctionObject, timeStep, processorField, writeDictionary, writeCellCentres, XiReactionRate, writeCellVolumes, specieReactionRates, setTimeStepFunctionObject, uniform, fieldExpression, shearStress, totalEnthalpy, meshToMeshAdjustTimeStepFunctionObject, Qdot, and dsmcFields.

Referenced by functionObject::clone().

Here is the caller graph for this function:

◆ executeAtStart()

bool executeAtStart ( ) const

virtual

Return true if the functionObject should be executed at the start.

Reimplemented in fieldAverage, timeControl, and dsmcFields.

Definition at line 141 of file functionObject.C.

References functionObject::executeAtStart_.

Referenced by functionObject::clone().

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, streamlines, regionSizeDistribution, populationBalanceSizeDistribution, comfort, turbulenceFields, populationBalanceMoments, sampledSurfaces, phaseScalarTransport, forceCoeffs, probes, nearWallFields, layerAverage, scalarTransport, fieldValueDelta, writeObjects, wallHeatTransferCoeff, age, wallShearStress, codedFunctionObject, interfaceHeight, systemCall, fieldValue, fieldsExpression, histogram, particles, fieldCoordinateSystemTransform, sampledSets, wallHeatFlux, sixDoFRigidBodyControl, readFields, yPlus, sixDoFRigidBodyState, phaseForces, cloudInfo, turbulenceIntensity, rigidBodyState, timeControl, residuals, timeActivatedFileUpdate, writeVTK, removeRegisteredObject, time, moleFractions< ThermoType >, stopAt, phaseMap, setWriteIntervalFunctionObject, timeStep, processorField, writeDictionary, writeCellCentres, writeCellVolumes, XiReactionRate, specieReactionRates, setTimeStepFunctionObject, uniform, fieldExpression, meshToMeshAdjustTimeStepFunctionObject, dsmcFields, shearStress, totalEnthalpy, and Qdot.

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, volFieldValue, forces, fieldAverage, streamlines, regionSizeDistribution, populationBalanceSizeDistribution, comfort, turbulenceFields, populationBalanceMoments, sampledSurfaces, phaseScalarTransport, forceCoeffs, probes, nearWallFields, layerAverage, scalarTransport, fieldValueDelta, writeObjects, wallHeatTransferCoeff, age, wallShearStress, codedFunctionObject, interfaceHeight, systemCall, fieldValue, histogram, fieldsExpression, particles, fieldCoordinateSystemTransform, sampledSets, wallHeatFlux, readFields, yPlus, sixDoFRigidBodyState, phaseForces, cloudInfo, turbulenceIntensity, rigidBodyState, timeControl, residuals, timeActivatedFileUpdate, writeVTK, removeRegisteredObject, patchProbes, time, moleFractions< ThermoType >, stopAt, phaseMap, setWriteIntervalFunctionObject, timeStep, processorField, writeDictionary, writeCellCentres, writeCellVolumes, XiReactionRate, specieReactionRates, setTimeStepFunctionObject, uniform, fieldExpression, components, meshToMeshAdjustTimeStepFunctionObject, dsmcFields, shearStress, totalEnthalpy, and Qdot.

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.

Reimplemented in codedFunctionObject, interfaceHeight, systemCall, stopAtFile, timeControl, and stopAt.

Definition at line 147 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 functionObject to.

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

Reimplemented in timeControl, and meshToMeshAdjustTimeStepFunctionObject.

Definition at line 153 of file functionObject.C.

Referenced by functionObject::clone().

Here is the caller graph for this function:

◆ movePoints()

void movePoints ( const polyMesh & mesh )

virtual

Update topology using the given map.

Reimplemented in surfaceFieldValue, streamlines, sampledSurfaces, probes, layerAverage, sampledSets, and timeControl.

Definition at line 159 of file functionObject.C.

Referenced by functionObject::clone().

Here is the caller graph for this function:

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

virtual

Update topology using the given map.

Reimplemented in surfaceFieldValue, streamlines, sampledSurfaces, probes, layerAverage, sampledSets, and timeControl.

Definition at line 163 of file functionObject.C.

Referenced by functionObject::clone().

Here is the caller graph for this function:

◆ mapMesh()

void mapMesh ( const polyMeshMap & )

virtual

Update from another mesh using the given map.

Reimplemented in surfaceFieldValue, streamlines, sampledSurfaces, probes, layerAverage, sampledSets, and timeControl.

Definition at line 167 of file functionObject.C.

Referenced by functionObject::clone().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const functionObject & )

delete

Disallow default bitwise assignment.

Referenced by functionObject::clone().

Here is the caller graph for this function:

Member Data Documentation

◆ postProcess

bool postProcess

static

Global post-processing mode switch.

Definition at line 246 of file functionObject.H.

Referenced by functionObject::read().

◆ log

Switch log

Switch write log to Info.

Definition at line 249 of file functionObject.H.

Referenced by functionObject::read().

◆ executeAtStart_

Switch executeAtStart_

Switch write log to Info.

Definition at line 252 of file functionObject.H.

Referenced by functionObject::executeAtStart(), and 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() [1/2]

◆ functionObject() [2/2]

◆ ~functionObject()

Member Function Documentation

◆ ClassName()

◆ type()

◆ declareRunTimeSelectionTable()

◆ clone()

◆ New()

◆ name()

◆ read()

◆ fields()

◆ executeAtStart()

◆ execute()

◆ write()

◆ end()

◆ timeToNextWrite()

◆ movePoints()

◆ topoChange()

◆ mapMesh()

◆ operator=()

Member Data Documentation

◆ postProcess

◆ log

◆ executeAtStart_