IOobject Class Reference

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

Inheritance diagram for IOobject:

Collaboration diagram for IOobject:

Public Types
enum	objectState { GOOD, BAD }
	Enumeration defining the valid states of an IOobject. More...
enum	readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
	Enumeration defining the read options. More...
enum	writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
	Enumeration defining the write options. More...

Public Member Functions
	TypeName ("IOobject")
	Runtime type information. More...
	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, registry, io options. More...
	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, local, registry, io options. More...
	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from path, registry, io options. More...
	IOobject (const IOobject &io, const word &name)
	Construct as copy resetting name. More...
Foam::autoPtr< IOobject >	clone () const
	Clone. More...
virtual	~IOobject ()
	Destructor. More...
const Time &	time () const
	Return time. More...
const objectRegistry &	db () const
	Return the local objectRegistry. More...
const word &	name () const
	Return name. More...
const word &	headerClassName () const
	Return name of the class name read from header. More...
string &	note ()
	Return non-constant access to the optional note. More...
const string &	note () const
	Return the optional note. More...
virtual void	rename (const word &newName)
	Rename. More...
bool &	registerObject ()
	Register object created from this IOobject with registry if true. More...
bool	registerObject () const
	Register object created from this IOobject with registry if true. More...
readOption	readOpt () const
readOption &	readOpt ()
writeOption	writeOpt () const
writeOption &	writeOpt ()
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
	Return complete path. More...
fileName	path (const word &instance, const fileName &local="") const
	Return complete path with alternative instance and local. More...
fileName	objectPath () const
	Return complete path + object name. More...
fileName	filePath () const
	Return complete path + object name if the file exists. More...
bool	readHeader (Istream &)
	Read header. More...
bool	headerOk ()
	Read and check header info. More...
bool	writeHeader (Ostream &) const
	Write header. More...
bool	writeHeader (Ostream &, const word &objectType) const
	Write header. Allow override of type. More...
bool	good () const
bool	bad () const
InfoProxy< IOobject >	info () const
	Return info proxy. More...
void	operator= (const IOobject &)
template<class Name >
Foam::word	groupName (Name name, const word &group)

