IOobject Class Reference

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 : char { GOOD, BAD }
	Enumeration defining the valid states of an IOobject. More...
enum	readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
	Enumeration defining the read options. More...
enum	writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }
	Enumeration defining the write options. More...
enum	fileCheckTypes : char { 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 as copy resetting registry. More...
	IOobject (const IOobject &io, const word &name)
	Construct as copy resetting name. More...
autoPtr< IOobject >	clone () const
	Clone. More...
autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...
virtual	~IOobject ()=default
	Destructor. More...
const objectRegistry &	db () const
	Return the local objectRegistry. More...
const Time &	time () const
	Return time. More...
const word &	name () const
	Return name. More...
const word &	headerClassName () const
	Return name of the class name read from header. More...
word &	headerClassName ()
	Return non-constant access to the class name read from header. More...
const string &	note () const
	Return the optional note. More...
string &	note ()
	Return non-constant access to the optional note. More...
virtual void	rename (const word &newName)
	Rename. More...
bool	registerObject () const
	Should object created with this IOobject be registered? More...
bool &	registerObject ()
	Should object created with this IOobject be registered? More...
bool	globalObject () const
	Is object same for all processors? More...
bool &	globalObject ()
	Is object same for all processors? More...
unsigned	labelByteSize () const
	The label byte-size, possibly read from the header. More...
unsigned	scalarByteSize () const
	The scalar byte-size, possibly read from the header. More...
bool	isHeaderClassName (const word &clsName) const
	Test if headerClassName() equals the given class name. More...
template<class Type >
bool	isHeaderClassName () const
	Test if headerClassName() equals Type::typeName. More...
readOption	readOpt () const
	The read option. More...
readOption &	readOpt ()
	Non-constant access to the read option. More...
writeOption	writeOpt () const
	The write option. More...
writeOption &	writeOpt ()
	Non-constant access to the write option. More...
word	group () const
	Return group (extension part of name) More...
word	member () const
	Return member (name without the extension) More...
const fileName &	rootPath () const
const fileName &	caseName () const
const fileName &	instance () const
fileName &	instance ()
const fileName &	local () const
fileName	path () const
	The complete path. More...
fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local. More...
fileName	objectPath () const
	The complete path + object name. More...
fileName	localFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches locally. More...
fileName	globalFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches up if in parallel. More...
bool	readHeader (Istream &is)
	Read header. More...
template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
	Read header (uses typeFilePath to find file) and check its info. More...
template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...
bool	writeHeader (Ostream &os) const
	Write header. More...
bool	writeHeader (Ostream &os, const word &objectType) const
	Write header. Allow override of type. More...
bool	good () const
bool	bad () const
InfoProxy< IOobject >	info () const
	Return info proxy. More...
void	operator= (const IOobject &io)
template<>
bool	isHeaderClassName () const
	Specialization for void always returns true (no headerClassName check). More...
template<class StringType >
Foam::word	groupName (StringType 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 StringType >
static word	groupName (StringType name, const word &group)
	Create dot-delimited name.group. More...
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...
static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
	Return the IOobject, but also consider an alternative file name. More...
static Ostream &	writeBanner (Ostream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...
static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider. More...
static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider. More...

Static Public Attributes
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes. More...
static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

Protected Member Functions
void	setBad (const string &s)
	Set the object state to bad. More...

Detailed Description

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

  Note

  Specifying registered does not result in the IOobject itself being registered. It is only serves as guidance for a regIOobject using it.

  See also

  Foam::objectRegistry Foam::regIOobject

  Source files

  • IOobject.H
  • IOobject.C
  • IOobjectReadHeader.C
  • IOobjectWriteHeader.C
  • IOobjectPrint.C

Definition at line 104 of file IOobject.H.

Member Enumeration Documentation

objectState

enum objectState : char

Enumeration defining the valid states of an IOobject.

Enumerator
GOOD
BAD

Definition at line 111 of file IOobject.H.

readOption

enum readOption : char

Enumeration defining the read options.

Enumerator
MUST_READ
MUST_READ_IF_MODIFIED
READ_IF_PRESENT
NO_READ

Definition at line 118 of file IOobject.H.

writeOption

enum writeOption : char

Enumeration defining the write options.

Enumerator
AUTO_WRITE
NO_WRITE

Definition at line 127 of file IOobject.H.

fileCheckTypes

enum fileCheckTypes : char

Enumeration defining the file checking options.

Enumerator
timeStamp
timeStampMaster
inotify
inotifyMaster

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

References Foam::expressions::patchExpr::debug, Foam::endl(), and InfoInFunction.

Here is the call 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 310 of file IOobject.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), and InfoInFunction.

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. A path that starts with a '/' is regarded as a file system path. Paths starting with either './' or '../' are relative to current working directory (and replaced with absolute equivalents). All other paths are considered to be relative to the case.

Definition at line 346 of file IOobject.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, InfoInFunction, and path().

Here is the call graph for this function:

IOobject() [4/5]

IOobject	(	const IOobject &	io,
		const objectRegistry &	registry
	)

Construct as copy resetting registry.

Definition at line 387 of file IOobject.C.

IOobject() [5/5]

IOobject	(	const IOobject &	io,
		const word &	name
	)

Construct as copy resetting name.

Definition at line 409 of file IOobject.C.

~IOobject()

virtual ~IOobject ( )

virtualdefault

Destructor.

Member Function Documentation

setBad()

void setBad ( const string &  s )

protected

Set the object state to bad.

Definition at line 503 of file IOobject.C.

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

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.

The splitting behaviour is as follows:

 input       | instance   | local | name
 ----------- | ---------- | ----- | ----
 a           |            |       | a
 a/b         | a          |       | b
 a/b/c/d     | a          | b/c   | d
 /a/b/c      | /a/b       |       | c
 ./a/b/c     | PWD/a/b    |       | c
 ../a/b/c    | PWD/../a/b |       | c
 a/b/        | ERROR      |       |

where PWD is the Foam::cwd() current working directory

Definition at line 112 of file IOobject.C.

References fileName::clean(), Foam::cwd(), Foam::endl(), Foam::isDir(), Foam::name(), path(), validate(), and WarningInFunction.

Here is the call graph for this function:

groupName() [1/2]

static word groupName ( StringType  name, const word &  group  )

inlinestatic

Create dot-delimited name.group.

If the group is an empty string, it is ignored.

Referenced by phaseChange::addToDriftRate(), alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField::calcAlphat(), nutkFilmWallFunctionFvPatchScalarField::calcNut(), nutkWallFunctionFvPatchScalarField::calcNut(), nutUWallFunctionFvPatchScalarField::calcNut(), nutkAtmRoughWallFunctionFvPatchScalarField::calcNut(), nutUTabulatedWallFunctionFvPatchScalarField::calcNut(), nutkRoughWallFunctionFvPatchScalarField::calcNut(), nutUBlendedWallFunctionFvPatchScalarField::calcNut(), nutUSpaldingWallFunctionFvPatchScalarField::calcNut(), nutkFilmWallFunctionFvPatchScalarField::calcUTau(), nutUBlendedWallFunctionFvPatchScalarField::calcUTau(), nutUSpaldingWallFunctionFvPatchScalarField::calcUTau(), nutUWallFunctionFvPatchScalarField::calcYPlus(), turbulentDispersionModel::continuousTurbulence(), populationBalanceModel::continuousTurbulence(), limitTemperature::correct(), powerLaw::correct(), Maxwell< BasicTurbulenceModel >::correct(), DarcyForchheimer::correct(), solidification::correct(), Gosman::D(), Burns::D(), Maxwell< BasicTurbulenceModel >::devRhoReff(), phasePressureModel::devRhoReff(), kineticTheoryModel::devRhoReff(), phaseSystem::dmdt(), LESeddyViscosity< BasicTurbulenceModel >::epsilon(), Stokes< BasicTurbulenceModel >::epsilon(), kEqn< BasicTurbulenceModel >::epsilon(), DeardorffDiffStress< BasicTurbulenceModel >::epsilon(), WALE< BasicTurbulenceModel >::epsilon(), Smagorinsky< BasicTurbulenceModel >::epsilon(), dynamicKEqn< BasicTurbulenceModel >::epsilon(), kOmegaSSTLM< BasicTurbulenceModel >::Flength(), kOmegaSSTLM< BasicTurbulenceModel >::Fonset(), phaseSystem::foundBlendedSubModel(), phaseSystem::foundSubModel(), kOmegaSSTLM< BasicTurbulenceModel >::Fthetat(), phaseSystem::generatePairsAndSubModels(), IDDESDelta::IDDESDelta(), WALE< BasicTurbulenceModel >::k(), Smagorinsky< BasicTurbulenceModel >::k(), Stokes< BasicTurbulenceModel >::k(), continuousGasKEqn< BasicTurbulenceModel >::liquidTurbulence(), continuousGasKEpsilon< BasicTurbulenceModel >::liquidTurbulence(), phaseSystem::lookupBlendedSubModel(), phaseSystem::lookupSubModel(), Stokes< BasicTurbulenceModel >::nuEff(), continuousGasKEpsilon< BasicTurbulenceModel >::nuEff(), LESModel< BasicTurbulenceModel >::nuEff(), RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >::nuEff(), Stokes< BasicTurbulenceModel >::nut(), basicThermo::phasePropertyName(), populationBalanceModel::populationBalanceModel(), Stokes< BasicTurbulenceModel >::R(), phasePressureModel::R(), continuousGasKEpsilon< BasicTurbulenceModel >::R(), kineticTheoryModel::R(), sampledSurfaces::read(), kOmegaSSTLM< BasicTurbulenceModel >::ReThetac(), kOmegaSSTLM< BasicTurbulenceModel >::ReThetat0(), continuousGasKEpsilon< BasicTurbulenceModel >::rhoEff(), fixedShearStressFvPatchVectorField::updateCoeffs(), JohnsonJacksonParticleSlipFvPatchVectorField::updateCoeffs(), JohnsonJacksonParticleThetaFvPatchScalarField::updateCoeffs(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), fWallFunctionFvPatchScalarField::updateCoeffs(), v2WallFunctionFvPatchScalarField::updateCoeffs(), alphatWallFunctionFvPatchScalarField::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), convectiveHeatTransferFvPatchScalarField::updateCoeffs(), wallHeatTransferFvPatchScalarField::updateCoeffs(), alphatFilmWallFunctionFvPatchScalarField::updateCoeffs(), turbulentMixingLengthDissipationRateInletFvPatchScalarField::updateCoeffs(), turbulentMixingLengthFrequencyInletFvPatchScalarField::updateCoeffs(), alphatJayatillekeWallFunctionFvPatchScalarField::updateCoeffs(), porousBafflePressureFvPatchField< Type >::updateCoeffs(), epsilonWallFunctionFvPatchScalarField::updateCoeffs(), omegaWallFunctionFvPatchScalarField::updateCoeffs(), alphatWallBoilingWallFunctionFvPatchScalarField::updateCoeffs(), epsilonWallFunctionFvPatchScalarField::updateWeightedCoeffs(), omegaWallFunctionFvPatchScalarField::updateWeightedCoeffs(), nutkFilmWallFunctionFvPatchScalarField::yPlus(), nutkWallFunctionFvPatchScalarField::yPlus(), nutLowReWallFunctionFvPatchScalarField::yPlus(), nutUWallFunctionFvPatchScalarField::yPlus(), nutUTabulatedWallFunctionFvPatchScalarField::yPlus(), nutUBlendedWallFunctionFvPatchScalarField::yPlus(), nutUSpaldingWallFunctionFvPatchScalarField::yPlus(), and nutURoughWallFunctionFvPatchScalarField::yPlus().

group() [1/2]

Foam::word group ( const word &  name )

static

Return group (extension part of name)

Definition at line 247 of file IOobject.C.

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

Here is the call graph for this function:

member() [1/2]

Foam::word member ( const word &  name )

static

Return member (name without the extension)

Definition at line 260 of file IOobject.C.

References Foam::name().

Here is the call graph for this function:

selectIO()

Foam::IOobject selectIO ( const IOobject &  io, const fileName &  altFile, const word &  ioName = ""  )

static

Return the IOobject, but also consider an alternative file name.

Parameters

io	The expected IOobject to use
altFile	Alternative fileName (ignored if empty).
ioName	The alternative name for the IOobject when the altFile resolves to a directory.

Note

If the alternative fileName is a non-empty string, it defines the location but uses all other properties of the expected IOobject. The location may be an absolute or a relative path. If it corresponds to a directory, the name of the expected IOobject will be used in its resolution. This expected name can provided via the ioName parameter.

Definition at line 203 of file IOobject.C.

References IOobject::db(), string::expand(), IOobject::globalObject(), Foam::isDir(), IOobject::name(), IOobject::readOpt(), IOobject::registerObject(), and IOobject::writeOpt().

Referenced by decompositionModel::selectIO(), and lumpedPointMovement::selectIO().

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.

Definition at line 326 of file IOobject.H.

References autoPtr< T >::New().

Referenced by searchableSurface::iNew::operator()(), polyMesh::readUpdate(), and searchableSurfaces::searchableSurfaces().

Here is the call graph for this function:

Here is the caller graph for this function:

clone() [2/2]

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

inline

Clone resetting registry.

Definition at line 332 of file IOobject.H.

References autoPtr< T >::New().

Here is the call graph for this function:

db()

const Foam::objectRegistry & db

(

)

const

Return the local objectRegistry.

Definition at line 432 of file IOobject.C.

Referenced by refinementHistory::add(), refinementHistory::apply(), SprayParcel< ParcelType >::calcAtomization(), faePatchField< Type >::db(), faPatchField< Type >::db(), uncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::filePathInfo(), hexRef8Data::hexRef8Data(), Foam::loadPointField(), masterUncollatedFileOperation::localObjectPath(), voxelMeshSearch::makeMesh(), simplifiedDynamicFvMeshBase::New(), engineMesh::New(), dynamicFvMesh::New(), fvMeshTools::newMesh(), lumpedPointDisplacementPointPatchVectorField::points0(), fileOperation::processorsPath(), Foam::readFields(), Foam::readUniformFields(), regionProperties::regionProperties(), searchableSurfaceCollection::searchableSurfaceCollection(), searchableSurfaceWithGaps::searchableSurfaceWithGaps(), IOobject::selectIO(), motionSmootherAlgo::setDisplacement(), surfMesh::surfMesh(), hexRef8Data::sync(), and MPPICParcel< ParcelType >::trackingData::updateAverages().

Here is the caller graph for this function:

time()

const Foam::Time & time

(

)

const

Return time.

Definition at line 438 of file IOobject.C.

References objectRegistry::time().

Referenced by fixedTemperatureConstraint::constrain(), distributedTriSurfaceMesh::distribute(), dynamicMultiMotionSolverFvMesh::dynamicMultiMotionSolverFvMesh(), masterUncollatedFileOperation::exists(), masterUncollatedFileOperation::filePath(), uncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::filePathInfo(), fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), codeStream::libs(), masterUncollatedFileOperation::localObjectPath(), simplifiedDynamicFvMeshBase::New(), engineMesh::New(), dynamicFvMesh::New(), fvMeshTools::newMesh(), collatedFileOperation::objectPath(), fileOperation::processorsCasePath(), pointFieldReconstructor::reconstructField(), sixDoFRigidBodyMotionSolver::solve(), uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs(), regIOobject::write(), collatedFileOperation::writeObject(), triSurfaceMesh::writeObject(), and masterUncollatedFileOperation::writeObject().

