All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
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:
Inheritance graph
[legend]
Collaboration diagram for IOobject:
Collaboration graph
[legend]

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, bool globalObject=false)
 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, bool globalObject=false)
 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...
 
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...
 
bool & registerObject ()
 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...
 
bool & globalObject ()
 Is object same for all processors. More...
 
bool globalObject () const
 Is object same for all processors. 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...
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const
 
fileNameinstance ()
 
const fileNamelocal () const
 
fileName path () const
 Return complete path. More...
 
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName localFilePath (const word &typeName) const
 Helper for filePath that searches locally. More...
 
fileName globalFilePath (const word &typeName) const
 Helper for filePath that searches up if in parallel. More...
 
bool readHeader (Istream &)
 Read header. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType=true)
 Read header (uses typeFilePath to find file) and check header. 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)
 

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 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 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...
 

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:

Definition at line 92 of file IOobject.H.

Member Enumeration Documentation

◆ objectState

Enumeration defining the valid states of an IOobject.

Enumerator
GOOD 
BAD 

Definition at line 100 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 107 of file IOobject.H.

◆ writeOption

Enumeration defining the write options.

Enumerator
AUTO_WRITE 
NO_WRITE 

Definition at line 116 of file IOobject.H.

◆ fileCheckTypes

Enumeration defining the file checking options.

Enumerator
timeStamp 
timeStampMaster 
inotify 
inotifyMaster 

Definition at line 123 of file IOobject.H.

Constructor & Destructor Documentation

◆ IOobject() [1/5]

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 209 of file IOobject.C.

References Foam::endl(), and InfoInFunction.

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

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

◆ IOobject() [2/5]

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

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

Definition at line 241 of file IOobject.C.

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

Here is the call graph for this function:

◆ IOobject() [3/5]

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

Construct from path, registry, io options.

Uses fileNameComponents() to split path into components.

Definition at line 275 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/5]

IOobject ( const IOobject io,
const objectRegistry registry 
)

Construct from copy resetting registry.

Definition at line 314 of file IOobject.C.

References IOobject::IOobject().

Here is the call graph for this function:

◆ IOobject() [5/5]

IOobject ( const IOobject io,
const word name 
)

Construct from copy resetting name.

Definition at line 334 of file IOobject.C.

◆ ~IOobject()

~IOobject ( )
virtual

Destructor.

Definition at line 355 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 435 of file IOobject.C.

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

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 106 of file IOobject.C.

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

