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 }
enum	readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
enum	writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }
enum	fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }

Public Member Functions
	TypeName ("IOobject")
	IOobject (const IOobject &)=default
virtual	~IOobject ()=default
	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
	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)
	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
	IOobject (const IOobject &io, const objectRegistry &registry)
	IOobject (const IOobject &io, const word &name)
	IOobject (const IOobject &io, readOption, writeOption)
autoPtr< IOobject >	clone () const
autoPtr< IOobject >	clone (const objectRegistry &registry) const
const objectRegistry &	db () const noexcept
const Time &	time () const
const word &	name () const noexcept
const word &	headerClassName () const noexcept
word &	headerClassName () noexcept
const string &	note () const noexcept
string &	note () noexcept
virtual void	rename (const word &newName)
bool	registerObject () const noexcept
bool	registerObject (bool on) noexcept
bool	globalObject () const noexcept
bool	globalObject (bool on) noexcept
unsigned	labelByteSize () const noexcept
unsigned	scalarByteSize () const noexcept
bool	isHeaderClassName (const word &clsName) const
template<class Type >
bool	isHeaderClassName () const
virtual const dictionary *	findMetaData () const noexcept
readOption	readOpt () const noexcept
readOption	readOpt (readOption opt) noexcept
writeOption	writeOpt () const noexcept
writeOption	writeOpt (writeOption opt) noexcept
word	group () const
word	member () const
const fileName &	rootPath () const
const fileName &	caseName () const
const fileName &	instance () const noexcept
fileName &	instance () noexcept
const fileName &	local () const noexcept
fileName	path () const
fileName	path (const word &instance, const fileName &local=fileName::null) const
fileName	objectPath () const
fileName	objectRelPath () const
fileName	localFilePath (const word &typeName, const bool search=true) const
fileName	globalFilePath (const word &typeName, const bool search=true) const
IOstreamOption	parseHeader (const dictionary &headerDict)
bool	readHeader (Istream &is)
bool	readHeader (dictionary &headerDict, Istream &is)
template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
template<class Type >
void	warnNoRereading () const
bool	writeHeader (Ostream &os) const
bool	writeHeader (Ostream &os, const word &objectType) const
void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const
void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
bool	good () const noexcept
bool	bad () const noexcept
InfoProxy< IOobject >	info () const
void	operator= (const IOobject &io)
readOption &	readOpt () noexcept
writeOption &	writeOpt () noexcept
bool &	registerObject () noexcept
bool &	globalObject () noexcept
template<>
bool	isHeaderClassName () const
template<class StringType >
Foam::word	groupName (StringType base, const word &group)

Static Public Member Functions
static bool	bannerEnabled () noexcept
static bool	bannerEnabled (bool on) noexcept
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
template<class StringType >
static word	groupName (StringType base, const word &group)
static word	group (const word &name)
static word	member (const word &name)
static word	scopedName (const std::string &scope, const word &name)
static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)
static Ostream &	writeDivider (Ostream &os)
static Ostream &	writeEndDivider (Ostream &os)

Static Public Attributes
static const Enum< fileCheckTypes >	fileCheckTypesNames
static char	scopeSeparator
static fileCheckTypes	fileModificationChecking
static float	fileModificationSkew
static int	maxFileModificationPolls

Protected Member Functions
void	setBad (const string &s)

Static Protected Member Functions
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)

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

  When serializing, the IOobject characteristics are typically written as a FoamFile header, which is a sub-dictionary with the following type of content:

Property	Description	Type	Reqd	Deflt
version	The base format version	float	no	2.0
format	The stream format (ascii/binary)	word	yes
arch	The architecture string	string	no
note	Descriptive note about the object	string	no
location	The relative location of the object	string	no
class	The type of the object	word	yes
object	The name of the object	word	yes

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

Member Enumeration Documentation

objectState

enum objectState : char

Enumerator
GOOD
BAD

Definition at line 172 of file IOobject.H.

readOption

enum readOption : char

Enumerator
MUST_READ
MUST_READ_IF_MODIFIED
READ_IF_PRESENT
NO_READ

