regIOobject Class Reference

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

Inheritance diagram for regIOobject:

Collaboration diagram for regIOobject:

Public Types
enum	fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Types of communications. More...
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...

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 &)
	Construct as copy. More...
	regIOobject (const regIOobject &, bool registerCopy)
	Construct as copy, transferring registry registration to copy. More...
	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Construct as copy with new name, transfering registry registration. More...
	regIOobject (const IOobject &, const regIOobject &)
	Construct as copy with new IO parameters. More...
virtual	~regIOobject ()
	Destructor. More...
bool	checkIn ()
	Add object to registry. More...
bool	checkOut ()
	Remove object from 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...
Istream &	readStream (const word &)
	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...
label	watchIndex () const
	Return file-monitoring handle. More...
label &	watchIndex ()
	Return file-monitoring handle. More...
virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) 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
	Write using given format, version and compression. More...
virtual bool	write () const
	Write using setting from DB. More...
void	operator= (const IOobject &)
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 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...
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
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)
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)

Static Public Attributes
static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames
static int	fileModificationSkew
static fileCheckTypes	fileModificationChecking

Static Protected Attributes
static bool	masterOnlyReading = false
	To flag master-only reading of objects. More...

Private Member Functions
Istream &	readStream ()
	Return Istream. More...
void	operator= (const regIOobject &)
	Dissallow assignment. More...

Private Attributes
bool	registered_
	Is this object registered with the registry. More...
bool	ownedByRegistry_
	Is this object owned by the registry. More...
label	watchIndex_
	Modification watch index. More...
label	eventNo_
	eventNo of last update More...
Istream *	isPtr_
	Istream for reading. More...

Friends
class	functionEntries::codeStream
	Declare friendship with any classes that need access to. More...

Additional Inherited Members
Protected Member Functions inherited from IOobject
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...

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 60 of file regIOobject.H.

Member Enumeration Documentation

fileCheckTypes

enum fileCheckTypes

Types of communications.

Enumerator
timeStamp
timeStampMaster
inotify
inotifyMaster

Definition at line 68 of file regIOobject.H.

Constructor & Destructor Documentation

regIOobject() [1/5]

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

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

top level regIOobject.

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

)

Construct as copy.

Definition at line 144 of file regIOobject.C.

regIOobject() [3/5]

regIOobject	(	const regIOobject &	rio,
		bool	registerCopy
	)

Construct as copy, transferring registry registration to copy.

if registerCopy is true

Definition at line 159 of file regIOobject.C.

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

Here is the call graph for this function:

regIOobject() [4/5]

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

Construct as copy with new name, transfering registry registration.

to copy as specified

Definition at line 177 of file regIOobject.C.

regIOobject() [5/5]

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

Construct as copy with new IO parameters.

Definition at line 198 of file regIOobject.C.

~regIOobject()

~regIOobject ( )

virtual

Destructor.

Definition at line 220 of file regIOobject.C.

References Foam::endl(), Foam::Info, Foam::name(), path(), and Foam::type().

Here is the call graph for this function:

Member Function Documentation

readStream() [1/2]

Foam::Istream & readStream ( )

private

Return Istream.

Definition at line 34 of file regIOobjectRead.C.

References Foam::abort(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::FatalIOError, FatalIOErrorInFunction, IOobject::filePath(), Time::getFile(), IOobject::headerClassName(), regIOobject::isPtr_, IOobject::name(), IOobject::NO_READ, IOobject::objectPath(), IOobject::objectStream(), Foam::Pout, IOobject::readHeader(), IOobject::readOpt(), Time::setUnmodified(), IOobject::time(), and regIOobject::watchIndex_.

Referenced by extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), featureEdgeMesh::featureEdgeMesh(), IODynList< T, IndexType >::IODynList(), IOLongList< T, Offset >::IOLongList(), IOMap< T >::IOMap(), IOmapDistribute::IOmapDistribute(), IOmapDistributePolyMesh::IOmapDistributePolyMesh(), IOdictionary::readFile(), polyTopoChanger::readModifiers(), refinementHistory::refinementHistory(), and topoSet::topoSet().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=() [1/2]