Referenced by addfileModificationCheckingToOpt::writeData().

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 basicMultiComponentMixture::basicMultiComponentMixture(), nutkWallFunctionFvPatchScalarField::calcNut(), nutUWallFunctionFvPatchScalarField::calcNut(), nutkFilmWallFunctionFvPatchScalarField::calcNut(), nutUSpaldingWallFunctionFvPatchScalarField::calcNut(), nutUTabulatedWallFunctionFvPatchScalarField::calcNut(), nutkRoughWallFunctionFvPatchScalarField::calcNut(), nutkAtmRoughWallFunctionFvPatchScalarField::calcNut(), nutkFilmWallFunctionFvPatchScalarField::calcUTau(), nutUSpaldingWallFunctionFvPatchScalarField::calcUTau(), nutUWallFunctionFvPatchScalarField::calcYPlus(), limitTemperature::correct(), powerLaw::correct(), Maxwell< BasicTurbulenceModel >::correct(), DarcyForchheimer::correct(), solidification::correct(), mixtureKEpsilon< BasicTurbulenceModel >::correctNut(), Maxwell< BasicTurbulenceModel >::devRhoReff(), LESeddyViscosity< BasicTurbulenceModel >::epsilon(), Stokes< BasicTurbulenceModel >::epsilon(), DeardorffDiffStress< BasicTurbulenceModel >::epsilon(), kEqn< BasicTurbulenceModel >::epsilon(), WALE< BasicTurbulenceModel >::epsilon(), Smagorinsky< BasicTurbulenceModel >::epsilon(), dynamicKEqn< BasicTurbulenceModel >::epsilon(), kOmegaSSTLM< BasicTurbulenceModel >::Flength(), kOmegaSSTLM< BasicTurbulenceModel >::Fonset(), kOmegaSSTLM< BasicTurbulenceModel >::Fthetat(), WALE< BasicTurbulenceModel >::k(), Smagorinsky< BasicTurbulenceModel >::k(), Stokes< BasicTurbulenceModel >::k(), limitTemperature::limitTemperature(), continuousGasKEqn< BasicTurbulenceModel >::liquidTurbulence(), continuousGasKEpsilon< BasicTurbulenceModel >::liquidTurbulence(), polyBoundaryMesh::mesh(), Stokes< BasicTurbulenceModel >::nuEff(), continuousGasKEpsilon< BasicTurbulenceModel >::nuEff(), LESModel< BasicTurbulenceModel >::nuEff(), RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >::nuEff(), Stokes< BasicTurbulenceModel >::nut(), basicThermo::phasePropertyName(), Stokes< BasicTurbulenceModel >::R(), continuousGasKEpsilon< BasicTurbulenceModel >::R(), SmagorinskyZhang< BasicTurbulenceModel >::read(), NicenoKEqn< BasicTurbulenceModel >::read(), LaheyKEpsilon< BasicTurbulenceModel >::read(), kOmegaSSTSato< BasicTurbulenceModel >::read(), kOmegaSSTLM< BasicTurbulenceModel >::ReThetac(), kOmegaSSTLM< BasicTurbulenceModel >::ReThetat0(), continuousGasKEpsilon< BasicTurbulenceModel >::rhoEff(), externalCoupledTemperatureMixedFvPatchScalarField::transferData(), fixedShearStressFvPatchVectorField::updateCoeffs(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), alphatWallFunctionFvPatchScalarField::updateCoeffs(), fWallFunctionFvPatchScalarField::updateCoeffs(), v2WallFunctionFvPatchScalarField::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), convectiveHeatTransferFvPatchScalarField::updateCoeffs(), wallHeatTransferFvPatchScalarField::updateCoeffs(), alphatFilmWallFunctionFvPatchScalarField::updateCoeffs(), turbulentMixingLengthDissipationRateInletFvPatchScalarField::updateCoeffs(), turbulentMixingLengthFrequencyInletFvPatchScalarField::updateCoeffs(), alphatJayatillekeWallFunctionFvPatchScalarField::updateCoeffs(), porousBafflePressureFvPatchField< Type >::updateCoeffs(), epsilonWallFunctionFvPatchScalarField::updateCoeffs(), omegaWallFunctionFvPatchScalarField::updateCoeffs(), epsilonWallFunctionFvPatchScalarField::updateWeightedCoeffs(), omegaWallFunctionFvPatchScalarField::updateWeightedCoeffs(), nutkWallFunctionFvPatchScalarField::yPlus(), nutLowReWallFunctionFvPatchScalarField::yPlus(), nutUWallFunctionFvPatchScalarField::yPlus(), nutkFilmWallFunctionFvPatchScalarField::yPlus(), nutUSpaldingWallFunctionFvPatchScalarField::yPlus(), nutUTabulatedWallFunctionFvPatchScalarField::yPlus(), and nutURoughWallFunctionFvPatchScalarField::yPlus().

◆ group() [1/2]

Foam::word group ( const word name)
static

◆ member() [1/2]

Foam::word member ( const word name)
static

Return member (name without the extension)

Definition at line 191 of file IOobject.C.

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

Referenced by singleStepCombustion< ReactionThermo, ThermoType >::R(), and laminar< ReactionThermo >::R().

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

◆ clone() [1/2]

autoPtr<IOobject> clone ( ) const
inline

◆ clone() [2/2]

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

Clone resetting registry.

Definition at line 276 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 367 of file IOobject.C.