Definition at line 179 of file IOobject.H.

writeOption

enum writeOption : char

Enumerator
AUTO_WRITE
NO_WRITE

Definition at line 188 of file IOobject.H.

fileCheckTypes

enum fileCheckTypes : char

Enumerator
timeStamp
timeStampMaster
inotify
inotifyMaster

Definition at line 195 of file IOobject.H.

Constructor & Destructor Documentation

IOobject() [1/7]

IOobject ( const IOobject &  )

default

~IOobject()

virtual ~IOobject ( )

virtualdefault

IOobject() [2/7]

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

Definition at line 304 of file IOobject.C.

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

Here is the call graph for this function:

IOobject() [3/7]

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
	)

Definition at line 340 of file IOobject.C.

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

Here is the call graph for this function:

IOobject() [4/7]

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

Definition at line 377 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() [5/7]

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

Definition at line 419 of file IOobject.C.

IOobject() [6/7]

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

Definition at line 442 of file IOobject.C.

IOobject() [7/7]

IOobject	(	const IOobject &	io,
		readOption	ro,
		writeOption	wo
	)

Definition at line 465 of file IOobject.C.

Member Function Documentation

writeHeaderContent() [1/2]

void writeHeaderContent ( Ostream &  os, const IOobject &  io, const word &  objectType, const dictionary *  metaDataDict = nullptr  )

staticprotected

Definition at line 148 of file IOobjectWriteHeader.C.

References Foam::foamVersion::buildArch, IOobject::db(), objectRegistry::dbDir(), IOstreamOption::format(), IOobject::instance(), IOobject::local(), IOobject::name(), IOobject::note(), os(), IOstreamOption::version(), dictionary::writeEntry(), and Foam::writeHeaderEntry().

Referenced by IOobject::writeHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

writeHeaderContent() [2/2]

void writeHeaderContent ( dictionary &  dict, const IOobject &  io, const word &  objectType, IOstreamOption  streamOpt, const dictionary *  metaDataDict = nullptr  )

staticprotected

Definition at line 187 of file IOobjectWriteHeader.C.

References dictionary::add(), Foam::foamVersion::buildArch, IOobject::db(), objectRegistry::dbDir(), dict, IOstreamOption::format(), IOobject::instance(), IOobject::local(), IOobject::name(), IOobject::note(), dictionary::set(), and IOstreamOption::version().

Here is the call graph for this function:

setBad()

void setBad ( const string &  s )

protected

Definition at line 583 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"

)

bannerEnabled() [1/2]

static bool bannerEnabled ( )

inlinestaticnoexcept

Definition at line 311 of file IOobject.H.

Referenced by decomposedBlockData::writeHeader(), IOobject::writeHeader(), and collatedFileOperation::writeObject().

Here is the caller graph for this function:

bannerEnabled() [2/2]

static bool bannerEnabled ( bool  on )

inlinestaticnoexcept

Definition at line 318 of file IOobject.H.

fileNameComponents()

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

static

Definition at line 140 of file IOobject.C.

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

Here is the call graph for this function:

groupName() [1/2]

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

inlinestatic

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

group() [1/2]

Foam::word group ( const word &  name )

static

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

Definition at line 288 of file IOobject.C.

References Foam::name().

Here is the call graph for this function:

scopedName()

Foam::word scopedName ( const std::string &  scope, const word &  name  )

inlinestatic

Definition at line 40 of file IOobjectI.H.

References Foam::name().

Referenced by solverInfo::createResidualField(), turbulenceFields::initialise(), multiRegion::read(), turbulenceFields::read(), functionObject::scopedName(), lduMatrix::setResidualField(), turbulenceFields::write(), and electricPotential::write().

Here is the call graph for this function:

Here is the caller graph for this function:

selectIO()

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

static

Definition at line 231 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().

Here is the call graph for this function:

Here is the caller graph for this function:

clone() [1/2]

autoPtr<IOobject> clone ( ) const

inline

Definition at line 464 of file IOobject.H.