void operator= ( const regIOobject &  )

private

Dissallow assignment.

TypeName()

TypeName

(

"regIOobject"

)

Runtime type information.

checkIn()

bool checkIn

(

)

Add object to registry.

Definition at line 247 of file regIOobject.C.

References Foam::abort(), polyMesh::defaultRegion, Foam::endl(), f(), Foam::FatalError, FatalErrorInFunction, Foam::name(), List::size(), 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 308 of file regIOobject.C.

Referenced by regIOobject::regIOobject().

Here is the caller graph for this function:

ownedByRegistry()

bool ownedByRegistry ( ) const

inline

Is this object owned by the registry?

Definition at line 28 of file regIOobjectI.H.

References regIOobject::ownedByRegistry_.

Referenced by objectRegistry::checkOut(), and removeRegisteredObject::execute().

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 34 of file regIOobjectI.H.

Referenced by fieldAverage::addMeanFieldType(), CrankNicolsonDdtScheme< Type >::ddt0_(), codedFixedValuePointPatchField< Type >::dict(), codedFixedValueFvPatchField< Type >::dict(), codedMixedFvPatchField< Type >::dict(), volPointInterpolation::interpolate(), options::New(), coordinateSystems::New(), vtkUnstructuredReader::read(), and objectRegistry::subRegistry().

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 41 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 57 of file regIOobjectI.H.

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

Here is the call graph for this function:

release()

void release ( )

inline

Release ownership of this object from its registry.

Definition at line 74 of file regIOobjectI.H.

eventNo() [1/2]

Foam::label & eventNo ( ) const

inline

Event number at last update.

Definition at line 80 of file regIOobjectI.H.

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

Here is the caller graph for this function:

eventNo() [2/2]

label& eventNo ( )

inline

Event number at last update.

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

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

Referenced by 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 368 of file regIOobject.C.

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

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 378 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

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

otherwise false

Definition at line 389 of file regIOobject.C.

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

setUpToDate()

void setUpToDate

(

)

Set up to date (obviously)

Flag me as up to date.

Definition at line 401 of file regIOobject.C.

rename()

void rename ( const word &  newName )

virtual

Rename.

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:

readStream() [2/2]

Foam::Istream & readStream

(

const word &

expectName

)

Return Istream and check object type against that given.

Definition at line 111 of file regIOobjectRead.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::name(), and Foam::Pout.

Here is the call graph for this function:

close()

void close

(

)

Close Istream.

Definition at line 148 of file regIOobjectRead.C.

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

Referenced by extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), featureEdgeMesh::featureEdgeMesh(), fieldDictionary::fieldDictionary(), IODynList< T, IndexType >::IODynList(), IOLongList< T, Offset >::IOLongList(), IOMap< T >::IOMap(), IOmapDistribute::IOmapDistribute(), IOmapDistributePolyMesh::IOmapDistributePolyMesh(), pointFieldPMG::pointFieldPMG(), polyBoundaryMeshEntries::polyBoundaryMeshEntries(), IOdictionary::readFile(), polyTopoChanger::readModifiers(), 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

Virtual readData function.

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

Reimplemented in refinementHistory, refinementHistory, extendedFeatureEdgeMesh, IOdictionary, featureEdgeMesh, IOmapDistribute, and IOmapDistributePolyMesh.

Definition at line 165 of file regIOobjectRead.C.

read()

bool read ( )

virtual

Read object.

