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

Inheritance diagram for regIOobject:

[legend]

Collaboration diagram for regIOobject:

[legend]

Public Member Functions
	TypeName ("regIOobject")
	Runtime type information. More...

	regIOobject (const IOobject &, const bool isTime=false)
	Construct from IOobject. Optional flag for if IOobject is the. More...

	regIOobject (const regIOobject &)
	Copy constructor. More...

	regIOobject (const regIOobject &&)
	Move constructor. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Copy constructor, transferring registry registration to copy. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy constructor with new name, transferring registry registration. More...

	regIOobject (const IOobject &, const regIOobject &)
	Copy constructor with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

virtual bool	global () const
	Return true if object is global, i.e. same for all processors. More...

virtual bool	globalFile () const
	Return true if object is global, i.e. same for all processors. More...

const fileName &	caseName () const

fileName	path () const
	Return complete path. More...

fileName	objectPath () const
	Return complete path + object name. More...

fileName	filePath () const
	Return complete path + object name if the file exists. More...

bool	checkIn ()
	Add object to registry. More...

bool	checkOut ()
	Remove object from registry. More...

void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) More...

bool	registered () const
	Is this object registered with the registry? More...

bool	ownedByRegistry () const
	Is this object owned by the registry? More...

void	store ()
	Transfer ownership of this object to its registry. More...

void	release ()
	Release ownership of this object from its registry. More...

label	eventNo () const
	Event number at last update. More...

label &	eventNo ()
	Event number at last update. More...

bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object. More...

bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

void	setUpToDate ()
	Set up to date (obviously) More...

virtual void	rename (const word &newName)
	Rename. More...

bool	headerOk ()
	Read and check header info. More...

Istream &	readStream (const word &, const bool read=true)
	Return Istream and check object type against that given. More...

void	close ()
	Close Istream. More...

virtual bool	readData (Istream &)
	Virtual readData function. More...

virtual bool	read ()
	Read object. More...

const labelList &	watchIndices () const
	Return file-monitoring handles. More...

labelList &	watchIndices ()
	Return file-monitoring handles. More...

virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) More...

virtual bool	dependenciesModified () const
	Return true if the object's dependencies have been modified. More...

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...

virtual bool	writeData (Ostream &) const =0
	Pure virtual writaData function. More...

virtual bool	writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
	Write using given format, version and compression. More...

virtual bool	write (const bool write=true) const
	Write using setting from DB. More...

void	operator= (const IOobject &)
	Assign to IOobject. More...

void	operator= (const regIOobject &)=delete
	Disallow default assignment. More...

const fileName &	caseName (const bool global) const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

fileName	filePath (const word &typeName, const bool global) const
	Return complete path + object name if the file exists. More...

Public Member Functions inherited from IOobject
	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 objectRegistry &registry)
	Construct from copy resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Construct from copy resetting name. More...

	IOobject (const IOobject &io)=default
	Copy constructor. More...

autoPtr< IOobject >	clone () const
	Clone. More...

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. 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...

word &	headerClassName ()
	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...

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 bool global) const

fileName &	instance () const
	Return the instance directory, constant, system, <time> etc. More...

void	updateInstance () const
	If the instance is a time directory update to the current time. More...

const fileName &	local () const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

fileName	relativePath () const
	Return the path relative to the case directory. More...

fileName	relativeObjectPath () const
	Return complete relativePath + object name. More...

fileName	filePath (const word &typeName, const bool global) const
	Return complete path + object name if the file exists. More...

bool	readHeader (Istream &)
	Read header. More...

bool	headerOk ()
	Read header of local object without type-checking. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...

bool	writeHeader (Ostream &) const
	Write header. More...

bool	writeHeader (Ostream &, const word &objectType) const
	Write header. Allow override of type. More...

bool	good () const

bool	bad () const

InfoProxy< 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
template<class Type >
static Type &	store (Type *)
	Transfer ownership of the given object pointer to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &)
	Transfer ownership of the given object pointer to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class Name >