References objectRegistry::time().

Referenced by regIOobject::addWatch(), motionSmootherAlgo::avg(), IOobject::clone(), fixedTemperatureConstraint::constrain(), masterUncollatedFileOperation::exists(), masterUncollatedFileOperation::filePath(), masterUncollatedFileOperation::filePathInfo(), fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), fvMeshSubset::interpolate(), Foam::fvm::laplacian(), masterUncollatedFileOperation::localObjectPath(), Foam::MapGeometricFields(), NamedEnum< directionType, 3 >::names(), engineMesh::New(), dynamicFvMesh::New(), laminarFlameSpeed::New(), SRFModel::New(), laminarModel< BasicTurbulenceModel >::New(), RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >::New(), LESModel< BasicTurbulenceModel >::New(), radiationModel::New(), collatedFileOperation::objectPath(), consumptionSpeed::omega0Sigma(), isNotEqOp< T >::operator()(), RaviPetersen::operator()(), continuousGasKEqn< BasicTurbulenceModel >::phaseTransferCoeff(), continuousGasKEpsilon< BasicTurbulenceModel >::phaseTransferCoeff(), NicenoKEqn< BasicTurbulenceModel >::phaseTransferCoeff(), LaheyKEpsilon< BasicTurbulenceModel >::phaseTransferCoeff(), fileOperation::processorsCasePath(), pointFieldReconstructor::reconstructField(), rigidBodyMeshMotionSolver::solve(), TurbulenceModel< volScalarField, geometricOneField, incompressibleTurbulenceModel, TransportModel >::TurbulenceModel(), uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs(), plenumPressureFvPatchScalarField::updateCoeffs(), regIOobject::write(), meshRefinement::write(), Foam::writeCellGraph(), collatedFileOperation::writeObject(), rigidBodyMeshMotionSolver::writeObject(), masterUncollatedFileOperation::writeObject(), Foam::writePatchGraph(), FSD< ReactionThermo, ThermoType >::~FSD(), Gulders::~Gulders(), GuldersEGR::~GuldersEGR(), and subCycleField< GeometricField >::~subCycleField().

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 361 of file IOobject.C.

Referenced by isoSurface::adaptPatchFields(), refinementHistory::add(), refinementHistory::apply(), Foam::atan2(), motionSmootherAlgo::avg(), regIOobject::checkIn(), regIOobject::checkOut(), IOobject::clone(), Foam::cmptAv(), mixtureKEpsilon< BasicTurbulenceModel >::correctNut(), refinementHistory::distribute(), masterUncollatedFileOperation::filePathInfo(), hexRef8Data::hexRef8Data(), InjectionModel< CloudType >::inject(), surfaceInterpolationScheme< GType >::interpolate(), volPointInterpolation::interpolate(), PhiScheme< Type, PhiLimiter >::limiter(), continuousGasKEqn< BasicTurbulenceModel >::liquidTurbulence(), continuousGasKEpsilon< BasicTurbulenceModel >::liquidTurbulence(), masterUncollatedFileOperation::localObjectPath(), Foam::mag(), Foam::magSqr(), Foam::New(), reuseTmpDimensionedField< TypeR, Type1, GeoMesh >::New(), engineMesh::New(), basicSolidChemistryModel::New(), reuseTmpDimensionedField< TypeR, TypeR, GeoMesh >::New(), dynamicFvMesh::New(), laminarFlameSpeed::New(), reuseTmpGeometricField< TypeR, Type1, PatchField, GeoMesh >::New(), SRFModel::New(), laminarModel< BasicTurbulenceModel >::New(), RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >::New(), reuseTmpTmpDimensionedField< TypeR, Type1, Type12, Type2, GeoMesh >::New(), LESModel< BasicTurbulenceModel >::New(), reuseTmpGeometricField< TypeR, TypeR, PatchField, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, Type1, Type12, TypeR, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, Type1, Type12, Type2, PatchField, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, Type2, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, Type1, Type12, TypeR, PatchField, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, TypeR, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, TypeR, TypeR, Type2, PatchField, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, TypeR, TypeR, TypeR, PatchField, GeoMesh >::New(), consumptionSpeed::omega0Sigma(), RaviPetersen::operator()(), sampledSurface::pointAverage(), Foam::pow(), fileOperation::processorsPath(), SmagorinskyZhang< BasicTurbulenceModel >::read(), NicenoKEqn< BasicTurbulenceModel >::read(), LaheyKEpsilon< BasicTurbulenceModel >::read(), kOmegaSSTSato< BasicTurbulenceModel >::read(), Foam::readFields(), Foam::readUniformFields(), refinementHistory::refinementHistory(), surfMesh::removeFiles(), searchableSurfaceCollection::searchableSurfaceCollection(), searchableSurfaceWithGaps::searchableSurfaceWithGaps(), decompositionModel::selectIO(), motionSmootherAlgo::setDisplacementPatchFields(), regIOobject::setUpToDate(), rigidBodyMeshMotionSolver::solve(), Foam::sqr(), Foam::stabilise(), surfMesh::surfMesh(), hexRef8Data::sync(), Foam::transform(), TurbulenceModel< volScalarField, geometricOneField, incompressibleTurbulenceModel, TransportModel >::TurbulenceModel(), IOobject::writeHeader(), FSD< ReactionThermo, ThermoType >::~FSD(), Gulders::~Gulders(), GuldersEGR::~GuldersEGR(), and regIOobject::~regIOobject().