Static Public Member Functions
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...
template<class Name >
static word	groupName (Name name, const word &group)
template<class Stream >
static Stream &	writeBanner (Stream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...
template<class Stream >
static Stream &	writeDivider (Stream &os)
	Write the standard file section divider. More...
template<class Stream >
static Stream &	writeEndDivider (Stream &os)
	Write the standard end file divider. More...
static void	replaceFileName (const word &from, const word &to)

Protected Member Functions
Istream *	objectStream ()
	Construct and return an IFstream for the object. More...
Istream *	objectStream (const fileName &)
	Construct and return an IFstream for the object given the. More...
void	setBad (const string &)
	Set the object state to bad. More...

Private Member Functions
const word &	uniqueFileName () const
	Unique on disk file name. More...

Private Attributes
word	name_
	Name. More...
word	headerClassName_
	Class name read from header. More...
string	note_
	Optional note. More...
fileName	instance_
	Instance path component. More...
fileName	local_
	Local path component. More...
const objectRegistry &	db_
	objectRegistry reference More...
readOption	rOpt_
	Read option. More...
writeOption	wOpt_
	Write option. More...
bool	registerObject_
	Register object created from this IOobject with registry if true. More...
objectState	objState_
	IOobject state. More...

Detailed Description

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

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

Read options

Define what is done on object construction and explicit reads:

Parameters

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:

Parameters

AUTO_WRITE	Object is written automatically when requested to by the objectRegistry.
NO_WRITE	No automatic write on destruction but can be written explicitly

Source files

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

Definition at line 91 of file IOobject.H.

Member Enumeration Documentation

objectState

enum objectState

Enumeration defining the valid states of an IOobject.

Enumerator
GOOD
BAD

Definition at line 99 of file IOobject.H.

readOption

enum readOption

Enumeration defining the read options.

Enumerator
MUST_READ
MUST_READ_IF_MODIFIED
READ_IF_PRESENT
NO_READ

Definition at line 106 of file IOobject.H.

writeOption

enum writeOption

Enumeration defining the write options.

Enumerator
AUTO_WRITE
NO_WRITE

Definition at line 115 of file IOobject.H.

Constructor & Destructor Documentation

IOobject() [1/4]

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

References Foam::endl(), and Foam::Info.

Referenced by IOobject::clone(), and displacementMotionSolver::points0IO().

Here is the call graph for this function:

Here is the caller graph for this function:

IOobject() [2/4]

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

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

Definition at line 146 of file IOobject.C.

References Foam::endl(), and Foam::Info.

Here is the call graph for this function:

IOobject() [3/4]

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

Construct from path, registry, io options.

Uses fileNameComponents() to split path into components.

Definition at line 177 of file IOobject.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, and path().

Here is the call graph for this function:

IOobject() [4/4]

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

Construct as copy resetting name.

Definition at line 213 of file IOobject.C.

~IOobject()

~IOobject ( )

virtual

Destructor.

Definition at line 233 of file IOobject.C.

Member Function Documentation

uniqueFileName()

const Foam::word & uniqueFileName ( ) const

private

Unique on disk file name.

Definition at line 324 of file IOobject.C.

References Foam::name(), and replacedFileNames_.

Referenced by IOobject::objectPath().

Here is the call graph for this function:

Here is the caller graph for this function:

objectStream() [1/2]

Foam::Istream * objectStream ( )

protected

Construct and return an IFstream for the object.

The results is NULL if the stream construction failed

Definition at line 410 of file IOobject.C.

Referenced by regIOobject::readStream().

Here is the caller graph for this function:

objectStream() [2/2]

Foam::Istream * objectStream ( const fileName &  fName )

protected

Construct and return an IFstream for the object given the.

exact file. The results is NULL if the stream construction failed

Definition at line 416 of file IOobject.C.

References IOstream::good().

Here is the call graph for this function:

setBad()

void setBad ( const string &  s )

protected

Set the object state to bad.

Definition at line 480 of file IOobject.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, 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.

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

Definition at line 43 of file IOobject.C.

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

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

groupName() [1/2]

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

inlinestatic

Referenced by nutkWallFunctionFvPatchScalarField::calcNut(), nutUWallFunctionFvPatchScalarField::calcNut(), nutkFilmWallFunctionFvPatchScalarField::calcNut(), nutUSpaldingWallFunctionFvPatchScalarField::calcNut(), nutUTabulatedWallFunctionFvPatchScalarField::calcNut(), nutkRoughWallFunctionFvPatchScalarField::calcNut(), nutURoughWallFunctionFvPatchScalarField::calcNut(), nutkAtmRoughWallFunctionFvPatchScalarField::calcNut(), FSD< CombThermoType, ThermoType >::calculateSourceNorm(), nutkFilmWallFunctionFvPatchScalarField::calcUTau(), nutUSpaldingWallFunctionFvPatchScalarField::calcUTau(), nutUWallFunctionFvPatchScalarField::calcYPlus(), nutURoughWallFunctionFvPatchScalarField::calcYPlus(), DarcyForchheimer::correct(), singleStepCombustion< CombThermoType, ThermoType >::dQ(), LESeddyViscosity< BasicTurbulenceModel >::epsilon(), kEqn< BasicTurbulenceModel >::epsilon(), DeardorffDiffStress< BasicTurbulenceModel >::epsilon(), WALE< BasicTurbulenceModel >::epsilon(), Smagorinsky< BasicTurbulenceModel >::epsilon(), dynamicKEqn< BasicTurbulenceModel >::epsilon(), SmagorinskyZhang< BasicTurbulenceModel >::gasTurbulence(), NicenoKEqn< BasicTurbulenceModel >::gasTurbulence(), LaheyKEpsilon< BasicTurbulenceModel >::gasTurbulence(), kOmegaSSTSato< BasicTurbulenceModel >::gasTurbulence(), WALE< BasicTurbulenceModel >::k(), Smagorinsky< BasicTurbulenceModel >::k(), BrownianMotionForce< CloudType >::kModel(), mixtureKEpsilon< BasicTurbulenceModel >::liquidTurbulence(), continuousGasKEqn< BasicTurbulenceModel >::liquidTurbulence(), continuousGasKEpsilon< BasicTurbulenceModel >::liquidTurbulence(), continuousGasKEpsilon< BasicTurbulenceModel >::nuEff(), LESModel< BasicTurbulenceModel >::nuEff(), RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >::nuEff(), basicThermo::phasePropertyName(), continuousGasKEpsilon< BasicTurbulenceModel >::R(), continuousGasKEpsilon< BasicTurbulenceModel >::rhoEff(), combustionModel::Sh(), fixedShearStressFvPatchVectorField::updateCoeffs(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), alphatWallFunctionFvPatchScalarField::updateCoeffs(), fWallFunctionFvPatchScalarField::updateCoeffs(), v2WallFunctionFvPatchScalarField::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), convectiveHeatTransferFvPatchScalarField::updateCoeffs(), wallHeatTransferFvPatchScalarField::updateCoeffs(), alphatFilmWallFunctionFvPatchScalarField::updateCoeffs(), turbulentMixingLengthDissipationRateInletFvPatchScalarField::updateCoeffs(), turbulentMixingLengthFrequencyInletFvPatchScalarField::updateCoeffs(), alphatJayatillekeWallFunctionFvPatchScalarField::updateCoeffs(), turbulentHeatFluxTemperatureFvPatchScalarField::updateCoeffs(), porousBafflePressureFvPatchField< Type >::updateCoeffs(), epsilonWallFunctionFvPatchScalarField::updateCoeffs(), omegaWallFunctionFvPatchScalarField::updateCoeffs(), basicSpecieMixture::W(), externalCoupledTemperatureMixedFvPatchScalarField::writeData(), nutkWallFunctionFvPatchScalarField::yPlus(), nutLowReWallFunctionFvPatchScalarField::yPlus(), nutUWallFunctionFvPatchScalarField::yPlus(), nutkFilmWallFunctionFvPatchScalarField::yPlus(), nutUSpaldingWallFunctionFvPatchScalarField::yPlus(), nutUTabulatedWallFunctionFvPatchScalarField::yPlus(), and nutURoughWallFunctionFvPatchScalarField::yPlus().