static word	groupName (Name name, const word &group)

static word	group (const word &name)
	Return group (extension part of name) More...

static word	member (const word &name)
	Return member (name without the extension) More...

template<class Stream >
static Stream &	writeBanner (Stream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

template<class Stream >
static Stream &	writeDivider (Stream &os)
	Write the standard file section divider. More...

template<class Stream >
static Stream &	writeEndDivider (Stream &os)
	Write the standard end file divider. More...

Static Public Attributes
static float	fileModificationSkew

Static Public Attributes inherited from IOobject
static constexpr const char *	foamFile = "FoamFile"
	Keyword for the FoamFile header sub-dictionary. More...

static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

Protected Member Functions
bool	readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
	Read header, check readOpt flags and read data if necessary. More...

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

template<class Type >
bool	typeHeaderOk (const bool checkType)
	Read header using typeGlobalFile to find file. More...

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState { GOOD , BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	readOption { MUST_READ , MUST_READ_IF_MODIFIED , READ_IF_PRESENT , NO_READ }
	Enumeration defining the read options. More...

enum	writeOption { AUTO_WRITE = 0 , NO_WRITE = 1 }
	Enumeration defining the write options. More...

enum	fileCheckTypes { timeStamp , timeStampMaster , inotify , inotifyMaster }
	Enumeration defining the file checking options. More...

Detailed Description

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

Source files

Definition at line 52 of file regIOobject.H.

Constructor & Destructor Documentation

◆ regIOobject() [1/6]

regIOobject	(	const IOobject &	io,
		const bool	isTime = `false`
	)

Construct from IOobject. Optional flag for if IOobject is the.

top level regIOobject.

Definition at line 41 of file regIOobject.C.

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

Here is the call graph for this function:

◆ regIOobject() [2/6]

regIOobject ( const regIOobject & rio )

Copy constructor.

Definition at line 62 of file regIOobject.C.

◆ regIOobject() [3/6]

regIOobject ( const regIOobject && rio )

Move constructor.

Registers copy if the object is registered

Definition at line 74 of file regIOobject.C.

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

Here is the call graph for this function:

◆ regIOobject() [4/6]

regIOobject	(	const regIOobject &	rio,
		bool	registerCopy
	)

Copy constructor, transferring registry registration to copy.

if registerCopy is true

Definition at line 90 of file regIOobject.C.

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

Here is the call graph for this function:

◆ regIOobject() [5/6]

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

Copy constructor with new name, transferring registry registration.

to copy as specified

Definition at line 109 of file regIOobject.C.

References regIOobject::checkIn().

Here is the call graph for this function:

◆ regIOobject() [6/6]

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

Copy constructor with new IO parameters.

Definition at line 129 of file regIOobject.C.

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

Here is the call graph for this function:

◆ ~regIOobject()

~regIOobject ( )

virtual

Destructor.

Definition at line 150 of file regIOobject.C.

Member Function Documentation

◆ readHeaderOk()

bool readHeaderOk	(	const IOstream::streamFormat	defaultFormat,
		const word &	typeName
	)

protected

Read header, check readOpt flags and read data if necessary.

Format is set to ASCII if defaultFormat and file format are ASCII

Definition at line 32 of file regIOobjectRead.C.

References Foam::fileHandler(), IOobject::fileModificationChecking, regIOobject::global(), regIOobject::headerOk(), IOobject::inotifyMaster, UPstream::master(), IOobject::MUST_READ, IOobject::MUST_READ_IF_MODIFIED, fileOperation::read(), IOobject::READ_IF_PRESENT, IOobject::readOpt(), Pstream::scatter(), and IOobject::timeStampMaster.

Referenced by coordinateSystems::coordinateSystems(), fvConstraints::fvConstraints(), fvModels::fvModels(), GlobalIOListBase< Container, IOContainer, Type >::GlobalIOListBase(), IOdictionary::IOdictionary(), localIOdictionary::localIOdictionary(), and timeIOdictionary::timeIOdictionary().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "regIOobject" )

Runtime type information.

◆ global()

bool global ( ) const

virtual

Return true if object is global, i.e. same for all processors.

Defaults to false, must be overridden by global IO classes

Reimplemented in distributedTriSurfaceMesh, UniformDimensionedField< Type >, UniformDimensionedField< scalar >, UniformDimensionedField< vector >, localIOdictionary, IOdictionary, GlobalIOListBase< Container, IOContainer, Type >, GlobalIOListBase< List, GlobalIOList, Type >, GlobalIOListBase< Field, GlobalIOField, Type >, triSurfaceMesh, featureEdgeMesh, extendedFeatureEdgeMesh, coordinateSystems, fvModels, and fvConstraints.

Definition at line 181 of file regIOobject.C.

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

Here is the caller graph for this function:

◆ globalFile()

bool globalFile ( ) const

virtual

Return true if object is global, i.e. same for all processors.

and written to the global case directory, i.e. not the processor time directory Defaults to global()

Reimplemented in timeIOdictionary.

Definition at line 187 of file regIOobject.C.

Referenced by regIOobject::writeObject().

Here is the caller graph for this function:

◆ caseName() [1/2]

const Foam::fileName & caseName ( ) const

Definition at line 193 of file regIOobject.C.

References IOobject::caseName().

Here is the call graph for this function:

◆ path() [1/2]

Foam::fileName path ( ) const

Return complete path.

Definition at line 199 of file regIOobject.C.

References IOobject::path().

Referenced by odeChemistryModel::logFile(), regIOobject::objectPath(), and collatedFileOperation::writeObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ objectPath() [1/2]

fileName objectPath ( ) const

inline

Return complete path + object name.

Definition at line 158 of file regIOobject.H.

References IOobject::name(), and regIOobject::path().

Referenced by collatedFileOperation::appendObject(), hexRef8::consistentSlowRefinement2(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), hexRef8::hexRef8(), IOdictionary::IOdictionary(), meshRefinement::mergeEdgesUndo(), meshRefinement::mergePatchFacesUndo(), masterUncollatedFileOperation::read(), uncollatedFileOperation::read(), IOdictionary::readData(), fileOperation::readObjects(), masterUncollatedFileOperation::readObjects(), uncollatedFileOperation::readObjects(), masterUncollatedFileOperation::readStream(), uncollatedFileOperation::readStream(), polyMesh::readUpdate(), hexRef8::setRefinement(), hexRef8::setUnrefinement(), surfacePatchIOList::surfacePatchIOList(), surfZoneIOList::surfZoneIOList(), boundaryRegion::writeDict(), cellTable::writeDict(), collatedFileOperation::writeObject(), fileOperation::writeObject(), masterUncollatedFileOperation::writeObject(), triSurfaceMesh::writeObject(), and distributedTriSurfaceMesh::writeObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ filePath() [1/2]

Foam::fileName filePath ( ) const

Return complete path + object name if the file exists.

in the case directory otherwise null.

For global objects in parallel searches up into the global case directory

Definition at line 447 of file regIOobject.C.

References IOobject::filePath(), and Foam::type().

Here is the call graph for this function:

◆ checkIn()

bool checkIn ( )

Add object to registry.

Definition at line 205 of file regIOobject.C.

References Foam::abort(), 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 ( )

Remove object from registry.

Definition at line 241 of file regIOobject.C.

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

Referenced by regionFunctionObject::clearObject(), regIOobject::regIOobject(), and populationBalanceModel::groups::retrieve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addWatch()

void addWatch ( )

Add file watch on object (if registered and READ_IF_MODIFIED)

Definition at line 259 of file regIOobject.C.

References Foam::abort(), f(), Foam::FatalError, FatalErrorIn, Foam::fileHandler(), IOobject::fileModificationChecking, fileOperation::findWatch(), forAll, forAllReverse, fileOperation::getFile(), UPstream::master(), UPstream::parRun(), fileOperation::removeWatch(), Pstream::scatter(), List< T >::setSize(), List< T >::size(), and Foam::type().

Referenced by fvConstraints::fvConstraints(), fvModels::fvModels(), IOdictionary::IOdictionary(), IOListBase< Container, IOContainer, Type >::IOListBase(), IOPtrList< Type >::IOPtrList(), localIOdictionary::localIOdictionary(), thermophysicalTransportModel::thermophysicalTransportModel(), Time::Time(), and timeIOdictionary::timeIOdictionary().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ registered()

bool registered ( ) const

inline

Is this object registered with the registry?

Definition at line 28 of file regIOobjectI.H.

◆ ownedByRegistry()

bool ownedByRegistry ( ) const

inline

Is this object owned by the registry?

Definition at line 34 of file regIOobjectI.H.

Referenced by objectRegistry::checkOut(), regionFunctionObject::clearObject(), removeRegisteredObject::execute(), and volPointInterpolation::interpolate().

Here is the caller graph for this function:

◆ store() [1/3]

void store ( )

inline

Transfer ownership of this object to its registry.

Definition at line 40 of file regIOobjectI.H.

Referenced by LiftForce< CloudType >::cacheFields(), PressureGradientForce< CloudType >::cacheFields(), zeroDimensionalMassSourceBase::correct(), volPointInterpolation::interpolate(), basicThermo::lookupOrConstruct(), waveSuperposition::New(), DemandDrivenMeshObject< Mesh, MeshObjectType, Type >::New(), populationBalanceModel::groups::New(), turbulenceFields::processField(), fieldAverage::readMeanFieldType(), objectRegistry::subRegistry(), waveSuperposition::waveSuperposition(), and waveSurfacePressureFvPatchScalarField::waveSurfacePressureFvPatchScalarField().

Here is the caller graph for this function:

◆ store() [2/3]

Type & store ( Type * tPtr )

inlinestatic

Transfer ownership of the given object pointer to its registry.

and return reference to object.

Definition at line 48 of file regIOobjectI.H.

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

Here is the call graph for this function:

◆ store() [3/3]

Type & store ( autoPtr< Type > & atPtr )

inlinestatic

Transfer ownership of the given object pointer to its registry.

and return reference to object.

Definition at line 65 of file regIOobjectI.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and autoPtr< T >::ptr().

Here is the call graph for this function:

◆ release()

void release ( )

inline

Release ownership of this object from its registry.

Definition at line 83 of file regIOobjectI.H.

Referenced by removeRegisteredObject::execute(), volPointInterpolation::interpolate(), and DemandDrivenMeshObject< Mesh, MeshObjectType, Type >::~DemandDrivenMeshObject().

Here is the caller graph for this function:

◆ eventNo() [1/2]

Foam::label eventNo ( ) const

inline

Event number at last update.

Definition at line 89 of file regIOobjectI.H.

Referenced by fvMatrix< Type >::fvMatrix(), objectRegistry::getEvent(), polyMesh::setUpToDatePoints(), and regIOobject::upToDate().

Here is the caller graph for this function:

◆ eventNo() [2/2]

Foam::label & eventNo ( )

inline

Event number at last update.

Definition at line 94 of file regIOobjectI.H.

◆ upToDate() [1/4]

bool upToDate ( const regIOobject & a ) const

Return true if up-to-date with respect to given object.

otherwise false

Definition at line 329 of file regIOobject.C.

References regIOobject::eventNo().

Referenced by volPointInterpolation::interpolate(), 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

Return true if up-to-date with respect to given objects.

otherwise false

Definition at line 342 of file regIOobject.C.

References b, and regIOobject::eventNo().

Here is the call graph for this function:

◆ upToDate() [3/4]

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

Return true if up-to-date with respect to given objects.

otherwise false

Definition at line 363 of file regIOobject.C.

References b, Foam::constant::universal::c, and regIOobject::eventNo().

Here is the call graph for this function:

◆ upToDate() [4/4]

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

Return true if up-to-date with respect to given objects.

otherwise false

Definition at line 386 of file regIOobject.C.

References b, Foam::constant::universal::c, and regIOobject::eventNo().

Here is the call graph for this function:

◆ setUpToDate()

void setUpToDate ( )

Set up to date (obviously)

Definition at line 411 of file regIOobject.C.

◆ rename()

void rename ( const word & newName )

virtual

Rename.

Reimplemented from IOobject.

Reimplemented in objectRegistry.

Definition at line 417 of file regIOobject.C.

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

Referenced by fvConstraints::fvConstraints(), fvModels::fvModels(), momentumTransportModel::momentumTransportModel(), reuseTmpTmpDimensionedField< TypeR, Type1, TypeR, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, Type2, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, GeoMesh >::New(), Foam::New(), reuseTmpDimensionedField< TypeR, TypeR, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, Type1, TypeR, PatchField, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, TypeR, Type2, PatchField, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, TypeR, TypeR, PatchField, GeoMesh >::New(), reuseTmpGeometricField< TypeR, TypeR, PatchField, GeoMesh >::New(), physicalProperties::physicalProperties(), and objectRegistry::rename().

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 453 of file regIOobject.C.

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

Referenced by CompactIOListBase< Container, IOContainer, CompactIOContainer, Type >::CompactIOListBase(), decomposedBlockData::decomposedBlockData(), extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), featureEdgeMesh::featureEdgeMesh(), functionObjectList::functionObjectList(), hexRef8::hexRef8(), IOdistributionMap::IOdistributionMap(), IOListBase< Container, IOContainer, Type >::IOListBase(), polyBoundaryMesh::polyBoundaryMesh(), boundaryRegion::readDict(), cellTable::readDict(), regIOobject::readHeaderOk(), refinementHistory::refinementHistory(), and UniformDimensionedField< Type >::UniformDimensionedField().

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	read = `true`
	)