References autoPtr::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

Definition at line 470 of file IOobject.H.

References autoPtr::New().

Here is the call graph for this function:

db()

const Foam::objectRegistry & db ( ) const

noexcept

Definition at line 480 of file IOobject.C.

Referenced by refinementHistory::add(), refinementHistory::apply(), SprayParcel::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(), MPPICParcel::trackingData::updateAverages(), KinematicParcel::trackingData::updateAverages(), PDRblock::writeBlockMeshDict(), decomposedBlockData::writeHeader(), and IOobject::writeHeaderContent().

Here is the caller graph for this function:

time()

const Foam::Time & time

(

)

const

Definition at line 486 of file IOobject.C.

References objectRegistry::time().

Referenced by objective::accumulateJMean(), fixedTemperatureConstraint::constrain(), distributedTriSurfaceMesh::distribute(), masterUncollatedFileOperation::exists(), masterUncollatedFileOperation::filePath(), uncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::filePathInfo(), fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), objective::isWithinIntegrationTime(), masterUncollatedFileOperation::localObjectPath(), simplifiedDynamicFvMeshBase::New(), engineMesh::New(), dynamicFvMesh::New(), fvMeshTools::newMesh(), collatedFileOperation::objectPath(), fileOperation::processorsCasePath(), sixDoFRigidBodyMotionSolver::solve(), 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

inlinenoexcept

Definition at line 58 of file IOobjectI.H.

Referenced by exprDriver::addContextObject(), snappyLayerDriver::addLayers(), exprResultGlobals::addValue(), collatedFileOperation::appendObject(), setsToFaceZone::applyToSet(), attachPolyTopoChanger::attach(), meshRefinement::balance(), 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(), displacementLaplacianFvMotionSolver::displacementLaplacianFvMotionSolver(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), removeRegisteredObject::execute(), fileOperation::exists(), masterUncollatedFileOperation::exists(), uncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::filePathInfo(), localPointRegion::findDuplicateFacePairs(), refinementSurfaces::findInside(), fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), coupleGroupIdentifier::findOtherPatchID(), genericPatchFieldBase::genericFatalSolveError(), GeometricField< scalar, faPatchField, areaMesh >::GeometricField(), exprResultGlobals::get(), exprResultGlobals::getNamespace(), IOobject::group(), hexRef8Data::hexRef8Data(), injectionModelList::info(), transferModelList::info(), dynamicRefineFvMesh::init(), readFields::loadAndStore(), fvExpressionField::loadAndStore(), Foam::loadPointField(), masterUncollatedFileOperation::localObjectPath(), objectRegistry::lookupClass(), mappedPatchBase::lookupMesh(), objectRegistry::lookupObjectPtr(), objectRegistry::lookupObjectRefPtr(), voxelMeshSearch::makeMesh(), Foam::MapConsistentSubMesh(), meshObject::movePoints(), baseIOdictionary::name(), fvMesh::name(), faMesh::name(), objectRegistry::namesImpl(), objectRegistry::namesTypeImpl(), simplifiedDynamicFvMeshBase::New(), dynamicFvMesh::New(), fvMeshTools::newMesh(), Foam::operator<<(), sampledPatch::patchIDs(), patchInjection::patchInjection(), PatchPostProcessing< CloudType >::PatchPostProcessing(), pointConstraints::pointConstraints(), pointMesh::pointMesh(), probes::prepare(), genericPatchFieldBase::processEntry(), rawIOField< Type >::rawIOField(), wallHeatFlux::read(), wallShearStress::read(), wallBoundedStreamLine::read(), masterUncollatedFileOperation::read(), decomposedBlockData::readBlocks(), uncollatedFileOperation::readStream(), masterUncollatedFileOperation::readStream(), polyMesh::readUpdate(), faFieldReconstructor::reconstructFaAreaField(), faFieldReconstructor::reconstructFaEdgeField(), pointFieldReconstructor::reconstructField(), fvFieldReconstructor::reconstructFvSurfaceField(), fvFieldReconstructor::reconstructFvVolumeField(), fvFieldReconstructor::reconstructFvVolumeInternalField(), triSurfaceMesh::regions(), IOobjectList::remove(), exprDriver::removeContextObject(), exprResultGlobals::removeValue(), genericPatchFieldBase::reportMissingEntry(), Time::run(), IOobject::selectIO(), refinementSurfaces::setMinLevelFields(), removeFaces::setRefinement(), solidBodyDisplacementLaplacianFvMotionSolver::solidBodyDisplacementLaplacianFvMotionSolver(), surfaceZonesInfo::surfaceZonesInfo(), surfMesh::surfMesh(), hexRef8Data::sync(), triSurfaceMesh::triSurfaceMesh(), MPPICParcel::trackingData::updateAverages(), KinematicParcel::trackingData::updateAverages(), mappedFlowRateFvPatchVectorField::updateCoeffs(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), humidityTemperatureCoupledMixedFvPatchScalarField::updateCoeffs(), topoBitSet::updateLabels(), topoBoolSet::updateLabels(), topoSet::updateLabels(), meshObject::updateMesh(), motionSmootherAlgo::updateMesh(), IOobject::warnNoRereading(), writeObjects::write(), ObukhovLength::write(), PDRblock::writeBlockMeshDict(), meshToMeshMethod::writeConnectivity(), boundaryRegion::writeDict(), cellTable::writeDict(), mappedPatchBase::writeDict(), fieldExtents::writeFileHeader(), decomposedBlockData::writeHeader(), IOobject::writeHeaderContent(), collatedFileOperation::writeObject(), and regionFunctionObject::writeObject().

