IOobject Class Reference

IOobject defines the attributes of an object for which implicit objectRegistry management is supported, and provides the infrastructure for performing stream I/O. More...

Inheritance diagram for IOobject:
Collaboration diagram for IOobject:

Public Types

enum  objectState { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
enum  fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Enumeration defining the file checking options. More...
 

Public Member Functions

 TypeName ("IOobject")
 Runtime type information. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Construct from copy resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Construct from copy resetting name. More...
 
 IOobject (const IOobject &io)=default
 Copy constructor. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
wordheaderClassName ()
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () const
 Return the optional note. More...
 
virtual void rename (const word &newName)
 Rename. More...
 
boolregisterObject ()
 Register object created from this IOobject with registry if true. More...
 
bool registerObject () const
 Register object created from this IOobject with registry if true. More...
 
readOption readOpt () const
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
word modelName (const char *name) const
 Return the name of the object within this model. More...
 
const fileNamerootPath () const
 
const fileNamecaseName (const bool global) const
 
fileNameinstance () const
 Return the instance directory, constant, system, <time> etc. More...
 
void updateInstance () const
 If the instance is a time directory update to the current time. More...
 
const fileNamelocal () const
 
fileName path (const bool global) const
 Return complete path including the processor sub-directory. More...
 
fileName objectPath (const bool global) const
 Return complete path + object name including the processor. More...
 
fileName relativePath () const
 Return the path relative to the case directory. More...
 
fileName relativeObjectPath () const
 Return complete relativePath + object name. More...
 
fileName filePath (const word &typeName, const bool global) const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read header of local object without type-checking. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &) const
 Write header. More...
 
bool writeHeader (Ostream &, const word &objectType) const
 Write header. Allow override of type. More...
 
bool good () const
 
bool bad () const
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 
template<class Name >
Foam::word modelName (Name name, const word &model)
 

Static Public Member Functions

static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class Name >
static word groupName (Name name, const word &group)
 
static word group (const word &name)
 Return group (extension part of name) More...
 
static word member (const word &name)
 Return member (name without the extension) More...
 
template<class Name >
static word modelName (Name name, const word &model)
 Return the name of the object within the given model. More...
 
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider. More...
 
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider. More...
 

Static Public Attributes

static constexpr const char * foamFile = "FoamFile"
 Keyword for the FoamFile header sub-dictionary. More...
 
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 

Protected Member Functions

void setBad (const string &)
 Set the object state to bad. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType)
 Read header using typeGlobalFile to find file. More...
 

Detailed Description

IOobject defines the attributes of an object for which implicit objectRegistry management is supported, and provides the infrastructure for performing stream I/O.

An IOobject is constructed with an object name, a class name, an instance path, a reference to a objectRegistry, and parameters determining its storage status.

Read options

Define what is done on object construction and explicit reads:

  • MUST_READ
    Object must be read from Istream on construction.
    Error if Istream does not exist or can't be read. Does not check timestamp or re-read.
  • MUST_READ_IF_MODIFIED
    Object must be read from Istream on construction.
    Error if Istream does not exist or can't be read. If object is registered its timestamp will be checked every timestep and possibly re-read.
  • READ_IF_PRESENT
    Read object from Istream if Istream exists, otherwise don't.
    Error only if Istream exists but can't be read. Does not check timestamp or re-read.
  • NO_READ
    Don't read
    Write options
    Define what is done on object destruction and explicit writes:
  • AUTO_WRITE
    Object is written automatically when requested to by the objectRegistry.
  • NO_WRITE
    No automatic write on destruction but can be written explicitly

Definition at line 98 of file IOobject.H.

Member Enumeration Documentation

◆ objectState

Enumeration defining the valid states of an IOobject.

Enumerator
GOOD 
BAD 

Definition at line 109 of file IOobject.H.

◆ readOption

enum readOption

Enumeration defining the read options.

Enumerator
MUST_READ 
MUST_READ_IF_MODIFIED 
READ_IF_PRESENT 
NO_READ 

Definition at line 116 of file IOobject.H.

◆ writeOption

Enumeration defining the write options.

Enumerator
AUTO_WRITE 
NO_WRITE 

Definition at line 125 of file IOobject.H.

◆ fileCheckTypes

Enumeration defining the file checking options.

Enumerator
timeStamp 
timeStampMaster 
inotify 
inotifyMaster 

Definition at line 132 of file IOobject.H.

Constructor & Destructor Documentation

◆ IOobject() [1/6]

IOobject ( const word name,
const fileName instance,
const objectRegistry registry,
readOption  r = NO_READ,
writeOption  w = NO_WRITE,
bool  registerObject = true 
)

Construct from name, instance, registry, io options.

Definition at line 167 of file IOobject.C.

References Foam::endl(), and InfoInFunction.

Referenced by IOobject::clone(), IOobject::IOobject(), IOobject::member(), fvMesh::V(), and fvMesh::V00().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ IOobject() [2/6]