Return Istream and check object type against that given.

Definition at line 134 of file regIOobjectRead.C.

References Foam::endl(), IOWarningInFunction, Foam::name(), Foam::Pout, Foam::read(), and Foam::type().

Referenced by DimensionedField< Type, GeoMesh >::DimensionedField(), extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), featureEdgeMesh::featureEdgeMesh(), fieldDictionary::fieldDictionary(), IOdistributionMap::IOdistributionMap(), IOListBase< Container, IOContainer, Type >::IOListBase(), IOPtrList< Type >::IOPtrList(), polyBoundaryMesh::polyBoundaryMesh(), polyBoundaryMeshEntries::polyBoundaryMeshEntries(), refinementHistory::refinementHistory(), surfacePatchIOList::surfacePatchIOList(), surfZoneIOList::surfZoneIOList(), and UniformDimensionedField< Type >::UniformDimensionedField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ close()

void close ( )

Close Istream.

Definition at line 182 of file regIOobjectRead.C.

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

Referenced by extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), featureEdgeMesh::featureEdgeMesh(), fieldDictionary::fieldDictionary(), IOdistributionMap::IOdistributionMap(), IOListBase< Container, IOContainer, Type >::IOListBase(), IOPtrList< Type >::IOPtrList(), polyBoundaryMesh::polyBoundaryMesh(), polyBoundaryMeshEntries::polyBoundaryMeshEntries(), masterUncollatedFileOperation::read(), uncollatedFileOperation::read(), refinementHistory::refinementHistory(), surfacePatchIOList::surfacePatchIOList(), and surfZoneIOList::surfZoneIOList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readData()