Reimplemented in radiationModel, phaseChangeTwoPhaseMixture, turbulenceModel, basicThermo, refinementHistory, refinementHistory, phaseSystem, Time, Time, Time, multiphaseSystem, multiphaseMixture, solarHeatLoad, solarLoad, kinematicSingleLayer, incompressibleThreePhaseMixture, engineTime, fvDOM, thermoSingleLayer, incompressibleTwoPhaseInteractingMixture, twoPhaseSystem, viewFactor, solidThermo, reactingOneDim, motionSolver, incompressibleTwoPhaseMixture, combustionModel, fvSchemes, SRFModel, solution, sixDoFRigidBodyMotionSolver, regionModel, rhoCombustionModel, psiCombustionModel, IOOutputFilter< OutputFilter >, SchnerrSauer, distributedTriSurfaceMesh, Kunz, P1, thermalBaffle, Merkle, regionModel1D, singlePhaseTransportModel, IOMRFZoneList, options, thermalBaffleModel, singleLayerRegion, opaqueSolid, rpm, noRadiation, tolerances, surfaceFilmModel, pyrolysisModel, IOporosityModelList, immiscibleIncompressibleTwoPhaseMixture, noPyrolysis, noThermo, and noFilm.

Definition at line 171 of file regIOobjectRead.C.

References UPstream::commsStruct::above(), IOstream::ASCII, UPstream::commsStruct::below(), Foam::endl(), regIOobject::fileModificationChecking, forAll, UPstream::linearCommunication(), UPstream::master(), regIOobject::masterOnlyReading, UPstream::msgType(), UPstream::myProcNo(), Foam::name(), UPstream::nProcs(), UPstream::nProcsSimpleSum, UPstream::parRun(), Foam::Pout, Pstream::scatter(), UPstream::scheduled, UPstream::treeCommunication(), Foam::type(), UPstream::worldComm, and writeData().

Referenced by IOporosityModelList::read(), tolerances::read(), IOMRFZoneList::read(), singlePhaseTransportModel::read(), turbulenceModel::read(), regionModel::read(), solution::read(), SRFModel::read(), fvSchemes::read(), combustionModel::read(), incompressibleTwoPhaseMixture::read(), motionSolver::read(), solidThermo::read(), radiationModel::read(), and basicThermo::read().

Here is the call graph for this function:

Here is the caller graph for this function:

watchIndex() [1/2]

Foam::label & watchIndex ( ) const

inline

Return file-monitoring handle.

Definition at line 91 of file regIOobjectI.H.

Referenced by Time::readDict().

Here is the caller graph for this function:

watchIndex() [2/2]

label& watchIndex ( )

inline

Return file-monitoring handle.

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 271 of file regIOobjectRead.C.

References fileMonitor::UNMODIFIED.

readIfModified()

bool readIfModified ( )

virtual

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

Reimplemented in objectRegistry.

Definition at line 284 of file regIOobjectRead.C.

References Foam::endl(), Foam::Info, Foam::name(), Foam::nl, and Foam::read().

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