Here is the call graph for this function:

Here is the caller graph for this function:

name()

const Foam::word & name ( ) const

inline

Return name.

Definition at line 46 of file IOobjectI.H.

Referenced by IOobjectList::add(), snappyLayerDriver::addLayers(), faceZoneSet::addSet(), exprResultGlobals::addValue(), collatedFileOperation::appendObject(), setsToFaceZone::applyToSet(), attachPolyTopoChanger::attach(), meshRefinement::balance(), mappedPatchBase::calcMapping(), faBoundaryMesh::checkDefinition(), polyBoundaryMesh::checkDefinition(), objectRegistry::checkIn(), objectRegistry::checkOut(), polyBoundaryMesh::checkParallelSync(), faceZone::checkParallelSync(), refinementFeatures::checkSizes(), objectRegistry::classesImpl(), meshObject::clear(), objectRegistry::clear(), meshObject::clearUpto(), wallBoiling::correct(), IOobjectList::countImpl(), objectRegistry::countImpl(), IOobjectList::countTypeImpl(), objectRegistry::countTypeImpl(), fvMeshTools::createDummyFvMeshFiles(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), dynamicRefineFvMesh::dynamicRefineFvMesh(), removeRegisteredObject::execute(), fileOperation::exists(), masterUncollatedFileOperation::exists(), uncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::filePathInfo(), localPointRegion::findDuplicateFacePairs(), refinementSurfaces::findInside(), fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), coupleGroupIdentifier::findOtherPatchID(), GeometricField< Type, fvPatchField, volMesh >::GeometricField(), exprResultGlobals::get(), exprResultGlobals::getNamespace(), IOobject::group(), IOobject::groupName(), polyBoundaryMesh::groupPatchIDs(), hexRef8Data::hexRef8Data(), injectionModelList::info(), transferModelList::info(), Foam::loadPointField(), masterUncollatedFileOperation::localObjectPath(), objectRegistry::lookupClass(), objectRegistry::lookupObjectPtr(), objectRegistry::lookupObjectRefPtr(), voxelMeshSearch::makeMesh(), Foam::MapConsistentSubMesh(), meshObject::movePoints(), baseIOdictionary::name(), objectRegistry::namesImpl(), objectRegistry::namesTypeImpl(), cyclicAMIPolyPatch::neighbPatchName(), simplifiedDynamicFvMeshBase::New(), dynamicFvMesh::New(), fvMeshTools::newMesh(), patchInjection::patchInjection(), PatchPostProcessing< CloudType >::PatchPostProcessing(), pointConstraints::pointConstraints(), pointMesh::pointMesh(), wallHeatFlux::read(), wallShearStress::read(), masterUncollatedFileOperation::read(), decomposedBlockData::readBlocks(), IOobject::readHeader(), uncollatedFileOperation::readStream(), masterUncollatedFileOperation::readStream(), polyMesh::readUpdate(), pointFieldReconstructor::reconstructField(), fvFieldReconstructor::reconstructFvSurfaceField(), fvFieldReconstructor::reconstructFvVolumeField(), fvFieldReconstructor::reconstructFvVolumeInternalField(), triSurfaceMesh::regions(), IOobjectList::remove(), exprResultGlobals::removeValue(), Time::run(), IOobject::selectIO(), refinementSurfaces::setMinLevelFields(), removeFaces::setRefinement(), faceZoneSet::subset(), faceZoneSet::subtractSet(), surfMesh::surfMesh(), hexRef8Data::sync(), triSurfaceMesh::triSurfaceMesh(), MPPICParcel< ParcelType >::trackingData::updateAverages(), mappedFlowRateFvPatchVectorField::updateCoeffs(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::updateCoeffs(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::updateCoeffs(), humidityTemperatureCoupledMixedFvPatchScalarField::updateCoeffs(), topoBitSet::updateLabels(), topoBoolSet::updateLabels(), topoSet::updateLabels(), meshObject::updateMesh(), motionSmootherAlgo::updateMesh(), IOobject::warnNoRereading(), writeObjects::write(), MeshedSurfaceProxy< Face >::write(), Foam::vtk::writeCellSetFaces(), meshToMeshMethod::writeConnectivity(), boundaryRegion::writeDict(), cellTable::writeDict(), Foam::vtk::writeFaceSet(), fieldExtents::writeFileHeader(), collatedFileOperation::writeObject(), regionFunctionObject::writeObject(), and Foam::vtk::writePointSet().

headerClassName() [1/2]

const Foam::word & headerClassName ( ) const

inline

Return name of the class name read from header.

Definition at line 64 of file IOobjectI.H.

Referenced by fieldToCell::applyToSet(), IOobjectList::classesImpl(), IOobjectList::countImpl(), fvExprDriver::evaluateVariable(), masterUncollatedFileOperation::filePathInfo(), fvExprDriver::foundField(), fvExprDriver::getTopoSetLabels(), Foam::loadPointField(), masterUncollatedFileOperation::localObjectPath(), IOobjectList::lookupClassImpl(), IOobjectList::namesImpl(), polyMesh::polyMesh(), uncollatedFileOperation::read(), masterUncollatedFileOperation::read(), decomposedBlockData::readBlocks(), uncollatedFileOperation::readHeader(), masterUncollatedFileOperation::readHeader(), uncollatedFileOperation::readStream(), masterUncollatedFileOperation::readStream(), polyMesh::readUpdate(), fvExprDriver::topoSetType(), and decomposedBlockData::writeData().

Here is the caller graph for this function:

headerClassName() [2/2]

Foam::word & headerClassName ( )

inline

Return non-constant access to the class name read from header.

Definition at line 70 of file IOobjectI.H.

note() [1/2]

const Foam::string & note ( ) const

inline

Return the optional note.

Definition at line 76 of file IOobjectI.H.

Referenced by uncollatedFileOperation::read(), masterUncollatedFileOperation::read(), decomposedBlockData::readBlocks(), masterUncollatedFileOperation::readHeader(), edgeMeshFormat::write(), decomposedBlockData::writeData(), boundaryRegion::writeDict(), and cellTable::writeDict().

Here is the caller graph for this function:

note() [2/2]

Foam::string & note ( )

inline

Return non-constant access to the optional note.

Definition at line 82 of file IOobjectI.H.

rename()

virtual void rename ( const word &  newName )

inlinevirtual

Rename.

Reimplemented in objectRegistry, and regIOobject.

Definition at line 368 of file IOobject.H.

Referenced by nearWallFields::createFields(), dynamicMotionSolverListFvMesh::dynamicMotionSolverListFvMesh(), searchableCone::findLine(), searchableCone::findLineAll(), searchableCone::findLineAny(), hexRef8Data::hexRef8Data(), points0MotionSolver::points0IO(), decomposedBlockData::readBlocks(), regIOobject::rename(), and hexRef8Data::sync().

Here is the caller graph for this function:

registerObject() [1/2]

bool registerObject ( ) const

inline

Should object created with this IOobject be registered?

Definition at line 88 of file IOobjectI.H.

Referenced by Foam::loadPointField(), regIOobject::regIOobject(), IOobject::selectIO(), and motionSolver::stealRegistration().

Here is the caller graph for this function:

registerObject() [2/2]

bool & registerObject ( )

inline

Should object created with this IOobject be registered?

Definition at line 94 of file IOobjectI.H.

globalObject() [1/2]

bool globalObject ( ) const

inline

Is object same for all processors?

Definition at line 100 of file IOobjectI.H.

Referenced by codeStream::doingMasterOnlyReading(), uncollatedFileOperation::read(), masterUncollatedFileOperation::read(), and IOobject::selectIO().

Here is the caller graph for this function:

globalObject() [2/2]

bool & globalObject ( )

inline

Is object same for all processors?

Definition at line 106 of file IOobjectI.H.

labelByteSize()

unsigned labelByteSize ( ) const

inline

The label byte-size, possibly read from the header.

Definition at line 112 of file IOobjectI.H.

scalarByteSize()

unsigned scalarByteSize ( ) const

inline

The scalar byte-size, possibly read from the header.

Definition at line 118 of file IOobjectI.H.

isHeaderClassName() [1/3]

bool isHeaderClassName ( const word &  clsName ) const

inline

Test if headerClassName() equals the given class name.

Definition at line 126 of file IOobjectI.H.

Referenced by IOobjectList::cfindObject(), IOobjectList::countTypeImpl(), IOobjectList::lookupClassTypeImpl(), and IOobjectList::namesTypeImpl().

Here is the caller graph for this function:

isHeaderClassName() [2/3]

bool isHeaderClassName ( ) const

inline

Test if headerClassName() equals Type::typeName.

Definition at line 133 of file IOobjectI.H.

readOpt() [1/2]

Foam::IOobject::readOption readOpt ( ) const

inline

The read option.

Definition at line 141 of file IOobjectI.H.

Referenced by columnFvMesh::columnFvMesh(), CompactIOField< T, BaseType >::CompactIOField(), CompactIOList< face, label >::CompactIOList(), nearWallFields::createFields(), decomposedBlockData::decomposedBlockData(), dynamicMotionSolverListFvMesh::dynamicMotionSolverListFvMesh(), dynamicMultiMotionSolverFvMesh::dynamicMultiMotionSolverFvMesh(), extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), faSchemes::faSchemes(), featureEdgeMesh::featureEdgeMesh(), fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), topoSet::findIOobject(), fvSchemes::fvSchemes(), hexRef8::hexRef8(), IOField< Type >::IOField(), IOList< labelList >::IOList(), IOMap< T >::IOMap(), IOmapDistribute::IOmapDistribute(), IOmapDistributePolyMesh::IOmapDistributePolyMesh(), IOPtrList< Foam::entry >::IOPtrList(), voxelMeshSearch::makeMesh(), polyTopoChange::makeMesh(), fvMeshTools::newMesh(), polyBoundaryMeshEntries::polyBoundaryMeshEntries(), radiativeIntensityRay::radiativeIntensityRay(), codedPoints0MotionSolver::redirectMotionSolver(), refinementHistory::refinementHistory(), IOobject::selectIO(), hexRef8Data::sync(), topoSet::topoSet(), triSurfaceMesh::triSurfaceMesh(), IOobject::warnNoRereading(), and Foam::ensightOutput::writeCloudField().