headerClassName() [1/2]

Foam::word & headerClassName ( ) const

inlinenoexcept

Definition at line 76 of file IOobjectI.H.

Referenced by fieldToCell::applyToSet(), IOobjectList::classesImpl(), IOobjectList::countImpl(), fvExprDriver::evaluateVariable(), readFields::execute(), masterUncollatedFileOperation::filePathInfo(), fvExprDriver::foundField(), fvExprDriver::getTopoSetLabels(), decomposedBlockData::isCollatedType(), readFields::loadAndStore(), fvExpressionField::loadAndStore(), fvExpressionField::loadFields(), Foam::loadPointField(), masterUncollatedFileOperation::localObjectPath(), IOobjectList::lookupClassImpl(), IOobjectList::namesImpl(), polyMesh::polyMesh(), uncollatedFileOperation::read(), masterUncollatedFileOperation::read(), decomposedBlockData::readBlocks(), decomposedBlockData::readHeader(), uncollatedFileOperation::readHeader(), masterUncollatedFileOperation::readHeader(), Cloud< passivePositionParticle >::readStoreFile(), polyMesh::readUpdate(), fvExprDriver::topoSetType(), decomposedBlockData::writeData(), and Foam::writeMeshObject().

Here is the caller graph for this function:

headerClassName() [2/2]

word& headerClassName ( )

inlinenoexcept

note() [1/2]

Foam::string & note ( ) const

inlinenoexcept

Definition at line 88 of file IOobjectI.H.

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

Here is the caller graph for this function:

note() [2/2]

string& note ( )

inlinenoexcept

rename()

virtual void rename ( const word &  newName )

inlinevirtual

Reimplemented in objectRegistry, and regIOobject.

Definition at line 502 of file IOobject.H.

Referenced by nearWallFields::createFields(), searchableCone::findLine(), searchableCone::findLineAll(), searchableCone::findLineAny(), dynamicMotionSolverListFvMesh::init(), points0MotionSolver::points0IO(), decomposedBlockData::readBlocks(), regIOobject::rename(), faMeshReconstructor::writeAddressing(), and faMeshReconstructor::writeMesh().

Here is the caller graph for this function:

registerObject() [1/3]

bool registerObject ( ) const

inlinenoexcept

Definition at line 100 of file IOobjectI.H.

Referenced by Foam::loadPointField(), Foam::operator<<(), regIOobject::regIOobject(), IOobject::selectIO(), motionSolver::stealRegistration(), and blockMesh::topology().