clone()

Foam::autoPtr<IOobject> clone ( ) const

inline

Clone.

Definition at line 252 of file IOobject.H.

References IOobject::IOobject().

Referenced by singleCellFvMesh::agglomerateMesh(), attachPolyTopoChanger::attach(), main(), polyTopoChange::makeMesh(), fvMeshTools::newMesh(), searchableSurface::iNew::operator()(), searchableSurfaces::searchableSurfaces(), fvMeshSubset::setCellSubset(), and fvMeshSubset::setLargeCellSubset().

Here is the call graph for this function:

Here is the caller graph for this function:

time()

const Foam::Time & time

(

)

const

Return time.

Definition at line 245 of file IOobject.C.

References objectRegistry::time().

Referenced by displacementInterpolationMotionSolver::calcInterpolation(), fixedTemperatureConstraint::constrain(), wallDist::constructn(), blockMesh::createTopology(), distributedTriSurfaceMesh::distribute(), distributedTriSurfaceMesh::independentlyDistributedBbs(), fvMeshSubset::interpolate(), codeStream::libs(), Foam::loadOrCreateMesh(), Foam::mergeAndWrite(), multiSolidBodyMotionFvMesh::multiSolidBodyMotionFvMesh(), engineMesh::New(), dynamicFvMesh::New(), fvMeshTools::newMesh(), regIOobject::readStream(), uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs(), regIOobject::write(), and triSurfaceMesh::writeObject().

Here is the call graph for this function:

Here is the caller graph for this function:

db()

const Foam::objectRegistry & db

(

)

const

Return the local objectRegistry.

Definition at line 239 of file IOobject.C.

Referenced by refinementHistory::add(), refinementHistory::apply(), hexRef8Data::hexRef8Data(), Foam::loadOrCreateMesh(), Foam::mergeAndWrite(), engineMesh::New(), dynamicFvMesh::New(), fvMeshTools::newMesh(), searchableSurfaceCollection::searchableSurfaceCollection(), searchableSurfaceWithGaps::searchableSurfaceWithGaps(), decompositionModel::selectIO(), motionSmootherAlgo::setDisplacement(), subTriSurfaceMesh::subset(), surfMesh::surfMesh(), hexRef8Data::sync(), MPPICParcel::TrackingData< CloudType >::updateAverages(), and IOobject::writeHeader().

Here is the caller graph for this function:

name()

const word& name ( ) const

inline

Return name.

Definition at line 273 of file IOobject.H.

References IOobject::name_.

