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 ()=default
	Destructor. More...

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

template<class ObjectType >
const ObjectType *	lookupObjectPtr (const word &fieldName) const
	Deprecated(2018-10) More...

template<class ObjectType >
ObjectType *	lookupObjectRefPtr (const word &fieldName) const
	Deprecated(2018-10) More...

Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)
	Construct from components. More...

virtual	~stateFunctionObject ()=default
	Destructor. More...

dictionary &	propertyDict ()
	Return access to the property dictionary. More...

bool	foundProperty (const word &entryName) const
	Return true if the property exists. More...

void	clearTrigger ()
	Remove the trigger index from the properties. More...

label	getTrigger () const
	Get the current trigger index. More...

bool	setTrigger (const label triggeri, bool increaseOnly=true)
	Set the trigger index. Normally only if greater than current. More...

bool	getDict (const word &entryName, dictionary &dict) const
	Set dictionary, return true if set. More...

bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
	Set dictionary from named object, return true if set. More...

template<class Type >
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property. More...

template<class Type >
bool	getProperty (const word &entryName, Type &value) const
	Set generic property, return true if set. More...

template<class Type >
void	setProperty (const word &entryName, const Type &value)
	Add generic property. More...

template<class Type >
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from named object. More...

template<class Type >
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
	Set generic property from named object, return true if set. More...

template<class Type >
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
	Add generic property from named object. More...

template<class Type >
void	setResult (const word &entryName, const Type &value)
	Add result. More...

template<class Type >
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
	Add result from named object. More...

template<class Type >
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result. More...

template<class Type >
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result from named object. More...

template<class Type >
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const
	Set result from named object, return true if set. More...

word	resultType (const word &entryName) const
	Retrieve the result type. More...

word	objectResultType (const word &objectName, const word &entryName) const
	Return the type of result. More...

wordList	objectResultEntries () const
	Retrieve the result entries. More...

wordList	objectResultEntries (const word &objectName) const
	Return result entries for named object. More...

void	writeResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

void	writeResultEntries (const word &objectName, Ostream &os) const
	Write the results entries for named object to stream. More...

void	writeAllResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
	Construct from Time. More...

virtual	~timeFunctionObject ()=default
	Destructor. More...

const Time &	time () const
	Return time database. More...

objectRegistry &	storedObjects ()

const objectRegistry &	storedObjects () const

Public Member Functions inherited from functionObject
	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)
	Construct from components. More...

autoPtr< functionObject >	clone () const
	Return clone. More...

virtual	~functionObject ()=default
	Destructor. More...

virtual const word &	type () const =0
	Runtime type information. More...

const word &	name () const noexcept
	Return the name of this functionObject. More...

bool	useNamePrefix () const noexcept
	Return the flag for adding a scoping name prefix. More...

bool	useNamePrefix (bool on) noexcept
	Modify the flag for adding a scoping name prefix. More...

virtual bool	execute ()=0
	Called at each ++ or += of the time-loop. More...

virtual bool	execute (const label subIndex)
	Execute using the specified subIndex. 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	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true. More...

virtual bool	filesModified () const
	Did any file get changed during execution? 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
virtual const objectRegistry &	obr () const
	The region or sub-region registry being used. More...

template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find object (eg, a field) in the (sub) objectRegistry. More...

template<class ObjectType >
const ObjectType *	cfindObject (const word &fieldName) const

template<class ObjectType >
const ObjectType *	findObject (const word &fieldName) const

template<class ObjectType >
ObjectType *	findObject (const word &fieldName)

template<class ObjectType >
ObjectType *	getObjectPtr (const word &fieldName) const

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

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

template<class ObjectType >
bool	storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)
	Store the field in an optional objectRegistry under the given name. More...

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

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

void	clearObjects (const wordList &objNames)
	Clear fields from the (sub) objectRegistry if present. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	No copy construct. More...