Here is the caller graph for this function:

registerObject() [2/3]

bool registerObject ( bool  on )

inlinenoexcept

Definition at line 106 of file IOobjectI.H.

globalObject() [1/3]

bool globalObject ( ) const

inlinenoexcept

Definition at line 114 of file IOobjectI.H.

Referenced by Foam::operator<<(), uncollatedFileOperation::read(), masterUncollatedFileOperation::read(), and IOobject::selectIO().

Here is the caller graph for this function:

globalObject() [2/3]

bool globalObject ( bool  on )

inlinenoexcept

Definition at line 120 of file IOobjectI.H.

labelByteSize()

unsigned labelByteSize ( ) const

inlinenoexcept

Definition at line 128 of file IOobjectI.H.

scalarByteSize()

unsigned scalarByteSize ( ) const

inlinenoexcept

Definition at line 134 of file IOobjectI.H.

isHeaderClassName() [1/3]

bool isHeaderClassName ( const word &  clsName ) const

inline

Definition at line 142 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

inline

Definition at line 149 of file IOobjectI.H.

findMetaData()

const Foam::dictionary * findMetaData ( ) const

virtualnoexcept

Reimplemented in regIOobject.

Definition at line 26 of file IOobjectMetaData.C.

Referenced by decomposedBlockData::writeExtraHeaderContent(), and decomposedBlockData::writeHeader().

Here is the caller graph for this function:

readOpt() [1/3]

Foam::IOobject::readOption readOpt ( ) const

inlinenoexcept

Definition at line 157 of file IOobjectI.H.

Referenced by unwatchedIOdictionary::addWatch(), columnFvMesh::columnFvMesh(), CompactIOField::CompactIOField(), CompactIOList< face, label >::CompactIOList(), nearWallFields::createFields(), decomposedBlockData::decomposedBlockData(), extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), featureEdgeMesh::featureEdgeMesh(), fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), topoSet::findIOobject(), hexRef8::hexRef8(), dynamicMotionSolverListFvMesh::init(), dynamicMultiMotionSolverFvMesh::init(), IOField::IOField(), IOList< labelList >::IOList(), IOMap< T >::IOMap(), IOmapDistribute::IOmapDistribute(), IOmapDistributePolyMesh::IOmapDistributePolyMesh(), IOPtrList< Foam::entry >::IOPtrList(), voxelMeshSearch::makeMesh(), Foam::MapConsistentVolFields(), Foam::MapVolFields(), fvMeshTools::newMesh(), Foam::operator<<(), polyBoundaryMeshEntries::polyBoundaryMeshEntries(), radiativeIntensityRay::radiativeIntensityRay(), rawIOField< Type >::rawIOField(), 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/3]

Foam::IOobject::readOption readOpt ( readOption  opt )

inlinenoexcept

Definition at line 164 of file IOobjectI.H.

writeOpt() [1/3]

Foam::IOobject::writeOption writeOpt ( ) const

inlinenoexcept

Definition at line 172 of file IOobjectI.H.

Referenced by snappyLayerDriver::addLayers(), nearWallFields::createFields(), dynamicMotionSolverListFvMesh::init(), PDRblock::innerMesh(), objectRegistry::objectRegistry(), Foam::operator<<(), IOobject::selectIO(), surfMesh::setWriteOption(), and writeObjects::write().

Here is the caller graph for this function:

writeOpt() [2/3]

Foam::IOobject::writeOption writeOpt ( writeOption  opt )

inlinenoexcept

Definition at line 179 of file IOobjectI.H.

group() [2/2]

Foam::word group ( ) const

inline

Definition at line 64 of file IOobjectI.H.

References word::ext().

Here is the call graph for this function:

member() [2/2]

Foam::word member ( ) const

inline

Definition at line 70 of file IOobjectI.H.

References word::lessExt().

Referenced by kineticGasEvaporation< Thermo, OtherThermo >::Kexp(), and kineticGasEvaporation< Thermo, OtherThermo >::kineticGasEvaporation().