bool readData ( Istream & )

virtual

Virtual readData function.

Must be defined in derived types for which re-reading is required

Reimplemented in refinementHistory, IOdistributionMap, IOdictionary, GlobalIOListBase< Container, IOContainer, Type >, GlobalIOListBase< List, GlobalIOList, Type >, GlobalIOListBase< Field, GlobalIOField, Type >, featureEdgeMesh, extendedFeatureEdgeMesh, coordinateSystems, fvModels, and fvConstraints.

Definition at line 196 of file regIOobjectRead.C.

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

Here is the caller graph for this function:

◆ read()

bool read ( )

virtual

Read object.

Reimplemented in twoPhaseMixture, thermophysicalTransportModel, solidThermophysicalTransportModel, phaseSolidThermophysicalTransportModel, radiationModel, viscosityModel, solutionControl, momentumTransportModel, twoPhaseVoFMixture, PhysicalPropertiesThermo< BasicThermoType >, PhysicalPropertiesThermo< solidThermo::composite >, BasicThermo< MixtureType, BasicThermoType >, viewFactor, P1, opaqueSolid, noRadiation, fvDOM, refinementHistory, constant, physicalProperties, tolerances, solution, controlIOdictionary, objectRegistry, decomposedBlockData, IOOutputFilter< OutputFilter >, functionObjectList, solver, fvSchemes, nonOrthogonalSolutionControl, fluidSolutionControl, simpleControl, pisoControl, pimpleNoLoopControl, pimpleMultiRegionControl, porosityModel, IOporosityModelList, IOMRFZoneList, fvModels, fvConstraints, zoneCombustion, singleStepCombustion, PaSR, noCombustion, laminar, infinitelyFastChemistry, FSD, EDC, diffusion, combustionModel, solidDisplacement, solid, multiphaseVoFMixture, phaseSystem, phaseModel, multiphaseEuler, isothermalFilm, incompressibleTwoPhaseVoFMixture, incompressibleMultiphaseVoFMixture, slurry, Quemada, plastic, BinghamPlastic, incompressibleDriftFluxMixture, fluidSolver, compressibleTwoPhaseVoFMixture, compressibleInterPhaseThermophysicalTransportModel, and PDRDragModel.