Here is the caller graph for this function:

readOpt() [2/2]

Foam::IOobject::readOption & readOpt ( )

inline

Non-constant access to the read option.

Definition at line 147 of file IOobjectI.H.

writeOpt() [1/2]

Foam::IOobject::writeOption writeOpt ( ) const

inline

The write option.

Definition at line 153 of file IOobjectI.H.

Referenced by nearWallFields::createFields(), dynamicMotionSolverListFvMesh::dynamicMotionSolverListFvMesh(), polyTopoChange::makeMesh(), objectRegistry::objectRegistry(), IOobject::selectIO(), surfMesh::setWriteOption(), and writeObjects::write().

Here is the caller graph for this function:

writeOpt() [2/2]

Foam::IOobject::writeOption & writeOpt ( )

inline

Non-constant access to the write option.

Definition at line 159 of file IOobjectI.H.

group() [2/2]

Foam::word group ( ) const

inline

Return group (extension part of name)

Definition at line 52 of file IOobjectI.H.

References word::ext().

Referenced by IOobject::groupName().

Here is the call graph for this function:

Here is the caller graph for this function:

member() [2/2]

Foam::word member ( ) const

inline

Return member (name without the extension)

Definition at line 58 of file IOobjectI.H.

References word::lessExt().

Here is the call graph for this function:

rootPath()

const Foam::fileName & rootPath

(

)

const

Definition at line 444 of file IOobject.C.

Referenced by uncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::localObjectPath(), and fileOperation::processorsCasePath().

Here is the caller graph for this function:

caseName()

const Foam::fileName & caseName

(

)

const

Definition at line 450 of file IOobject.C.

Referenced by uncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::filePathInfo(), and masterUncollatedFileOperation::localObjectPath().

Here is the caller graph for this function:

instance() [1/2]

const Foam::fileName & instance ( ) const

inline

Definition at line 167 of file IOobjectI.H.

Referenced by directions::directions(), masterUncollatedFileOperation::exists(), uncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::filePathInfo(), Time::findInstance(), fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), Foam::loadPointField(), masterUncollatedFileOperation::localObjectPath(), meshRefinement::mergePatchFacesUndo(), triSurfaceMesh::movePoints(), fvMeshTools::newMesh(), collatedFileOperation::objectPath(), points0MotionSolver::points0IO(), Foam::readFields(), Foam::readUniformFields(), surfMesh::surfMesh(), collatedFileOperation::writeObject(), regIOobject::writeObject(), triSurfaceMesh::writeObject(), and distributedTriSurfaceMesh::writeObject().

Here is the caller graph for this function:

instance() [2/2]

