Specialization of Foam::functionObject for a region and providing a reference to the region Foam::objectRegistry. More...

Inheritance diagram for regionFunctionObject:

[legend]

Collaboration diagram for regionFunctionObject:

[legend]

Public Member Functions
	TypeName ("regionFunctionObject")
	Runtime type information. More...

	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

virtual	~regionFunctionObject ()
	Destructor. More...

virtual bool	read (const dictionary &)
	Read optional controls. More...

Public Member Functions inherited from 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...

virtual	~functionObject ()
	Destructor. More...

const word &	name () const
	Return the name of this functionObject. 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...

Protected Member Functions
template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find field in the objectRegistry. More...

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup object from the objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName)
	Lookup non-const object reference from the objectRegistry. More...

template<class ObjectType >
bool	store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
	Store the given field in the objectRegistry under the given name. More...

bool	writeObject (const word &fieldName)
	Write field if present in objectRegistry. More...

bool	clearObject (const word &fieldName)
	Clear field from the objectRegistry if present. More...

Protected Attributes
const Time &	time_
	Reference to the Time. More...

const objectRegistry &	obr_
	Reference to the region objectRegistry. More...

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &, const dictionary &)
	Select from dictionary, based on its "type" entry. More...

Public Attributes inherited from functionObject
Switch	log
	Switch write log to Info. More...

Static Public Attributes inherited from functionObject
static int	debug

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

Detailed Description

Specialization of Foam::functionObject for a region and providing a reference to the region Foam::objectRegistry.

See also: Foam::functionObject

Source files

Definition at line 58 of file regionFunctionObject.H.

Constructor & Destructor Documentation

◆ regionFunctionObject() [1/2]

regionFunctionObject	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict
	)

Construct from Time and dictionary.

The region objectRegistry is looked-up runTime with the name looked-up from the dictionary (defaults to polyMesh::defaultRegion)

Definition at line 94 of file regionFunctionObject.C.

◆ regionFunctionObject() [2/2]

regionFunctionObject	(	const word &	name,
		const objectRegistry &	obr,
		const dictionary &	dict
	)

Construct from the region objectRegistry and dictionary.

Definition at line 113 of file regionFunctionObject.C.

◆ ~regionFunctionObject()

~regionFunctionObject ( )

virtual

Destructor.

Definition at line 127 of file regionFunctionObject.C.

Member Function Documentation

◆ foundObject()

bool foundObject ( const word & fieldName ) const

protected

Find field in the objectRegistry.

Definition at line 33 of file regionFunctionObjectTemplates.C.

References regionFunctionObject::lookupObject().

Here is the call graph for this function:

◆ lookupObject()

const ObjectType & lookupObject ( const word & fieldName ) const

protected

Lookup object from the objectRegistry.

Definition at line 43 of file regionFunctionObjectTemplates.C.

References regionFunctionObject::lookupObjectRef().

Referenced by regionFunctionObject::foundObject(), moleFractions< ThermoType >::moleFractions(), turbulenceIntensity::write(), yPlus::write(), wallHeatFlux::write(), wallShearStress::write(), and wallHeatTransferCoeff::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupObjectRef()

ObjectType & lookupObjectRef ( const word & fieldName )

protected

Lookup non-const object reference from the objectRegistry.

Definition at line 53 of file regionFunctionObjectTemplates.C.

References regionFunctionObject::store().

Referenced by regionFunctionObject::lookupObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ store()

bool store	(	word &	fieldName,
		const tmp< ObjectType > &	tfield,
		bool	cacheable = `false`
	)

protected

Store the given field in the objectRegistry under the given name.

Definition at line 63 of file regionFunctionObjectTemplates.C.

References Foam::endl(), Foam::name(), Foam::nl, tmp< T >::ptr(), tmp< T >::ref(), and WarningInFunction.

Referenced by fieldsExpression::calcFieldTypes(), and regionFunctionObject::lookupObjectRef().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeObject()

bool writeObject ( const word & fieldName )

protected

Write field if present in objectRegistry.

Definition at line 44 of file regionFunctionObject.C.

References regionFunctionObject::clearObject(), Foam::endl(), Log, Foam::name(), IOobject::name(), Foam::type(), and regIOobject::write().

Here is the call graph for this function:

◆ clearObject()

bool clearObject ( const word & fieldName )

protected

Clear field from the objectRegistry if present.

Definition at line 67 of file regionFunctionObject.C.

References regIOobject::checkOut(), and regIOobject::ownedByRegistry().

Referenced by regionFunctionObject::writeObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "regionFunctionObject" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read optional controls.

Reimplemented from functionObject.

Reimplemented in surfaceFieldValue, forces, pressure, volFieldValue, fieldAverage, streamLine, regionSizeDistribution, sizeDistribution, turbulenceFields, forceCoeffs, nearWallFields, wallHeatTransferCoeff, fieldMinMax, fieldValueDelta, histogram, wallShearStress, icoUncoupledKinematicCloud, phaseForces, fieldValue, wallHeatFlux, interfaceHeight, surfaceInterpolate, fieldCoordinateSystemTransform, readFields, cloudInfo, scalarTransport, yPlus, turbulenceIntensity, writeVTK, residuals, sixDoFRigidBodyState, fieldsExpression, time, moleFractions< ThermoType >, processorField, fieldExpression, CourantNo, specieReactionRates< ChemistryModelType >, blendingFactor, scale, randomise, and dsmcFields.

Definition at line 133 of file regionFunctionObject.C.

References functionObject::read().

Referenced by fieldExpression::read(), processorField::read(), fieldsExpression::read(), residuals::read(), sixDoFRigidBodyState::read(), turbulenceIntensity::read(), yPlus::read(), scalarTransport::read(), cloudInfo::read(), readFields::read(), fieldCoordinateSystemTransform::read(), wallHeatFlux::read(), fieldValue::read(), icoUncoupledKinematicCloud::read(), wallShearStress::read(), fieldValueDelta::read(), fieldMinMax::read(), wallHeatTransferCoeff::read(), nearWallFields::read(), fieldAverage::read(), and forces::read().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ time_

const Time& time_

protected

Reference to the Time.

Definition at line 68 of file regionFunctionObject.H.

◆ obr_

const objectRegistry& obr_

protected

Reference to the region objectRegistry.

Definition at line 71 of file regionFunctionObject.H.

Referenced by fieldAverage::addMeanField(), fieldAverage::addMeanFieldType(), fieldAverage::addMeanSqrToPrime2MeanType(), fieldAverage::addPrime2MeanField(), fieldAverage::addPrime2MeanFieldType(), fieldAverage::calculateMeanFieldType(), fieldAverage::calculatePrime2MeanFieldType(), sizeDistribution::mesh(), surfaceFieldValue::outputDir(), fieldAverage::writeFieldType(), residuals::writeFileHeader(), and residuals::writeResidual().

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

src/OpenFOAM/db/functionObjects/regionFunctionObject/regionFunctionObject.H
src/OpenFOAM/db/functionObjects/regionFunctionObject/regionFunctionObject.C
src/OpenFOAM/db/functionObjects/regionFunctionObject/regionFunctionObjectTemplates.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ regionFunctionObject() [1/2]

◆ regionFunctionObject() [2/2]

◆ ~regionFunctionObject()

Member Function Documentation

◆ foundObject()

◆ lookupObject()

◆ lookupObjectRef()

◆ store()

◆ writeObject()

◆ clearObject()

◆ TypeName()

◆ read()

Member Data Documentation

◆ time_

◆ obr_