Definition at line 202 of file regIOobjectRead.C.

References IOstream::BINARY, Foam::fileHandler(), IOobject::fileModificationChecking, forAll, forAllReverse, fileOperation::getFile(), fileOperation::read(), fileOperation::removeWatch(), List< T >::setSize(), List< T >::size(), and Foam::type().

Referenced by CompactIOListBase< Container, IOContainer, CompactIOContainer, Type >::CompactIOListBase(), incompressibleMultiphaseVoFMixture::read(), phaseSystem::read(), multiphaseVoFMixture::read(), combustionModel::read(), fvConstraints::read(), fvModels::read(), IOMRFZoneList::read(), IOporosityModelList::read(), fvSchemes::read(), functionObjectList::read(), IOOutputFilter< OutputFilter >::read(), controlIOdictionary::read(), solution::read(), tolerances::read(), physicalProperties::read(), momentumTransportModel::read(), radiationModel::read(), phaseSolidThermophysicalTransportModel::read(), solidThermophysicalTransportModel::read(), thermophysicalTransportModel::read(), and twoPhaseMixture::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ watchIndices() [1/2]

const Foam::labelList & watchIndices ( ) const

inline

Return file-monitoring handles.

Definition at line 100 of file regIOobjectI.H.

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

Here is the caller graph for this function:

◆ watchIndices() [2/2]

Foam::labelList & watchIndices ( )

inline

Return file-monitoring handles.

Definition at line 106 of file regIOobjectI.H.

◆ modified()

bool modified ( ) const

virtual

Return true if the object's file (or files for objectRegistry)

have been modified. (modified state is cached by Time)

Reimplemented in objectRegistry.

Definition at line 248 of file regIOobjectRead.C.

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

Referenced by fluidSolver::dependenciesModified(), solidDisplacement::dependenciesModified(), and singleRegionSolutionControl::dependenciesModified().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dependenciesModified()

virtual bool dependenciesModified ( ) const

inlinevirtual

Return true if the object's dependencies have been modified.

Reimplemented in solutionControl, objectRegistry, singleRegionSolutionControl, solidDisplacement, solid, isothermalFilm, and fluidSolver.

Definition at line 286 of file regIOobject.H.

◆ readIfModified()

bool readIfModified ( )

virtual

Read object if modified (as set by call to modified)

Reimplemented in objectRegistry.

Definition at line 262 of file regIOobjectRead.C.

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

Here is the call graph for this function:

◆ writeData()

virtual bool writeData ( Ostream & ) const

pure virtual

Pure virtual writaData function.

Must be defined in derived types

Referenced by collatedFileOperation::appendObject(), masterUncollatedFileOperation::read(), uncollatedFileOperation::read(), searchableSurfaceWithGaps::writeData(), collatedFileOperation::writeObject(), fileOperation::writeObject(), and masterUncollatedFileOperation::writeObject().