◆ name()

const word& name ( ) const
inline

Return name.

Definition at line 297 of file IOobject.H.

Referenced by isoSurface::adaptPatchFields(), multivariateSurfaceInterpolationScheme< Type >::fieldTable::add(), IOobjectList::add(), snappyLayerDriver::addLayers(), polyTopoChange::addMesh(), faceZoneSet::addSet(), solidificationMeltingSource::addSup(), 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(), meshRefinement::checkCoupledFaceZones(), polyBoundaryMesh::checkDefinition(), Cloud< streamLineParticle >::checkFieldFieldIOobject(), Cloud< streamLineParticle >::checkFieldIOobject(), regIOobject::checkIn(), objectRegistry::checkIn(), Foam::checkMethod(), objectRegistry::checkOut(), polyBoundaryMesh::checkParallelSync(), faceZone::checkParallelSync(), meshRefinement::checkZoneFaces(), meshObject::clear(), meshObject::clearUpto(), KinematicCloud< Cloud< basicKinematicCollidingParcel > >::cloneBare(), Foam::cmptAv(), Foam::MULES::correct(), optionList::correct(), cubic< Type >::correction(), correctedSnGrad< Type >::correction(), faceCorrectedSnGrad< Type >::correction(), linearUpwind< Type >::correction(), linearUpwindV< Type >::correction(), localBlended< Type >::correction(), Foam::fvc::curl(), Foam::fvc::d2dt2(), Foam::fvm::d2dt2(), optionList::d2dt2(), objectRegistry::dbDir(), Foam::fvm::ddt(), Foam::fvc::ddt(), Foam::fvc::ddtCorr(), fvFieldDecomposer::decomposeField(), faceZoneSet::deleteSet(), Foam::fvc::div(), Foam::fvm::div(), Foam::fvc::domainIntegrate(), dynamicRefineFvMesh::dynamicRefineFvMesh(), effectivenessHeatExchangerSource::effectivenessHeatExchangerSource(), removeRegisteredObject::execute(), fileOperation::exists(), masterUncollatedFileOperation::exists(), Foam::MULES::explicitSolve(), triSurfaceMesh::extractCloseness(), triSurfaceMesh::extractPointCloseness(), masterUncollatedFileOperation::filePathInfo(), surfaceFieldValue::filterField(), localPointRegion::findDuplicateFacePairs(), coordinateSystems::findIndex(), coordinateSystems::findIndices(), refinementSurfaces::findInside(), fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), polyTopoChanger::findModifierID(), coupleGroupIdentifier::findOtherPatchID(), fixedTemperatureConstraint::fixedTemperatureConstraint(), Foam::fvc::flux(), objectRegistry::foundObject(), correctedSnGrad< Type >::fullGradCorrection(), faceCorrectedSnGrad< Type >::fullGradCorrection(), steadyStateD2dt2Scheme< Type >::fvcD2dt2(), EulerD2dt2Scheme< Type >::fvcD2dt2(), steadyStateDdtScheme< Type >::fvcDdt(), EulerDdtScheme< 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(), CrankNicolsonDdtScheme< Type >::fvmDdt(), gaussLaplacianScheme< Type, GType >::fvmLaplacian(), gaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), GeometricField< vector, pointPatchField, pointMesh >::GeometricField(), globalIndexAndTransform::globalIndexAndTransform(), Foam::fvc::grad(), IOobject::groupName(), polyBoundaryMesh::groupPatchIDs(), hexRef8Data::hexRef8Data(), thermoSingleLayer::hs(), injectionModelList::info(), transferModelList::info(), Foam::interpolate(), localMin< Type >::interpolate(), localMax< Type >::interpolate(), surfaceInterpolationScheme< GType >::interpolate(), localBlended< Type >::interpolate(), singleCellFvMesh::interpolate(), fvMeshSubset::interpolate(), volPointInterpolation::interpolate(), meshToMesh0::interpolate(), IOmapDistribute::IOmapDistribute(), isoSurface::isoSurface(), sizeGroup::keyword(), Foam::fvm::laplacian(), Foam::fvc::laplacian(), Foam::MULES::limiter(), LimitedScheme< Type, Limiter, LimitFunc >::limiter(), Foam::MULES::limiterCorr(), limitTemperature::limitTemperature(), masterUncollatedFileOperation::localObjectPath(), objectRegistry::lookupClass(), objectRegistry::lookupObject(), objectRegistry::lookupObjectRef(), Foam::mag(), Foam::magSqr(), Foam::makeGraph(), Foam::MapConsistentSubMesh(), Foam::MapGeometricFields(), mappedFixedValueFvPatchField< Type >::mapper(), meshToMesh::mapSrcToTgt(), meshToMesh::mapTgtToSrc(), fvMeshAdder::MapVolFields(), Foam::fvc::meshPhi(), meshObject::movePoints(), baseIOdictionary::name(), NamedEnum< directionType, 3 >::names(), cyclicAMIPolyPatch::neighbPatchName(), interpolation< Foam::Vector >::New(), dynamicFvMesh::New(), IOobject::objectPath(), isNotEqOp< T >::operator()(), optionList::operator()(), patchInjection::patchInjection(), pointConstraints::pointConstraints(), pointMesh::pointMesh(), polyMesh::polyMesh(), Foam::pow(), fvMeshDistribute::printCoupleInfo(), radiation::radiation(), interfaceProperties::read(), wallHeatFlux::read(), wallShearStress::read(), wallHeatTransferCoeff::read(), masterUncollatedFileOperation::read(), decomposedBlockData::readBlocks(), Foam::readFields(), IOobject::readHeader(), regIOobject::readHeaderOk(), regIOobject::readIfModified(), uncollatedFileOperation::readStream(), regIOobject::readStream(), masterUncollatedFileOperation::readStream(), Foam::readUniformFields(), surfMesh::readUpdate(), polyMesh::readUpdate(), Foam::fvc::reconstruct(), pointFieldReconstructor::reconstructField(), fvFieldReconstructor::reconstructFvSurfaceField(), fvFieldReconstructor::reconstructFvVolumeField(), fvFieldReconstructor::reconstructFvVolumeInternalField(), Foam::fvc::reconstructMag(), IOobjectList::remove(), sampledPatchInternalField::sampledPatchInternalField(), mappedPatchBase::samplePatch(), mappedPatchBase::sampleRegion(), searchableSurfaces::searchableSurfaces(), Foam::setRefCell(), removeCells::setRefinement(), skewCorrected< Type >::skewCorrection(), Foam::fvc::snGrad(), snGradScheme< Type >::snGrad(), solidificationMeltingSource::solidificationMeltingSource(), fvMatrix< Type >::fvSolver::solve(), fvMatrix< Type >::solveCoupled(), fvMatrix< Type >::solveSegregated(), kinematicSingleLayer::solveThickness(), Foam::sqr(), Foam::stabilise(), faceZoneSet::subset(), Foam::fvc::surfaceIntegrate(), Foam::fvc::surfaceSum(), surfMesh::surfMesh(), thermoSingleLayer::T(), fvMesh::thisDb(), Foam::transform(), triSurfaceTools::triangulate(), triSurfaceTools::triangulateFaceCentre(), triSurfaceMesh::triSurfaceMesh(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), waveSurfacePressureFvPatchScalarField::updateCoeffs(), meshObject::updateMesh(), motionSmootherAlgo::updateMesh(), basicThermo::validate(), meshReader::warnDuplicates(), IOobject::warnNoRereading(), extendedUpwindCellToFaceStencil::weightedSum(), extendedFaceToCellStencil::weightedSum(), extendedCellToFaceStencil::weightedSum(), localBlended< Type >::weights(), PatchPostProcessing< CloudType >::write(), FacePostProcessing< CloudType >::write(), writeCellVolumes::write(), XiReactionRate::write(), MeshedSurfaceProxy< Face >::write(), histogram::write(), regionSizeDistribution::write(), Foam::writeCellGraph(), meshToMeshMethod::writeConnectivity(), boundaryRegion::writeDict(), cellTable::writeDict(), molecule::writeFields(), IOobject::writeHeader(), regionFunctionObject::writeObject(), writeObjectsBase::writeObject(), cellZoneSet::writeObject(), pointZoneSet::writeObject(), collatedFileOperation::writeObject(), faceZoneSet::writeObject(), Foam::writePatchGraph(), gradScheme< Type >::~gradScheme(), and regIOobject::~regIOobject().