Referenced by IOobjectList::add(), autoLayerDriver::addLayers(), faceZoneSet::addSet(), setsToFaceZone::applyToSet(), attachPolyTopoChanger::attach(), linearValveLayersFvMesh::attached(), linearValveFvMesh::attached(), meshRefinement::balance(), polyDualMesh::calcDual(), mappedPatchBase::calcMapping(), meshToMesh::calculate(), motionSmootherAlgo::checkConstraints(), polyBoundaryMesh::checkDefinition(), shellSurfaces::checkGapLevels(), Foam::checkGeometry(), objectRegistry::checkIn(), Foam::checkMeshQuality(), objectRegistry::checkOut(), polyBoundaryMesh::checkParallelSync(), faceZone::checkParallelSync(), Foam::checkTopology(), meshObject::clear(), meshObject::clearUpto(), polyMeshFilter::copySets(), createDummyFvMeshFiles(), IOporosityModelList::createIOobject(), options::createIOobject(), IOMRFZoneList::createIOobject(), lagrangianFieldDecomposer::decomposeField(), lagrangianFieldDecomposer::decomposeFieldField(), faceZoneSet::deleteSet(), displacementLaplacianFvMotionSolver::displacementLaplacianFvMotionSolver(), doCommand(), dynamicRefineFvMesh::dynamicRefineFvMesh(), removeRegisteredObject::execute(), coupleGroupIdentifier::findOtherPatchID(), meshRefinement::getChangedFaces(), IOobject::groupName(), polyBoundaryMesh::groupPatchIDs(), hexRef8Data::hexRef8Data(), injectionModelList::info(), contactAngleForce::initialise(), IOmapDistribute::IOmapDistribute(), Foam::loadOrCreateMesh(), main(), Foam::MapConsistentSubMesh(), meshRefinement::markSmallFeatureRefinement(), Foam::mergeAndWrite(), meshObject::movePoints(), IOdictionary::name(), cyclicAMIPolyPatch::neighbPatchName(), dynamicFvMesh::New(), fvMeshTools::newMesh(), Foam::operator<<(), patchInjection::patchInjection(), PatchPostProcessing< CloudType >::PatchPostProcessing(), pointConstraints::pointConstraints(), pointMesh::pointMesh(), printAllSets(), autoLayerDriver::printLayerData(), refinementFeatures::read(), wallShearStress::read(), wallBoundedStreamLine::read(), IOobject::readHeader(), regIOobject::readStream(), pointFieldReconstructor::reconstructField(), fvFieldReconstructor::reconstructFvSurfaceField(), fvFieldReconstructor::reconstructFvVolumeField(), fvFieldReconstructor::reconstructFvVolumeInternalField(), parLagrangianRedistributor::redistributeStoredLagrangianFields(), IOobjectList::remove(), shellSurfaces::setAndCheckLevels(), refinementSurfaces::setMinLevelFields(), MRFZone::setMRFFaces(), removeFaces::setRefinement(), faceZoneSet::subset(), surfMesh::surfMesh(), triSurfaceMesh::triSurfaceMesh(), autoLayerDriver::truncateDisplacement(), MPPICParcel::TrackingData< CloudType >::updateAverages(), mappedFlowRateFvPatchVectorField::updateCoeffs(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), turbulentBoundaryCoupledFvPatchScalarField::updateCoeffs(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::updateCoeffs(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::updateCoeffs(), humidityTemperatureCoupledMixedFvPatchScalarField::updateCoeffs(), topoSet::updateLabels(), meshObject::updateMesh(), OutputFilterFunctionObject< OutputFilter >::updateMesh(), calcMag::write(), writeRegisteredObject::write(), calcFvcDiv::write(), calcFvcGrad::write(), fieldCoordinateSystemTransform::write(), addSubtract::writeAddSubtractField(), addSubtract::writeAddSubtractValue(), components::writeComponentFields(), meshToMeshMethod::writeConnectivity(), domainDecomposition::writeDecomposition(), boundaryRegion::writeDict(), cellTable::writeDict(), div::writeDivField(), Foam::writeFaceSet(), IOobject::writeHeader(), meshReader::writeInterfaces(), interpolate::writeInterpolateField(), autoLayerDriver::writeLayerSets(), mag::writeMagField(), magGrad::writeMagGradField(), magSqr::writeMagSqrField(), meshReader::writeMeshLabelList(), randomise::writeRandomField(), and writeVTK().

headerClassName()

const word& headerClassName ( ) const

inline

Return name of the class name read from header.

Definition at line 279 of file IOobject.H.

References IOobject::headerClassName_.

Referenced by fieldToCell::applyToSet(), mag::calc(), magSqr::calc(), interpolate::calc(), components::calc(), magGrad::calc(), randomise::calc(), div::calc(), readFields::loadField(), main(), IOdictionary::readFile(), regIOobject::readStream(), fieldCoordinateSystemTransform::transform(), addSubtract::writeAddSubtractField(), addSubtract::writeAddSubtractFields(), addSubtract::writeAddSubtractValue(), addSubtract::writeAddSubtractValues(), components::writeComponentFields(), div::writeDivField(), interpolate::writeInterpolateField(), mag::writeMagField(), magGrad::writeMagGradField(), magSqr::writeMagSqrField(), Foam::writeMeshObject(), and randomise::writeRandomField().

Here is the caller graph for this function:

note() [1/2]

string& note ( )

inline

Return non-constant access to the optional note.

Definition at line 285 of file IOobject.H.

References IOobject::note_.

Referenced by polyMesh::initMesh(), IOdictionary::readFile(), edgeMeshFormat::write(), boundaryRegion::writeDict(), cellTable::writeDict(), IOobject::writeHeader(), meshReader::writeInterfaces(), and meshReader::writeMeshLabelList().

Here is the caller graph for this function:

note() [2/2]

const string& note ( ) const

inline

Return the optional note.

Definition at line 291 of file IOobject.H.

References IOobject::note_.

rename()

virtual void rename ( const word &  newName )

inlinevirtual

Rename.

Reimplemented in regIOobject, and objectRegistry.

Definition at line 297 of file IOobject.H.

References IOobject::name_.

Referenced by nearWallFields::createFields(), searchableCone::findLine(), searchableCone::findLineAll(), searchableCone::findLineAny(), hexRef8Data::hexRef8Data(), regIOobject::rename(), and hexRef8Data::sync().

Here is the caller graph for this function:

registerObject() [1/2]

bool& registerObject ( )

inline

Register object created from this IOobject with registry if true.

Definition at line 303 of file IOobject.H.

References IOobject::registerObject_.

Referenced by regIOobject::regIOobject(), decompositionModel::selectIO(), and motionSolver::stealRegistration().

Here is the caller graph for this function:

registerObject() [2/2]

bool registerObject ( ) const

inline

Register object created from this IOobject with registry if true.

Definition at line 309 of file IOobject.H.

References IOobject::registerObject_.

readOpt() [1/2]

readOption readOpt ( ) const

inline

Definition at line 317 of file IOobject.H.

References IOobject::rOpt_.

Referenced by AverageIOField< Type >::AverageIOField(), boundaryRadiationProperties::boundaryRadiationProperties(), vtkPV4Foam::convertDimFields(), nearWallFields::createFields(), IOporosityModelList::createIOobject(), options::createIOobject(), boundaryRadiationProperties::createIOobject(), IOMRFZoneList::createIOobject(), radiationModel::createIOobject(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), featureEdgeMesh::featureEdgeMesh(), fvSchemes::fvSchemes(), hexRef8::hexRef8(), hexRef8Data::hexRef8Data(), IOdictionary::IOdictionary(), IODynList< T, IndexType >::IODynList(), IOField< vector >::IOField(), IOList< labelList >::IOList(), IOLongList< T, Offset >::IOLongList(), IOMap< T >::IOMap(), IOmapDistribute::IOmapDistribute(), IOmapDistributePolyMesh::IOmapDistributePolyMesh(), IOPtrList< Foam::entry >::IOPtrList(), Foam::loadOrCreateMesh(), polyTopoChange::makeMesh(), Foam::MapConsistentVolFields(), Foam::MapVolFields(), fvMeshTools::newMesh(), radiativeIntensityRay::radiativeIntensityRay(), polyTopoChanger::readModifiers(), regIOobject::readStream(), refinementHistory::refinementHistory(), decompositionModel::selectIO(), hexRef8Data::sync(), topoSet::topoSet(), and UniformDimensionedField< vector >::UniformDimensionedField().

Here is the caller graph for this function:

readOpt() [2/2]

readOption& readOpt ( )

inline

Definition at line 322 of file IOobject.H.

References IOobject::rOpt_.

writeOpt() [1/2]

writeOption writeOpt ( ) const

inline

Definition at line 327 of file IOobject.H.

References IOobject::wOpt_.

Referenced by autoLayerDriver::addLayers(), linearValveFvMesh::addZonesAndModifiers(), mixerFvMesh::addZonesAndModifiers(), nearWallFields::createFields(), readFields(), decompositionModel::selectIO(), surfMesh::setInstance(), polyMesh::setInstance(), and writeRegisteredObject::write().

Here is the caller graph for this function:

writeOpt() [2/2]

writeOption& writeOpt ( )

inline

Definition at line 332 of file IOobject.H.

References IOobject::wOpt_.

group()

Foam::word group

(

)

const

Return group (extension part of name)

Definition at line 257 of file IOobject.C.

References word::null.

Referenced by IOobject::groupName().

Here is the caller graph for this function:

member()

Foam::word member

(

)

const

Return member (name without the extension)

Definition at line 272 of file IOobject.C.

rootPath()

const Foam::fileName & rootPath

(

)

const

Definition at line 287 of file IOobject.C.

caseName()

const Foam::fileName & caseName

(

)

const

Definition at line 251 of file IOobject.C.

References fileName::caseName().

Here is the call graph for this function:

instance() [1/2]

const fileName& instance ( ) const

inline

Definition at line 350 of file IOobject.H.

References IOobject::instance_.

Referenced by autoLayerDriver::addLayers(), Foam::checkGeometry(), Foam::checkMeshQuality(), Foam::checkTopology(), options::createIOobject(), autoRefineDriver::danglingCellRefine(), doCommand(), meshRefinement::findEdgeConnectedProblemCells(), meshRefinement::handleSnapProblems(), Foam::loadOrCreateMesh(), main(), volPointInterpolation::makeWeights(), meshRefinement::markFacesOnProblemCells(), meshRefinement::mergeEdgesUndo(), meshRefinement::mergePatchFacesUndo(), triSurfaceMesh::movePoints(), fvMeshTools::newMesh(), displacementMotionSolver::points0IO(), meshReader::polyBoundaryPatches(), autoRefineDriver::refinementInterfaceRefine(), surfMesh::setInstance(), polyMesh::setInstance(), surfMesh::surfMesh(), IOobject::writeHeader(), autoLayerDriver::writeLayerSets(), regIOobject::writeObject(), triSurfaceMesh::writeObject(), and distributedTriSurfaceMesh::writeObject().

Here is the caller graph for this function:

instance() [2/2]

fileName& instance ( )

inline

Definition at line 355 of file IOobject.H.

References IOobject::instance_.

local()

const fileName& local ( ) const

inline

Definition at line 360 of file IOobject.H.

References IOobject::local_.

Referenced by doCommand(), surfMesh::surfMesh(), and IOobject::writeHeader().

Here is the caller graph for this function:

path() [1/2]

Foam::fileName path

(

)

const

Return complete path.

Definition at line 293 of file IOobject.C.

Referenced by searchableSurfaces::checkIntersection(), sampledIsoSurface::getIsoFields(), IOobjectList::IOobjectList(), main(), IOobject::objectPath(), Foam::operator<<(), motionSmootherAlgo::setDisplacement(), surfMesh::surfMesh(), boundaryDataSurfaceWriter::write(), Time::writeObject(), and boundaryDataSurfaceWriter::writeTemplate().

Here is the caller graph for this function:

path() [2/2]

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

Return complete path with alternative instance and local.

Definition at line 307 of file IOobject.C.

objectPath()

fileName objectPath ( ) const

inline

Return complete path + object name.

Definition at line 376 of file IOobject.H.

References IOobject::path(), and IOobject::uniqueFileName().

Referenced by timeVaryingMappedFixedValuePointPatchField< Type >::checkTable(), timeVaryingMappedFixedValueFvPatchField< Type >::checkTable(), hexRef8::consistentSlowRefinement2(), createDummyFvMeshFiles(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), findBaffles(), meshRefinement::findEdgeConnectedProblemCells(), STARCD::getCellTable(), meshRefinement::handleSnapProblems(), hexRef8::hexRef8(), IOdictionary::IOdictionary(), main(), meshRefinement::markFacesOnProblemCells(), meshRefinement::mergeEdgesUndo(), meshRefinement::mergePatchFacesUndo(), multiSolidBodyMotionFvMesh::multiSolidBodyMotionFvMesh(), polyMesh::polyMesh(), refinementFeatures::read(), IOdictionary::readFile(), readProcAddressing(), regIOobject::readStream(), polyMesh::readUpdate(), hexRef8::setRefinement(), hexRef8::setUnrefinement(), solidBodyMotionFvMesh::solidBodyMotionFvMesh(), surfacePatchIOList::surfacePatchIOList(), surfZoneIOList::surfZoneIOList(), boundaryDataSurfaceWriter::write(), writeCellDistance(), boundaryRegion::writeDict(), cellTable::writeDict(), meshReader::writeInterfaces(), meshReader::writeMeshLabelList(), triSurfaceMesh::writeObject(), distributedTriSurfaceMesh::writeObject(), writeProcAddressing(), and boundaryDataSurfaceWriter::writeTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

filePath()

Foam::fileName filePath

(

)

const

Return complete path + object name if the file exists.

either in the case/processor or case otherwise null

Definition at line 336 of file IOobject.C.

References Foam::isDir(), Foam::isFile(), fileName::null, path(), and Foam::system().

Referenced by fieldToCell::applyToSet(), timeVaryingMappedFixedValuePointPatchField< Type >::checkTable(), timeVaryingMappedFixedValueFvPatchField< Type >::checkTable(), componentDisplacementMotionSolver::componentDisplacementMotionSolver(), displacementMotionSolver::displacementMotionSolver(), main(), refinementFeatures::read(), extendedEdgeMeshFormat::read(), edgeMeshFormat::read(), and regIOobject::readStream().

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 31 of file IOobjectReadHeader.C.

References IOobject::BAD, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, IOstream::format(), IOobject::GOOD, IOstream::good(), IOobject::headerClassName_, Foam::Info, IOWarningInFunction, token::isWord(), IOstream::lineNumber(), dictionary::lookup(), IOobject::MUST_READ, IOobject::MUST_READ_IF_MODIFIED, IOobject::name(), IOstream::name(), Foam::nl, IOobject::note_, IOobject::objState_, dictionary::readIfPresent(), IOobject::rOpt_, SeriousIOErrorInFunction, IOstream::version(), token::wordToken(), and IOobject::writeHeader().

Referenced by extendedEdgeMeshFormat::read(), edgeMeshFormat::read(), and regIOobject::readStream().

Here is the call graph for this function:

Here is the caller graph for this function:

headerOk()

bool headerOk

(

)

Read and check header info.

Definition at line 439 of file IOobject.C.

References Foam::endl(), Foam::Info, and IOWarningInFunction.

Referenced by fieldToCell::applyToSet(), basicMultiComponentMixture::basicMultiComponentMixture(), Foam::calc(), interpolate::calc(), mag::calc(), magSqr::calc(), div::calc(), magGrad::calc(), randomise::calc(), components::calc(), addSubtract::calc(), createDummyFvMeshFiles(), IOporosityModelList::createIOobject(), options::createIOobject(), boundaryRadiationProperties::createIOobject(), IOMRFZoneList::createIOobject(), radiationModel::createIOobject(), displacementLaplacianFvMotionSolver::displacementLaplacianFvMotionSolver(), extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), featureEdgeMesh::featureEdgeMesh(), fvSchemes::fvSchemes(), STARCD::getCellTable(), sampledIsoSurface::getIsoFields(), hexRef8::hexRef8(), hexRef8Data::hexRef8Data(), IOdictionary::IOdictionary(), IODynList< T, IndexType >::IODynList(), IOLongList< T, Offset >::IOLongList(), IOMap< T >::IOMap(), IOmapDistribute::IOmapDistribute(), IOmapDistributePolyMesh::IOmapDistributePolyMesh(), IOobjectList::IOobjectList(), readFields::loadField(), main(), Foam::MapConsistentVolFields(), Foam::MapVolFields(), radiationModel::New(), displacementMotionSolver::points0IO(), Foam::preservePatchTypes(), pyrolysisChemistryModel< CompType, SolidThermo, GasThermo >::pyrolysisChemistryModel(), radiativeIntensityRay::radiativeIntensityRay(), extendedEdgeMeshFormat::read(), edgeMeshFormat::read(), Cloud< streamLineParticle >::readCloudUniformProperties(), boundaryRegion::readDict(), cellTable::readDict(), particle< Type >::readFields(), polyTopoChanger::readModifiers(), GeometricField< vector, pointPatchField, pointMesh >::readOldTimeIfPresent(), refinementHistory::refinementHistory(), globalMeshData::sharedPointGlobalLabels(), topoSet::topoSet(), fieldCoordinateSystemTransform::transform(), uniformInterpolatedDisplacementPointPatchVectorField::uniformInterpolatedDisplacementPointPatchVectorField(), addSubtract::writeAddSubtractFields(), and Foam::writeMeshObject().

Here is the call graph for this function:

writeBanner()

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

inlinestatic

Write the standard OpenFOAM file/dictionary banner.

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

Definition at line 45 of file IOobjectI.H.

References Foam::FOAMversion.

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

Here is the caller graph for this function:

writeDivider()

Stream & writeDivider ( Stream &  os )

inlinestatic

Write the standard file section divider.

Definition at line 108 of file IOobjectI.H.

Referenced by writeDictionary::execute(), main(), argList::parse(), printCleaning(), and IOobject::writeHeader().

Here is the caller graph for this function:

writeEndDivider()

Stream & writeEndDivider ( Stream &  os )

inlinestatic

Write the standard end file divider.

Definition at line 118 of file IOobjectI.H.

Referenced by boundaryDataSurfaceWriter::write(), meshReader::writeInterfaces(), and boundaryDataSurfaceWriter::writeTemplate().

Here is the caller graph for this function:

writeHeader() [1/2]

bool writeHeader

(

Ostream &

os

)

const

Write header.

Definition at line 67 of file IOobjectWriteHeader.C.

References Foam::type().

Referenced by IOdictionary::readFile(), IOobject::readHeader(), polyMeshGen::write(), edgeMeshFormat::write(), boundaryDataSurfaceWriter::write(), interpolationLookUpTable< scalar >::write(), boundaryRegion::writeDict(), cellTable::writeDict(), meshReader::writeInterfaces(), and boundaryDataSurfaceWriter::writeTemplate().

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 35 of file IOobjectWriteHeader.C.

References IOobject::db(), objectRegistry::dbDir(), Foam::endl(), IOstream::format(), IOstream::good(), Foam::Info, IOstream::info(), IOobject::instance(), IOobject::local(), IOobject::name(), Foam::nl, IOobject::note(), Foam::type(), IOstream::version(), IOobject::writeBanner(), and IOobject::writeDivider().

Here is the call graph for this function:

good()

bool good ( ) const

inline

Definition at line 419 of file IOobject.H.

References IOobject::GOOD, and IOobject::objState_.

Referenced by topoSet::topoSet().

Here is the caller graph for this function:

bad()

bool bad ( ) const

inline

Definition at line 424 of file IOobject.H.

References IOobject::BAD, and IOobject::objState_.

info()

InfoProxy<IOobject> info ( ) const

inline

Return info proxy.

Used to print token information to a stream

Definition at line 434 of file IOobject.H.

Referenced by searchableSurfaceWithGaps::findNearest(), searchableSurface::findNearest(), searchableSurfaceWithGaps::getField(), searchableSurfaceWithGaps::getNormal(), searchableSurfaceWithGaps::getRegion(), and searchableSurfaceWithGaps::getVolumeType().

Here is the caller graph for this function:

operator=()

void operator=

(

const IOobject &

io

)

Definition at line 499 of file IOobject.C.

References IOobject::headerClassName_, IOobject::instance_, IOobject::local_, IOobject::name_, IOobject::note_, IOobject::objState_, IOobject::rOpt_, and IOobject::wOpt_.

Referenced by regIOobject::operator=().

Here is the caller graph for this function:

replaceFileName()

void replaceFileName ( const word &  from, const word &  to  )

static

Set unique on disk file name e.g., b -> b_ to avoid upper/lowercase clash with B

Definition at line 317 of file IOobject.C.

References replacedFileNames_.

groupName() [2/2]

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

inline

Definition at line 31 of file IOobjectI.H.

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

Here is the call graph for this function:

Field Documentation

name_

word name_

private

Name.

Definition at line 127 of file IOobject.H.

Referenced by IOobject::name(), IOobject::operator=(), and IOobject::rename().

headerClassName_

word headerClassName_

private

Class name read from header.

Definition at line 130 of file IOobject.H.

Referenced by IOobject::headerClassName(), IOobject::operator=(), and IOobject::readHeader().

note_

string note_

private

Optional note.

Definition at line 133 of file IOobject.H.

Referenced by IOobject::note(), IOobject::operator=(), and IOobject::readHeader().

instance_

fileName instance_

private

Instance path component.

Definition at line 136 of file IOobject.H.

Referenced by IOobject::instance(), and IOobject::operator=().

local_

fileName local_

private

Local path component.

Definition at line 139 of file IOobject.H.

Referenced by IOobject::local(), and IOobject::operator=().

db_

const objectRegistry& db_

private

objectRegistry reference

Definition at line 142 of file IOobject.H.

rOpt_

readOption rOpt_

private

Read option.

Definition at line 145 of file IOobject.H.

Referenced by IOobject::operator=(), IOobject::readHeader(), and IOobject::readOpt().

wOpt_

writeOption wOpt_

private

Write option.

Definition at line 148 of file IOobject.H.

Referenced by IOobject::operator=(), and IOobject::writeOpt().

registerObject_

bool registerObject_

private

Register object created from this IOobject with registry if true.

Definition at line 151 of file IOobject.H.

Referenced by IOobject::registerObject().

objState_

objectState objState_

private

IOobject state.

Definition at line 154 of file IOobject.H.

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

---

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/IOobjectWriteHeader.C