IOobject ( const word name,
const fileName instance,
const fileName local,
const objectRegistry registry,
readOption  r = NO_READ,
writeOption  w = NO_WRITE,
bool  registerObject = true 
)

Construct from name, instance, local, registry, io options.

Definition at line 198 of file IOobject.C.

References Foam::endl(), InfoInFunction, and IOobject::IOobject().

Here is the call graph for this function:

◆ IOobject() [3/6]

IOobject ( const fileName path,
const objectRegistry registry,
readOption  r = NO_READ,
writeOption  w = NO_WRITE,
bool  registerObject = true 
)

Construct from path, registry, io options.

Uses fileNameComponents() to split path into components.

Definition at line 230 of file IOobject.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, InfoInFunction, and IOobject::IOobject().

Here is the call graph for this function:

◆ IOobject() [4/6]

IOobject ( const IOobject io,
const objectRegistry registry 
)

Construct from copy resetting registry.

Definition at line 267 of file IOobject.C.

References IOobject::IOobject().

Here is the call graph for this function:

◆ IOobject() [5/6]

IOobject ( const IOobject io,
const word name 
)

Construct from copy resetting name.

Definition at line 286 of file IOobject.C.

◆ IOobject() [6/6]

IOobject ( const IOobject io)
default

Copy constructor.

◆ ~IOobject()

~IOobject ( )
virtual

Destructor.

Definition at line 306 of file IOobject.C.

Referenced by IOobject::clone().

Here is the caller graph for this function:

Member Function Documentation

◆ setBad()

void setBad ( const string s)
protected

Set the object state to bad.

Definition at line 416 of file IOobject.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, InfoInFunction, and messageStream::level.

Here is the call graph for this function:

◆ typeHeaderOk()

bool typeHeaderOk ( const bool  checkType)
protected

Read header using typeGlobalFile to find file.

and optionally check the headerClassName against Type

Definition at line 35 of file IOobjectTemplates.C.

References Foam::endl(), Foam::fileHandler(), IOobject::fileModificationChecking, IOobject::filePath(), IOobject::inotifyMaster, UPstream::master(), fileOperation::readHeader(), Pstream::scatter(), IOobject::timeStampMaster, and WarningInFunction.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "IOobject"  )

Runtime type information.

◆ fileNameComponents()

bool fileNameComponents ( const fileName path,
fileName instance,
fileName local,
word name 
)
static

Split path into instance, local, name components.

input IOobject(instance, local, name) ----- ------ "foo" ("", "", "foo") "foo/bar" ("foo", "", "bar") "/XXX/bar" ("/XXX", "", "bar") "foo/bar/" ERROR - no name "foo/xxx/bar" ("foo", "xxx", "bar") "foo/xxx/yyy/bar" ("foo", "xxx/yyy", "bar")

Definition at line 64 of file IOobject.C.

References Foam::endl(), Foam::first(), fileName::isAbsolute(), Foam::isDir(), Foam::name(), and WarningInFunction.

Referenced by NamedEnum< compressibleField, 8 >::names().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ groupName() [1/2]

static word groupName ( Name  name,
const word group 
)
inlinestatic