◆ headerClassName() [1/2]

const word& headerClassName ( ) const
inline

◆ headerClassName() [2/2]

word& headerClassName ( )
inline

Return name of the class name read from header.

Definition at line 309 of file IOobject.H.

◆ note() [1/2]

string& note ( )
inline

◆ note() [2/2]

const string& note ( ) const
inline

Return the optional note.

Definition at line 321 of file IOobject.H.

◆ rename()

virtual void rename ( const word newName)
inlinevirtual

Rename.

Reimplemented in regIOobject, and objectRegistry.

Definition at line 327 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 333 of file IOobject.H.

Referenced by regIOobject::operator=(), regIOobject::regIOobject(), regIOobject::rename(), and decompositionModel::selectIO().

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 339 of file IOobject.H.

◆ globalObject() [1/2]

bool& globalObject ( )
inline

Is object same for all processors.

Definition at line 345 of file IOobject.H.

Referenced by uncollatedFileOperation::read(), and masterUncollatedFileOperation::read().

Here is the caller graph for this function:

◆ globalObject() [2/2]

bool globalObject ( ) const
inline

Is object same for all processors.

Definition at line 351 of file IOobject.H.

◆ readOpt() [1/2]

readOption readOpt ( ) const
inline

◆ readOpt() [2/2]

