Specialisation of Foam::functionObject which holds a reference to an object registry. Provides a number of functions for caching and accessing objects from the registry. More...

Inheritance diagram for objectRegistryFunctionObject:

[legend]

Collaboration diagram for objectRegistryFunctionObject:

[legend]

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

	objectRegistryFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from an objectRegistry and dictionary. More...

	objectRegistryFunctionObject (const word &name, const objectRegistry &obr)
	Construct from an objectRegistry. More...

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

virtual	~objectRegistryFunctionObject ()
	Destructor. More...

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

void	operator= (const objectRegistryFunctionObject &)=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, const Time &runTime)
	Construct from components. More...

	functionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from dictionary. 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	timeToNextAction ()
	Called by Time::adjustTimeStep(). Allows the functionObject to. More...

virtual scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. 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...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution 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...

void	cannotFindObjects (const wordList &fieldNames)
	Prints a warning message that fieldNames 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 >
ObjectType &	store (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

template<class ObjectType >
ObjectType &	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 objectRegistry &	obr_
	Reference to the objectRegistry. More...

Protected Attributes inherited from functionObject
const Time &	time_
	Reference to time. 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 execute at start time. More...

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

Detailed Description

Specialisation of Foam::functionObject which holds a reference to an object registry. Provides a number of functions for caching and accessing objects from the registry.

See also: Foam::functionObject

Source files

Definition at line 59 of file objectRegistryFunctionObject.H.

Constructor & Destructor Documentation

◆ objectRegistryFunctionObject() [1/3]

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

Construct from an objectRegistry and dictionary.

Definition at line 114 of file objectRegistryFunctionObject.C.

◆ objectRegistryFunctionObject() [2/3]

objectRegistryFunctionObject	(	const word &	name,
		const objectRegistry &	obr
	)

Construct from an objectRegistry.

Definition at line 127 of file objectRegistryFunctionObject.C.

◆ objectRegistryFunctionObject() [3/3]

objectRegistryFunctionObject ( const objectRegistryFunctionObject & )

delete

Disallow default bitwise copy construction.

◆ ~objectRegistryFunctionObject()

~objectRegistryFunctionObject ( )

virtual

Destructor.

Definition at line 141 of file objectRegistryFunctionObject.C.

Member Function Documentation

◆ foundObject()

bool foundObject ( const word & fieldName ) const

protected

Find field in the objectRegistry.

Definition at line 32 of file objectRegistryFunctionObjectTemplates.C.

References objectRegistry::foundObject(), and objectRegistryFunctionObject::obr_.

Here is the call 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 42 of file objectRegistryFunctionObjectTemplates.C.

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

Here is the call 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 42 of file objectRegistryFunctionObject.C.

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

Here is the call graph for this function:

◆ cannotFindObjects()

void cannotFindObjects ( const wordList & fieldNames )

protected

Prints a warning message that fieldNames cannot be found.

Definition at line 53 of file objectRegistryFunctionObject.C.

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

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

Referenced by power::write(), turbulenceIntensity::write(), wallHeatFlux::write(), wallShearStress::write(), yPlus::write(), and cloudInfo::write().

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 67 of file objectRegistryFunctionObjectTemplates.C.

◆ store() [1/2]

ObjectType & store ( const tmp< ObjectType > & tfield )

protected

Store the given field in the objectRegistry.

Definition at line 77 of file objectRegistryFunctionObjectTemplates.C.

References tmp< T >::ptr().

Referenced by cloudGravitationalPotentialEnergy::execute(), cloudKineticEnergy::execute(), cloudLagrangianVolumeFraction::execute(), cloudSurfaceAreaPerUnitVolume::execute(), cloudVolumeFraction::execute(), fieldsExpression::opAndStore(), and fieldCoordinateSystemTransform::transformField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ store() [2/2]

ObjectType & 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 111 of file objectRegistryFunctionObjectTemplates.C.

References Foam::endl(), 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 64 of file objectRegistryFunctionObject.C.

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

Referenced by cloudGravitationalPotentialEnergy::write(), cloudKineticEnergy::write(), cloudLagrangianVolumeFraction::write(), cloudSurfaceAreaPerUnitVolume::write(), and cloudVolumeFraction::write().

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 87 of file objectRegistryFunctionObject.C.

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

Referenced by cloudGravitationalPotentialEnergy::clear(), cloudKineticEnergy::clear(), cloudLagrangianVolumeFraction::clear(), cloudSurfaceAreaPerUnitVolume::clear(), cloudVolumeFraction::clear(), cloudGravitationalPotentialEnergy::preSolve(), cloudKineticEnergy::preSolve(), and cloudLagrangianVolumeFraction::preSolve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "objectRegistryFunctionObject" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read optional controls.

Reimplemented from functionObject.

Reimplemented in fieldValue, phaseForces, moleFractions, massFractions, specieReactionRates, reactionRates, adjustTimeStepToChemistry, sampledSurfaces, sampledSets, sixDoFRigidBodyState, sixDoFRigidBodyControl, rigidBodyState, rigidBodyPoints, rigidBodyForces, LagrangianFieldValue, LagrangianDistribution, particles, dsmcFields, cloudInfo, cloudSurfaceDistribution, meshToMeshAdjustTimeStep, multiValveEngineState, userTimeStep, timeStep, time, residuals, checkMesh, scalarTransport, phaseScalarTransport, movingForces, forcesBase, forces, forceCoeffs, yPlus, wallShearStress, wallHeatTransferCoeff, wallHeatFlux, uniform, turbulenceIntensity, turbulenceFields, totalEnthalpy, streamlines, shearStress, scale, regionSizeDistribution, readFields, randomise, processorField, pressure, power, patchCutLayerAverage, nearWallFields, log, layerAverage, interfaceHeight, histogram, volFieldValue, surfaceFieldValue, fieldValueDelta, fieldsExpression, fieldCoordinateSystemTransform, fieldAverage, cutLayerAverage, CourantNo, comfort, bXiProgress, blendingFactor, age, Qdot, adjustTimeStepToCombustion, writeVTK, wallBoilingProperty, populationBalanceSizeDistribution, populationBalanceMoments, adjustTimeStepToNucleation, and fluidMaxDeltaT.

Definition at line 148 of file objectRegistryFunctionObject.C.

References dict, and functionObject::read().

Referenced by fieldAverage::fieldAverage(), fieldExpression::fieldExpression(), fvModel::fvModel(), populationBalanceSetSizeDistribution::populationBalanceSetSizeDistribution(), fluidMaxDeltaT::read(), populationBalanceMoments::read(), populationBalanceSizeDistribution::read(), wallBoilingProperty::read(), Qdot::read(), CourantNo::read(), fieldAverage::read(), fieldCoordinateSystemTransform::read(), fieldsExpression::read(), fieldValueDelta::read(), interfaceHeight::read(), nearWallFields::read(), power::read(), processorField::read(), readFields::read(), shearStress::read(), totalEnthalpy::read(), turbulenceIntensity::read(), uniform::read(), wallHeatFlux::read(), wallHeatTransferCoeff::read(), wallShearStress::read(), yPlus::read(), forcesBase::read(), phaseScalarTransport::read(), scalarTransport::read(), residuals::read(), multiValveEngineState::read(), meshToMeshAdjustTimeStep::read(), cloudSurfaceDistribution::read(), cloudInfo::read(), particles::read(), LagrangianDistribution::read(), LagrangianFieldValue::read(), rigidBodyPoints::read(), rigidBodyState::read(), sixDoFRigidBodyState::read(), reactionRates::read(), specieReactionRates::read(), phaseForces::read(), fieldValue::read(), writeCellCentres::writeCellCentres(), writeCellVolumes::writeCellVolumes(), and XiReactionRate::XiReactionRate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const objectRegistryFunctionObject & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ obr_

const objectRegistry& obr_

protected

Reference to the objectRegistry.

Definition at line 69 of file objectRegistryFunctionObject.H.

Referenced by nearWallFields::createFields(), objectRegistryFunctionObject::foundObject(), readFields::loadField(), turbulenceFields::processField(), fieldAverage::readMeanFieldType(), surfaceFieldValue::validField(), volFieldValue::validField(), and residuals::writeFileHeader().

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

src/OpenFOAM/db/functionObjects/objectRegistryFunctionObject/objectRegistryFunctionObject.H
src/OpenFOAM/db/functionObjects/objectRegistryFunctionObject/objectRegistryFunctionObject.C
src/OpenFOAM/db/functionObjects/objectRegistryFunctionObject/objectRegistryFunctionObjectTemplates.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ objectRegistryFunctionObject() [1/3]

◆ objectRegistryFunctionObject() [2/3]

◆ objectRegistryFunctionObject() [3/3]

◆ ~objectRegistryFunctionObject()

Member Function Documentation

◆ foundObject()

◆ cannotFindObject() [1/2]

◆ cannotFindObject() [2/2]

◆ cannotFindObjects()

◆ lookupObject()

◆ lookupObjectRef()

◆ store() [1/2]

◆ store() [2/2]

◆ writeObject()

◆ clearObject()

◆ TypeName()

◆ read()

◆ operator=()

Member Data Documentation

◆ obr_