Here is the call graph for this function:

Here is the caller graph for this function:

rootPath()

const Foam::fileName & rootPath

(

)

const

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

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

Here is the caller graph for this function:

instance() [1/2]

Foam::fileName & instance ( ) const

inlinenoexcept

Definition at line 189 of file IOobjectI.H.

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

Here is the caller graph for this function:

instance() [2/2]

fileName& instance ( )

inlinenoexcept

local()

const Foam::fileName & local ( ) const

inlinenoexcept

Definition at line 201 of file IOobjectI.H.

Referenced by masterUncollatedFileOperation::dirPath(), masterUncollatedFileOperation::filePath(), uncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::filePathInfo(), fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), Foam::loadPointField(), masterUncollatedFileOperation::localObjectPath(), Foam::operator<<(), fileOperation::processorsPath(), Foam::readFields(), Foam::readUniformFields(), surfMesh::surfMesh(), PDRblock::writeBlockMeshDict(), decomposedBlockData::writeHeader(), and IOobject::writeHeaderContent().

Here is the caller graph for this function:

path() [1/2]

Foam::fileName path

(

)

const

Definition at line 504 of file IOobject.C.

Referenced by searchableSurfaces::checkIntersection(), uncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::localObjectPath(), Foam::operator<<(), fileOperation::readObjects(), topoSet::removeFiles(), refinementHistory::removeFiles(), hexRef8::removeFiles(), meshRefinement::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

Definition at line 528 of file IOobject.C.

objectPath()

Foam::fileName objectPath ( ) const

inline

Definition at line 207 of file IOobjectI.H.

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

Referenced by collatedFileOperation::appendObject(), surfaceFormatsCore::checkFile(), hexRef8::consistentSlowRefinement2(), uncollatedFileOperation::dirPath(), masterUncollatedFileOperation::dirPath(), fileOperation::exists(), masterUncollatedFileOperation::exists(), uncollatedFileOperation::filePath(), masterUncollatedFileOperation::filePath(), uncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::findInstance(), genericPatchFieldBase::genericFatalSolveError(), hexRef8::hexRef8(), meshRefinement::mergeEdgesUndo(), meshRefinement::mergePatchFacesUndo(), fileOperation::objectPath(), genericPatchFieldBase::processEntry(), collatedFileOperation::processorsDir(), rawIOField< Type >::rawIOField(), uncollatedFileOperation::read(), masterUncollatedFileOperation::read(), uncollatedFileOperation::readHeader(), masterUncollatedFileOperation::readHeader(), uncollatedFileOperation::readObjects(), fileOperation::readObjects(), masterUncollatedFileOperation::readObjects(), uncollatedFileOperation::readStream(), masterUncollatedFileOperation::readStream(), processorMeshes::removeFiles(), genericPatchFieldBase::reportMissingEntry(), hexRef8::setRefinement(), hexRef8::setUnrefinement(), surfZoneIOList::surfZoneIOList(), syncObjects::sync(), triSurfaceMesh::triSurfaceMesh(), trackingInverseDistance::update(), PDRblock::writeBlockMeshDict(), 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:

objectRelPath()

Foam::fileName objectRelPath

(

)

const

Definition at line 538 of file IOobject.C.

References Foam::name().

Here is the call graph for this function:

localFilePath()

Foam::fileName localFilePath	(	const word &	typeName,
		const bool	search = true
	)		const

Definition at line 562 of file IOobject.C.

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

Referenced by surfaceFormatsCore::checkFile(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), localIOdictionary::filePath(), distributedTriSurfaceMesh::filePath(), surfaceFormatsCore::findFile(), 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

Definition at line 573 of file IOobject.C.

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

Referenced by surfaceFormatsCore::checkFile(), GlobalIOList< kinematicParcelInjectionData >::filePath(), featureEdgeMesh::filePath(), GlobalIOField< vector >::filePath(), IOMap< T >::filePath(), IOdictionary::filePath(), unwatchedIOdictionary::filePath(), UniformDimensionedField< vector >::filePath(), extendedFeatureEdgeMesh::filePath(), searchableSurface::filePath(), porosityModel::filePath(), triSurfaceMesh::filePath(), surfaceFormatsCore::findFile(), 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:

parseHeader()

Foam::IOstreamOption parseHeader

(

const dictionary &

headerDict

)

Definition at line 28 of file IOobjectReadHeader.C.

References IOstreamOption::format(), dictionary::get(), Foam::foamVersion::labelByteSize(), dictionary::readIfPresent(), Foam::foamVersion::scalarByteSize(), and IOstreamOption::version().

Here is the call graph for this function:

readHeader() [1/2]

bool readHeader

(

Istream &

is

)

Definition at line 158 of file IOobjectReadHeader.C.

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

Here is the caller graph for this function:

readHeader() [2/2]

bool readHeader	(	dictionary &	headerDict,
		Istream &	is
	)

Definition at line 66 of file IOobjectReadHeader.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, IOstreamOption::format(), IOstream::good(), Foam::Info, InfoInFunction, IOWarningInFunction, token::isWord(), IOstream::lineNumber(), Foam::name(), IOstream::name(), Foam::nl, dictionary::read(), IOstream::relativeName(), SeriousIOErrorInFunction, IOstream::setLabelByteSize(), IOstream::setScalarByteSize(), IOstreamOption::version(), and Foam::writeHeader().

Here is the call graph for this function:

typeHeaderOk()

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

Definition at line 32 of file IOobjectTemplates.C.

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

Referenced by fieldToCell::applyToSet(), basicMultiComponentMixture::basicMultiComponentMixture(), boundaryRadiationProperties::boundaryRadiationProperties(), cellVolumeWeight::cellVolumeWeight(), fvMeshTools::createDummyFvMeshFiles(), displacementLaplacianFvMotionSolver::displacementLaplacianFvMotionSolver(), readFields::execute(), fileOperation::exists(), topoSet::findIOobject(), hexRef8::hexRef8(), hexRef8Data::hexRef8Data(), inverseDistance::inverseDistance(), fvExpressionField::loadFields(), Foam::MapConsistentVolFields(), Foam::MapVolFields(), combustionModel::New(), simplifiedDynamicFvMeshBase::New(), surfaceFilmModel::New(), dynamicFvMesh::New(), radiationModel::New(), PatchCollisionDensity< CloudType >::PatchCollisionDensity(), phaseModel::phaseModel(), points0MotionSolver::points0IO(), Foam::preservePatchTypes(), pyrolysisChemistryModel< CompType, SolidThermo, GasThermo >::pyrolysisChemistryModel(), radiativeIntensityRay::radiativeIntensityRay(), extendedEdgeMeshFormat::read(), edgeMeshFormat::read(), particle< Type >::readFields(), lagrangianReconstructor::reconstructField(), lagrangianReconstructor::reconstructFieldField(), variablesSet::renameTurbulenceField(), fieldAverage::restoreWindowFieldsType(), globalMeshData::sharedPointGlobalLabels(), sensitivitySurface::smoothSensitivities(), solidBodyDisplacementLaplacianFvMotionSolver::solidBodyDisplacementLaplacianFvMotionSolver(), stabilityBlendingFactor::stabilityBlendingFactor(), TDACChemistryModel< CompType, ThermoType >::TDACChemistryModel(), uniformInterpolatedDisplacementPointPatchVectorField::uniformInterpolatedDisplacementPointPatchVectorField(), lagrangianWriter::writeFields(), Foam::writeMeshObject(), and writer::writeSolution().

Here is the call graph for this function:

Here is the caller graph for this function:

warnNoRereading()

void warnNoRereading

Definition at line 81 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, const bool  noSyntaxHint = false  )

static

Definition at line 69 of file IOobjectWriteHeader.C.

References Foam::foamVersion::api, and os().

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

Here is the call graph for this function:

Here is the caller graph for this function:

writeDivider()

Foam::Ostream & writeDivider ( Ostream &  os )

static

Definition at line 125 of file IOobjectWriteHeader.C.

