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

	regionFunctionObject (const regionFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~regionFunctionObject ()
	Destructor. More...

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

void	operator= (const regionFunctionObject &)=delete
	Disallow default bitwise assignment. More...

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

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

template<class ObjectType >
void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. 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 (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

template<class ObjectType >
bool	store (const 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...

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

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

Detailed Description

Specialisation 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/3]

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 105 of file regionFunctionObject.C.

Referenced by regionFunctionObject::clearObject().

Here is the caller graph for this function:

◆ regionFunctionObject() [2/3]

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

Construct from the region objectRegistry and dictionary.

Definition at line 124 of file regionFunctionObject.C.

◆ regionFunctionObject() [3/3]

regionFunctionObject ( const regionFunctionObject & )

delete

Disallow default bitwise copy construction.

◆ ~regionFunctionObject()

~regionFunctionObject ( )

virtual

Destructor.

Definition at line 138 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::cannotFindObject().

Referenced by fieldsExpression::foldAB().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cannotFindObject() [1/2]

void cannotFindObject ( const word & fieldName )

protected

Prints a warning message that fieldName cannot be found.

Definition at line 43 of file regionFunctionObjectTemplates.C.

References Foam::endl(), regionFunctionObject::lookupObject(), Foam::name(), Foam::type(), and Foam::Warning.

Referenced by regionFunctionObject::foundObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cannotFindObject() [2/2]

void cannotFindObject ( const word & fieldName )

protected

Prints a warning message that fieldName cannot be found.

Definition at line 44 of file regionFunctionObject.C.

References Foam::endl(), Foam::name(), Foam::type(), Foam::Warning, and regionFunctionObject::writeObject().

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 56 of file regionFunctionObjectTemplates.C.

References regionFunctionObject::lookupObjectRef().

Referenced by regionFunctionObject::cannotFindObject(), fieldsExpression::foldAB(), turbulenceIntensity::write(), yPlus::write(), wallHeatFlux::write(), and wallShearStress::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 66 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() [1/2]

bool store ( const tmp< ObjectType > & tfield )

protected

Store the given field in the objectRegistry.

Definition at line 76 of file regionFunctionObjectTemplates.C.

References field(), and tmp< T >::ptr().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ store() [2/2]

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

protected

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

Definition at line 107 of file regionFunctionObjectTemplates.C.

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

Here is the call graph for this function:

◆ writeObject()

bool writeObject ( const word & fieldName )

protected

Write field if present in objectRegistry.

Definition at line 55 of file regionFunctionObject.C.

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

Referenced by regionFunctionObject::cannotFindObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearObject()

bool clearObject ( const word & fieldName )

protected

Clear field from the objectRegistry if present.

Definition at line 78 of file regionFunctionObject.C.

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

Referenced by fieldsExpression::foldAB(), and 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, volFieldValue, forces, fieldAverage, pressure, streamlines, regionSizeDistribution, populationBalanceSizeDistribution, comfort, turbulenceFields, sampledSurfaces, populationBalanceMoments, phaseScalarTransport, forceCoeffs, nearWallFields, layerAverage, scalarTransport, fieldValueDelta, age, wallHeatTransferCoeff, wallShearStress, interfaceHeight, fieldValue, fieldsExpression, histogram, fieldCoordinateSystemTransform, sampledSets, particles, sixDoFRigidBodyControl, wallHeatFlux, readFields, yPlus, log, sixDoFRigidBodyState, phaseForces, cloudInfo, turbulenceIntensity, rigidBodyState, writeVTK, residuals, time, moleFractions< ThermoType >, timeStep, processorField, CourantNo, specieReactionRates, blendingFactor, scale, uniform, randomise, shearStress, totalEnthalpy, meshToMeshAdjustTimeStepFunctionObject, Qdot, and dsmcFields.

Definition at line 144 of file regionFunctionObject.C.

References functionObject::read().

Referenced by Qdot::read(), shearStress::read(), totalEnthalpy::read(), meshToMeshAdjustTimeStepFunctionObject::read(), uniform::read(), specieReactionRates::read(), CourantNo::read(), processorField::read(), residuals::read(), rigidBodyState::read(), turbulenceIntensity::read(), cloudInfo::read(), sixDoFRigidBodyState::read(), yPlus::read(), readFields::read(), wallHeatFlux::read(), particles::read(), fieldCoordinateSystemTransform::read(), fieldsExpression::read(), fieldValue::read(), interfaceHeight::read(), wallShearStress::read(), wallHeatTransferCoeff::read(), fieldValueDelta::read(), scalarTransport::read(), nearWallFields::read(), phaseScalarTransport::read(), fieldAverage::read(), and forces::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const regionFunctionObject & )

delete

Disallow default bitwise assignment.

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::addMeanSqrToPrime2Mean(), fieldAverage::addMeanSqrToPrime2MeanType(), fieldAverage::addPrime2MeanField(), fieldAverage::addPrime2MeanFieldType(), fieldAverage::calculateMeanFields(), fieldAverage::calculateMeanFieldType(), fieldAverage::calculatePrime2MeanFields(), fieldAverage::calculatePrime2MeanFieldType(), 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/3]

◆ regionFunctionObject() [2/3]

◆ regionFunctionObject() [3/3]

◆ ~regionFunctionObject()

Member Function Documentation

◆ foundObject()

◆ cannotFindObject() [1/2]

◆ cannotFindObject() [2/2]

◆ lookupObject()

◆ lookupObjectRef()

◆ store() [1/2]

◆ store() [2/2]

◆ writeObject()

◆ clearObject()

◆ TypeName()

◆ read()

◆ operator=()

Member Data Documentation

◆ time_

◆ obr_