Referenced by buoyancyEnergy::addSupFields(), solidEquilibriumEnergySource::addSupFields(), forces::alpha(), basicCombustionMixture::basicCombustionMixture(), basicSpecieMixture::basicSpecieMixture(), nutkFilmWallFunctionFvPatchScalarField::calcUTau(), nutUSpaldingWallFunctionFvPatchScalarField::calcUTau(), limitTemperature::constrain(), fixedTemperatureConstraint::constrain(), limitTemperature::constrainedFields(), fixedTemperatureConstraint::constrainedFields(), powerLaw::correct(), DarcyForchheimer::correct(), Maxwell< BasicMomentumTransportModel >::correct(), solidification::correct(), phaseStabilisedSnGrad< Type >::correction(), basicSpecieMixture::correctMassFractions(), mixtureKEpsilon< BasicMomentumTransportModel >::correctNut(), Maxwell< BasicMomentumTransportModel >::devTau(), forces::devTau(), LESeddyViscosity< BasicMomentumTransportModel >::epsilon(), kEqn< BasicMomentumTransportModel >::epsilon(), DeardorffDiffStress< BasicMomentumTransportModel >::epsilon(), WALE< BasicMomentumTransportModel >::epsilon(), dynamicKEqn< BasicMomentumTransportModel >::epsilon(), Qdot::execute(), shearStress::execute(), totalEnthalpy::execute(), yPlus::execute(), wallHeatFlux::execute(), wallShearStress::execute(), turbulenceFields::execute(), physicalProperties::findModelDict(), kOmegaSSTLM< BasicMomentumTransportModel >::Flength(), kOmegaSSTLM< BasicMomentumTransportModel >::Fonset(), kOmegaSSTLM< BasicMomentumTransportModel >::Fthetat(), unityLewisFourier< laminarThermophysicalTransportModel >::j(), MaxwellStefan< unityLewisFourier< laminarThermophysicalTransportModel > >::j(), unityLewisEddyDiffusivity< TurbulenceThermophysicalTransportModel >::j(), WALE< BasicMomentumTransportModel >::k(), Smagorinsky< BasicMomentumTransportModel >::k(), continuousGasKEqn< BasicMomentumTransportModel >::liquidTurbulence(), continuousGasKEpsilon< BasicMomentumTransportModel >::liquidTurbulence(), Maxwell< BasicMomentumTransportModel >::Maxwell(), polyBoundaryMesh::mesh(), momentumTransportModel::momentumTransportModel(), forces::mu(), basicSpecieMixture::normalise(), strainRateFunction::nu(), Stokes< BasicMomentumTransportModel >::nuEff(), generalisedNewtonian< BasicMomentumTransportModel >::nuEff(), continuousGasKEpsilon< BasicMomentumTransportModel >::nuEff(), Maxwell< BasicMomentumTransportModel >::nuEff(), lambdaThixotropic< BasicMomentumTransportModel >::nuEff(), LESModel< BasicMomentumTransportModel >::nuEff(), RASModel< phaseCompressible::momentumTransportModel >::nuEff(), nutkWallFunctionFvPatchScalarField::nut(), nutUWallFunctionFvPatchScalarField::nut(), nutkFilmWallFunctionFvPatchScalarField::nut(), nutUSpaldingWallFunctionFvPatchScalarField::nut(), nutURoughWallFunctionFvPatchScalarField::nut(), nutkAtmRoughWallFunctionFvPatchScalarField::nut(), nutkRoughWallFunctionFvPatchScalarField::nut(), LESeddyViscosity< BasicMomentumTransportModel >::omega(), DeardorffDiffStress< BasicMomentumTransportModel >::omega(), basicThermo::phasePropertyName(), physicalProperties::physicalProperties(), phaseIncompressibleMomentumTransportModel::pPrime(), phaseCompressibleMomentumTransportModel::pPrime(), phaseIncompressibleMomentumTransportModel::pPrimef(), phaseCompressibleMomentumTransportModel::pPrimef(), phaseSurfaceArrheniusReactionRate::preEvaluate(), Fourier< BasicThermophysicalTransportModel >::q(), Fickian< unityLewisFourier< laminarThermophysicalTransportModel > >::q(), unityLewisFourier< laminarThermophysicalTransportModel >::q(), nonUnityLewisEddyDiffusivity< TurbulenceThermophysicalTransportModel >::q(), eddyDiffusivity< TurbulenceThermophysicalTransportModel >::q(), MaxwellStefan< unityLewisFourier< laminarThermophysicalTransportModel > >::q(), unityLewisEddyDiffusivity< TurbulenceThermophysicalTransportModel >::q(), Qdot::Qdot(), SmagorinskyZhang< BasicMomentumTransportModel >::read(), NicenoKEqn< BasicMomentumTransportModel >::read(), LaheyKEpsilon< BasicMomentumTransportModel >::read(), yPlus::read(), phaseScalarTransport::read(), turbulenceFields::read(), forces::read(), momentumTransportModel::readModelDict(), kOmegaSSTLM< BasicMomentumTransportModel >::ReThetac(), kOmegaSSTLM< BasicMomentumTransportModel >::ReThetat0(), continuousGasKEpsilon< BasicMomentumTransportModel >::rhoEff(), scalarTransport::scalarTransport(), shearStress::shearStress(), continuousGasKEpsilon< BasicMomentumTransportModel >::sigma(), MPLIC::surfaceAlpha(), surfaceFilm::surfaceFilm(), totalEnthalpy::totalEnthalpy(), externalCoupledTemperatureMixedFvPatchScalarField::transferData(), fixedShearStressFvPatchVectorField::updateCoeffs(), fWallFunctionFvPatchScalarField::updateCoeffs(), v2WallFunctionFvPatchScalarField::updateCoeffs(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), alphatWallFunctionFvPatchScalarField::updateCoeffs(), convectiveHeatTransferFvPatchScalarField::updateCoeffs(), alphatJayatillekeWallFunctionFvPatchScalarField::updateCoeffs(), alphatFilmWallFunctionFvPatchScalarField::updateCoeffs(), turbulentMixingLengthFrequencyInletFvPatchScalarField::updateCoeffs(), turbulentMixingLengthDissipationRateInletFvPatchScalarField::updateCoeffs(), epsilonWallFunctionFvPatchScalarField::updateCoeffs(), thermalBaffle1DFvPatchScalarField< solidType >::updateCoeffs(), porousBafflePressureFvPatchField< Type >::updateCoeffs(), omegaWallFunctionFvPatchScalarField::updateCoeffs(), wallHeatFlux::wallHeatFlux(), wallShearStress::wallShearStress(), yPlus::write(), wallHeatFlux::write(), wallShearStress::write(), turbulenceFields::write(), nutUWallFunctionFvPatchScalarField::yPlus(), nutURoughWallFunctionFvPatchScalarField::yPlus(), nutkWallFunctionFvPatchScalarField::yPlus(), nutLowReWallFunctionFvPatchScalarField::yPlus(), nutkFilmWallFunctionFvPatchScalarField::yPlus(), and nutUSpaldingWallFunctionFvPatchScalarField::yPlus().