References os().

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

Here is the call graph for this function:

Here is the caller graph for this function:

writeEndDivider()

Foam::Ostream & writeEndDivider ( Ostream &  os )

static

Definition at line 135 of file IOobjectWriteHeader.C.

References os().

Referenced by PDRblock::writeBlockMeshDict(), decomposedBlockData::writeData(), collatedFileOperation::writeObject(), fileOperation::writeObject(), and masterUncollatedFileOperation::writeObject().

Here is the call graph for this function:

Here is the caller graph for this function:

writeHeader() [1/4]

bool writeHeader

(

Ostream &

os

)

const

Definition at line 270 of file IOobjectWriteHeader.C.

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

Referenced by PDRblock::blockMeshDict(), edgeMeshFormat::write(), interpolationLookUpTable< Type >::write(), decomposedBlockData::writeBlockEntry(), PDRblock::writeBlockMeshDict(), boundaryRegion::writeDict(), cellTable::writeDict(), IOobject::writeHeader(), 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/4]

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

Definition at line 229 of file IOobjectWriteHeader.C.

References IOobject::bannerEnabled(), Ostream::beginBlock(), Ostream::endBlock(), Foam::endl(), IOstream::good(), IOstream::info(), InfoInFunction, Foam::nl, os(), IOobject::writeBanner(), IOobject::writeDivider(), and IOobject::writeHeaderContent().

Here is the call graph for this function:

writeHeader() [3/4]

void writeHeader	(	dictionary &	dict,
		IOstreamOption	streamOpt
	)		const

Definition at line 295 of file IOobjectWriteHeader.C.

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

Here is the call graph for this function:

writeHeader() [4/4]

void writeHeader	(	dictionary &	dict,
		const word &	objectType,
		IOstreamOption	streamOpt
	)		const

Definition at line 277 of file IOobjectWriteHeader.C.

References dict, and IOobject::writeHeaderContent().

Here is the call graph for this function:

good()

bool good ( ) const

inlinenoexcept

Definition at line 215 of file IOobjectI.H.

Referenced by topoSet::topoSet().

Here is the caller graph for this function:

bad()

bool bad ( ) const

inlinenoexcept

Definition at line 221 of file IOobjectI.H.

info()

InfoProxy<IOobject> info ( ) const

inline

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

Referenced by regIOobject::operator=().

Here is the caller graph for this function:

readOpt() [3/3]

readOption& readOpt ( )

inlinenoexcept

Definition at line 700 of file IOobject.H.

writeOpt() [3/3]

writeOption& writeOpt ( )

inlinenoexcept

Definition at line 704 of file IOobject.H.

registerObject() [3/3]

bool& registerObject ( )

inlinenoexcept

Definition at line 708 of file IOobject.H.

globalObject() [3/3]

bool& globalObject ( )

inlinenoexcept

Definition at line 712 of file IOobject.H.

isHeaderClassName() [3/3]

bool isHeaderClassName ( ) const

inline

Definition at line 720 of file IOobject.H.

groupName() [2/2]

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

inline

Definition at line 25 of file IOobjectI.H.

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

Member Data Documentation

fileCheckTypesNames

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

static

Definition at line 204 of file IOobject.H.

Referenced by argList::parse().

scopeSeparator

char scopeSeparator

static

Definition at line 296 of file IOobject.H.

Referenced by dsmcFields::write().

fileModificationChecking

Foam::IOobject::fileCheckTypes fileModificationChecking

static

Definition at line 299 of file IOobject.H.

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

fileModificationSkew

float fileModificationSkew

static

Definition at line 302 of file IOobject.H.

Referenced by argList::parse().

maxFileModificationPolls

int maxFileModificationPolls

static

Definition at line 305 of file IOobject.H.

Referenced by argList::parse().

---

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/IOobjectMetaData.C
• src/OpenFOAM/db/IOobject/IOobjectReadHeader.C
• src/OpenFOAM/db/IOobject/IOobjectTemplates.C
• src/OpenFOAM/db/IOobject/IOobjectWriteHeader.C