Specialisation of Foam::functionObject for an Foam::fvMesh, providing a reference to the Foam::fvMesh. More...
Inherits regionFunctionObject.
Inherited by Qdot, XiReactionRate, age, checkMesh, comfort, dsmcFields, fieldAverage, fieldCoordinateSystemTransform, fieldExpression, fieldValue, fieldsExpression, forces, fvModel, histogram, interfaceHeight, layerAverage, massFractions, meshToMeshAdjustTimeStepFunctionObject, moleFractions, nearWallFields, particles, patchCutLayerAverage, phaseForces, phaseMap, phaseScalarTransport, populationBalanceMoments, populationBalanceSizeDistribution, processorField, readFields, regionSizeDistribution, residuals, rigidBodyPoints, rigidBodyState, sampledSets, sampledSurfaces, scalarTransport, shearStress, sixDoFRigidBodyState, specieReactionRates, streamlines, totalEnthalpy, turbulenceFields, turbulenceIntensity, uniform, wallBoilingProperties, wallHeatFlux, wallHeatTransferCoeff, wallShearStress, writeCellCentres, writeCellVolumes, writeVTK, and yPlus.
Public Member Functions | |
TypeName ("fvMeshFunctionObject") | |
Runtime type information. More... | |
fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict) | |
Construct from Time and dictionary. More... | |
fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict) | |
Construct from the region objectRegistry and dictionary. More... | |
fvMeshFunctionObject (const fvMeshFunctionObject &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~fvMeshFunctionObject () |
Destructor. More... | |
void | operator= (const fvMeshFunctionObject &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from regionFunctionObject | |
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, const Time &runTime) | |
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 | timeToNextAction () |
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... | |
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 Attributes | |
const fvMesh & | mesh_ |
Reference to the fvMesh. More... | |
Protected Attributes inherited from regionFunctionObject | |
const objectRegistry & | obr_ |
Reference to the region 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 write log to Info. More... | |
Static Public Attributes inherited from functionObject | |
static bool | postProcess |
Global post-processing mode switch. More... | |
Protected Member Functions inherited from regionFunctionObject | |
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... | |
Specialisation of Foam::functionObject for an Foam::fvMesh, providing a reference to the Foam::fvMesh.
If the selected region is not an Foam::fvMesh a Foam::FatalError will be generated.
Definition at line 62 of file fvMeshFunctionObject.H.
fvMeshFunctionObject | ( | const word & | name, |
const Time & | runTime, | ||
const dictionary & | dict | ||
) |
Construct from Time and dictionary.
Definition at line 43 of file fvMeshFunctionObject.C.
fvMeshFunctionObject | ( | const word & | name, |
const objectRegistry & | obr, | ||
const dictionary & | dict | ||
) |
Construct from the region objectRegistry and dictionary.
Definition at line 55 of file fvMeshFunctionObject.C.
|
delete |
Disallow default bitwise copy construction.
|
virtual |
Destructor.
Definition at line 69 of file fvMeshFunctionObject.C.
TypeName | ( | "fvMeshFunctionObject" | ) |
Runtime type information.
|
delete |
Disallow default bitwise assignment.
|
protected |
Reference to the fvMesh.
Definition at line 72 of file fvMeshFunctionObject.H.
Referenced by nearWallFields::calcAddressing(), volFieldValue::compareScalars(), nearWallFields::createFields(), readFields::loadField(), phaseForces::phaseForces(), fieldAverage::readMeanFieldType(), sampledSets::sampleLocalType(), sampledSurfaces::sampleLocalType(), scalarTransport::scalarTransport(), streamFunction::streamFunction(), volFieldValue::write(), specieReactionRates::write(), and residuals::writeFileHeader().