◆ group() [1/2]

◆ member() [1/2]

Foam::word member ( const word name)
static

Return member (name without the extension)

Definition at line 149 of file IOobject.C.

References IOobject::IOobject(), and Foam::name().

Referenced by laminar::R(), singleStepCombustion::R(), EDC::R(), and Foam::surfaceToVolVelocity().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ modelName() [1/3]

◆ clone() [1/2]

◆ clone() [2/2]

autoPtr<IOobject> clone ( const objectRegistry registry) const
inline

Clone resetting registry.

Definition at line 294 of file IOobject.H.

References IOobject::db(), IOobject::IOobject(), IOobject::time(), and IOobject::~IOobject().

Here is the call graph for this function:

◆ time()

const Foam::Time & time ( ) const

Return time.

Definition at line 318 of file IOobject.C.

References objectRegistry::time().

Referenced by regIOobject::addWatch(), searchableSurface::clone(), IOobject::clone(), dynamicMeshPointInterpolator::curPointField(), masterUncollatedFileOperation::exists(), masterUncollatedFileOperation::filePath(), masterUncollatedFileOperation::filePathInfo(), fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), fvMeshSubset::interpolate(), Foam::fvm::laplacian(), odeChemistryModel::logFile(), Foam::MapGeometricFields(), Foam::MeshToMeshMapVolFields(), NamedEnum< compressibleField, 8 >::names(), laminarFlameSpeed::New(), twoPhaseChangeModel::New(), SRFModel::New(), radiationModel::New(), collatedFileOperation::objectPath(), isNotEqOp< T >::operator()(), RaviPetersen::operator()(), continuousGasKEqn< BasicMomentumTransportModel >::phaseTransferCoeff(), continuousGasKEpsilon< BasicMomentumTransportModel >::phaseTransferCoeff(), NicenoKEqn< BasicMomentumTransportModel >::phaseTransferCoeff(), LaheyKEpsilon< BasicMomentumTransportModel >::phaseTransferCoeff(), fileOperation::processorsCasePath(), masterUncollatedFileOperation::read(), masterUncollatedFileOperation::relativeObjectPath(), subCycleField< GeometricField >::time(), plenumPressureFvPatchScalarField::updateCoeffs(), regIOobject::write(), meshRefinement::write(), collatedFileOperation::writeObject(), and masterUncollatedFileOperation::writeObject().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ db()

const Foam::objectRegistry & db ( ) const

Return the local objectRegistry.

Definition at line 312 of file IOobject.C.

Referenced by refinementHistory::add(), pointMesh::addPatch(), refinementHistory::apply(), regIOobject::checkIn(), regIOobject::checkOut(), IOobject::clone(), phaseStabilisedSnGrad< Type >::correction(), mixtureKEpsilon< BasicMomentumTransportModel >::correctNut(), refinementHistory::distribute(), masterUncollatedFileOperation::filePathInfo(), hexRef8Data::hexRef8Data(), InjectionModel< CloudType >::inject(), volPointInterpolation::interpolate(), volPointInterpolation::interpolateUnconstrained(), PhiScheme< Type, PhiLimiter >::limiter(), continuousGasKEqn< BasicMomentumTransportModel >::liquidTurbulence(), continuousGasKEpsilon< BasicMomentumTransportModel >::liquidTurbulence(), SchnerrSauer::mDotAlphal(), SchnerrSauer::mDotP(), NamedEnum< compressibleField, 8 >::names(), momentumTransportModel::New(), laminarFlameSpeed::New(), twoPhaseChangeModel::New(), laminarModel< BasicMomentumTransportModel >::New(), SRFModel::New(), RASModel< phaseCompressible::momentumTransportModel >::New(), LESModel< BasicMomentumTransportModel >::New(), DimensionedField< Type, Foam::pointMesh >::New(), RaviPetersen::operator()(), fileOperation::processorsPath(), SmagorinskyZhang< BasicMomentumTransportModel >::read(), NicenoKEqn< BasicMomentumTransportModel >::read(), LaheyKEpsilon< BasicMomentumTransportModel >::read(), Foam::readFields(), Foam::readUniformFields(), refinementHistory::refinementHistory(), masterUncollatedFileOperation::relativeObjectPath(), surfMesh::removeFiles(), pointMesh::reorderPatches(), searchableSurfaceCollection::searchableSurfaceCollection(), searchableSurfaceWithGaps::searchableSurfaceWithGaps(), motionSmootherAlgo::setDisplacement(), regIOobject::setUpToDate(), surfMesh::surfMesh(), hexRef8Data::sync(), waveSuperposition::waveSuperposition(), IOobject::writeHeader(), FSD::~FSD(), and regIOobject::~regIOobject().

