Abstract base-class for Time/database function objects. More...
Classes | |
class | unavailableFunctionObject |
Abstract functionObject to report when a real version is unavailable. More... | |
Public Member Functions | |
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... | |
virtual | ~functionObject ()=default |
Destructor. More... | |
const word & | name () const |
Return the name of this functionObject. More... | |
virtual bool | read (const dictionary &dict) |
Read and set the function object if its data have changed. 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... | |
Static Public Member Functions | |
static autoPtr< functionObject > | New (const word &name, const Time &runTime, const dictionary &dict) |
Select from dictionary, based on its "type" entry. More... | |
Public Attributes | |
bool | log |
Flag to write log into Info. More... | |
Static Public Attributes | |
static int | debug |
Flag to execute debug content. More... | |
static bool | postProcess |
Global post-processing mode switch. More... | |
static word | outputPrefix |
Directory prefix. More... | |
Protected Member Functions | |
word | scopedName (const word &name) const |
Return a scoped name, e.g. used to construct local field names. More... | |
Abstract base-class for Time/database function objects.
Definition at line 309 of file functionObject.H.
functionObject | ( | const word & | name | ) |
Construct from components.
Definition at line 57 of file functionObject.C.
|
virtualdefault |
Destructor.
|
protected |
Return a scoped name, e.g. used to construct local field names.
Definition at line 49 of file functionObject.C.
References functionObject::name().
|
pure virtual |
Runtime type information.
Referenced by extractEulerianParticles::checkFaceZone(), runTimeControl::execute(), surfaceInterpolate::execute(), surfaceDistance::execute(), fieldAverage::initialize(), abort::read(), derivedFields::read(), particleDistribution::read(), limitFields::read(), wallBoundedStreamLine::track(), and fieldValueDelta::write().
declareRunTimeSelectionTable | ( | autoPtr | , |
functionObject | , | ||
dictionary | , | ||
(const word &name, const Time &runTime, const dictionary &dict) | , | ||
(name, runTime, dict) | |||
) |
|
inline |
|
static |
Select from dictionary, based on its "type" entry.
Definition at line 67 of file functionObject.C.
References dictionary::csearchCompat(), DebugInfo, dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, FatalErrorInLookup, dictionary::get(), Foam::name(), Foam::nl, and runTime.
Referenced by reactingEulerHtcModel::q(), functionObjectList::read(), and codedFunctionObject::redirectFunctionObject().
const Foam::word & name | ( | ) | const |
Return the name of this functionObject.
Definition at line 131 of file functionObject.C.
Referenced by extractEulerianParticles::checkFaceZone(), runTimeControl::execute(), surfaceInterpolate::execute(), forces::fieldName(), fieldAverage::initialize(), abort::read(), particleDistribution::read(), limitFields::read(), functionObjectList::read(), functionObject::scopedName(), yPlus::write(), DESModelRegions::write(), wallHeatFlux::write(), wallShearStress::write(), and fieldValueDelta::write().
|
virtual |
Read and set the function object if its data have changed.
Reimplemented in surfaceFieldValue, volFieldValue, sampledSurfaces, vtkWrite, externalCoupled, fluxSummary, ObukhovLength, setFlow, ensightWrite, vtkCloud, sizeDistribution, reference, dataCloud, nearWallFields, limitFields, areaWrite, derivedFields, heatTransferCoeff, zeroGradient, fieldValue, columnAverage, wallHeatFlux, regionFunctionObject, hydrostaticPressure, systemCall, fieldsExpression, abort, setTimeStepFunctionObject, fieldExpression, timeInfo, phaseForces, cloudInfo, removeRegisteredObject, pointHistory, specieReactionRates< ChemistryModelType >, reactingEulerHtcModel, writeFreeSurface, STDMD, stabilityBlendingFactor, pressure, regionSizeDistribution, forces, fieldAverage, extractEulerianParticles, forceCoeffs, momentum, energyTransport, wallBoundedStreamLine, scalarTransport, Curle, streamLine, turbulenceFields, mapFields, probes, sampledSets, log, fieldMinMax, interfaceHeight, pow, fieldValueDelta, fieldExtents, blendingFactor, particleDistribution, timeControl, ddt2, streamLineBase, histogram, proudmanAcousticPower, valueAverage, reactionsSensitivityAnalysis< chemistryType >, continuityError, codedFunctionObject, wallShearStress, AMIWeights, momentumError, thermoCoupleProbes, surfaceDistance, randomise, readFields, writeObjects, DESModelRegions, surfaceInterpolate, CourantNo, PecletNo, solverInfo, patchProbes, icoUncoupledKinematicCloud, yPlus, energySpectrum, writeCellCentres, timeActivatedFileUpdate, processorField, writeCellVolumes, XiReactionRate, sixDoFRigidBodyState, runTimeControl, dsmcFields, moleFractions< ThermoType >, and writeDictionary.
Definition at line 137 of file functionObject.C.
References dict, dictionary::getOrDefault(), and Foam::log().
Referenced by timeInfo::read(), timeActivatedFileUpdate::read(), setTimeStepFunctionObject::read(), abort::read(), systemCall::read(), writeObjects::read(), regionFunctionObject::read(), codedFunctionObject::read(), functionObjectList::read(), externalCoupled::read(), and vtkWrite::read().
|
pure virtual |
Called at each ++ or += of the time-loop.
postProcess overrides the usual executeControl behaviour and forces execution (used in post-processing mode)
Implemented in STDMD, forces, regionSizeDistribution, functionObject::unavailableFunctionObject, sampledSurfaces, vtkWrite, fieldAverage, extractEulerianParticles, externalCoupled, forceCoeffs, momentum, energyTransport, fluxSummary, ObukhovLength, setFlow, ensightWrite, scalarTransport, vtkCloud, Curle, sizeDistribution, turbulenceFields, mapFields, probes, sampledSets, fieldMinMax, interfaceHeight, dataCloud, nearWallFields, fieldValueDelta, fieldExtents, limitFields, particleDistribution, areaWrite, ddt2, streamLineBase, histogram, proudmanAcousticPower, valueAverage, reactionsSensitivityAnalysis< chemistryType >, derivedFields, zeroGradient, continuityError, wallShearStress, timeControl, fieldValue, columnAverage, wallHeatFlux, AMIWeights, codedFunctionObject, hydrostaticPressure, momentumError, surfaceDistance, readFields, thermoCoupleProbes, writeObjects, DESModelRegions, surfaceInterpolate, systemCall, solverInfo, icoUncoupledKinematicCloud, yPlus, fieldsExpression, energySpectrum, writeCellCentres, abort, setTimeStepFunctionObject, timeActivatedFileUpdate, processorField, writeCellVolumes, XiReactionRate, fieldExpression, timeInfo, phaseForces, cloudInfo, sixDoFRigidBodyState, runTimeControl, removeRegisteredObject, dsmcFields, moleFractions< ThermoType >, writeDictionary, specieReactionRates< ChemistryModelType >, pointHistory, parProfiling, and writeFreeSurface.
|
virtual |
Execute using the specified subIndex.
The base implementation is a no-op.
subIndex | an execution sub-index corresponding to a sub-cycle or something similar. |
Reimplemented in externalCoupled, and timeControl.
Definition at line 148 of file functionObject.C.
|
pure virtual |
Called at each ++ or += of the time-loop.
postProcess overrides the usual writeControl behaviour and forces writing always (used in post-processing mode)
Implemented in surfaceFieldValue, STDMD, stabilityBlendingFactor, forces, regionSizeDistribution, functionObject::unavailableFunctionObject, volFieldValue, sampledSurfaces, vtkWrite, fieldAverage, extractEulerianParticles, externalCoupled, forceCoeffs, momentum, energyTransport, fluxSummary, ObukhovLength, setFlow, ensightWrite, scalarTransport, vtkCloud, Curle, sizeDistribution, turbulenceFields, mapFields, probes, sampledSets, interfaceHeight, fieldMinMax, dataCloud, nearWallFields, fieldValueDelta, fieldExtents, limitFields, blendingFactor, particleDistribution, areaWrite, histogram, ddt2, streamLineBase, proudmanAcousticPower, valueAverage, reactionsSensitivityAnalysis< chemistryType >, derivedFields, components, zeroGradient, continuityError, timeControl, wallShearStress, fieldValue, columnAverage, wallHeatFlux, codedFunctionObject, AMIWeights, hydrostaticPressure, momentumError, surfaceDistance, readFields, writeObjects, DESModelRegions, surfaceInterpolate, thermoCoupleProbes, systemCall, solverInfo, icoUncoupledKinematicCloud, yPlus, patchProbes, fieldsExpression, energySpectrum, writeCellCentres, abort, setTimeStepFunctionObject, timeActivatedFileUpdate, processorField, writeCellVolumes, XiReactionRate, fieldExpression, timeInfo, phaseForces, cloudInfo, sixDoFRigidBodyState, runTimeControl, removeRegisteredObject, dsmcFields, moleFractions< ThermoType >, writeDictionary, pointHistory, specieReactionRates< ChemistryModelType >, parProfiling, and writeFreeSurface.
|
virtual |
Called when Time::run() determines that the time-loop exits.
The base implementation is a no-op.
Reimplemented in vtkWrite, externalCoupled, ensightWrite, interfaceHeight, timeControl, codedFunctionObject, systemCall, abort, and parProfiling.
Definition at line 154 of file functionObject.C.
Referenced by nearWallFields::calcAddressing(), and externalCoupled::end().
|
virtual |
Called at the end of Time::adjustDeltaT() if adjustTime is true.
Reimplemented in timeControl, and setTimeStepFunctionObject.
Definition at line 160 of file functionObject.C.
|
virtual |
Did any file get changed during execution?
Reimplemented in timeControl, and timeActivatedFileUpdate.
Definition at line 166 of file functionObject.C.
|
virtual |
Update for changes of mesh.
The base implementation is a no-op.
Reimplemented in surfaceFieldValue, sampledSurfaces, vtkWrite, ObukhovLength, ensightWrite, areaWrite, timeControl, derivedFields, momentum, sampledSets, probes, and streamLineBase.
Definition at line 172 of file functionObject.C.
|
virtual |
Update for changes of mesh.
The base implementation is a no-op.
Reimplemented in ensightWrite, surfaceFieldValue, sampledSurfaces, vtkWrite, areaWrite, timeControl, ObukhovLength, derivedFields, momentum, sampledSets, probes, and streamLineBase.
Definition at line 176 of file functionObject.C.
|
static |
Flag to execute debug content.
Definition at line 334 of file functionObject.H.
Referenced by nearWallFields::calcAddressing(), patchProbes::findElements(), and probes::findElements().
|
static |
Global post-processing mode switch.
Definition at line 337 of file functionObject.H.
|
static |
Directory prefix.
Definition at line 340 of file functionObject.H.
Referenced by writeFile::baseFileDir(), noiseModel::baseFileDir(), CloudFunctionObject< CloudType >::CloudFunctionObject(), meshRefinement::findRegions(), if(), dynamicFvMesh::New(), probes::prepare(), dataCloud::read(), vtkCloud::read(), ensightWrite::read(), vtkWrite::read(), sampledSets::sampledSets(), shortestPathSet::shortestPathSet(), and streamLineBase::writeToFile().
bool log |
Flag to write log into Info.
Definition at line 343 of file functionObject.H.