Here is the caller graph for this function:

◆ writeObject()

bool writeObject	(	IOstream::streamFormat	fmt,
		IOstream::versionNumber	ver,
		IOstream::compressionType	cmp,
		const bool	write
	)		const

virtual

Write using given format, version and compression.

Reimplemented in pointZoneSet, faceZoneSet, cellZoneSet, ZoneList< ZoneType, ZonesType, MeshType >, ZoneList< pointZone, pointZoneList, polyMesh >, ZoneList< faceZone, faceZoneList, polyMesh >, ZoneList< cellZone, cellZoneList, polyMesh >, Time, decomposedBlockData, CompactIOListBase< Container, IOContainer, CompactIOContainer, Type >, CompactIOListBase< List, IOList, CompactIOList, Type >, CompactIOListBase< Field, IOField, CompactIOField, Type >, distributedTriSurfaceMesh, polyMesh, polyBoundaryMesh, triSurfaceMesh, Cloud< ParticleType >, Cloud< ParcelType >, Cloud< solidParticle >, Cloud< molecule >, Cloud< sampledSetParticle >, Cloud< streamlinesParticle >, Cloud< passiveParticle >, fvMesh, objectRegistry, and fvModels.

Definition at line 36 of file regIOobjectWrite.C.

References Foam::endl(), Foam::fileHandler(), IOobject::fileModificationChecking, regIOobject::globalFile(), IOobject::good(), IOobject::inotifyMaster, UList< T >::last(), UPstream::master(), IOobject::name(), Foam::Pout, SeriousErrorInFunction, fileOperation::setUnmodified(), List< T >::size(), IOobject::timeStampMaster, IOobject::updateInstance(), regIOobject::write(), and fileOperation::writeObject().

Referenced by polyBoundaryMesh::writeObject(), CompactIOListBase< Container, IOContainer, CompactIOContainer, Type >::writeObject(), cellZoneSet::writeObject(), faceZoneSet::writeObject(), and pointZoneSet::writeObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

bool write ( const bool write = true ) const

virtual

Write using setting from DB.

Reimplemented in AveragingMethod< Type >, AveragingMethod< scalar >, AveragingMethod< Foam::Vector >, IOPosition< CloudType >, and fvMesh.

Definition at line 93 of file regIOobjectWrite.C.

References IOstream::currentVersion, and Foam::vtkWriteOps::write().