Here is the caller graph for this function:

◆ name()

const word& name ( ) const
inline

Return name.

Definition at line 315 of file IOobject.H.

Referenced by multivariateSurfaceInterpolationScheme< Type >::fieldTable::add(), IOobjectList::add(), snappyLayerDriver::addLayers(), polyTopoChange::addMesh(), meshObject::addPatch(), faceZoneSet::addSet(), surfaceFilm::addSup(), solidEquilibriumEnergySource::addSup(), clouds::addSup(), solidificationMeltingSource::addSup(), radiation::addSupFields(), buoyancyEnergy::addSupFields(), heatSource::addSupFields(), solidEquilibriumEnergySource::addSupFields(), heatTransfer::addSupFields(), interRegionHeatTransfer::addSupFields(), clouds::addSupFields(), effectivenessHeatExchangerSource::addSupFields(), solidificationMeltingSource::addSupFields(), ParcelCloudBase< ParticleType >::ap(), collatedFileOperation::appendObject(), setsToFaceZone::applyToSet(), Foam::atan2(), attachPolyTopoChanger::attach(), Foam::fvc::average(), motionSmootherAlgo::avg(), writeFile::baseFileDir(), blended< Type >::blendingFactor(), localBlended< Type >::blendingFactor(), CoBlended< Type >::blendingFactor(), cellCoBlended< Type >::blendingFactor(), Foam::bound(), faceLimitedGrad< Type >::calcGrad(), interpolationCellPointWallModified< Type >::calcPointField(), meshRefinement::checkCoupledFaceZones(), polyBoundaryMesh::checkDefinition(), Cloud< passiveParticle >::checkFieldFieldIOobject(), Cloud< passiveParticle >::checkFieldIOobject(), regIOobject::checkIn(), objectRegistry::checkIn(), Foam::checkMethod(), objectRegistry::checkOut(), polyBoundaryMesh::checkParallelSync(), faceZone::checkParallelSync(), meshRefinement::checkZoneFaces(), meshObject::clear(), meshObject::clearUpto(), MomentumCloud< Foam::DSMCCloud >::cloneBare(), Foam::cmptAv(), fvConstraints::constrain(), limitTemperature::constrainedFields(), fixedTemperatureConstraint::constrainedFields(), vtkPVFoam::convertVolInternalField(), Foam::MULES::correct(), Maxwell< BasicMomentumTransportModel >::correct(), Foam::correctContactAngle(), linearUpwind< Type >::correction(), cubic< Type >::correction(), linearUpwindV< Type >::correction(), correctedSnGrad< Type >::correction(), faceCorrectedSnGrad< Type >::correction(), deferred< Type >::correction(), localBlended< Type >::correction(), Foam::CorrectPhi(), Foam::fvc::curl(), Foam::fvc::d2dt2(), Foam::fvm::d2dt2(), fvModels::d2dt2(), objectRegistry::dbDir(), Foam::fvm::ddt(), Foam::fvc::ddt(), Foam::fvc::ddtCorr(), faceZoneSet::deleteSet(), meshObject::distribute(), Foam::fvc::div(), Foam::fvm::div(), Foam::fvc::domainIntegrate(), ParcelCloudBase< ParticleType >::Ep(), Foam::evaluate(), removeRegisteredObject::execute(), phaseScalarTransport::execute(), fileOperation::exists(), masterUncollatedFileOperation::exists(), Foam::MULES::explicitSolve(), triSurfaceMesh::extractCloseness(), triSurfaceMesh::extractPointCloseness(), masterUncollatedFileOperation::filePathInfo(), surfaceFieldValue::filterField(), localPointRegion::findDuplicateFacePairs(), refinementSurfaces::findInside(), fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), polyTopoChanger::findModifierID(), coupleGroupIdentifier::findOtherPatchID(), Foam::fvc::flux(), objectRegistry::foundObject(), correctedSnGrad< Type >::fullGradCorrection(), faceCorrectedSnGrad< Type >::fullGradCorrection(), steadyStateD2dt2Scheme< Type >::fvcD2dt2(), EulerD2dt2Scheme< Type >::fvcD2dt2(), EulerDdtScheme< Type >::fvcDdt(), steadyStateDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), steadyStateDdtScheme< Type >::fvcDdtPhiCorr(), EulerDdtScheme< Type >::fvcDdtPhiCorr(), CoEulerDdtScheme< Type >::fvcDdtPhiCorr(), SLTSDdtScheme< Type >::fvcDdtPhiCorr(), backwardDdtScheme< Type >::fvcDdtPhiCorr(), localEulerDdtScheme< Type >::fvcDdtPhiCorr(), CrankNicolsonDdtScheme< Type >::fvcDdtPhiCorr(), steadyStateDdtScheme< Type >::fvcDdtUfCorr(), EulerDdtScheme< Type >::fvcDdtUfCorr(), CoEulerDdtScheme< Type >::fvcDdtUfCorr(), SLTSDdtScheme< Type >::fvcDdtUfCorr(), backwardDdtScheme< Type >::fvcDdtUfCorr(), localEulerDdtScheme< Type >::fvcDdtUfCorr(), CrankNicolsonDdtScheme< Type >::fvcDdtUfCorr(), gaussConvectionScheme< Type >::fvcDiv(), gaussLaplacianScheme< Type, GType >::fvcLaplacian(), fvConstraints::fvConstraints(), CrankNicolsonDdtScheme< Type >::fvmDdt(), gaussLaplacianScheme< Type, GType >::fvmLaplacian(), gaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), fvModels::fvModels(), GeometricField< vector, pointPatchField, pointMesh >::GeometricField(), globalIndexAndTransform::globalIndexAndTransform(), Foam::fvc::grad(), IOobject::groupName(), polyBoundaryMesh::groupPatchIDs(), hexRef8Data::hexRef8Data(), ParcelCloudBase< ParticleType >::hsCoeff(), ParcelCloudBase< ParticleType >::hsTrans(), basicSpecieMixture::index(), ejectionModelList::info(), transferModelList::info(), Foam::interpolate(), fvMeshSubset::interpolate(), localMin< Type >::interpolate(), localMax< Type >::interpolate(), surfaceInterpolationScheme< GType >::interpolate(), localBlended< Type >::interpolate(), singleCellFvMesh::interpolate(), meshToMesh0::interpolate(), volPointInterpolation::interpolate(), volPointInterpolation::interpolateUnconstrained(), IOdistributionMap::IOdistributionMap(), unityLewisFourier< laminarThermophysicalTransportModel >::j(), unityLewisEddyDiffusivity< TurbulenceThermophysicalTransportModel >::j(), Foam::fvm::laplacian(), Foam::fvc::laplacian(), Foam::MULES::limiter(), LimitedScheme< Type, Limiter, LimitFunc >::limiter(), Foam::MULES::limiterCorr(), IOobject::local(), objectRegistry::lookupClass(), objectRegistry::lookupObject(), objectRegistry::lookupObjectRef(), Foam::mag(), Foam::magSqr(), Foam::MapGeometricFields(), meshObject::mapMesh(), mappedFixedValueFvPatchField< Type >::mapper(), meshToMesh::mapSrcToTgt(), meshToMesh::mapTgtToSrc(), fvMeshAdder::MapVolFields(), Foam::fvc::meshPhi(), Foam::MeshToMeshMapVolFields(), IOobject::modelName(), meshObject::movePoints(), NamedEnum< compressibleField, 8 >::names(), regionModel::nbrCoupledPatchID(), cyclicAMIPolyPatch::nbrPatchName(), optionalCpuLoad::New(), interpolation< Foam::Vector >::New(), twoPhaseChangeModel::New(), regIOobject::objectPath(), isNotEqOp< T >::operator()(), populationBalanceModel::iNew::operator()(), patchEjection::patchEjection(), patchInternalField::patchInternalField(), pointConstraints::pointConstraints(), pointMesh::pointMesh(), polyMesh::polyMesh(), Foam::pow(), fvMeshDistribute::printCoupleInfo(), wallHeatTransferCoeff::read(), masterUncollatedFileOperation::read(), decomposedBlockData::readBlocks(), Foam::readFields(), uncollatedFileOperation::readHeader(), IOobject::readHeader(), masterUncollatedFileOperation::readHeader(), regIOobject::readHeaderOk(), regIOobject::readIfModified(), uncollatedFileOperation::readStream(), regIOobject::readStream(), masterUncollatedFileOperation::readStream(), Foam::readUniformFields(), surfMesh::readUpdate(), polyMesh::readUpdate(), Foam::fvc::reconstruct(), Foam::fvc::reconstructMag(), refinementRegions::refinementRegions(), refiner::refiner(), IOobject::relativeObjectPath(), masterUncollatedFileOperation::relativeObjectPath(), IOobjectList::remove(), regIOobject::rename(), meshObject::reorderPatches(), objectRegistry::resetCacheTemporaryObject(), mappedPatchBase::samplePatch(), mappedPatchBase::sampleRegion(), searchableSurfaces::searchableSurfaces(), Foam::setRefCell(), removeCells::setRefinement(), ParcelCloudBase< ParticleType >::sigmap(), skewCorrected< Type >::skewCorrection(), Foam::fvc::snGrad(), snGradScheme< Type >::snGrad(), kinematicSingleLayer::solveAlpha(), fvMatrix< Type >::solveCoupled(), fvMatrix< Type >::solveSegregated(), fvModels::source(), fvModel::source(), Foam::sqr(), ParcelCloudBase< ParticleType >::Srho(), Foam::stabilise(), subCycleField< GeometricField >::subCycleField(), faceZoneSet::subset(), Foam::fvc::surfaceIntegrate(), Foam::fvc::surfaceSum(), surfMesh::surfMesh(), fvMesh::thisDb(), meshObject::topoChange(), Foam::transform(), triSurfaceTools::triangulate(), triSurfaceTools::triangulateFaceCentre(), triSurfaceMesh::triSurfaceMesh(), ParcelCloudBase< ParticleType >::UCoeff(), meshToMesh::update(), waveSurfacePressureFvPatchScalarField::updateCoeffs(), ParcelCloudBase< ParticleType >::UTrans(), meshReader::warnDuplicates(), IOobject::warnNoRereading(), extendedUpwindCellToFaceStencil::weightedSum(), extendedFaceToCellStencil::weightedSum(), extendedCellToFaceStencil::weightedSum(), localBlended< Type >::weights(), PatchPostProcessing< CloudType >::write(), FacePostProcessing< CloudType >::write(), XiReactionRate::write(), writeCellVolumes::write(), MeshedSurfaceProxy< Face >::write(), histogram::write(), regionSizeDistribution::write(), meshToMeshMethod::writeConnectivity(), boundaryRegion::writeDict(), cellTable::writeDict(), molecule::writeFields(), IOobject::writeHeader(), regionFunctionObject::writeObject(), writeObjectsBase::writeObject(), cellZoneSet::writeObject(), pointZoneSet::writeObject(), collatedFileOperation::writeObject(), faceZoneSet::writeObject(), IOobject::writeOpt(), domainDecomposition::writeProcs(), gradScheme< Type >::~gradScheme(), and regIOobject::~regIOobject().