readOption& readOpt ( )
inline

Definition at line 364 of file IOobject.H.

◆ writeOpt() [1/2]

writeOption writeOpt ( ) const
inline

◆ writeOpt() [2/2]

writeOption& writeOpt ( )
inline

Definition at line 374 of file IOobject.H.

References IOobject::caseName(), IOobject::group(), IOobject::member(), and IOobject::rootPath().

Here is the call graph for this function:

◆ group() [2/2]

Foam::word group ( ) const

Return group (extension part of name)

Definition at line 379 of file IOobject.C.

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

Referenced by IOobject::groupName(), 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 385 of file IOobject.C.

Referenced by IOobject::writeOpt().

Here is the caller graph for this function:

◆ rootPath()

const Foam::fileName & rootPath ( ) const

◆ caseName()

const Foam::fileName & caseName ( ) const

Definition at line 373 of file IOobject.C.

References fileName::caseName().

Referenced by masterUncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::localObjectPath(), Foam::makeGraph(), IOobject::writeOpt(), and regIOobject::~regIOobject().

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

◆ instance() [1/2]

const fileName& instance ( ) const
inline

Definition at line 392 of file IOobject.H.

Referenced by isoSurface::adaptPatchFields(), snappyLayerDriver::addLayers(), Foam::atan2(), Foam::fvc::average(), Foam::checkMethod(), Foam::cmptAv(), correctedSnGrad< Type >::correction(), faceCorrectedSnGrad< Type >::correction(), directions::directions(), masterUncollatedFileOperation::exists(), surfMesh::facesInstance(), polyMesh::facesInstance(), masterUncollatedFileOperation::filePathInfo(), Time::findInstance(), fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), faceCorrectedSnGrad< Type >::fullGradCorrection(), gaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), surfaceInterpolationScheme< GType >::interpolate(), volPointInterpolation::interpolate(), Foam::fvc::laplacian(), Foam::fvm::laplacian(), IOobject::local(), masterUncollatedFileOperation::localObjectPath(), Foam::mag(), Foam::magSqr(), Foam::makeGraph(), Foam::MapGeometricFields(), meshRefinement::mergePatchFacesUndo(), polyMesh::movePoints(), Foam::New(), reuseTmpDimensionedField< TypeR, Type1, GeoMesh >::New(), reuseTmpDimensionedField< TypeR, TypeR, GeoMesh >::New(), reuseTmpGeometricField< TypeR, Type1, PatchField, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, Type1, Type12, Type2, GeoMesh >::New(), reuseTmpGeometricField< TypeR, TypeR, PatchField, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, Type1, Type12, TypeR, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, Type1, Type12, Type2, PatchField, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, Type2, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, Type1, Type12, TypeR, PatchField, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, TypeR, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, TypeR, TypeR, Type2, PatchField, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, TypeR, TypeR, TypeR, PatchField, GeoMesh >::New(), collatedFileOperation::objectPath(), surfMesh::pointsInstance(), polyMesh::pointsInstance(), polyMesh::polyMesh(), Foam::pow(), Foam::readFields(), Foam::readUniformFields(), surfMesh::readUpdate(), polyMesh::readUpdate(), Foam::fvc::reconstruct(), Foam::fvc::reconstructMag(), surfMesh::removeFiles(), polyMesh::removeFiles(), surfMesh::setInstance(), polyMesh::setInstance(), snappyRefineDriver::snappyRefineDriver(), snGradScheme< Type >::snGrad(), Foam::sqr(), Foam::stabilise(), Foam::fvc::surfaceIntegrate(), Foam::fvc::surfaceSum(), surfMesh::surfMesh(), polyMesh::tetBasePtIs(), Foam::transform(), polyTopoChanger::update(), meshRefinement::write(), IOobject::writeHeader(), collatedFileOperation::writeObject(), regIOobject::writeObject(), distributedTriSurfaceMesh::writeObject(), and regIOobject::~regIOobject().