Foam::fileName & instance ( )

inline

Definition at line 173 of file IOobjectI.H.

local()

const Foam::fileName & local ( ) const

inline

Definition at line 179 of file IOobjectI.H.

Referenced by masterUncollatedFileOperation::dirPath(), masterUncollatedFileOperation::filePath(), uncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::filePathInfo(), fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), Foam::loadPointField(), masterUncollatedFileOperation::localObjectPath(), fileOperation::processorsPath(), Foam::readFields(), Foam::readUniformFields(), and surfMesh::surfMesh().

Here is the caller graph for this function:

path() [1/2]

Foam::fileName path

(

)

const

The complete path.

Definition at line 456 of file IOobject.C.

Referenced by searchableSurfaces::checkIntersection(), uncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::localObjectPath(), fileOperation::readObjects(), refinementHistory::removeFiles(), motionSmootherAlgo::setDisplacement(), surfMesh::surfMesh(), collatedFileOperation::writeObject(), and Time::writeObject().

Here is the caller graph for this function:

path() [2/2]

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

The complete path with alternative instance and local.

Definition at line 471 of file IOobject.C.

objectPath()

Foam::fileName objectPath ( ) const

inline

The complete path + object name.

Definition at line 185 of file IOobjectI.H.

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

Referenced by collatedFileOperation::appendObject(), baseIOdictionary::baseIOdictionary(), triSurfaceMesh::checkFile(), hexRef8::consistentSlowRefinement2(), uncollatedFileOperation::dirPath(), masterUncollatedFileOperation::dirPath(), fileOperation::exists(), masterUncollatedFileOperation::exists(), uncollatedFileOperation::filePath(), masterUncollatedFileOperation::filePath(), uncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::findInstance(), hexRef8::hexRef8(), meshRefinement::mergePatchFacesUndo(), fileOperation::objectPath(), collatedFileOperation::processorsDir(), uncollatedFileOperation::read(), masterUncollatedFileOperation::read(), baseIOdictionary::readData(), uncollatedFileOperation::readHeader(), masterUncollatedFileOperation::readHeader(), uncollatedFileOperation::readObjects(), fileOperation::readObjects(), masterUncollatedFileOperation::readObjects(), uncollatedFileOperation::readStream(), masterUncollatedFileOperation::readStream(), hexRef8::setUnrefinement(), surfZoneIOList::surfZoneIOList(), triSurfaceMesh::triSurfaceMesh(), 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 bool	search = true
	)		const

