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... | |
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 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 bool | setTimeStep () |
Called by Time::setDeltaT(). Allows the functionObject to override. More... | |
virtual scalar | timeToNextWrite () |
Called by Time::adjustTimeStep(). Allows the functionObject 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... | |
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 > | |
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... | |
Specialization of Foam::functionObject for a region and providing a reference to the region Foam::objectRegistry.
Definition at line 58 of file regionFunctionObject.H.
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.
Referenced by regionFunctionObject::clearObject().
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.
|
delete |
Disallow default bitwise copy construction.
|
virtual |
Destructor.
Definition at line 127 of file regionFunctionObject.C.
|
protected |
Find field in the objectRegistry.
Definition at line 33 of file regionFunctionObjectTemplates.C.
References regionFunctionObject::lookupObject().
|
protected |
Lookup object from the objectRegistry.
Definition at line 43 of file regionFunctionObjectTemplates.C.
References regionFunctionObject::lookupObjectRef().
Referenced by regionFunctionObject::foundObject(), turbulenceIntensity::write(), yPlus::write(), wallHeatFlux::write(), wallShearStress::write(), and wallHeatTransferCoeff::write().
|
protected |
Lookup non-const object reference from the objectRegistry.
Definition at line 53 of file regionFunctionObjectTemplates.C.
References regionFunctionObject::store().
Referenced by regionFunctionObject::lookupObject().
|
protected |
Store the given field in the objectRegistry.
Definition at line 63 of file regionFunctionObjectTemplates.C.
References field(), and tmp< T >::ptr().
Referenced by fieldsExpression::calcFieldTypes(), and regionFunctionObject::lookupObjectRef().
|
protected |
Store the given field in the objectRegistry under the given name.
Definition at line 94 of file regionFunctionObjectTemplates.C.
References Foam::endl(), field(), Foam::name(), Foam::nl, tmp< T >::ptr(), tmp< T >::ref(), and WarningInFunction.
|
protected |
Write field if present in objectRegistry.
Definition at line 44 of file regionFunctionObject.C.
References regionFunctionObject::clearObject(), Foam::endl(), field(), Log, Foam::name(), IOobject::name(), Foam::type(), and regIOobject::write().
|
protected |
Clear field from the objectRegistry if present.
Definition at line 67 of file regionFunctionObject.C.
References regIOobject::checkOut(), regIOobject::ownedByRegistry(), and regionFunctionObject::regionFunctionObject().
Referenced by regionFunctionObject::writeObject().
TypeName | ( | "regionFunctionObject" | ) |
Runtime type information.
|
virtual |
Read optional controls.
Reimplemented from functionObject.
Reimplemented in surfaceFieldValue, fieldAverage, forces, pressure, volFieldValue, streamLine, regionSizeDistribution, sizeDistribution, comfort, turbulenceFields, phaseScalarTransport, forceCoeffs, nearWallFields, wallHeatTransferCoeff, fieldMinMax, fieldValueDelta, age, histogram, interfaceHeight, wallShearStress, fieldValue, particles, fieldCoordinateSystemTransform, wallHeatFlux, sixDoFRigidBodyControl, surfaceInterpolate, readFields, yPlus, log, phaseForces, sixDoFRigidBodyState, scalarTransport, cloudInfo, turbulenceIntensity, rigidBodyState, writeVTK, residuals, time, fieldsExpression, moleFractions< ThermoType >, processorField, CourantNo, fieldExpression, specieReactionRates< ChemistryModelType >, blendingFactor, scale, randomise, shearStress, totalEnthalpy, Qdot, and dsmcFields.
Definition at line 133 of file regionFunctionObject.C.
References functionObject::read().
Referenced by Qdot::read(), shearStress::read(), totalEnthalpy::read(), processorField::read(), fieldsExpression::read(), residuals::read(), turbulenceIntensity::read(), rigidBodyState::read(), cloudInfo::read(), scalarTransport::read(), sixDoFRigidBodyState::read(), yPlus::read(), readFields::read(), wallHeatFlux::read(), fieldCoordinateSystemTransform::read(), particles::read(), fieldValue::read(), wallShearStress::read(), fieldMinMax::read(), fieldValueDelta::read(), wallHeatTransferCoeff::read(), nearWallFields::read(), phaseScalarTransport::read(), forces::read(), and fieldAverage::read().
|
delete |
Disallow default bitwise assignment.
|
protected |
Reference to the Time.
Definition at line 68 of file regionFunctionObject.H.
|
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(), surfaceFieldValue::outputDir(), fieldAverage::writeFieldType(), residuals::writeFileHeader(), and residuals::writeResidual().