◆ instance() [2/2]

fileName& instance ( )
inline

Definition at line 397 of file IOobject.H.

◆ local()

const fileName& local ( ) const
inline

◆ path() [1/2]

Foam::fileName path ( ) const

◆ path() [2/2]

Foam::fileName path ( const word instance,
const fileName local = "" 
) const

Return complete path with alternative instance and local.

Definition at line 411 of file IOobject.C.

◆ objectPath()

fileName objectPath ( ) const
inline

Return complete path + object name.

Definition at line 418 of file IOobject.H.

References IOobject::globalFilePath(), IOobject::localFilePath(), IOobject::name(), IOobject::path(), IOobject::readHeader(), IOobject::typeHeaderOk(), IOobject::warnNoRereading(), IOobject::writeBanner(), IOobject::writeDivider(), IOobject::writeEndDivider(), and IOobject::writeHeader().

Referenced by unwatchedIOdictionary::addWatch(), regIOobject::addWatch(), collatedFileOperation::appendObject(), baseIOdictionary::baseIOdictionary(), regIOobject::checkIn(), hexRef8::consistentSlowRefinement2(), uncollatedFileOperation::dirPath(), masterUncollatedFileOperation::dirPath(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), fileOperation::exists(), masterUncollatedFileOperation::exists(), uncollatedFileOperation::filePath(), masterUncollatedFileOperation::filePath(), masterUncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::findInstance(), regIOobject::headerOk(), hexRef8::hexRef8(), mappedFixedValueFvPatchField< Type >::mapper(), meshRefinement::mergePatchFacesUndo(), fileOperation::objectPath(), collatedFileOperation::processorsDir(), uncollatedFileOperation::read(), masterUncollatedFileOperation::read(), baseIOdictionary::readData(), uncollatedFileOperation::readHeader(), masterUncollatedFileOperation::readHeader(), regIOobject::readHeaderOk(), uncollatedFileOperation::readObjects(), fileOperation::readObjects(), masterUncollatedFileOperation::readObjects(), uncollatedFileOperation::readStream(), masterUncollatedFileOperation::readStream(), polyMesh::readUpdate(), hexRef8::setUnrefinement(), surfacePatchIOList::surfacePatchIOList(), surfZoneIOList::surfZoneIOList(), meshReader::warnDuplicates(), boundaryRegion::writeDict(), cellTable::writeDict(), collatedFileOperation::writeObject(), triSurfaceMesh::writeObject(), fileOperation::writeObject(), distributedTriSurfaceMesh::writeObject(), and masterUncollatedFileOperation::writeObject().

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