◆ headerClassName() [1/2]

◆ headerClassName() [2/2]

word& headerClassName ( )
inline

Return name of the class name read from header.

Definition at line 327 of file IOobject.H.

◆ note() [1/2]

◆ note() [2/2]

const string& note ( ) const
inline

Return the optional note.

Definition at line 339 of file IOobject.H.

◆ rename()

virtual void rename ( const word newName)
inlinevirtual

Rename.

Reimplemented in regIOobject, and objectRegistry.

Definition at line 345 of file IOobject.H.

Referenced by hexRef8Data::hexRef8Data(), decomposedBlockData::readBlocks(), regIOobject::rename(), and hexRef8Data::sync().

Here is the caller graph for this function:

◆ registerObject() [1/2]

bool& registerObject ( )
inline

Register object created from this IOobject with registry if true.

Definition at line 351 of file IOobject.H.

Referenced by regIOobject::operator=(), regIOobject::regIOobject(), regIOobject::rename(), Foam::unregister(), and physicalProperties::~physicalProperties().

Here is the caller graph for this function:

◆ registerObject() [2/2]

bool registerObject ( ) const
inline

Register object created from this IOobject with registry if true.

Definition at line 357 of file IOobject.H.

◆ readOpt() [1/2]

◆ readOpt() [2/2]

