Abstract base-class for Time/database function objects. 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... | |
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 | read (const dictionary &) |
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 | 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 function object to override. More... | |
virtual scalar | timeToNextWrite () |
Called by Time::adjustTimeStep(). Allows the function object 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... | |
Static Public Member Functions | |
static autoPtr< functionObject > | New (const word &name, const Time &, const dictionary &) |
Select from dictionary, based on its "type" entry. More... | |
Public Attributes | |
Switch | log |
Switch write log to Info. More... | |
Static Public Attributes | |
static int | debug |
static bool | postProcess |
Global post-processing mode switch. More... | |
Abstract base-class for Time/database function objects.
Definition at line 223 of file functionObject.H.
functionObject | ( | const word & | name | ) |
Construct from components.
Definition at line 44 of file functionObject.C.
References functionObject::New().
Referenced by functionObject::clone().
|
delete |
Disallow default bitwise copy construction.
|
virtual |
Destructor.
Definition at line 114 of file functionObject.C.
Referenced by functionObject::clone().
|
pure virtual |
Runtime type information.
Referenced by probes::classifyFields().
declareRunTimeSelectionTable | ( | autoPtr | , |
functionObject | , | ||
dictionary | , | ||
(const word &name, const Time &runTime, const dictionary &dict) | , | ||
(name, runTime, dict) | |||
) |
|
inline |
Return clone.
Definition at line 263 of file functionObject.H.
References functionObject::end(), functionObject::execute(), functionObject::functionObject(), mesh, functionObject::movePoints(), functionObject::name(), functionObject::New(), NotImplemented, functionObject::operator=(), functionObject::read(), functionObject::setTimeStep(), functionObject::timeToNextWrite(), functionObject::updateMesh(), functionObject::write(), and functionObject::~functionObject().
|
static |
Select from dictionary, based on its "type" entry.
Definition at line 54 of file functionObject.C.
References functionObject::debug, dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, dictionary::found(), Foam::Info, dictionary::lookup(), functionObject::name(), Foam::nl, and runTime.
Referenced by functionObject::clone(), functionObject::functionObject(), functionObjectList::read(), and codedFunctionObject::redirectFunctionObject().
const Foam::word & name | ( | ) | const |
Return the name of this functionObject.
Definition at line 120 of file functionObject.C.
Referenced by functionObject::clone(), forces::file(), functionObject::New(), surfaceFieldValue::outputDir(), patchInternalField::print(), sampledSurfaces::thresholdCellFaces::print(), isoSurface::print(), plane::print(), cuttingPlane::print(), distanceSurface::print(), patch::print(), and sampledSurfaces::triSurfaceMesh::print().
|
virtual |
Read and set the function object if its data have changed.
Reimplemented in surfaceFieldValue, forces, pressure, volFieldValue, fieldAverage, streamLine, regionSizeDistribution, sizeDistribution, sampledSets, turbulenceFields, phaseScalarTransport, probes, forceCoeffs, nearWallFields, sampledSurfaces, codedFunctionObject, fieldMinMax, wallHeatTransferCoeff, fieldValueDelta, writeObjects, histogram, interfaceHeight, wallShearStress, fieldValue, age, systemCall, icoUncoupledKinematicCloud, fieldCoordinateSystemTransform, wallHeatFlux, sixDoFRigidBodyControl, timeControl, surfaceInterpolate, readFields, patchProbes, phaseForces, sixDoFRigidBodyState, scalarTransport, regionFunctionObject, yPlus, cloudInfo, turbulenceIntensity, rigidBodyState, writeVTK, removeRegisteredObject, timeActivatedFileUpdate, residuals, time, abort, fieldsExpression, moleFractions< ThermoType >, processorField, writeDictionary, fieldExpression, CourantNo, specieReactionRates< ChemistryModelType >, setTimeStepFunctionObject, blendingFactor, scale, randomise, log, Qdot, and dsmcFields.
Definition at line 126 of file functionObject.C.
References functionObject::log, dictionary::lookupOrDefault(), and functionObject::postProcess.
Referenced by functionObject::clone(), time::read(), regionFunctionObject::read(), writeObjects::read(), and functionObjectList::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 forces, fieldAverage, streamLine, regionSizeDistribution, sizeDistribution, sampledSets, turbulenceFields, phaseScalarTransport, probes, forceCoeffs, nearWallFields, sampledSurfaces, fieldMinMax, wallHeatTransferCoeff, fieldValueDelta, codedFunctionObject, writeObjects, histogram, interfaceHeight, wallShearStress, fieldValue, age, systemCall, icoUncoupledKinematicCloud, fieldCoordinateSystemTransform, wallHeatFlux, sixDoFRigidBodyControl, surfaceInterpolate, readFields, phaseForces, sixDoFRigidBodyState, timeControl, scalarTransport, yPlus, cloudInfo, turbulenceIntensity, rigidBodyState, writeVTK, removeRegisteredObject, timeActivatedFileUpdate, residuals, time, abort, fieldsExpression, moleFractions< ThermoType >, processorField, writeDictionary, writeCellCentres, XiReactionRate, fieldExpression, writeCellVolumes, setTimeStepFunctionObject, specieReactionRates< ChemistryModelType >, Qdot, and dsmcFields.
Referenced by functionObject::clone().
|
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, forces, volFieldValue, fieldAverage, streamLine, regionSizeDistribution, sizeDistribution, sampledSets, turbulenceFields, phaseScalarTransport, probes, forceCoeffs, nearWallFields, sampledSurfaces, fieldMinMax, wallHeatTransferCoeff, fieldValueDelta, codedFunctionObject, writeObjects, histogram, interfaceHeight, wallShearStress, fieldValue, systemCall, age, icoUncoupledKinematicCloud, fieldCoordinateSystemTransform, wallHeatFlux, surfaceInterpolate, readFields, phaseForces, timeControl, patchProbes, sixDoFRigidBodyState, scalarTransport, yPlus, cloudInfo, turbulenceIntensity, rigidBodyState, writeVTK, removeRegisteredObject, timeActivatedFileUpdate, residuals, time, abort, fieldsExpression, moleFractions< ThermoType >, processorField, writeDictionary, writeCellCentres, XiReactionRate, fieldExpression, writeCellVolumes, setTimeStepFunctionObject, specieReactionRates< ChemistryModelType >, components, Qdot, and dsmcFields.
Referenced by functionObject::clone().
|
virtual |
Called when Time::run() determines that the time-loop exits.
By default it simply calls execute().
Reimplemented in codedFunctionObject, interfaceHeight, systemCall, timeControl, and abort.
Definition at line 137 of file functionObject.C.
Referenced by functionObject::clone().
|
virtual |
Called by Time::setDeltaT(). Allows the function object to override.
the time-step value. Returns whether or not the value was overridden.
Reimplemented in setTimeStepFunctionObject.
Definition at line 143 of file functionObject.C.
Referenced by functionObject::clone().
|
virtual |
Called by Time::adjustTimeStep(). Allows the function object to.
insert a write time earlier than that already in use by the run time. Returns the write time, or vGreat.
Reimplemented in timeControl.
Definition at line 149 of file functionObject.C.
Referenced by functionObject::clone().
|
virtual |
Update for changes of mesh.
Reimplemented in streamLine, sampledSets, probes, sampledSurfaces, and timeControl.
Definition at line 155 of file functionObject.C.
Referenced by functionObject::clone().
|
virtual |
Update for changes of mesh.
Reimplemented in streamLine, sampledSets, probes, sampledSurfaces, and timeControl.
Definition at line 159 of file functionObject.C.
Referenced by functionObject::clone().
|
delete |
Disallow default bitwise assignment.
Referenced by functionObject::clone().
|
static |
Definition at line 236 of file functionObject.H.
Referenced by arcUniform::arcUniform(), boundaryPoints::boundaryPoints(), boundaryRandom::boundaryRandom(), boxUniform::boxUniform(), circleRandom::circleRandom(), cuttingPlane::cuttingPlane(), cuttingPlane::expire(), distanceSurface::expire(), lineCell::lineCell(), lineCellFace::lineCellFace(), lineFace::lineFace(), lineUniform::lineUniform(), NamedEnum< directionType, 3 >::names(), functionObject::New(), plane::plane(), points::points(), sampledSets::sphereRandom::sphereRandom(), sampledSets::triSurfaceMeshSampledSet::triSurfaceMeshSampledSet(), plane::update(), cuttingPlane::update(), distanceSurface::update(), and patch::update().
|
static |
Global post-processing mode switch.
Definition at line 239 of file functionObject.H.
Referenced by functionObject::read().
Switch log |
Switch write log to Info.
Definition at line 242 of file functionObject.H.
Referenced by functionObject::read().