Specialization of Foam::functionObject for a region and providing a reference to the region Foam::objectRegistry. More...
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) |
Set new trigger index. 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... | |
bool | getObjectResultDict (const word &objectName, dictionary &dict) const |
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 () |
Write access to the output objects ("functionObjectObjects") registered on Time. More... | |
const objectRegistry & | storedObjects () const |
Const access to the output objects ("functionObjectObjects") registered on Time. More... | |
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 |
Return const pointer to the object (eg, a field) in the (sub) objectRegistry. More... | |
template<class ObjectType > | |
const ObjectType * | findObject (const word &fieldName) const |
Return const pointer to the object (eg, a field) in the (sub) objectRegistry. More... | |
template<class ObjectType > | |
ObjectType * | findObject (const word &fieldName) |
Return non-const pointer to the object of the given Type, (sub) objectRegistry. More... | |
template<class ObjectType > | |
ObjectType * | getObjectPtr (const word &fieldName) const |
Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable. More... | |
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... | |
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 | "" |
Definition at line 86 of file regionFunctionObject.H.
|
protecteddelete |
No copy construct.
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 131 of file regionFunctionObject.C.
regionFunctionObject | ( | const word & | name, |
const objectRegistry & | obr, | ||
const dictionary & | dict | ||
) |
Construct from the region objectRegistry and dictionary.
Definition at line 151 of file regionFunctionObject.C.
|
virtualdefault |
Destructor.
|
protectedvirtual |
The region or sub-region registry being used.
Reimplemented in surfaceFieldValue.
Definition at line 40 of file regionFunctionObject.C.
References objectRegistry::cfindObject(), Foam::nl, regionFunctionObject::obr_, regionFunctionObject::obrPtr_, timeFunctionObject::storedObjects(), regionFunctionObject::subRegistryName_, and WarningInFunction.
Referenced by fieldAverage::initialize().
|
protected |
Find object (eg, a field) in the (sub) objectRegistry.
Definition at line 29 of file regionFunctionObjectTemplates.C.
|
protected |
Return const pointer to the object (eg, a field) in the (sub) objectRegistry.
Definition at line 39 of file regionFunctionObjectTemplates.C.
|
protected |
Return const pointer to the object (eg, a field) in the (sub) objectRegistry.
Definition at line 49 of file regionFunctionObjectTemplates.C.
|
protected |
Return non-const pointer to the object of the given Type, (sub) objectRegistry.
Definition at line 59 of file regionFunctionObjectTemplates.C.
|
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.
Definition at line 70 of file regionFunctionObjectTemplates.C.
|
protected |
Lookup and return object (eg, a field) from the (sub) objectRegistry.
Definition at line 80 of file regionFunctionObjectTemplates.C.
Referenced by yPlus::write(), and wallShearStress::write().
|
protected |
Lookup and return object (eg, a field) from the (sub) objectRegistry.
Definition at line 90 of file regionFunctionObjectTemplates.C.
Referenced by wallShearStress::execute().
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 100 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().
|
protected |
Store the field in an optional objectRegistry under the given name.
Definition at line 158 of file regionFunctionObjectTemplates.C.
References objectRegistry::getObjectPtr(), tmp< T >::ptr(), and tmp< T >::ref().
|
protected |
Write field if present in the (sub) objectRegistry.
Definition at line 67 of file regionFunctionObject.C.
References Foam::endl(), Log, Foam::name(), IOobject::name(), Foam::type(), and regIOobject::write().
|
protected |
Clear field from the (sub) objectRegistry if present.
Definition at line 88 of file regionFunctionObject.C.
References regIOobject::checkOut(), and regIOobject::ownedByRegistry().
|
protected |
Clear fields from the (sub) objectRegistry if present.
Definition at line 112 of file regionFunctionObject.C.
References regIOobject::checkOut(), and regIOobject::ownedByRegistry().
|
protecteddelete |
No copy assignment.
TypeName | ( | "regionFunctionObject" | ) |
Runtime type information.
|
virtual |
Read optional controls.
Reimplemented from functionObject.
Reimplemented in surfaceFieldValue, forceCoeffs, stabilityBlendingFactor, forces, propellerInfo, pressure, regionSizeDistribution, volFieldValue, sampledSurfaces, fieldAverage, extractEulerianParticles, sampledSets, ensightWrite, probes, fluxSummary, electricPotential, energyTransport, momentum, setFlow, BilgerMixtureFraction, ObukhovLength, DMD, comfort, turbulenceFields, norm, sizeDistribution, scalarTransport, ensightCloudWriteObject, fvExpressionField, vtkCloud, wallBoundedStreamLine, Curle, mapFields, streamLine, proudmanAcousticPower, streamLineBase, interfaceHeight, log, fieldMinMax, heatTransferCoeff, binField, nearWallFields, dataCloud, areaWrite, pow, fieldExtents, reactionsSensitivityAnalysis< chemistryType >, cellDecomposer, limitFields, reference, particleDistribution, ddt2, solverInfo, derivedFields, wallShearStress, blendingFactor, fieldValue, age, zeroGradient, continuityError, randomise, columnAverage, hydrostaticPressure, momentumError, AMIWeights, thermoCoupleProbes, wallHeatFlux, yPlus, readFields, surfaceDistance, resolutionIndex, moleFractions< ThermoType >, multiphaseInterHtcModel, reactingEulerHtcModel, cloudInfo, DESModelRegions, valueAverage, surfaceInterpolate, CourantNo, histogram, PecletNo, icoUncoupledKinematicCloud, fieldExpression, energySpectrum, viewFactorHeatFlux, fieldsExpression, patchProbes, writeCellCentres, runTimeControl, processorField, writeCellVolumes, phaseForces, XiReactionRate, sixDoFRigidBodyState, removeRegisteredObject, dsmcFields, writeDictionary, and specieReactionRates< ChemistryModelType >.
Definition at line 166 of file regionFunctionObject.C.
References dict, word::null, and functionObject::read().
Referenced by writeDictionary::read(), removeRegisteredObject::read(), sixDoFRigidBodyState::read(), XiReactionRate::read(), writeCellVolumes::read(), phaseForces::read(), processorField::read(), writeCellCentres::read(), fieldsExpression::read(), energySpectrum::read(), viewFactorHeatFlux::read(), fieldExpression::read(), icoUncoupledKinematicCloud::read(), histogram::read(), DESModelRegions::read(), valueAverage::read(), cloudInfo::read(), resolutionIndex::read(), readFields::read(), yPlus::read(), wallHeatFlux::read(), AMIWeights::read(), momentumError::read(), hydrostaticPressure::read(), columnAverage::read(), continuityError::read(), zeroGradient::read(), age::read(), fieldValue::read(), wallShearStress::read(), derivedFields::read(), ddt2::read(), solverInfo::read(), particleDistribution::read(), limitFields::read(), cellDecomposer::read(), fieldExtents::read(), pow::read(), dataCloud::read(), nearWallFields::read(), binField::read(), fieldMinMax::read(), log::read(), proudmanAcousticPower::read(), streamLineBase::read(), mapFields::read(), vtkCloud::read(), fvExpressionField::read(), scalarTransport::read(), sizeDistribution::read(), turbulenceFields::read(), comfort::read(), DMD::read(), ObukhovLength::read(), BilgerMixtureFraction::read(), setFlow::read(), momentum::read(), energyTransport::read(), electricPotential::read(), fluxSummary::read(), ensightWrite::read(), extractEulerianParticles::read(), fieldAverage::read(), and forces::read().
|
inline |
Deprecated(2018-10)
Definition at line 287 of file regionFunctionObject.H.
|
inline |
Deprecated(2018-10)
Definition at line 299 of file regionFunctionObject.H.
|
protected |
Name for alternative object registry.
Definition at line 97 of file regionFunctionObject.H.
Referenced by regionFunctionObject::obr().
|
protected |
Reference to the region objectRegistry.
Definition at line 102 of file regionFunctionObject.H.
Referenced by turbulenceFields::initialise(), surfaceInterpolate::interpolateFields(), sizeDistribution::mesh(), regionFunctionObject::obr(), and areaWrite::read().
|
mutableprotected |
Pointer to alternative (eg, sub-region) objectRegistry.
If a sub-region is not in effect, this is a nullptr
Definition at line 109 of file regionFunctionObject.H.
Referenced by regionFunctionObject::obr().