Implemented in searchableSurfaceWithGaps, porosityModel, DarcyForchheimer, powerLaw, fixedCoeff, virtualMassModel, virtualMassModel, surfaceTensionModel, AverageIOField< Type >, fieldDictionary, refinementHistory, refinementHistory, searchableCone, topoSet, triSurfaceMesh, searchableSurfaceCollection, searchableBox, searchableRotatedBox, searchableCylinder, polyBoundaryMesh, searchableDisk, searchablePlate, searchableSphere, objectRegistry, searchablePlane, PDRDragModel, polyTopoChanger, extendedFeatureEdgeMesh, coordinateSystems, pointFieldPMG, IOdictionary, faceListPMG, surfacePatchIOList, surfacePatchIOList, surfZoneIOList, UniformDimensionedField< Type >, UniformDimensionedField< scalar >, UniformDimensionedField< vector >, IOPtrList< T >, IOPtrList< coordinateSystem >, IOPtrList< Foam::entry >, featureEdgeMesh, IOmapDistribute, IOList< T >, IOMap< T >, IOList< label >, IOList< reactingParcelInjectionData >, IOList< reactingMultiphaseParcelInjectionData >, IOList< kinematicParcelInjectionData >, IOList< labelList >, IOField< Type >, IOField< vector >, IOmapDistributePolyMesh, IODynList< T, IndexType >, IOLongList< T, Offset >, cellIOGraph, faceIOGraph, polyBoundaryMeshEntries, SLGThermo, MeshObject< fvMesh, MoveableMeshObject, FitDataType >, MeshObject< polyMesh, UpdateableMeshObject, decompositionModel >, MeshObject< fvMesh, MoveableMeshObject, CentredFitData< Polynomial > >, MeshObject< fvMesh, TopologicalMeshObject, centredCPCCellToFaceStencilObject >, MeshObject< polyMesh, GeometricMeshObject, meshSearchMeshObject >, MeshObject< fvMesh, UpdateableMeshObject, wallDist >, MeshObject< pointMesh, UpdateableMeshObject, pointConstraints >, MeshObject< polyMesh, UpdateableMeshObject, twoDPointCorrector >, MeshObject< fvMesh, TopologicalMeshObject, centredCECCellToCellStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, centredCFCFaceToCellStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, upwindFECCellToFaceStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, centredCPCCellToCellStencilObject >, MeshObject< polyMesh, GeometricMeshObject, meshSearchFACE_CENTRE_TRISMeshObject >, MeshObject< fvMesh, TopologicalMeshObject, centredCFCCellToCellStencilObject >, MeshObject< fvMesh, MoveableMeshObject, LeastSquaresVectors< Stencil > >, MeshObject< fvMesh, Foam::GeometricMeshObject, boundaryRadiationProperties >, MeshObject< fvMesh, MoveableMeshObject, leastSquaresVectors >, MeshObject< fvMesh, TopologicalMeshObject, upwindCECCellToFaceStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, upwindCFCCellToFaceStencilObject >, MeshObject< fvMesh, UpdateableMeshObject, volPointInterpolation >, MeshObject< fvMesh, TopologicalMeshObject, pureUpwindCFCCellToFaceStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, upwindCPCCellToFaceStencilObject >, MeshObject< lduMesh, GeometricMeshObject, GAMGAgglomeration >, MeshObject< fvMesh, MoveableMeshObject, skewCorrectionVectors >, MeshObject< fvMesh, TopologicalMeshObject, centredCECCellToFaceStencilObject >, MeshObject< fvMesh, MoveableMeshObject, UpwindFitData< Polynomial > >, MeshObject< polyMesh, TopologicalMeshObject, regionSplit >, MeshObject< polyMesh, UpdateableMeshObject, pointMesh >, MeshObject< fvMesh, TopologicalMeshObject, centredCFCCellToFaceStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, centredFECCellToFaceStencilObject >, and MeshObject< fvMesh, MoveableMeshObject, CentredFitSnGradData< Polynomial > >.

Referenced by searchableSurfaceWithGaps::writeData().

Here is the caller graph for this function:

writeObject()

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

virtual

Write using given format, version and compression.

Reimplemented in Time, Time, Time, faceZoneSet, pointZoneSet, cellZoneSet, distributedTriSurfaceMesh, triSurfaceMesh, dynamicRefineFvMesh, polyBoundaryMesh, objectRegistry, motionSolver, and sixDoFRigidBodyMotionSolver.

Definition at line 37 of file regIOobjectWrite.C.

References Foam::endl(), IOstream::good(), Foam::Info, IOobject::instance(), Foam::mkDir(), Foam::name(), path(), SeriousErrorInFunction, Foam::system(), timeName, and writeData().

Referenced by main(), regIOobject::write(), Cloud< streamLineParticle >::writeCloudUniformProperties(), meshReader::writeMeshLabelList(), CompactIOField::writeObject(), cellZoneSet::writeObject(), pointZoneSet::writeObject(), faceZoneSet::writeObject(), and polyBoundaryMesh::writeObject().

Here is the call graph for this function:

Here is the caller graph for this function:

write()

bool write ( ) const

virtual

Write using setting from DB.

Reimplemented in fvMesh.

Definition at line 126 of file regIOobjectWrite.C.

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