Helper for filePath that searches locally.

When search is false, simply use the current instance, otherwise search previous instances.

Definition at line 482 of file IOobject.C.

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

Referenced by triSurfaceMesh::checkFile(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), triSurfaceMesh::triSurfaceMesh(), 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 bool	search = true
	)		const

Helper for filePath that searches up if in parallel.

When search is false, simply use the current instance, otherwise search previous instances.

Definition at line 493 of file IOobject.C.

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

Referenced by triSurfaceMesh::checkFile(), GlobalIOField< vector >::filePath(), triSurfaceMesh::triSurfaceMesh(), Foam::typeFilePath(), and Foam::typeFilePath< IOMap< dictionary > >().

Here is the call graph for this function:

Here is the caller graph for this function:

readHeader()

bool readHeader

(

Istream &

is

)

Read header.

Definition at line 35 of file IOobjectReadHeader.C.

References IOobject::BAD, Foam::expressions::patchExpr::debug, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, IOstreamOption::format(), dictionary::get(), IOobject::GOOD, IOstream::good(), Foam::Info, InfoInFunction, IOWarningInFunction, token::isWord(), Foam::foamVersion::labelByteSize(), IOstream::lineNumber(), IOobject::MUST_READ, IOobject::MUST_READ_IF_MODIFIED, IOstream::name(), IOobject::name(), Foam::nl, dictionary::readIfPresent(), Foam::foamVersion::scalarByteSize(), SeriousIOErrorInFunction, IOstream::setLabelByteSize(), IOstream::setScalarByteSize(), Foam::val, IOstreamOption::version(), token::wordToken(), and IOobject::writeHeader().