void	operator= (const regionFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const
	Return a const reference to the state dictionary. More...

functionObjects::properties &	stateDict ()
	Return non-const access to the state dictionary. More...

	stateFunctionObject (const stateFunctionObject &)=delete
	No copy construct. More...

void	operator= (const stateFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	Remove specified items from "functionObjectObjects". More...

	timeFunctionObject (const timeFunctionObject &)=delete
	No copy construct. More...

void	operator= (const timeFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name. More...

Protected Attributes
word	subRegistryName_
	Name for alternative object registry. More...

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

const objectRegistry *	obrPtr_
	Pointer to alternative (eg, sub-region) objectRegistry. More...

Protected Attributes inherited from timeFunctionObject
const Time &	time_
	Reference to the time database. More...

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

Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info. More...

Static Public Attributes inherited from functionObject
static int	debug
	Flag to execute debug content. More...

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

static bool	defaultUseNamePrefix
	Global default for useNamePrefix. More...

static word	outputPrefix
	Directory prefix. More...

Detailed Description

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

Also provides support for referencing an alternative objectRegistry that can hold fields. This may be used, for example, to access stored surfaces and fields.

Dictionary controls

Property	Description	Type	Req'd	Dflt
`region`	Name of the mesh region	word	no	region0
`subRegion`	Name for alternative objectRegistry	word	no	""

See also: Foam::functionObjects::stateFunctionObject

Source files

Definition at line 90 of file regionFunctionObject.H.

Constructor & Destructor Documentation

◆ regionFunctionObject() [1/3]

regionFunctionObject ( const regionFunctionObject & )

protecteddelete

No copy construct.

◆ regionFunctionObject() [2/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 138 of file regionFunctionObject.C.

◆ regionFunctionObject() [3/3]

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

Construct from the region objectRegistry and dictionary.

Definition at line 158 of file regionFunctionObject.C.

◆ ~regionFunctionObject()

virtual ~regionFunctionObject ( )

virtualdefault

Destructor.

Member Function Documentation

◆ obr()

const Foam::objectRegistry & obr ( ) const

protectedvirtual

The region or sub-region registry being used.

Reimplemented in surfaceFieldValue.

Definition at line 47 of file regionFunctionObject.C.

References objectRegistry::cfindObject(), Foam::nl, regionFunctionObject::obr_, regionFunctionObject::obrPtr_, timeFunctionObject::storedObjects(), regionFunctionObject::subRegistryName_, and WarningInFunction.

Referenced by fieldAverage::initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ foundObject()

bool foundObject ( const word & fieldName ) const

protected

Find object (eg, a field) in the (sub) objectRegistry.

Definition at line 36 of file regionFunctionObjectTemplates.C.

◆ cfindObject()

const ObjectType * cfindObject ( const word & fieldName ) const

protected

Return const pointer to the object (eg, a field) in the (sub) objectRegistry.

Returns: nullptr if the object was not found or had incorrect type.

Definition at line 46 of file regionFunctionObjectTemplates.C.

◆ findObject() [1/2]

const ObjectType * findObject ( const word & fieldName ) const

protected

Return const pointer to the object (eg, a field) in the (sub) objectRegistry.

Returns: nullptr if the object was not found or had incorrect type.

Definition at line 56 of file regionFunctionObjectTemplates.C.

◆ findObject() [2/2]

ObjectType * findObject ( const word & fieldName )

protected

Return non-const pointer to the object of the given Type, (sub) objectRegistry.

Returns: nullptr if the object was not found or had incorrect type.

Definition at line 66 of file regionFunctionObjectTemplates.C.

◆ getObjectPtr()

ObjectType * getObjectPtr ( const word & fieldName ) const

protected

Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable.

Exercise caution when using.

Returns: nullptr if the object was not found or had incorrect type.

Definition at line 77 of file regionFunctionObjectTemplates.C.

◆ lookupObject()

const ObjectType & lookupObject ( const word & fieldName ) const

protected

Lookup and return object (eg, a field) from the (sub) objectRegistry.

Definition at line 87 of file regionFunctionObjectTemplates.C.

Referenced by yPlus::write(), and wallShearStress::write().

Here is the caller graph for this function:

◆ lookupObjectRef()

ObjectType & lookupObjectRef ( const word & fieldName ) const

protected

Lookup and return object (eg, a field) from the (sub) objectRegistry.

Definition at line 97 of file regionFunctionObjectTemplates.C.

Referenced by wallShearStress::execute().

Here is the caller graph for this function:

◆ store()

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

protected

Store the field in the (sub) objectRegistry under the given name.

Note: sets the fieldName to tfield().name() if not already set

Definition at line 107 of file regionFunctionObjectTemplates.C.

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

Referenced by fieldsExpression::calcFieldTypes(), and surfaceInterpolate::interpolateFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storeInDb()

bool storeInDb	(	const word &	fieldName,
		const tmp< ObjectType > &	tfield,
		const objectRegistry &	obr
	)

protected

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

Definition at line 165 of file regionFunctionObjectTemplates.C.

References objectRegistry::getObjectPtr(), tmp< T >::ptr(), and tmp< T >::ref().

Here is the call graph for this function:

◆ writeObject()

bool writeObject ( const word & fieldName )

protected

Write field if present in the (sub) objectRegistry.

Definition at line 74 of file regionFunctionObject.C.

References 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 (sub) objectRegistry if present.

Definition at line 95 of file regionFunctionObject.C.

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

Here is the call graph for this function:

◆ clearObjects()

void clearObjects ( const wordList & objNames )

protected

Clear fields from the (sub) objectRegistry if present.

Definition at line 119 of file regionFunctionObject.C.

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

Here is the call graph for this function:

◆ operator=()

void operator= ( const regionFunctionObject & )

protecteddelete

No copy assignment.

◆ TypeName()

TypeName ( "regionFunctionObject" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read optional controls.

Reimplemented from functionObject.

Reimplemented in surfaceFieldValue, volFieldValue, sampledSurfaces, fluxSummary, ObukhovLength, setFlow, ensightWrite, electricPotential, DMD, vtkCloud, fvExpressionField, sizeDistribution, heatTransferCoeff, dataCloud, nearWallFields, reference, limitFields, areaWrite, derivedFields, zeroGradient, randomise, columnAverage, fieldValue, wallHeatFlux, hydrostaticPressure, readFields, moleFractions< ThermoType >, fieldExpression, fieldsExpression, phaseForces, cloudInfo, removeRegisteredObject, specieReactionRates< ChemistryModelType >, reactingEulerHtcModel, stabilityBlendingFactor, propellerInfo, pressure, regionSizeDistribution, forces, fieldAverage, extractEulerianParticles, forceCoeffs, energyTransport, momentum, BilgerMixtureFraction, comfort, turbulenceFields, wallBoundedStreamLine, scalarTransport, Curle, streamLine, mapFields, proudmanAcousticPower, log, sampledSets, fieldMinMax, interfaceHeight, pow, fieldExtents, blendingFactor, particleDistribution, ddt2, streamLineBase, histogram, valueAverage, solverInfo, reactionsSensitivityAnalysis< chemistryType >, age, continuityError, wallShearStress, momentumError, AMIWeights, surfaceDistance, yPlus, DESModelRegions, surfaceInterpolate, CourantNo, PecletNo, icoUncoupledKinematicCloud, energySpectrum, writeCellCentres, processorField, writeCellVolumes, XiReactionRate, sixDoFRigidBodyState, runTimeControl, dsmcFields, and writeDictionary.

Definition at line 173 of file regionFunctionObject.C.

References dict, word::null, and functionObject::read().

Referenced by writeDictionary::read(), removeRegisteredObject::read(), sixDoFRigidBodyState::read(), cloudInfo::read(), phaseForces::read(), XiReactionRate::read(), writeCellVolumes::read(), processorField::read(), writeCellCentres::read(), energySpectrum::read(), fieldsExpression::read(), icoUncoupledKinematicCloud::read(), fieldExpression::read(), DESModelRegions::read(), yPlus::read(), readFields::read(), hydrostaticPressure::read(), AMIWeights::read(), wallHeatFlux::read(), momentumError::read(), columnAverage::read(), fieldValue::read(), wallShearStress::read(), continuityError::read(), zeroGradient::read(), derivedFields::read(), age::read(), valueAverage::read(), solverInfo::read(), histogram::read(), streamLineBase::read(), ddt2::read(), particleDistribution::read(), limitFields::read(), fieldExtents::read(), nearWallFields::read(), pow::read(), dataCloud::read(), fieldMinMax::read(), log::read(), proudmanAcousticPower::read(), mapFields::read(), sizeDistribution::read(), fvExpressionField::read(), vtkCloud::read(), DMD::read(), scalarTransport::read(), turbulenceFields::read(), comfort::read(), electricPotential::read(), ensightWrite::read(), BilgerMixtureFraction::read(), setFlow::read(), ObukhovLength::read(), momentum::read(), fluxSummary::read(), energyTransport::read(), extractEulerianParticles::read(), fieldAverage::read(), forces::read(), and regionSizeDistribution::read().

Here is the call graph for this function:

◆ lookupObjectPtr()

const ObjectType* lookupObjectPtr ( const word & fieldName ) const

inline

Deprecated(2018-10)

Deprecated:: (2018-10) - use findObject() method

Definition at line 235 of file regionFunctionObject.H.

◆ lookupObjectRefPtr()

ObjectType* lookupObjectRefPtr ( const word & fieldName ) const

inline

Deprecated(2018-10)

Deprecated:: (2018-10) - use getObjectPtr() method

Definition at line 244 of file regionFunctionObject.H.

Member Data Documentation

◆ subRegistryName_

word subRegistryName_

protected

Name for alternative object registry.

Definition at line 99 of file regionFunctionObject.H.

Referenced by regionFunctionObject::obr().

◆ obr_

const objectRegistry& obr_

protected

Reference to the region objectRegistry.

Definition at line 102 of file regionFunctionObject.H.

Referenced by turbulenceFields::initialise(), surfaceInterpolate::interpolateFields(), sizeDistribution::mesh(), and regionFunctionObject::obr().

◆ obrPtr_

const objectRegistry* obrPtr_

mutableprotected

Pointer to alternative (eg, sub-region) objectRegistry.

If a sub-region is not in effect, this is a nullptr

Definition at line 106 of file regionFunctionObject.H.

Referenced by regionFunctionObject::obr().

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

◆ obr()

◆ foundObject()

◆ cfindObject()

◆ findObject() [1/2]

◆ findObject() [2/2]

◆ getObjectPtr()

◆ lookupObject()

◆ lookupObjectRef()

◆ store()

◆ storeInDb()

◆ writeObject()

◆ clearObject()

◆ clearObjects()

◆ operator=()

◆ TypeName()

◆ read()

◆ lookupObjectPtr()

◆ lookupObjectRefPtr()

Member Data Documentation

◆ subRegistryName_

◆ obr_

◆ obrPtr_