Specialization of Foam::functionObject for an Foam::fvMesh, providing a reference to the Foam::fvMesh. More...
#include <fvMeshFunctionObject.H>
Inherits regionFunctionObject.
Inherited by Probes< patchFieldProbe >, Probes< internalFieldProbe >, reactionsSensitivityAnalysis< BasicChemistryModel< psiReactionThermo > >, reactionsSensitivityAnalysis< BasicChemistryModel< rhoReactionThermo > >, specieReactionRates< BasicChemistryModel< psiReactionThermo > >, specieReactionRates< BasicChemistryModel< rhoReactionThermo > >, moleFractions< psiReactionThermo >, moleFractions< rhoReactionThermo >, Probes< ProbeType >, areaWrite, AMIWeights, BilgerMixtureFraction, Curle, DESModelRegions, DMD, ObukhovLength, XiReactionRate, age, binField, bladeForces, cellDecomposer, columnAverage, comfort, continuityError, dataCloud, ddt2, derivedFields, dsmcFields, electricPotential, energySpectrum, energyTransport, ensightCloudWriteObject, ensightWrite, extractEulerianParticles, fieldAverage, fieldExpression, fieldExtents, fieldMinMax, fieldStatistics, fieldValue, fieldsExpression, fluxSummary, forces, fvExpressionField, histogram, hydrostaticPressure, icoUncoupledKinematicCloud, interfaceHeight, limitFields, mapFields, momentum, momentumError, nearWallFields, particleDistribution, processorField, proudmanAcousticPower, radiometerProbes, reactionsSensitivityAnalysis< chemistryType >, readFields, regionSizeDistribution, resolutionIndex, runTimeControl, scalarTransport, setFlow, sixDoFRigidBodyState, sizeDistribution, solverInfo, specieReactionRates< ChemistryModelType >, streamLineBase, surfaceCourantNumber, surfaceDistance, surfaceInterpolate, turbulenceFields, viewFactorHeatFlux, vtkCloud, wallHeatFlux, wallShearStress, writeCellCentres, writeCellVolumes, writeFreeSurface, yPlus, zeroGradient, moleFractions< ThermoType >, sampledSets, and sampledSurfaces.
Public Member Functions | |
| TypeName ("fvMeshFunctionObject") | |
| Runtime type information. | |
| fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict) | |
| Construct from Time and dictionary. | |
| fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict) | |
| Construct from the region objectRegistry and dictionary. | |
| virtual | ~fvMeshFunctionObject ()=default |
| Destructor. | |
| Public Member Functions inherited from regionFunctionObject | |
| TypeName ("regionFunctionObject") | |
| Runtime type information. | |
| regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict) | |
| Construct from Time and dictionary. | |
| regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict) | |
| Construct from the region objectRegistry and dictionary. | |
| virtual | ~regionFunctionObject ()=default |
| Destructor. | |
| virtual bool | read (const dictionary &dict) |
| Read optional controls. | |
| template<class ObjectType> | |
| const ObjectType * | lookupObjectPtr (const word &fieldName) const |
| Deprecated(2018-10). | |
| template<class ObjectType> | |
| ObjectType * | lookupObjectRefPtr (const word &fieldName) const |
| Deprecated(2018-10). | |
| Public Member Functions inherited from stateFunctionObject | |
| stateFunctionObject (const word &name, const Time &runTime) | |
| Construct from components. | |
| virtual | ~stateFunctionObject ()=default |
| Destructor. | |
| dictionary & | propertyDict () |
| Return access to the property dictionary. | |
| bool | foundProperty (const word &entryName) const |
| Return true if the property exists. | |
| void | clearTrigger () |
| Remove the trigger index from the properties. | |
| label | getTrigger () const |
| Get the current trigger index. | |
| bool | setTrigger (const label triggeri) |
| Set new trigger index. | |
| bool | getDict (const word &entryName, dictionary &dict) const |
| Set dictionary, return true if set. | |
| bool | getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const |
| Set dictionary from named object, return true if set. | |
| template<class Type> | |
| Type | getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const |
| Retrieve generic property. | |
| template<class Type> | |
| bool | getProperty (const word &entryName, Type &value) const |
| Set generic property, return true if set. | |
| template<class Type> | |
| void | setProperty (const word &entryName, const Type &value) |
| Add generic property. | |
| template<class Type> | |
| Type | getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const |
| Retrieve generic property from named object. | |
| template<class Type> | |
| bool | getObjectProperty (const word &objectName, const word &entryName, Type &value) const |
| Set generic property from named object, return true if set. | |
| template<class Type> | |
| void | setObjectProperty (const word &objectName, const word &entryName, const Type &value) |
| Add generic property from named object. | |
| bool | getObjectResultDict (const word &objectName, dictionary &dict) const |
| template<class Type> | |
| void | setResult (const word &entryName, const Type &value) |
| Add result. | |
| template<class Type> | |
| void | setObjectResult (const word &objectName, const word &entryName, const Type &value) |
| Add result from named object. | |
| template<class Type> | |
| Type | getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const |
| Retrieve result. | |
| template<class Type> | |
| Type | getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const |
| Retrieve result from named object. | |
| template<class Type> | |
| bool | getObjectResult (const word &objectName, const word &entryName, Type &value) const |
| Set result from named object, return true if set. | |
| word | resultType (const word &entryName) const |
| Retrieve the result type. | |
| word | objectResultType (const word &objectName, const word &entryName) const |
| Return the type of result. | |
| wordList | objectResultEntries () const |
| Retrieve the result entries. | |
| wordList | objectResultEntries (const word &objectName) const |
| Return result entries for named object. | |
| void | writeResultEntries (Ostream &os) const |
| Write the results entries for all objects to stream. | |
| void | writeResultEntries (const word &objectName, Ostream &os) const |
| Write the results entries for named object to stream. | |
| void | writeAllResultEntries (Ostream &os) const |
| Write the results entries for all objects to stream. | |
| Public Member Functions inherited from timeFunctionObject | |
| timeFunctionObject (const word &name, const Time &runTime) | |
| Construct from Time. | |
| virtual | ~timeFunctionObject ()=default |
| Destructor. | |
| const Time & | time () const |
| Return time database. | |
| objectRegistry & | storedObjects () |
| Write access to the output objects ("functionObjectObjects") registered on Time. | |
| const objectRegistry & | storedObjects () const |
| Const access to the output objects ("functionObjectObjects") registered on Time. | |
| 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. | |
| autoPtr< functionObject > | clone () const |
| Return clone. | |
| virtual | ~functionObject ()=default |
| Destructor. | |
| virtual const word & | type () const =0 |
| Runtime type information. | |
| const word & | name () const noexcept |
| Return the name of this functionObject. | |
| bool | useNamePrefix () const noexcept |
| Return the flag for adding a scoping name prefix. | |
| bool | useNamePrefix (bool on) noexcept |
| Modify the flag for adding a scoping name prefix. | |
| virtual bool | execute ()=0 |
| Called at each ++ or += of the time-loop. | |
| virtual bool | execute (const label subIndex) |
| Execute using the specified subIndex. | |
| virtual bool | write ()=0 |
| Called at each ++ or += of the time-loop. | |
| virtual bool | end () |
| Called when Time::run() determines that the time-loop exits. | |
| virtual bool | adjustTimeStep () |
| Called at the end of Time::adjustDeltaT() if adjustTime is true. | |
| virtual bool | filesModified () const |
| Did any file get changed during execution? | |
| virtual void | updateMesh (const mapPolyMesh &mpm) |
| Update for changes of mesh. | |
| virtual void | movePoints (const polyMesh &mesh) |
| Update for changes of mesh. | |
Protected Member Functions | |
| fvMeshFunctionObject (const fvMeshFunctionObject &)=delete | |
| No copy construct. | |
| void | operator= (const fvMeshFunctionObject &)=delete |
| No copy assignment. | |
| Protected Member Functions inherited from regionFunctionObject | |
| virtual const objectRegistry & | obr () const |
| The region or sub-region registry being used. | |
| template<class ObjectType> | |
| bool | foundObject (const word &fieldName) const |
| Find object (eg, a field) in the (sub) objectRegistry. | |
| template<class ObjectType> | |
| const ObjectType * | cfindObject (const word &fieldName) const |
| Return const pointer to the object (eg, a field) in the (sub) objectRegistry. | |
| template<class ObjectType> | |
| const ObjectType * | findObject (const word &fieldName) const |
| Return const pointer to the object (eg, a field) in the (sub) objectRegistry. | |
| template<class ObjectType> | |
| ObjectType * | findObject (const word &fieldName) |
| Return non-const pointer to the object of the given Type, (sub) objectRegistry. | |
| 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. | |
| template<class ObjectType> | |
| const ObjectType & | lookupObject (const word &fieldName) const |
| Lookup and return object (eg, a field) from the (sub) objectRegistry. | |
| template<class ObjectType> | |
| ObjectType & | lookupObjectRef (const word &fieldName) const |
| Lookup and return object (eg, a field) from the (sub) objectRegistry. | |
| 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. | |
| 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. | |
| bool | writeObject (const word &fieldName) |
| Write field if present in the (sub) objectRegistry. | |
| bool | clearObject (const word &fieldName) |
| Clear field from the (sub) objectRegistry if present. | |
| void | clearObjects (const wordList &objNames) |
| Clear fields from the (sub) objectRegistry if present. | |
| regionFunctionObject (const regionFunctionObject &)=delete | |
| No copy construct. | |
| void | operator= (const regionFunctionObject &)=delete |
| No copy assignment. | |
| Protected Member Functions inherited from stateFunctionObject | |
| const functionObjects::properties & | stateDict () const |
| Return a const reference to the state dictionary. | |
| functionObjects::properties & | stateDict () |
| Return non-const access to the state dictionary. | |
| stateFunctionObject (const stateFunctionObject &)=delete | |
| No copy construct. | |
| void | operator= (const stateFunctionObject &)=delete |
| No copy assignment. | |
| Protected Member Functions inherited from timeFunctionObject | |
| void | clearOutputObjects (const wordList &objNames) |
| Remove specified items from "functionObjectObjects". | |
| timeFunctionObject (const timeFunctionObject &)=delete | |
| No copy construct. | |
| void | operator= (const timeFunctionObject &)=delete |
| No copy assignment. | |
| Protected Member Functions inherited from functionObject | |
| word | scopedName (const word &name) const |
| Return a scoped (prefixed) name. | |
Protected Attributes | |
| const fvMesh & | mesh_ |
| Reference to the fvMesh. | |
| Protected Attributes inherited from regionFunctionObject | |
| word | subRegistryName_ |
| Name for alternative object registry. | |
| const objectRegistry & | obr_ |
| Reference to the region objectRegistry. | |
| const objectRegistry * | obrPtr_ |
| Pointer to alternative (eg, sub-region) objectRegistry. | |
| Protected Attributes inherited from timeFunctionObject | |
| const Time & | time_ |
| Reference to the time database. | |
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. | |
| Public Attributes inherited from functionObject | |
| bool | log |
| Flag to write log into Info. | |
| Static Public Attributes inherited from functionObject | |
| static int | debug |
| Flag to execute debug content. | |
| static bool | postProcess |
| Global post-processing mode switch. | |
| static bool | defaultUseNamePrefix |
| Global default for useNamePrefix. | |
| static word | outputPrefix |
| Directory prefix. | |
Specialization 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 60 of file fvMeshFunctionObject.H.
|
protecteddelete |
No copy construct.
References fvMeshFunctionObject().
Referenced by age::age(), AMIWeights::AMIWeights(), BilgerMixtureFraction::BilgerMixtureFraction(), binField::binField(), binField::binField(), cellDecomposer::cellDecomposer(), columnAverage::columnAverage(), comfort::comfort(), continuityError::continuityError(), Curle::Curle(), dataCloud::dataCloud(), ddt2::ddt2(), derivedFields::derivedFields(), DESModelRegions::DESModelRegions(), DMD::DMD(), dsmcFields::dsmcFields(), electricPotential::electricPotential(), energySpectrum::energySpectrum(), energyTransport::energyTransport(), extractEulerianParticles::extractEulerianParticles(), fieldAverage::fieldAverage(), fieldExpression::fieldExpression(), fieldExtents::fieldExtents(), fieldMinMax::fieldMinMax(), fieldsExpression::fieldsExpression(), fieldValue::fieldValue(), fieldValue::fieldValue(), fluxSummary::fluxSummary(), forces::forces(), forces::forces(), fvExpressionField::fvExpressionField(), fvMeshFunctionObject(), histogram::histogram(), hydrostaticPressure::hydrostaticPressure(), icoUncoupledKinematicCloud::icoUncoupledKinematicCloud(), interfaceHeight::interfaceHeight(), limitFields::limitFields(), mapFields::mapFields(), moleFractions< ThermoType >::moleFractions(), momentum::momentum(), momentum::momentum(), momentumError::momentumError(), nearWallFields::nearWallFields(), ObukhovLength::ObukhovLength(), operator=(), particleDistribution::particleDistribution(), Probes< ProbeType >::Probes(), processorField::processorField(), proudmanAcousticPower::proudmanAcousticPower(), radiometerProbes::radiometerProbes(), reactionsSensitivityAnalysis< chemistryType >::reactionsSensitivityAnalysis(), readFields::readFields(), regionSizeDistribution::regionSizeDistribution(), resolutionIndex::resolutionIndex(), runTimeControl::runTimeControl(), sampledSets::sampledSets(), sampledSets::sampledSets(), sampledSurfaces::sampledSurfaces(), sampledSurfaces::sampledSurfaces(), scalarTransport::scalarTransport(), setFlow::setFlow(), sixDoFRigidBodyState::sixDoFRigidBodyState(), sizeDistribution::sizeDistribution(), solverInfo::solverInfo(), specieReactionRates< ChemistryModelType >::specieReactionRates(), streamLineBase::streamLineBase(), streamLineBase::streamLineBase(), surfaceCourantNumber::surfaceCourantNumber(), surfaceDistance::surfaceDistance(), surfaceInterpolate::surfaceInterpolate(), turbulenceFields::turbulenceFields(), viewFactorHeatFlux::viewFactorHeatFlux(), viewFactorHeatFlux::viewFactorHeatFlux(), wallShearStress::wallShearStress(), writeCellCentres::writeCellCentres(), writeCellVolumes::writeCellVolumes(), writeFreeSurface::writeFreeSurface(), XiReactionRate::XiReactionRate(), yPlus::yPlus(), and zeroGradient::zeroGradient().
| fvMeshFunctionObject | ( | const word & | name, |
| const Time & | runTime, | ||
| const dictionary & | dict ) |
Construct from Time and dictionary.
Definition at line 38 of file fvMeshFunctionObject.C.
References dict, mesh_, functionObject::name(), regionFunctionObject::obr_, Foam::refCast(), regionFunctionObject::regionFunctionObject(), and runTime.
| fvMeshFunctionObject | ( | const word & | name, |
| const objectRegistry & | obr, | ||
| const dictionary & | dict ) |
Construct from the region objectRegistry and dictionary.
Definition at line 50 of file fvMeshFunctionObject.C.
References dict, mesh_, functionObject::name(), regionFunctionObject::obr(), regionFunctionObject::obr_, Foam::refCast(), and regionFunctionObject::regionFunctionObject().
|
virtualdefault |
Destructor.
|
protecteddelete |
| TypeName | ( | "fvMeshFunctionObject" | ) |
Runtime type information.
References dict, functionObject::name(), regionFunctionObject::obr(), and runTime.
|
protected |
Reference to the fvMesh.
Definition at line 71 of file fvMeshFunctionObject.H.
Referenced by extractEulerianParticles::accumulateParticleInfo(), AMIWeights::AMIWeights(), BilgerMixtureFraction::BilgerMixtureFraction(), blendingFactor::blendingFactor(), heatTransferCoeff::calc(), nearWallFields::calcAddressing(), fieldExtents::calcFieldExtents(), forces::calcForcesMoments(), fieldMinMax::calcMinMaxFieldType(), momentumError::calcMomentError(), norm::calcNormType(), ObukhovLength::calcOL(), wallShearStress::calcShearStress(), hydrostaticPressure::calculateAndWrite(), extractEulerianParticles::checkFaceZone(), extractEulerianParticles::collectParticle(), columnAverage::columnAverage(), continuityError::continuityError(), solverInfo::createResidualField(), Curle::Curle(), thermoCoupleProbes::derivatives(), DESModelRegions::DESModelRegions(), DMD::DMD(), electricPotential::electricPotential(), DMD::end(), energySpectrum::energySpectrum(), energyTransport::energyTransport(), age::execute(), cellDecomposer::execute(), comfort::execute(), Curle::execute(), ddt2::execute(), derivedFields::execute(), DESModelRegions::execute(), energyTransport::execute(), extractEulerianParticles::execute(), mapFields::execute(), processorField::execute(), proudmanAcousticPower::execute(), readFields::execute(), scalarTransport::execute(), setFlow::execute(), surfaceDistance::execute(), thermoCoupleProbes::execute(), turbulenceFields::execute(), wallShearStress::execute(), yPlus::execute(), zeroGradient::execute(), extractEulerianParticles::extractEulerianParticles(), extractEulerianParticles::faceValue(), fieldExtents::fieldExtents(), fieldMinMax::fieldMinMax(), norm::fieldNorm(), norm::fieldNorm(), norm::fieldNorm(), wallBoundedStreamLine::findNearestTet(), forces::force(), forceCoeffs::forceCoeff(), forces::forces(), forces::forces(), fvMeshFunctionObject(), fvMeshFunctionObject(), Probes< patchFieldProbe >::getOrLoadField(), sampledSets::getOrLoadField(), heatTransferCoeff::heatTransferCoeff(), hydrostaticPressure::hydrostaticPressure(), icoUncoupledKinematicCloud::icoUncoupledKinematicCloud(), extractEulerianParticles::initialiseBins(), fluxSummary::initialiseCellZoneAndDirection(), fluxSummary::initialiseFaceZone(), fluxSummary::initialiseFaceZoneAndDirection(), solverInfo::initialiseResidualField(), streamLineBase::initInterpolations(), limitFields::limitFields(), fvExpressionField::loadAndStore(), readFields::loadAndStore(), fvExpressionField::loadFields(), moleFractions< ThermoType >::moleFractions(), forces::moment(), forceCoeffs::momentCoeff(), momentum::momentum(), momentum::momentum(), momentumError::momentumError(), derivedFields::movePoints(), ObukhovLength::movePoints(), sampledSets::movePoints(), sampledSurfaces::movePoints(), multiphaseInterHtcModel::multiphaseInterHtcModel(), momentum::newField(), fvExpressionField::performAction(), extractEulerianParticles::phiU(), hydrostaticPressure::pRef(), Probes< ProbeType >::prepare(), Probes< ProbeType >::Probes(), processorField::processorField(), proudmanAcousticPower::proudmanAcousticPower(), radiometerProbes::radiometerProbes(), randomise::randomise(), reactingEulerHtcModel::reactingEulerHtcModel(), reactionsSensitivityAnalysis< chemistryType >::reactionsSensitivityAnalysis(), age::read(), AMIWeights::read(), BilgerMixtureFraction::read(), binField::read(), columnAverage::read(), Curle::read(), ddt2::read(), electricPotential::read(), energySpectrum::read(), fieldExpression::read(), fieldExtents::read(), forces::read(), fvExpressionField::read(), histogram::read(), mapFields::read(), momentumError::read(), nearWallFields::read(), norm::read(), propellerInfo::read(), resolutionIndex::read(), setFlow::read(), surfaceCourantNumber::read(), surfaceDistance::read(), wallBoundedStreamLine::read(), wallShearStress::read(), sampledSurfaces::read(), derivedFields::removeDerivedFields(), ObukhovLength::removeObukhovLength(), AMIWeights::reportPatch(), forces::rho(), forces::rho(), streamLineBase::sampledSetPoints(), sampledSets::sampledSets(), sampledSets::sampledSets(), scalarTransport::scalarTransport(), extractEulerianParticles::setBlockedFaces(), propellerInfo::setCoordinateSystem(), propellerInfo::setRotationalSpeed(), sixDoFRigidBodyState::sixDoFRigidBodyState(), solverInfo::solverInfo(), specieReactionRates< ChemistryModelType >::specieReactionRates(), stabilityBlendingFactor::stabilityBlendingFactor(), streamFunction::streamFunction(), surfaceCourantNumber::surfaceCourantNumber(), surfaceDistance::surfaceDistance(), thermoCoupleProbes::thermoCoupleProbes(), fluxSummary::totalArea(), streamLine::track(), wallBoundedStreamLine::track(), propellerInfo::U(), derivedFields::updateMesh(), ObukhovLength::updateMesh(), processorField::updateMesh(), streamLineBase::updateMesh(), sampledSets::updateMesh(), sampledSurfaces::updateMesh(), propellerInfo::updateSampleDiskCells(), solverInfo::updateSolverInfo(), viewFactorHeatFlux::viewFactorHeatFlux(), viewFactorHeatFlux::viewFactorHeatFlux(), volFieldValue::volFieldValue(), volFieldValue::volFieldValue(), streamLineBase::wallPatch(), wallShearStress::wallShearStress(), AMIWeights::write(), continuityError::write(), dataCloud::write(), derivedFields::write(), dsmcFields::write(), energySpectrum::write(), volFieldValue::write(), momentum::write(), ObukhovLength::write(), particleDistribution::write(), processorField::write(), proudmanAcousticPower::write(), radiometerProbes::write(), regionSizeDistribution::write(), setFlow::write(), solverInfo::write(), specieReactionRates< ChemistryModelType >::write(), surfaceDistance::write(), viewFactorHeatFlux::write(), wallShearStress::write(), writeCellCentres::write(), writeCellVolumes::write(), XiReactionRate::write(), yPlus::write(), fieldExtents::writeFileHeader(), solverInfo::writeFileHeader(), streamLineBase::writeToFile(), AMIWeights::writeWeightField(), and yPlus::yPlus().
1.16.1 