readOption& readOpt ( )
inline

Definition at line 370 of file IOobject.H.

◆ writeOpt() [1/2]

◆ writeOpt() [2/2]

writeOption& writeOpt ( )
inline

◆ group() [2/2]

Foam::word group ( ) const

Return group (extension part of name)

Definition at line 324 of file IOobject.C.

References Foam::constant::atomic::group.

Referenced by massSource::addsSupToField(), IOobject::groupName(), odeChemistryModel::logFile(), and IOobject::writeOpt().

Here is the caller graph for this function:

◆ member() [2/2]

Foam::word member ( ) const

Return member (name without the extension)

Definition at line 330 of file IOobject.C.

Referenced by IOobject::writeOpt().

Here is the caller graph for this function:

◆ modelName() [2/3]

Foam::word modelName ( const char *  name) const
inline

Return the name of the object within this model.

as <model>:<name>

Definition at line 58 of file IOobjectI.H.

References IOobject::name(), and Foam::type().

Here is the call graph for this function:

◆ rootPath()

◆ caseName()

const Foam::fileName & caseName ( const bool  global) const

Definition at line 342 of file IOobject.C.

References fileName::caseName().

Referenced by regIOobject::caseName(), masterUncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::relativeObjectPath(), and IOobject::writeOpt().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ instance()

Foam::fileName & instance ( ) const

◆ updateInstance()

void updateInstance ( ) const

If the instance is a time directory update to the current time.

Definition at line 361 of file IOobject.C.

References Foam::readScalar().

Referenced by IOobject::writeOpt().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ local()