Referenced by extendedEdgeMeshFormat::read(), edgeMeshFormat::read(), decomposedBlockData::read(), masterUncollatedFileOperation::read(), decomposedBlockData::readBlock(), decomposedBlockData::readBlocks(), uncollatedFileOperation::readHeader(), masterUncollatedFileOperation::readHeader(), decomposedBlockData::readMasterHeader(), uncollatedFileOperation::readStream(), masterUncollatedFileOperation::readStream(), and decomposedBlockData::writeData().

Here is the call graph for this function:

Here is the caller graph for this function:

typeHeaderOk()

bool typeHeaderOk	(	const bool	checkType = true,
		const bool	search = true,
		const bool	verbose = true
	)

Read header (uses typeFilePath to find file) and check its info.

Optionally checks headerClassName against the type-name. When search is false, simply use the current instance, otherwise search previous instances.

Definition at line 39 of file IOobjectTemplates.C.

References Foam::endl(), Foam::fileHandler(), fileOperation::readHeader(), Foam::search(), and WarningInFunction.

Referenced by fieldToCell::applyToSet(), fvMeshTools::createDummyFvMeshFiles(), fileOperation::exists(), topoSet::findIOobject(), hexRef8::hexRef8(), hexRef8Data::hexRef8Data(), PatchCollisionDensity< CloudType >::PatchCollisionDensity(), points0MotionSolver::points0IO(), Foam::preservePatchTypes(), pyrolysisChemistryModel< CompType, SolidThermo, GasThermo >::pyrolysisChemistryModel(), extendedEdgeMeshFormat::read(), edgeMeshFormat::read(), particle< Type >::readFields(), fieldAverage::restoreWindowFieldsType(), and TDACChemistryModel< CompType, ThermoType >::TDACChemistryModel().

Here is the call graph for this function:

Here is the caller graph for this function:

warnNoRereading()

void warnNoRereading

(

)

const

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

Definition at line 88 of file IOobjectTemplates.C.

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

Here is the call graph for this function:

writeBanner()

Foam::Ostream & writeBanner ( Ostream &  os, bool  noHint = false  )

static

Write the standard OpenFOAM file/dictionary banner.

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

Definition at line 45 of file IOobjectWriteHeader.C.

References Foam::foamVersion::version.

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

Here is the caller graph for this function:

writeDivider()

Foam::Ostream & writeDivider ( Ostream &  os )

static

Write the standard file section divider.

Definition at line 99 of file IOobjectWriteHeader.C.

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

Here is the caller graph for this function:

writeEndDivider()

Foam::Ostream & writeEndDivider ( Ostream &  os )

static

Write the standard end file divider.

Definition at line 109 of file IOobjectWriteHeader.C.

Referenced by collatedFileOperation::appendObject(), MeshedSurfaceProxy< Face >::write(), decomposedBlockData::writeData(), collatedFileOperation::writeObject(), fileOperation::writeObject(), and masterUncollatedFileOperation::writeObject().

Here is the caller graph for this function:

writeHeader() [1/2]

bool writeHeader

(

Ostream &

os

)

const

Write header.

Definition at line 156 of file IOobjectWriteHeader.C.

References Foam::type(), and Foam::writeHeader().

Referenced by collatedFileOperation::appendObject(), baseIOdictionary::readData(), IOobject::readHeader(), edgeMeshFormat::write(), interpolationLookUpTable< scalar >::write(), MeshedSurfaceProxy< Face >::write(), boundaryRegion::writeDict(), cellTable::writeDict(), decomposedBlockData::writeObject(), collatedFileOperation::writeObject(), fileOperation::writeObject(), and masterUncollatedFileOperation::writeObject().

Here is the call graph for this function:

Here is the caller graph for this function:

writeHeader() [2/2]

bool writeHeader	(	Ostream &	os,
		const word &	objectType
	)		const

Write header. Allow override of type.

Definition at line 119 of file IOobjectWriteHeader.C.

References IOstreamOption::BINARY, Foam::foamVersion::buildArch, Foam::endl(), IOstreamOption::format(), IOstream::good(), IOstream::info(), InfoInFunction, Foam::name(), Foam::nl, Foam::type(), and IOstreamOption::version().

Here is the call graph for this function:

good()

bool good ( ) const

inline

Definition at line 193 of file IOobjectI.H.

Referenced by topoSet::topoSet().

Here is the caller graph for this function:

bad()

bool bad ( ) const

inline

Definition at line 199 of file IOobjectI.H.

info()

InfoProxy<IOobject> info ( ) const

inline

Return info proxy.

Used to print token information to a stream

Definition at line 519 of file IOobject.H.

Referenced by profiling::create(), searchableSurfaceWithGaps::findNearest(), searchableSurface::findNearest(), searchableSurfaceWithGaps::getField(), searchableSurfaceWithGaps::getNormal(), searchableSurfaceWithGaps::getRegion(), searchableSurfaceWithGaps::getVolumeType(), waveGenerationModel::info(), irregularWaveModel::info(), solitaryWaveModel::info(), Grimshaw::info(), Boussinesq::info(), McCowan::info(), and KinematicCloud< Cloud< basicKinematicCollidingParcel > >::solve().

Here is the caller graph for this function:

operator=()

void operator=

(

const IOobject &

io

)

Definition at line 524 of file IOobject.C.

Referenced by regIOobject::operator=().

Here is the caller graph for this function:

isHeaderClassName() [3/3]

bool isHeaderClassName ( ) const

inline

Specialization for void always returns true (no headerClassName check).

Definition at line 533 of file IOobject.H.

groupName() [2/2]

Foam::word groupName ( StringType  name, const word &  group  )

inline

Definition at line 31 of file IOobjectI.H.

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

Here is the call graph for this function:

Member Data Documentation

fileCheckTypesNames

const Foam::Enum< Foam::IOobject::fileCheckTypes > fileCheckTypesNames

static

Names for the fileCheckTypes.

Definition at line 143 of file IOobject.H.

Referenced by argList::parse().

fileModificationChecking

Foam::IOobject::fileCheckTypes fileModificationChecking

static

Type of file modification checking.

Definition at line 207 of file IOobject.H.

Referenced by unwatchedIOdictionary::addWatch(), regIOobject::addWatch(), collatedFileOperation::collatedFileOperation(), fileOperation::monitor(), fvMeshTools::newMesh(), argList::parse(), regIOobject::read(), and Time::readModifiedObjects().

---

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

• src/OpenFOAM/db/IOobject/IOobject.H
• src/OpenFOAM/db/IOobject/IOobject.C
• src/OpenFOAM/db/IOobject/IOobjectI.H
• src/OpenFOAM/db/IOobject/IOobjectReadHeader.C
• src/OpenFOAM/db/IOobject/IOobjectTemplates.C
• src/OpenFOAM/db/IOobject/IOobjectWriteHeader.C