Referenced by polyDualMesh::calcDual(), meshToMesh::calculate(), Foam::checkGeometry(), Foam::checkMeshQuality(), Foam::checkTopology(), hexRef8::consistentSlowRefinement2(), autoRefineDriver::danglingCellRefine(), doCommand(), dynamicRefineFvMesh::dynamicRefineFvMesh(), findBaffles(), meshRefinement::findEdgeConnectedProblemCells(), meshRefinement::getChangedFaces(), meshRefinement::handleSnapProblems(), main(), Foam::MapLagrangianFields(), meshRefinement::markFacesOnProblemCells(), meshRefinement::mergeEdgesUndo(), meshRefinement::mergePatchFacesUndo(), polyMesh::movePoints(), polyMesh::polyMesh(), parLagrangianRedistributor::redistributeLagrangianFields(), autoRefineDriver::refinementInterfaceRefine(), MRFZone::setMRFFaces(), removeFaces::setRefinement(), hexRef8::setRefinement(), hexRef8::setUnrefinement(), IOPosition::write(), polyMeshGenPoints::write(), polyMeshGenCells::write(), polyMeshGenFaces::write(), calcMag::write(), writeRegisteredObject::write(), calcFvcDiv::write(), calcFvcGrad::write(), fieldCoordinateSystemTransform::write(), fvMesh::write(), writeCellDistance(), domainDecomposition::writeDecomposition(), writeDecomposition(), wallBoundedStreamLineParticle::writeFields(), solidParticle::writeFields(), MPPICParcel::writeFields(), streamLineParticle::writeFields(), CollidingParcel::writeFields(), DSMCParcel::writeFields(), wallBoundedParticle::writeFields(), molecule::writeFields(), ReactingParcel::writeFields(), ReactingMultiphaseParcel::writeFields(), ThermoParcel::writeFields(), SprayParcel::writeFields(), particle< Type >::writeFields(), KinematicParcel::writeFields(), autoLayerDriver::writeLayerSets(), writeProcAddressing(), and cellSource::writeValues().

Here is the call graph for this function:

operator=() [2/2]

void operator=

(

const IOobject &

io

)

Definition at line 424 of file regIOobject.C.

References IOobject::operator=().

Here is the call graph for this function:

Friends And Related Function Documentation

functionEntries::codeStream

friend class functionEntries::codeStream

friend

Declare friendship with any classes that need access to.

masterOnlyReading

Definition at line 118 of file regIOobject.H.

Field Documentation

fileCheckTypesNames

const Foam::NamedEnum< Foam::regIOobject::fileCheckTypes, 4 > fileCheckTypesNames

static

Definition at line 76 of file regIOobject.H.

Referenced by argList::parse(), addfileModificationCheckingToOpt::readData(), and addfileModificationCheckingToOpt::writeData().

masterOnlyReading

bool masterOnlyReading = false

staticprotected

To flag master-only reading of objects.

Definition at line 82 of file regIOobject.H.

Referenced by regIOobject::read(), and IOdictionary::readFile().

registered_

bool registered_

private

Is this object registered with the registry.

Definition at line 90 of file regIOobject.H.

Referenced by regIOobject::regIOobject().

ownedByRegistry_

bool ownedByRegistry_

private

Is this object owned by the registry.

Definition at line 93 of file regIOobject.H.

Referenced by regIOobject::ownedByRegistry().

watchIndex_

label watchIndex_

mutableprivate

Modification watch index.

Definition at line 96 of file regIOobject.H.

Referenced by regIOobject::readStream().

eventNo_

label eventNo_

private

eventNo of last update

Definition at line 99 of file regIOobject.H.

isPtr_

Istream* isPtr_

private

Istream for reading.

Definition at line 102 of file regIOobject.H.

Referenced by regIOobject::readStream().

fileModificationSkew

int fileModificationSkew

static

Definition at line 126 of file regIOobject.H.

Referenced by fileMonitor::checkFiles().

fileModificationChecking

Foam::regIOobject::fileCheckTypes fileModificationChecking

static

Definition at line 128 of file regIOobject.H.

Referenced by distributedTriSurfaceMesh::distributedTriSurfaceMesh(), hexRef8::hexRef8(), IOdictionary::IOdictionary(), main(), fvMeshTools::newMesh(), argList::parse(), regIOobject::read(), addfileModificationCheckingToOpt::readData(), readLagrangian(), Time::readModifiedObjects(), Time::Time(), and addfileModificationCheckingToOpt::writeData().

---

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