◆ path()

Foam::fileName path ( const bool  global) const

Return complete path including the processor sub-directory.

for a parallel run if global is set false

Definition at line 380 of file IOobject.C.

Referenced by IOobject::local(), regIOobject::path(), masterUncollatedFileOperation::relativeObjectPath(), and surfMesh::surfMesh().

Here is the caller graph for this function:

◆ objectPath()

◆ relativePath()

Foam::fileName relativePath ( ) const

Return the path relative to the case directory.

Definition at line 393 of file IOobject.C.

References IOobject::filePath().

Referenced by IOobject::local(), and IOobject::relativeObjectPath().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ relativeObjectPath()

fileName relativeObjectPath ( ) const
inline

◆ filePath()

Foam::fileName filePath ( const word typeName,
const bool  global 
) const

Return complete path + object name if the file exists.

in the case directory otherwise null.

If global and parallel searches up into the global case directory.

Definition at line 407 of file IOobject.C.

References Foam::fileHandler(), and fileOperation::filePath().

Referenced by regIOobject::filePath(), typeIOobject< Type >::filePath(), regIOobject::objectPath(), typeIOobject< Type >::objectPath(), IOobject::relativeObjectPath(), IOobject::relativePath(), and IOobject::typeHeaderOk().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ readHeader()

◆ headerOk()

bool headerOk ( )

Read header of local object without type-checking.

Mainly used to create IOobjectLists

Definition at line 31 of file IOobjectReadHeader.C.

Referenced by fileOperation::exists(), IOobjectList::IOobjectList(), IOobject::relativeObjectPath(), and typeIOobject< Type >::typeIOobject().

Here is the caller graph for this function:

◆ warnNoRereading()

void warnNoRereading ( ) const

Helper: warn that type does not support re-reading.

Definition at line 80 of file IOobjectTemplates.C.

References Foam::endl(), IOobject::MUST_READ_IF_MODIFIED, IOobject::name(), IOobject::readOpt(), and WarningInFunction.

Referenced by IOobject::relativeObjectPath().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ writeBanner()

Stream & writeBanner ( Stream &  os,
bool  noHint = false 
)
inlinestatic

Write the standard OpenFOAM file/dictionary banner.

Optionally without -*- C++ -*- editor hint (eg, for logs)

Definition at line 65 of file IOobjectI.H.

References Foam::FOAMversion.

Referenced by collatedFileOperation::appendObject(), argList::parse(), IOobject::relativeObjectPath(), decomposedBlockData::writeHeader(), and IOobject::writeHeader().

Here is the caller graph for this function:

◆ writeDivider()

Stream & writeDivider ( Stream &  os)
inlinestatic

Write the standard file section divider.

Definition at line 113 of file IOobjectI.H.

Referenced by collatedFileOperation::appendObject(), Foam::listSwitches(), argList::parse(), IOobject::relativeObjectPath(), writeDictionary::write(), decomposedBlockData::writeHeader(), and IOobject::writeHeader().

Here is the caller graph for this function:

◆ writeEndDivider()

Stream & writeEndDivider ( Stream &  os)
inlinestatic

◆ writeHeader() [1/2]

◆ writeHeader() [2/2]

◆ good()

bool good ( ) const
inline

Definition at line 480 of file IOobject.H.

References IOobject::GOOD.

Referenced by CompactIOField< Type, BaseType >::writeObject().

Here is the caller graph for this function:

◆ bad()

bool bad ( ) const
inline

Definition at line 485 of file IOobject.H.

References IOobject::BAD, IOobject::info(), and IOobject::operator=().

Here is the call graph for this function:

◆ info()

InfoProxy<IOobject> info ( ) const
inline

Return info proxy.

Used to print token information to a stream

Definition at line 495 of file IOobject.H.

Referenced by IOobject::bad().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const IOobject io)

Definition at line 435 of file IOobject.C.

Referenced by IOobject::bad(), and regIOobject::operator=().

Here is the caller graph for this function:

◆ groupName() [2/2]

Foam::word groupName ( Name  name,
const word group 
)
inline

Definition at line 31 of file IOobjectI.H.

References IOobject::group(), IOobject::name(), and word::null.

Here is the call graph for this function:

◆ modelName() [3/3]

Foam::word modelName ( Name  name,
const word model 
)
inline

Definition at line 45 of file IOobjectI.H.

References IOobject::name(), and word::null.

Here is the call graph for this function:

Member Data Documentation

◆ foamFile

constexpr const char* foamFile = "FoamFile"
static

◆ fileCheckTypesNames

const Foam::NamedEnum< Foam::IOobject::fileCheckTypes, 4 > fileCheckTypesNames
static

Definition at line 140 of file IOobject.H.

Referenced by NamedEnum< compressibleField, 8 >::names(), and argList::parse().

◆ fileModificationChecking


The documentation for this class was generated from the following files: