regIOobject Class Reference

regIOobject is an abstract class derived from IOobject to handle automatic object registration with the objectRegistry. More...

Inherits IOobject.

Inherited by adjointSolverManager, ATCModel, baseIOdictionary, BlendedInterfacialModel< ModelType >, coordinateSystems, decomposedBlockData, populationBalanceModel, exprResultGlobals, fvExprDriverWriter, extendedFeatureEdgeMesh, faBoundaryMesh, featureEdgeMesh, fieldDictionary, GlobalIOField< Type >, GlobalIOList< Type >, adjointTurbulenceModel, IOList< T >, IOMap< T >, IOmapDistribute, IOmapDistributePolyMesh, IOPtrList< T >, lduPrimitiveMeshAssembly, lumpedPointIOMovement, meshObject, surfaceTensionModel, objectiveManager, objectRegistry, PDRDragModel, polyBoundaryMesh, polyBoundaryMeshEntries, polyTopoChanger, porosityModel, porousModel, rawIOField< Type >, refinementHistory, searchableSurface, SLGThermo, solutionControl, SubDimensionedField< Type, GeoMesh >, surfaceTensionModel, surfZoneIOList, topoSet, UniformDimensionedField< Type >, virtualMassModel, GlobalIOField< vector >, GlobalIOList< kinematicParcelInjectionData >, GlobalIOList< reactingMultiphaseParcelInjectionData >, GlobalIOList< reactingParcelInjectionData >, IOList< label >, IOList< labelList >, IOPtrList< Foam::entry >, UniformDimensionedField< scalar >, and UniformDimensionedField< vector >.

Collaboration diagram for regIOobject:

Public Member Functions
	TypeName ("regIOobject")
	regIOobject (const IOobject &io, const bool isTimeObject=false)
	regIOobject (const regIOobject &rio)
	regIOobject (const regIOobject &rio, bool registerCopy)
	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	regIOobject (const IOobject &io, const regIOobject &rio)
virtual	~regIOobject ()
bool	checkIn ()
bool	checkOut ()
virtual void	addWatch ()
bool	ownedByRegistry () const
bool	store ()
void	release (const bool unregister=false)
label	eventNo () const
label &	eventNo ()
bool	upToDate (const regIOobject &) const
bool	upToDate (const regIOobject &, const regIOobject &) const
bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
void	setUpToDate ()
virtual void	rename (const word &newName)
const dictionary *	findMetaData () const noexcept
dictionary &	getMetaData () noexcept
void	removeMetaData ()
virtual void	updateMetaData ()
virtual fileName	filePath () const
bool	headerOk ()
Istream &	readStream (const word &, const bool valid=true)
void	close ()
virtual bool	readData (Istream &)
virtual bool	read ()
virtual label	addWatch (const fileName &)
const labelList &	watchIndices () const
labelList &	watchIndices ()
virtual bool	modified () const
virtual bool	readIfModified ()
virtual bool	writeData (Ostream &) const =0
virtual bool	writeObject (IOstreamOption streamOpt, const bool valid) const
virtual bool	write (const bool valid=true) const
virtual bool	global () const
void	operator= (const IOobject &io)
virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const
Public Member Functions inherited from IOobject
	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
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
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
template<class Type >
static Type &	store (Type *p)
template<class Type >
static Type &	store (autoPtr< Type > &ptr)
template<class Type >
static Type &	store (autoPtr< Type > &&ptr)
template<class Type >
static Type &	store (refPtr< Type > &ptr)
template<class Type >
static Type &	store (refPtr< Type > &&ptr)
template<class Type >
static Type &	store (tmp< Type > &ptr)
template<class Type >
static Type &	store (tmp< Type > &&ptr)
Static Public Member Functions inherited from IOobject
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)

Protected Member Functions
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
Protected Member Functions inherited from IOobject
void	setBad (const string &s)

Static Protected Attributes
static bool	masterOnlyReading = false

Friends
class	functionEntries::codeStream
class	fileOperations::uncollatedFileOperation

Additional Inherited Members
Public Types inherited from IOobject
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 }
Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
static char	scopeSeparator
static fileCheckTypes	fileModificationChecking
static float	fileModificationSkew
static int	maxFileModificationPolls
Static Protected Member Functions inherited from IOobject
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

regIOobject is an abstract class derived from IOobject to handle automatic object registration with the objectRegistry.

Source files

• regIOobject.H
• regIOobject.C
• regIOobjectRead.C
• regIOobjectWrite.C

Definition at line 69 of file regIOobject.H.

Constructor & Destructor Documentation

regIOobject() [1/5]

regIOobject	(	const IOobject &	io,
		const bool	isTimeObject = false
	)

Definition at line 40 of file regIOobject.C.

References regIOobject::checkIn(), and IOobject::registerObject().

Here is the call graph for this function:

regIOobject() [2/5]

regIOobject

(

const regIOobject &

rio

)

Definition at line 58 of file regIOobject.C.

regIOobject() [3/5]

regIOobject	(	const regIOobject &	rio,
		bool	registerCopy
	)

Definition at line 72 of file regIOobject.C.

References regIOobject::checkIn(), and regIOobject::checkOut().

Here is the call graph for this function:

regIOobject() [4/5]

regIOobject	(	const word &	newName,
		const regIOobject &	rio,
		bool	registerCopy
	)

Definition at line 95 of file regIOobject.C.

regIOobject() [5/5]

regIOobject	(	const IOobject &	io,
		const regIOobject &	rio
	)

Definition at line 120 of file regIOobject.C.

~regIOobject()

~regIOobject ( )

virtual

Definition at line 142 of file regIOobject.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::name(), path(), Foam::Pout, and Foam::type().

Here is the call graph for this function:

Member Function Documentation

readHeaderOk()

bool readHeaderOk ( const IOstreamOption::streamFormat  fmt, const word &  typeName  )

protected

Definition at line 32 of file regIOobjectRead.C.

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

Here is the call graph for this function:

TypeName()

TypeName

(

"regIOobject"

)

checkIn()

bool checkIn

(

)

Definition at line 181 of file regIOobject.C.

References Foam::abort(), Foam::expressions::patchExpr::debug, polyMesh::defaultRegion, Foam::endl(), Foam::FatalError, FatalErrorInFunction, Foam::name(), and WarningInFunction.

Referenced by regIOobject::regIOobject().

Here is the call graph for this function:

Here is the caller graph for this function:

checkOut()

bool checkOut

(

)

Definition at line 217 of file regIOobject.C.

References Foam::fileHandler(), forAllReverse, and fileOperation::removeWatch().

Referenced by regionFunctionObject::clearObject(), regionFunctionObject::clearObjects(), removeRegisteredObject::execute(), regIOobject::regIOobject(), and lumpedPointDisplacementPointPatchVectorField::~lumpedPointDisplacementPointPatchVectorField().

Here is the call graph for this function:

Here is the caller graph for this function:

addWatch() [1/2]

void addWatch ( )

virtual

Reimplemented in unwatchedIOdictionary.

Definition at line 260 of file regIOobject.C.

References Foam::abort(), f(), Foam::FatalError, FatalErrorInFunction, Foam::fileHandler(), IOobject::fileModificationChecking, fileOperation::findWatch(), forAll, forAllReverse, fileOperation::getFile(), IOobject::inotifyMaster, UPstream::master(), UPstream::parRun(), fileOperation::removeWatch(), Pstream::scatter(), List::setSize(), IOobject::timeStampMaster, and Foam::type().

Referenced by includeEntry::execute(), and IOMap< T >::IOMap().

Here is the call graph for this function:

Here is the caller graph for this function:

ownedByRegistry()

bool ownedByRegistry ( ) const

inline

Definition at line 24 of file regIOobjectI.H.

Referenced by objectRegistry::clear(), regionFunctionObject::clearObject(), regionFunctionObject::clearObjects(), objectRegistry::erase(), and removeRegisteredObject::execute().

Here is the caller graph for this function:

store() [1/8]

bool store ( )

inline

Definition at line 30 of file regIOobjectI.H.

References Foam::name(), Foam::nl, and WarningInFunction.

Referenced by codedBase::codeDict(), mappedPatchBase::constructIOField(), fvMatrix< Type >::createOrUpdateLduPrimitiveAssembly(), CrankNicolsonDdtScheme< Type >::ddt0_(), volPointInterpolation::interpolate(), waveModel::lookupOrCreate(), lumpedPointDisplacementPointPatchVectorField::movement(), options::New(), zoneDistribute::New(), zoneCPCStencil::New(), coordinateSystems::New(), polySurface::polySurface(), mappedPatchBase::storeField(), sampledSurface::storeSurfMesh(), objectRegistry::subRegistry(), and cellCellStencil::zoneID().

Here is the call graph for this function:

Here is the caller graph for this function:

store() [2/8]

Type & store ( Type *  p )

inlinestatic

Definition at line 47 of file regIOobjectI.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and p.

Here is the call graph for this function:

store() [3/8]

Type & store ( autoPtr< Type > &  ptr )

inlinestatic

Definition at line 71 of file regIOobjectI.H.

References autoPtr::release().

Here is the call graph for this function:

store() [4/8]

Type & store ( autoPtr< Type > &&  ptr )

inlinestatic

Definition at line 79 of file regIOobjectI.H.

store() [5/8]

Type & store ( refPtr< Type > &  ptr )

inlinestatic

Definition at line 87 of file regIOobjectI.H.

References refPtr::cref(), refPtr::get(), refPtr::is_pointer(), p, refPtr::release(), and WarningInFunction.

Here is the call graph for this function:

store() [6/8]

Type & store ( refPtr< Type > &&  ptr )

inlinestatic

Definition at line 120 of file regIOobjectI.H.

store() [7/8]

Type & store ( tmp< Type > &  ptr )

inlinestatic

Definition at line 128 of file regIOobjectI.H.

References tmp::cref(), tmp::get(), tmp::is_pointer(), p, tmp::ptr(), and WarningInFunction.

Here is the call graph for this function:

store() [8/8]

Type & store ( tmp< Type > &&  ptr )

inlinestatic

Definition at line 161 of file regIOobjectI.H.

release()

void release ( const bool  unregister = false )

inline

Definition at line 168 of file regIOobjectI.H.

Referenced by objectRegistry::clear(), and objectRegistry::erase().

Here is the caller graph for this function:

eventNo() [1/2]

Foam::label & eventNo ( ) const

inline

Definition at line 178 of file regIOobjectI.H.

Referenced by triSurfaceMesh::movePoints(), polyMesh::setUpToDatePoints(), cyclicACMIPolyPatch::updateAreas(), and regIOobject::upToDate().

Here is the caller graph for this function:

eventNo() [2/2]

label& eventNo ( )

inline

upToDate() [1/4]

bool upToDate

(

const regIOobject &

a

)

const

Definition at line 330 of file regIOobject.C.

References regIOobject::eventNo(), and Foam::labelMax.

Referenced by cyclicACMIPolyPatch::upToDate(), and polyMesh::upToDatePoints().

Here is the call graph for this function:

Here is the caller graph for this function:

upToDate() [2/4]

bool upToDate	(	const regIOobject &	a,
		const regIOobject &	b
	)		const

Definition at line 370 of file regIOobject.C.

References Foam::constant::physicoChemical::b.

upToDate() [3/4]

bool upToDate	(	const regIOobject &	a,
		const regIOobject &	b,
		const regIOobject &	c
	)		const

Definition at line 380 of file regIOobject.C.

References Foam::constant::physicoChemical::b, and Foam::constant::universal::c.

upToDate() [4/4]

bool upToDate	(	const regIOobject &	a,
		const regIOobject &	b,
		const regIOobject &	c,
		const regIOobject &	d
	)		const

Definition at line 391 of file regIOobject.C.

References Foam::constant::physicoChemical::b, and Foam::constant::universal::c.

setUpToDate()

void setUpToDate

(

)

Definition at line 402 of file regIOobject.C.

Referenced by cyclicACMIPolyPatch::setUpToDate(), and cyclicACMIPolyPatch::updateAreas().

Here is the caller graph for this function:

rename()

void rename ( const word &  newName )

virtual

Reimplemented from IOobject.

Reimplemented in objectRegistry.

Definition at line 408 of file regIOobject.C.

References IOobject::rename().

Referenced by objectRegistry::rename().

Here is the call graph for this function:

Here is the caller graph for this function:

findMetaData()

const Foam::dictionary * findMetaData ( ) const

virtualnoexcept

Reimplemented from IOobject.

Definition at line 26 of file regIOobjectMetaData.C.

getMetaData()

Foam::dictionary & getMetaData ( )

noexcept

Definition at line 32 of file regIOobjectMetaData.C.

removeMetaData()

void removeMetaData

(

)

Definition at line 42 of file regIOobjectMetaData.C.

updateMetaData()

void updateMetaData ( )

virtual

Definition at line 48 of file regIOobjectMetaData.C.

filePath()

Foam::fileName filePath ( ) const

virtual

Reimplemented in baseIOdictionary, distributedTriSurfaceMesh, triSurfaceMesh, porosityModel, searchableSurface, extendedFeatureEdgeMesh, UniformDimensionedField< Type >, unwatchedIOdictionary, IOdictionary, localIOdictionary, GlobalIOField< Type >, IOMap< T >, featureEdgeMesh, and GlobalIOList< Type >.

Definition at line 423 of file regIOobject.C.

References Foam::type().

Referenced by rawIOField< Type >::rawIOField(), and decomposedBlockData::read().

Here is the call graph for this function:

Here is the caller graph for this function:

headerOk()

bool headerOk

(

)

Definition at line 429 of file regIOobject.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::fileHandler(), IOWarningInFunction, fileOperation::readHeader(), and Foam::type().

Referenced by extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), featureEdgeMesh::featureEdgeMesh(), IOMap< T >::IOMap(), IOmapDistribute::IOmapDistribute(), IOmapDistributePolyMesh::IOmapDistributePolyMesh(), polyBoundaryMeshEntries::polyBoundaryMeshEntries(), rawIOField< Type >::rawIOField(), boundaryRegion::readDict(), cellTable::readDict(), refinementHistory::refinementHistory(), and topoSet::topoSet().

Here is the call graph for this function:

Here is the caller graph for this function:

readStream()

Foam::Istream & readStream	(	const word &	expectName,
		const bool	valid = true
	)

Definition at line 122 of file regIOobjectRead.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::name(), Foam::Pout, and Foam::type().

Referenced by extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), featureEdgeMesh::featureEdgeMesh(), fieldDictionary::fieldDictionary(), IOMap< T >::IOMap(), IOmapDistribute::IOmapDistribute(), IOmapDistributePolyMesh::IOmapDistributePolyMesh(), polyBoundaryMeshEntries::polyBoundaryMeshEntries(), rawIOField< Type >::rawIOField(), refinementHistory::refinementHistory(), and topoSet::topoSet().

Here is the call graph for this function:

Here is the caller graph for this function:

close()

void close

(

)

Definition at line 164 of file regIOobjectRead.C.

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

Referenced by extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), featureEdgeMesh::featureEdgeMesh(), fieldDictionary::fieldDictionary(), IOMap< T >::IOMap(), IOmapDistribute::IOmapDistribute(), IOmapDistributePolyMesh::IOmapDistributePolyMesh(), rawIOField< Type >::rawIOField(), uncollatedFileOperation::read(), adjointRASModel::read(), masterUncollatedFileOperation::read(), refinementHistory::refinementHistory(), and topoSet::topoSet().

Here is the call graph for this function:

Here is the caller graph for this function:

readData()

bool readData ( Istream &  )

virtual

Reimplemented in exprResultGlobals, GlobalIOField< Type >, GlobalIOField< vector >, lumpedPointIOMovement, GlobalIOList< Type >, GlobalIOList< reactingParcelInjectionData >, GlobalIOList< reactingMultiphaseParcelInjectionData >, GlobalIOList< kinematicParcelInjectionData >, fvExprDriverWriter, IOmapDistributePolyMesh, refinementHistory, extendedFeatureEdgeMesh, baseIOdictionary, UniformDimensionedField< Type >, UniformDimensionedField< scalar >, UniformDimensionedField< vector >, featureEdgeMesh, and IOmapDistribute.

Definition at line 178 of file regIOobjectRead.C.

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

Here is the caller graph for this function:

read()

bool read ( )

virtual

Reimplemented in radiationModel, adjointTurbulenceModel, phaseChangeTwoPhaseMixture, turbulenceModel, phaseSystem, basicThermo, phaseSystem, Time, refinementHistory, adjointSpalartAllmaras, schemesLookup, twoPhaseMixtureThermo, adjointRASModel, twoPhaseMixtureEThermo, solarLoad, multiphaseSystem, multiphaseMixture, laserDTRM, fvDOM, kinematicSingleLayer, incompressibleThreePhaseMixture, diffusionMulticomponent< ReactionThermo, ThermoType >, EDC< ReactionThermo >, thermoSingleLayer, crankConRod, incompressibleTwoPhaseInteractingMixture, viewFactor, solidThermo, rigidBodyMeshMotion, twoPhaseSystem, motionSolver, decomposedBlockData, solution, reactingOneDim, multiphaseSystem, engineTime, incompressibleTwoPhaseMixture, rigidBodyMeshMotionSolver, FSD< ReactionThermo, ThermoType >, combustionModel, temperaturePhaseChangeTwoPhaseMixture, SRFModel, sixDoFRigidBodyMotionSolver, interfaceHeatResistance, thermoIncompressibleTwoPhaseMixture, adjointLaminar, regionModel, SIMPLEControl, CombustionModel< ReactionThermo >, solutionControl, optimisationManager, SchnerrSauer, zoneCombustion< ReactionThermo >, P1, Kunz, laminar< ReactionThermo >, eddyDissipationDiffusionModel< ReactionThermo, ThermoType >, PaSR< ReactionThermo >, eddyDissipationModelBase< ReactionThermo, ThermoType >, IOMRFZoneList, thermalBaffle, Merkle, singleStepCombustion< ReactionThermo, ThermoType >, diffusion< ReactionThermo, ThermoType >, singlePhaseTransportModel, constant, pimpleControl, infinitelyFastChemistry< ReactionThermo, ThermoType >, regionModel1D, noCombustion< ReactionThermo >, options, options, thermalBaffleModel, opaqueSolid, noRadiation, tolerances, rpm, singleLayerRegion, pyrolysisModel, IOporosityModelList, immiscibleIncompressibleTwoPhaseMixture, surfaceFilmRegionModel, thermo, noPyrolysis, noThermo, SIMPLEControlOpt, simpleControl, and SIMPLEControlSingleRun.

Definition at line 184 of file regIOobjectRead.C.

References IOstreamOption::BINARY, Foam::fileHandler(), IOobject::fileModificationChecking, forAll, forAllReverse, fileOperation::getFile(), IOobject::inotifyMaster, fileOperation::read(), fileOperation::removeWatch(), List::setSize(), IOobject::timeStampMaster, and Foam::type().

Referenced by IOporosityModelList::read(), tolerances::read(), singlePhaseTransportModel::read(), IOMRFZoneList::read(), turbulenceModel::read(), optimisationManager::read(), regionModel::read(), SRFModel::read(), combustionModel::read(), incompressibleTwoPhaseMixture::read(), solution::read(), motionSolver::read(), twoPhaseSystem::read(), solidThermo::read(), radiationModel::read(), multiphaseSystem::read(), schemesLookup::read(), basicThermo::read(), and phaseSystem::read().

Here is the call graph for this function:

Here is the caller graph for this function:

addWatch() [2/2]

Foam::label addWatch ( const fileName &  f )

virtual

Reimplemented in unwatchedIOdictionary.

Definition at line 236 of file regIOobject.C.

References f(), Foam::fileHandler(), and fileOperation::findWatch().

Here is the call graph for this function:

watchIndices() [1/2]

Foam::labelList & watchIndices ( ) const

inline

Definition at line 189 of file regIOobjectI.H.

Referenced by fileOperation::addWatches(), masterUncollatedFileOperation::addWatches(), and Time::readDict().

Here is the caller graph for this function:

watchIndices() [2/2]

labelList& watchIndices ( )

inline

modified()

bool modified ( ) const

virtual

Reimplemented in objectRegistry.

Definition at line 230 of file regIOobjectRead.C.

References Foam::fileHandler(), forAllReverse, and fileMonitor::UNMODIFIED.

Here is the call graph for this function:

readIfModified()

bool readIfModified ( )

virtual

Reimplemented in objectRegistry.

Definition at line 244 of file regIOobjectRead.C.

References Foam::endl(), Foam::fileHandler(), forAllReverse, fileOperation::getFile(), InfoInFunction, Foam::name(), Foam::read(), and fileMonitor::UNMODIFIED.

Here is the call graph for this function:

writeData()

virtual bool writeData ( Ostream &  ) const

pure virtual

Implemented in surfaceTensionModel, objective, searchableSurfaceWithGaps, polyBoundaryMesh, porosityModel, profiling, solidification, powerLawLopesdaCosta, faBoundaryMesh, adjointSimple, BlendedInterfacialModel< ModelType >, DarcyForchheimer, exprResultGlobals, decomposedBlockData, coordinateSystems, powerLaw, fixedCoeff, simple, virtualMassModel, virtualMassModel, temperatureDependent, MeshObject< fvMesh, MoveableMeshObject, FitDataType >, MeshObject< polyMesh, UpdateableMeshObject, decompositionModel >, MeshObject< polyMesh, GeometricMeshObject, meshSearchMeshObject >, MeshObject< fvMesh, TopologicalMeshObject, centredCPCCellToFaceStencilObject >, MeshObject< fvMesh, MoveableMeshObject, CentredFitData< Polynomial > >, MeshObject< polyMesh, UpdateableMeshObject, twoDPointCorrector >, MeshObject< fvMesh, UpdateableMeshObject, wallDist >, MeshObject< faMesh, Foam::MoveableMeshObject, leastSquaresFaVectors >, MeshObject< fvMesh, TopologicalMeshObject, zoneDistribute >, MeshObject< pointMesh, UpdateableMeshObject, pointConstraints >, MeshObject< fvMesh, TopologicalMeshObject, centredCFCFaceToCellStencilObject >, MeshObject< polyMesh, GeometricMeshObject, meshSearchFACE_CENTRE_TRISMeshObject >, MeshObject< fvMesh, TopologicalMeshObject, centredCPCCellToCellStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, upwindFECCellToFaceStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, centredCECCellToCellStencilObject >, MeshObject< fvMesh, MoveableMeshObject, LeastSquaresVectors< Stencil > >, MeshObject< fvMesh, TopologicalMeshObject, centredCFCCellToCellStencilObject >, MeshObject< polyMesh, MoveableMeshObject, cellAspectRatio >, MeshObject< fvMesh, MoveableMeshObject, leastSquaresVectors >, MeshObject< fvMesh, Foam::GeometricMeshObject, boundaryRadiationProperties >, MeshObject< fvMesh, TopologicalMeshObject, upwindCFCCellToFaceStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, upwindCECCellToFaceStencilObject >, MeshObject< fvMesh, UpdateableMeshObject, volPointInterpolation >, MeshObject< lduMesh, GeometricMeshObject, GAMGAgglomeration >, MeshObject< fvMesh, TopologicalMeshObject, pureUpwindCFCCellToFaceStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, upwindCPCCellToFaceStencilObject >, MeshObject< fvMesh, UpdateableMeshObject, volBSplinesBase >, MeshObject< polyMesh, TopologicalMeshObject, regionSplit >, MeshObject< fvMesh, MoveableMeshObject, skewCorrectionVectors >, MeshObject< polyMesh, Foam::UpdateableMeshObject, faMesh >, MeshObject< fvMesh, TopologicalMeshObject, centredCECCellToFaceStencilObject >, MeshObject< fvMesh, MoveableMeshObject, UpwindFitData< Polynomial > >, MeshObject< fvMesh, TopologicalMeshObject, centredCFCCellToFaceStencilObject >, MeshObject< polyMesh, UpdateableMeshObject, pointMesh >, MeshObject< Time, TopologicalMeshObject, multiWorldConnections >, MeshObject< fvMesh, TopologicalMeshObject, centredFECCellToFaceStencilObject >, MeshObject< Time, TopologicalMeshObject, gravity >, MeshObject< fvMesh, MoveableMeshObject, CentredFitSnGradData< Polynomial > >, MeshObject< fvMesh, TopologicalMeshObject, zoneCPCStencil >, surfaceTensionModel, liquidProperties, RASTurbulenceModel, surfaceTensionModel, porousModel, GlobalIOField< Type >, GlobalIOField< vector >, lumpedPointIOMovement, constant, GlobalIOList< Type >, GlobalIOList< reactingParcelInjectionData >, GlobalIOList< reactingMultiphaseParcelInjectionData >, GlobalIOList< kinematicParcelInjectionData >, fvExprDriverWriter, IOmapDistributePolyMesh, IOPtrList< T >, IOPtrList< Foam::entry >, IOMap< T >, rawIOField< Type >, IOList< T >, IOList< label >, IOList< labelList >, surfZoneIOList, fieldDictionary, objectRegistry, populationBalanceModel, refinementHistory, searchableSphere, topoSet, triSurfaceMesh, searchableCone, searchableSurfaceCollection, searchableBox, searchableRotatedBox, searchableCylinder, searchableDisk, searchablePlate, searchableExtrudedCircle, searchablePlane, lduPrimitiveMeshAssembly, adjointTurbulenceModel, ATCModel, objectiveManager, solver, adjointSolverManager, solutionControl, PDRDragModel, polyTopoChanger, extendedFeatureEdgeMesh, baseIOdictionary, UniformDimensionedField< Type >, UniformDimensionedField< scalar >, UniformDimensionedField< vector >, featureEdgeMesh, IOmapDistribute, polyBoundaryMeshEntries, and SLGThermo.

Referenced by uncollatedFileOperation::read(), masterUncollatedFileOperation::read(), decomposedBlockData::writeBlockEntry(), searchableSurfaceWithGaps::writeData(), mappedPatchBase::writeDict(), collatedFileOperation::writeObject(), fileOperation::writeObject(), and masterUncollatedFileOperation::writeObject().

Here is the caller graph for this function:

writeObject() [1/2]

bool writeObject ( IOstreamOption  streamOpt, const bool  valid  ) const

virtual

Reimplemented in profiling, coordinateSystems, distributedTriSurfaceMesh, objectRegistry, fvMesh, Time, polySurface, dynamicOversetFvMesh, triSurfaceMesh, surfMesh, polyBoundaryMesh, dynamicRefineFvMesh, faBoundaryMesh, decomposedBlockData, rigidBodyMeshMotion, motionSolver, faceZoneSet, rigidBodyMeshMotionSolver, sixDoFRigidBodyMotionSolver, pointZoneSet, and cellZoneSet.

Definition at line 29 of file regIOobjectWrite.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::fileHandler(), IOobject::instance(), Foam::name(), Foam::Pout, SeriousErrorInFunction, fileOperation::setUnmodified(), Foam::system(), timeName, and fileOperation::writeObject().

Referenced by regIOobject::write(), CompactIOField::writeObject(), cellZoneSet::writeObject(), pointZoneSet::writeObject(), faceZoneSet::writeObject(), coordinateSystems::writeObject(), faBoundaryMesh::writeObject(), profiling::writeObject(), and polyBoundaryMesh::writeObject().

Here is the call graph for this function:

Here is the caller graph for this function:

write()

bool write ( const bool  valid = true ) const

virtual

Reimplemented in SIMPLEControl, faMesh, fvMesh, objective, objectiveIncompressible, solver, incompressibleAdjointSolver, incompressiblePrimalSolver, SIMPLEControlOpt, and SIMPLEControlSingleRun.

Definition at line 125 of file regIOobjectWrite.C.

References IOobject::time(), and regIOobject::writeObject().

Referenced by columnFvMesh::columnFvMesh(), hexRef8::consistentSlowRefinement2(), dynamicRefineFvMesh::init(), SIMPLEControlOpt::loop(), meshRefinement::mergeEdgesUndo(), meshRefinement::mergePatchFacesUndo(), polyMesh::movePoints(), polyMesh::polyMesh(), removeFaces::setRefinement(), hexRef8::setRefinement(), hexRef8::setUnrefinement(), SIMPLEControlSingleRun::write(), surfaceInterpolate::write(), writeObjects::write(), columnAverage::write(), zeroGradient::write(), ddt2::write(), ObukhovLength::write(), fvMesh::write(), faMeshReconstructor::writeAddressing(), faMeshDecomposition::writeDecomposition(), faMeshReconstructor::writeMesh(), regionFunctionObject::writeObject(), and isoAdvection::writeSurfaceCells().

Here is the call graph for this function:

Here is the caller graph for this function:

global()

virtual bool global ( ) const

inlinevirtual

Reimplemented in baseIOdictionary, distributedTriSurfaceMesh, triSurfaceMesh, porosityModel, searchableSurface, extendedFeatureEdgeMesh, UniformDimensionedField< Type >, unwatchedIOdictionary, IOdictionary, localIOdictionary, GlobalIOField< Type >, IOMap< T >, featureEdgeMesh, and GlobalIOList< Type >.

Definition at line 350 of file regIOobject.H.

Referenced by masterUncollatedFileOperation::readStream(), and collatedFileOperation::writeObject().

Here is the caller graph for this function:

operator=()

void operator=

(

const IOobject &

io

)

Definition at line 450 of file regIOobject.C.

References IOobject::operator=().

Here is the call graph for this function:

writeObject() [2/2]

bool writeObject ( IOstreamOption::streamFormat  fmt, IOstreamOption::versionNumber  ver, IOstreamOption::compressionType  comp, const bool  valid  ) const

virtual

Definition at line 136 of file regIOobjectWrite.C.

Friends And Related Function Documentation

functionEntries::codeStream

friend class functionEntries::codeStream

friend

Definition at line 121 of file regIOobject.H.

fileOperations::uncollatedFileOperation

friend class fileOperations::uncollatedFileOperation

friend

Definition at line 122 of file regIOobject.H.

Member Data Documentation

masterOnlyReading

bool masterOnlyReading = false

staticprotected

Definition at line 83 of file regIOobject.H.

---

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

• src/OpenFOAM/db/regIOobject/regIOobject.H
• src/OpenFOAM/db/regIOobject/regIOobject.C
• src/OpenFOAM/db/regIOobject/regIOobjectI.H
• src/OpenFOAM/db/regIOobject/regIOobjectMetaData.C
• src/OpenFOAM/db/regIOobject/regIOobjectRead.C
• src/OpenFOAM/db/regIOobject/regIOobjectWrite.C