Referenced by snappyLayerDriver::addLayers(), rotorDisk::addSup(), multiValveEngine::movingObject::calcScale(), DarcyForchheimer::calcTransformModelData(), Foam::meshCheck::checkGeometry(), Foam::meshCheck::checkTopology(), compressibleTwoPhaseVoFMixture::compressibleTwoPhaseVoFMixture(), compressibleVoFphase::compressibleVoFphase(), hexRef8::consistentSlowRefinement2(), snappySnapDriver::doSnap(), meshRefinement::dumpRefinementLevel(), massFractions::execute(), Foam::hydrostaticInitialisation(), main(), Foam::MapConsistentVolFields(), Foam::MapLagrangianFields(), Foam::MapVolFields(), meshRefinement::mergeEdgesUndo(), meshRefinement::mergePatchFacesUndo(), multiphaseVoFMixture::multiphaseVoFMixture(), Foam::operator<<(), mappedExtrudedPatchBase::patchLocalPoints(), polyMesh::polyMesh(), solidDisplacement::postSolve(), refiner::refiner(), snappySnapDriver::scaleMesh(), hexRef8::setRefinement(), hexRef8::setUnrefinement(), sixDoFRigidBodyMotionSolver::sixDoFRigidBodyMotionSolver(), snappySnapDriver::smoothDisplacement(), cellsToCells::update(), wallBoilingProperties::write(), regionSizeDistribution::write(), writeCellCentres::write(), writeCellVolumes::write(), XiReactionRate::write(), dsmcFields::write(), RelativeVelocity< CloudType >::write(), fvMesh::write(), refiner::write(), IOPosition< CloudType >::write(), DSMCParcel< ParcelType >::writeFields(), molecule::writeFields(), solidParticle::writeFields(), streamlinesParticle::writeFields(), CollidingParcel< ParcelType >::writeFields(), MomentumParcel< ParcelType >::writeFields(), ReactingMultiphaseParcel< ParcelType >::writeFields(), SprayParcel< ParcelType >::writeFields(), particle::writeFields(), writeObjectsBase::writeObject(), regionFunctionObject::writeObject(), fvMesh::writeObject(), regIOobject::writeObject(), cellZoneSet::writeObject(), faceZoneSet::writeObject(), pointZoneSet::writeObject(), domainDecomposition::writeProcs(), and volFieldValue::writeValues().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [1/2]

void operator= ( const IOobject & io )

Assign to IOobject.

Definition at line 474 of file regIOobject.C.

References IOobject::operator=().

Here is the call graph for this function:

◆ operator=() [2/2]

void operator= ( const regIOobject & )

delete

Disallow default assignment.

◆ caseName() [2/2]

const Foam::fileName & caseName

Definition at line 391 of file IOobject.C.

◆ path() [2/2]

Foam::fileName path

Return complete path including the processor sub-directory.

for a parallel run if global is set false

Definition at line 407 of file IOobject.C.

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

Here is the call graph for this function:

◆ objectPath() [2/2]

fileName objectPath

inline

Return complete path + object name including the processor.

sub-directory for a parallel run if global is set false

Definition at line 411 of file IOobject.H.

◆ filePath() [2/2]

Foam::fileName filePath

Return complete path + object name if the file exists.

in the case directory otherwise null.

If global and parallel searches up into the global case directory.

Definition at line 430 of file IOobject.C.

Member Data Documentation

◆ fileModificationSkew

float fileModificationSkew

static

Definition at line 100 of file regIOobject.H.

Referenced by argList::parse().

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/regIOobjectRead.C
src/OpenFOAM/db/regIOobject/regIOobjectWrite.C

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ regIOobject() [1/6]

◆ regIOobject() [2/6]

◆ regIOobject() [3/6]

◆ regIOobject() [4/6]

◆ regIOobject() [5/6]

◆ regIOobject() [6/6]

◆ ~regIOobject()

Member Function Documentation

◆ readHeaderOk()

◆ TypeName()

◆ global()

◆ globalFile()

◆ caseName() [1/2]

◆ path() [1/2]

◆ objectPath() [1/2]

◆ filePath() [1/2]

◆ checkIn()

◆ checkOut()

◆ addWatch()

◆ registered()

◆ ownedByRegistry()

◆ store() [1/3]

◆ store() [2/3]

◆ store() [3/3]

◆ release()

◆ eventNo() [1/2]

◆ eventNo() [2/2]

◆ upToDate() [1/4]

◆ upToDate() [2/4]

◆ upToDate() [3/4]

◆ upToDate() [4/4]

◆ setUpToDate()

◆ rename()

◆ headerOk()

◆ readStream()

◆ close()

◆ readData()

◆ read()

◆ watchIndices() [1/2]

◆ watchIndices() [2/2]

◆ modified()

◆ dependenciesModified()

◆ readIfModified()

◆ writeData()

◆ writeObject()

◆ write()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ caseName() [2/2]

◆ path() [2/2]

◆ objectPath() [2/2]

◆ filePath() [2/2]

Member Data Documentation

◆ fileModificationSkew