◆ localFilePath()

Foam::fileName localFilePath ( const word typeName) const

Helper for filePath that searches locally.

Definition at line 421 of file IOobject.C.

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

Referenced by regIOobject::filePath(), localIOdictionary::global(), distributedTriSurfaceMesh::global(), IOobject::objectPath(), and Foam::typeFilePath().

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

◆ globalFilePath()

Foam::fileName globalFilePath ( const word typeName) const

◆ readHeader()

bool readHeader ( Istream is)

◆ typeHeaderOk()

bool typeHeaderOk ( const bool  checkType = true)

◆ warnNoRereading()

void warnNoRereading ( ) const

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

Definition at line 77 of file IOobjectTemplates.C.

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

Referenced by IOobject::objectPath().

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 45 of file IOobjectI.H.

References Foam::FOAMversion.

Referenced by collatedFileOperation::appendObject(), IOobject::objectPath(), argList::parse(), 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 93 of file IOobjectI.H.

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

Here is the caller graph for this function:

◆ writeEndDivider()

Stream & writeEndDivider ( Stream &  os)
inlinestatic

◆ writeHeader() [1/2]

bool writeHeader ( Ostream os) const

◆ writeHeader() [2/2]

bool writeHeader ( Ostream os,
const word objectType 
) const

◆ good()

bool good ( ) const
inline

Definition at line 468 of file IOobject.H.

References IOobject::GOOD.

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

Here is the caller graph for this function:

◆ bad()

bool bad ( ) const
inline

Definition at line 473 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 483 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 454 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:

Member Data Documentation

◆ fileCheckTypesNames

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

◆ fileModificationChecking

Foam::IOobject::fileCheckTypes fileModificationChecking
static

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