regIOobject is an abstract class derived from IOobject to handle automatic object registration with the objectRegistry. More...
Inherits IOobject.
Inherited by AveragingMethod< Foam::Vector >, AveragingMethod< scalar >, BlendedInterfacialModel< Foam::dragModel >, BlendedInterfacialModel< Foam::heatTransferModel >, BlendedInterfacialModel< Foam::liftModel >, BlendedInterfacialModel< Foam::turbulentDispersionModel >, BlendedInterfacialModel< Foam::virtualMassModel >, BlendedInterfacialModel< Foam::wallLubricationModel >, CompactIOList< face, label >, DimensionedField< scalar, Foam::volMesh >, DimensionedField< scalar, triSurfacePointGeoMesh >, DimensionedField< Type, Foam::pointMesh >, DimensionedField< Type, Foam::surfaceMesh >, DimensionedField< Type, Foam::volMesh >, DimensionedField< vector, Foam::pointMesh >, AveragingMethod< Type >, baseIOdictionary, BlendedInterfacialModel< ModelType >, CompactIOField< T, BaseType >, CompactIOList< T, BaseType >, decomposedBlockData, populationBalanceModel, DimensionedField< Type, GeoMesh >, dragModel, dragModel, extendedFeatureEdgeMesh, featureEdgeMesh, fieldDictionary, GlobalIOField< Type >, GlobalIOList< Type >, IOField< Type >, IOList< T >, IOMap< T >, IOmapDistribute, IOPosition< CloudType >, IOPtrList< T >, meshObject, objectRegistry, PDRDragModel, polyBoundaryMesh, polyBoundaryMeshEntries, polyTopoChanger, porosityModel, refinementHistory, searchableSurface, SLGThermo, solutionControl, SubDimensionedField< Type, GeoMesh >, surfacePatchIOList, surfaceTensionModel, surfaceTensionModel, surfZoneIOList, topoSet, UniformDimensionedField< Type >, virtualMassModel, virtualMassModel, ZoneMesh< ZoneType, MeshType >, GlobalIOField< Foam::Vector >, IOList< kinematicParcelInjectionData >, IOList< label >, IOList< labelList >, IOList< reactingMultiphaseParcelInjectionData >, IOList< reactingParcelInjectionData >, IOPtrList< coordinateSystem >, UniformDimensionedField< scalar >, UniformDimensionedField< vector >, ZoneMesh< cellZone, polyMesh >, ZoneMesh< faceZone, polyMesh >, and ZoneMesh< pointZone, polyMesh >.
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, transferring 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... | |
| virtual void | addWatch () |
| Add file watch on object (if registered and READ_IF_MODIFIED) 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... | |
| virtual fileName | filePath () const |
| Return complete path + object name if the file exists. More... | |
| bool | headerOk () |
| Read and check header info. More... | |
| Istream & | readStream (const word &, const bool valid=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... | |
| virtual label | addWatch (const fileName &) |
| Add file watch for fileName on object if not yet watched. Return. 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 | 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 valid) const |
| Write using given format, version and compression. More... | |
| virtual bool | write (const bool valid=true) const |
| Write using setting from DB. More... | |
| virtual bool | global () const |
| Is object global. 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 ®istry, 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 ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| Construct from name, instance, local, registry, io options. More... | |
| IOobject (const fileName &path, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| Construct from path, registry, io options. More... | |
| IOobject (const IOobject &io, const objectRegistry ®istry) | |
| Construct from copy resetting registry. More... | |
| IOobject (const IOobject &io, const word &name) | |
| Construct from copy resetting name. More... | |
| autoPtr< IOobject > | clone () const |
| Clone. More... | |
| autoPtr< IOobject > | clone (const objectRegistry ®istry) 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... | |
| bool & | globalObject () |
| Is object same for all processors. More... | |
| bool | globalObject () const |
| Is object same for all processors. 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 | localFilePath (const word &typeName) const |
| Helper for filePath that searches locally. More... | |
| fileName | globalFilePath (const word &typeName) const |
| Helper for filePath that searches up if in parallel. More... | |
| bool | readHeader (Istream &) |
| Read header. More... | |
| template<class Type > | |
| bool | typeHeaderOk (const bool checkType=true) |
| Read header (uses typeFilePath to find file) and check header. 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 const NamedEnum< fileCheckTypes, 4 > | fileCheckTypesNames |
| static fileCheckTypes | fileModificationChecking |
| Type of file modification checking. More... | |
Protected Member Functions | |
| bool | readHeaderOk (const IOstream::streamFormat PstreamFormat, const word &typeName) |
| Helper: check readOpt flags and read if necessary. More... | |
| Protected Member Functions inherited from IOobject | |
| void | setBad (const string &) |
| Set the object state to bad. More... | |
Static Protected Attributes | |
| static bool | masterOnlyReading = false |
| To flag master-only reading of objects. More... | |
Friends | |
| class | functionEntries::codeStream |
| Declare friendship with any classes that need access to. More... | |
| class | fileOperations::uncollatedFileOperation |
| class | fileOperations::masterUncollatedFileOperation |
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... | |
regIOobject is an abstract class derived from IOobject to handle automatic object registration with the objectRegistry.
Definition at line 65 of file regIOobject.H.
| regIOobject | ( | const IOobject & | io, |
| const bool | isTime = false |
||
| ) |
Construct from IOobject. Optional flag for if IOobject is the.
top level regIOobject.
Definition at line 56 of file regIOobject.C.
References regIOobject::checkIn(), and IOobject::registerObject().
Referenced by regIOobject::regIOobject().
| regIOobject | ( | const regIOobject & | rio | ) |
Construct as copy.
Definition at line 77 of file regIOobject.C.
| regIOobject | ( | const regIOobject & | rio, |
| bool | registerCopy | ||
| ) |
Construct as copy, transferring registry registration to copy.
if registerCopy is true
Definition at line 89 of file regIOobject.C.
References regIOobject::checkIn(), regIOobject::checkOut(), and regIOobject::regIOobject().
| regIOobject | ( | const word & | newName, |
| const regIOobject & | rio, | ||
| bool | registerCopy | ||
| ) |
Construct as copy with new name, transferring registry registration.
to copy as specified
Definition at line 106 of file regIOobject.C.
References regIOobject::checkIn(), and regIOobject::regIOobject().
| regIOobject | ( | const IOobject & | io, |
| const regIOobject & | rio | ||
| ) |
Construct as copy with new IO parameters.
Definition at line 126 of file regIOobject.C.
References regIOobject::checkIn(), and IOobject::registerObject().
|
virtual |
Destructor.
Definition at line 146 of file regIOobject.C.
References IOobject::caseName(), regIOobject::checkOut(), IOobject::db(), Foam::endl(), IOobject::instance(), IOobject::name(), IOobject::path(), Foam::Pout, and IOobject::rootPath().
|
protected |
Helper: check readOpt flags and read if necessary.
Definition at line 36 of file regIOobjectRead.C.
References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, Foam::fileHandler(), regIOobject::filePath(), fileOperation::getFile(), regIOobject::global(), IOobject::headerClassName(), InfoInFunction, UList< T >::last(), IOobject::name(), IOobject::NO_READ, IOobject::objectPath(), Foam::Pout, fileOperation::read(), IOobject::readOpt(), fileOperation::readStream(), List< T >::size(), and Foam::type().
Referenced by GlobalIOList< Type >::GlobalIOList(), IOdictionary::IOdictionary(), localIOdictionary::localIOdictionary(), and unwatchedIOdictionary::unwatchedIOdictionary().
| TypeName | ( | "regIOobject" | ) |
Runtime type information.
| bool checkIn | ( | ) |
Add object to registry.
Definition at line 174 of file regIOobject.C.
References Foam::abort(), objectRegistry::checkIn(), IOobject::db(), polyMesh::defaultRegion, Foam::endl(), Foam::FatalError, FatalErrorInFunction, IOobject::name(), IOobject::objectPath(), HashTable< T, Key, Hash >::sortedToc(), and WarningInFunction.
Referenced by objectRegistry::dbDir(), regIOobject::operator=(), regIOobject::regIOobject(), and regIOobject::rename().
| bool checkOut | ( | ) |
Remove object from registry.
Definition at line 210 of file regIOobject.C.
References objectRegistry::checkOut(), List< T >::clear(), IOobject::db(), Foam::fileHandler(), forAllReverse, and fileOperation::removeWatch().
Referenced by regionFunctionObject::clearObject(), objectRegistry::dbDir(), regIOobject::operator=(), regIOobject::regIOobject(), regIOobject::rename(), and regIOobject::~regIOobject().
|
virtual |
Add file watch on object (if registered and READ_IF_MODIFIED)
Reimplemented in unwatchedIOdictionary.
Definition at line 251 of file regIOobject.C.
References Foam::abort(), List< T >::append(), List< T >::clear(), f(), Foam::FatalError, FatalErrorIn, Foam::fileHandler(), IOobject::fileModificationChecking, regIOobject::filePath(), fileOperation::findWatch(), forAll, forAllReverse, fileOperation::getFile(), regIOobject::global(), IOobject::inotifyMaster, UPstream::master(), IOobject::MUST_READ_IF_MODIFIED, IOobject::objectPath(), UPstream::parRun(), IOobject::readOpt(), fileOperation::removeWatch(), Pstream::scatter(), List< T >::setSize(), List< T >::size(), IOobject::time(), IOobject::timeStampMaster, and Foam::type().
Referenced by regIOobject::addWatch(), IOdictionary::IOdictionary(), IOMap< T >::IOMap(), localIOdictionary::localIOdictionary(), and regIOobject::read().
|
inline |
Is this object owned by the registry?
Definition at line 28 of file regIOobjectI.H.
Referenced by objectRegistry::checkOut(), regionFunctionObject::clearObject(), and removeRegisteredObject::execute().
|
inline |
Transfer ownership of this object to its registry.
Definition at line 34 of file regIOobjectI.H.
Referenced by fieldAverage::addMeanFieldType(), fieldAverage::addPrime2MeanFieldType(), CrankNicolsonDdtScheme< Type >::ddt0_(), volPointInterpolation::interpolate(), basicThermo::lookupOrConstruct(), NamedEnum< directionType, 3 >::names(), options::New(), coordinateSystems::New(), objectRegistry::subRegistry(), and vtkUnstructuredReader::vtkUnstructuredReader().
|
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.
|
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< T >::ptr().
|
inline |
Release ownership of this object from its registry.
Definition at line 74 of file regIOobjectI.H.
Referenced by removeRegisteredObject::execute().
|
inline |
Event number at last update.
Definition at line 80 of file regIOobjectI.H.
Referenced by fvMatrix< Type >::fvMatrix(), objectRegistry::getEvent(), polyMesh::movePoints(), polyMesh::setUpToDatePoints(), and regIOobject::upToDate().
|
inline |
Event number at last update.
Definition at line 85 of file regIOobjectI.H.
| bool upToDate | ( | const regIOobject & | a | ) | const |
Return true if up-to-date with respect to given object.
otherwise false
Definition at line 321 of file regIOobject.C.
References regIOobject::eventNo().
Referenced by regIOobject::upToDate(), and polyMesh::upToDatePoints().
| 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 335 of file regIOobject.C.
References regIOobject::eventNo(), and regIOobject::upToDate().
| 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 356 of file regIOobject.C.
References regIOobject::eventNo(), and regIOobject::upToDate().
| 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 379 of file regIOobject.C.
References regIOobject::eventNo().
| void setUpToDate | ( | ) |
Set up to date (obviously)
Definition at line 403 of file regIOobject.C.
References IOobject::db(), and objectRegistry::getEvent().
|
virtual |
Rename.
Reimplemented from IOobject.
Reimplemented in objectRegistry.
Definition at line 409 of file regIOobject.C.
References regIOobject::checkIn(), regIOobject::checkOut(), IOobject::registerObject(), and IOobject::rename().
Referenced by heThermo< BasicSolidThermo, MixtureType >::alphaEff(), heThermo< BasicSolidThermo, MixtureType >::alphahe(), ReynoldsStress< RASModel< BasicTurbulenceModel > >::k(), heThermo< BasicSolidThermo, MixtureType >::kappa(), heThermo< BasicSolidThermo, MixtureType >::kappaEff(), Foam::New(), reuseTmpDimensionedField< TypeR, TypeR, GeoMesh >::New(), reuseTmpGeometricField< TypeR, TypeR, PatchField, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, Type1, Type12, TypeR, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, Type2, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, Type1, Type12, TypeR, PatchField, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, TypeR, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, TypeR, TypeR, Type2, PatchField, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, TypeR, TypeR, TypeR, PatchField, GeoMesh >::New(), and objectRegistry::rename().
|
virtual |
Return complete path + object name if the file exists.
in the case directory otherwise null. Does not search up if parallel. Can be overridden to provide this functionality (e.g. IOdictionary)
Reimplemented in distributedTriSurfaceMesh, triSurfaceMesh, extendedFeatureEdgeMesh, UniformDimensionedField< Type >, UniformDimensionedField< scalar >, UniformDimensionedField< vector >, featureEdgeMesh, IOMap< T >, GlobalIOField< Type >, GlobalIOList< Type >, GlobalIOField< Foam::Vector >, baseIOdictionary, IOdictionary, localIOdictionary, and unwatchedIOdictionary.
Definition at line 424 of file regIOobject.C.
References IOobject::localFilePath(), and Foam::type().
Referenced by regIOobject::addWatch(), regIOobject::headerOk(), regIOobject::readHeaderOk(), and Time::writeObject().
| bool headerOk | ( | ) |
Read and check header info.
Definition at line 430 of file regIOobject.C.
References Foam::endl(), Foam::fileHandler(), regIOobject::filePath(), IOWarningInFunction, IOobject::objectPath(), fileOperation::readHeader(), and Foam::type().
Referenced by CompactIOField< T, BaseType >::CompactIOField(), extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), featureEdgeMesh::featureEdgeMesh(), fvSchemes::fvSchemes(), hexRef8::hexRef8(), IOField< Type >::IOField(), IOMap< T >::IOMap(), IOmapDistribute::IOmapDistribute(), boundaryRegion::readDict(), cellTable::readDict(), and refinementHistory::refinementHistory().
| Foam::Istream & readStream | ( | const word & | expectName, |
| const bool | valid = true |
||
| ) |
Return Istream and check object type against that given.
Definition at line 138 of file regIOobjectRead.C.
References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, IOobject::headerClassName(), IOobject::name(), and Foam::Pout.
Referenced by extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), featureEdgeMesh::featureEdgeMesh(), fieldDictionary::fieldDictionary(), IOField< Type >::IOField(), IOMap< T >::IOMap(), IOmapDistribute::IOmapDistribute(), polyBoundaryMeshEntries::polyBoundaryMeshEntries(), refinementHistory::read(), and refinementHistory::refinementHistory().
| void close | ( | ) |
Close Istream.
Definition at line 178 of file regIOobjectRead.C.
References Foam::endl(), and Foam::Pout.
Referenced by extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), featureEdgeMesh::featureEdgeMesh(), fieldDictionary::fieldDictionary(), IOField< Type >::IOField(), IOMap< T >::IOMap(), IOmapDistribute::IOmapDistribute(), polyBoundaryMeshEntries::polyBoundaryMeshEntries(), uncollatedFileOperation::read(), refinementHistory::read(), masterUncollatedFileOperation::read(), and refinementHistory::refinementHistory().
|
virtual |
Virtual readData function.
Must be defined in derived types for which re-reading is required
Reimplemented in refinementHistory, extendedFeatureEdgeMesh, GlobalIOField< Type >, GlobalIOList< Type >, GlobalIOField< Foam::Vector >, baseIOdictionary, featureEdgeMesh, and IOmapDistribute.
Definition at line 192 of file regIOobjectRead.C.
Referenced by uncollatedFileOperation::read(), masterUncollatedFileOperation::read(), and IOPosition< CloudType >::type().
|
virtual |
Read object.
Reimplemented in phaseSystem, basicThermo, refinementHistory, phaseModel, Time, twoPhaseMixtureThermo, multiphaseSystem, multiphaseMixture, kinematicSingleLayer, incompressibleThreePhaseMixture, radiationModel, phaseModel, EDC< ReactionThermo >, thermoSingleLayer, crankConRod, incompressibleTwoPhaseInteractingMixture, kineticTheoryModel, kineticTheoryModel, twoPhaseSystem, motionSolver, fvDOM, rigidBodyMeshMotion, RASModel< EddyDiffusivity< ThermalDiffusivity< PhaseCompressibleTurbulenceModel< phaseModel > > > >, RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >, rigidBodyMeshMotionSolver, engineTime, reactingOneDim, incompressibleTwoPhaseMixture, solidThermo, viewFactor, FSD< ReactionThermo, ThermoType >, combustionModel, phaseChangeTwoPhaseMixture, fvSchemes, SRFModel, solution, sixDoFRigidBodyMotionSolver, phasePressureModel, phasePressureModel, regionModel, decomposedBlockData, SchnerrSauer, zoneCombustion< ReactionThermo >, IOOutputFilter< OutputFilter >, CombustionModel< ReactionThermo >, turbulenceModel, Kunz, P1, laminar< ReactionThermo >, pimpleMultiRegionControl, PaSR< ReactionThermo >, thermalBaffle, Merkle, singleStepCombustion< ReactionThermo, ThermoType >, singlePhaseTransportModel, diffusion< ReactionThermo, ThermoType >, pimpleControl, regionModel1D, EddyDiffusivity< ThermalDiffusivity< PhaseCompressibleTurbulenceModel< phaseModel > > >, EddyDiffusivity< phaseCompressibleTurbulenceModel >, IOMRFZoneList, solutionControl, infinitelyFastChemistry< ReactionThermo, ThermoType >, eddyViscosity< RASModel< EddyDiffusivity< ThermalDiffusivity< PhaseCompressibleTurbulenceModel< phaseModel > > > > >, eddyViscosity< RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > >, pimpleNoLoopControl, noCombustion< ReactionThermo >, options, thermalBaffleModel, fluidSolutionControl, noRadiation, opaqueSolid, simpleControl, rpm, singleLayerRegion, pisoControl, tolerances, nonOrthogonalSolutionControl, pyrolysisModel, IOporosityModelList, linearViscousStress< RASModel< EddyDiffusivity< ThermalDiffusivity< PhaseCompressibleTurbulenceModel< phaseModel > > > > >, linearViscousStress< RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > >, immiscibleIncompressibleTwoPhaseMixture, solidNoLoopControl, surfaceFilmRegionModel, noPyrolysis, and noThermo.
Definition at line 198 of file regIOobjectRead.C.
References regIOobject::addWatch(), IOstream::BINARY, List< T >::clear(), Foam::fileHandler(), IOobject::fileModificationChecking, forAll, forAllReverse, fileOperation::getFile(), regIOobject::global(), IOobject::inotifyMaster, fileOperation::read(), fileOperation::removeWatch(), List< T >::setSize(), List< T >::size(), IOobject::timeStampMaster, and Foam::type().
Referenced by phaseModel::alphaPhi(), PDRDragModel::on(), porosityModel::iNew::operator()(), IOporosityModelList::read(), tolerances::read(), IOMRFZoneList::read(), singlePhaseTransportModel::read(), turbulenceModel::read(), regionModel::read(), SRFModel::read(), solution::read(), fvSchemes::read(), combustionModel::read(), solidThermo::read(), incompressibleTwoPhaseMixture::read(), motionSolver::read(), radiationModel::read(), basicThermo::read(), regIOobject::readIfModified(), and phase::rho().
|
virtual |
Add file watch for fileName on object if not yet watched. Return.
index of watch
Reimplemented in unwatchedIOdictionary.
Definition at line 228 of file regIOobject.C.
References regIOobject::addWatch(), List< T >::append(), Foam::fileHandler(), fileOperation::findWatch(), IOobject::MUST_READ_IF_MODIFIED, IOobject::readOpt(), List< T >::size(), and IOobject::time().
|
inline |
Return file-monitoring handles.
Definition at line 91 of file regIOobjectI.H.
Referenced by fileOperation::addWatches(), masterUncollatedFileOperation::addWatches(), and Time::readDict().
|
inline |
Return file-monitoring handles.
Definition at line 97 of file regIOobjectI.H.
|
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 244 of file regIOobjectRead.C.
References Foam::fileHandler(), forAllReverse, and fileMonitor::UNMODIFIED.
Referenced by regIOobject::readIfModified().
|
virtual |
Read object if modified (as set by call to modified)
Reimplemented in objectRegistry.
Definition at line 258 of file regIOobjectRead.C.
References Foam::endl(), Foam::fileHandler(), forAllReverse, fileOperation::getFile(), Foam::Info, UList< T >::last(), regIOobject::modified(), IOobject::name(), Foam::nl, regIOobject::read(), and fileMonitor::UNMODIFIED.
Referenced by Time::readModifiedObjects().
|
pure virtual |
Pure virtual writaData function.
Must be defined in derived types
Implemented in GeometricField< Type, PatchField, GeoMesh >, GeometricField< Type, Foam::pointPatchField, Foam::pointMesh >, GeometricField< Type, Foam::fvPatchField, Foam::volMesh >, GeometricField< scalar, Foam::fvPatchField, Foam::volMesh >, GeometricField< symmTensor, fvPatchField, volMesh >, GeometricField< tensor, fvPatchField, volMesh >, GeometricField< vector, fvsPatchField, surfaceMesh >, GeometricField< scalar, fvPatchField, volMesh >, GeometricField< scalar, fvsPatchField, surfaceMesh >, GeometricField< Foam::Vector, Foam::pointPatchField, Foam::pointMesh >, GeometricField< scalar, pointPatchField, pointMesh >, GeometricField< vector, fvPatchField, volMesh >, GeometricField< scalar, Foam::pointPatchField, Foam::pointMesh >, GeometricField< Type, Foam::fvsPatchField, Foam::surfaceMesh >, GeometricField< Foam::Vector, Foam::fvPatchField, Foam::volMesh >, GeometricField< vector, pointPatchField, pointMesh >, refinementHistory, populationBalanceModel, triSurfaceMesh, DimensionedField< Type, GeoMesh >, DimensionedField< scalar, Foam::volMesh >, DimensionedField< scalar, triSurfacePointGeoMesh >, DimensionedField< Type, Foam::surfaceMesh >, DimensionedField< Type, Foam::volMesh >, DimensionedField< vector, Foam::pointMesh >, DimensionedField< Type, Foam::pointMesh >, searchableSurfaceWithGaps, topoSet, searchableSurfaceCollection, porosityModel, searchableBox, searchableCylinder, solidification, polyBoundaryMesh, searchableDisk, searchablePlate, powerLawLopesdaCosta, objectRegistry, searchableExtrudedCircle, searchableSphere, searchablePlane, BlendedInterfacialModel< ModelType >, BlendedInterfacialModel< Foam::wallLubricationModel >, BlendedInterfacialModel< Foam::dragModel >, BlendedInterfacialModel< Foam::heatTransferModel >, BlendedInterfacialModel< Foam::virtualMassModel >, BlendedInterfacialModel< Foam::liftModel >, BlendedInterfacialModel< Foam::turbulentDispersionModel >, DarcyForchheimer, ZoneMesh< ZoneType, MeshType >, ZoneMesh< faceZone, polyMesh >, ZoneMesh< pointZone, polyMesh >, ZoneMesh< cellZone, polyMesh >, powerLaw, PDRDragModel, AveragingMethod< Type >, AveragingMethod< scalar >, AveragingMethod< Foam::Vector >, fixedCoeff, MeshObject< fvMesh, MoveableMeshObject, FitDataType >, MeshObject< polyMesh, GeometricMeshObject, meshSearchMeshObject >, MeshObject< polyMesh, UpdateableMeshObject, decompositionModel >, MeshObject< fvMesh, MoveableMeshObject, CentredFitData< Polynomial > >, MeshObject< fvMesh, TopologicalMeshObject, centredCPCCellToFaceStencilObject >, MeshObject< polyMesh, UpdateableMeshObject, twoDPointCorrector >, MeshObject< fvMesh, UpdateableMeshObject, wallDist >, MeshObject< pointMesh, UpdateableMeshObject, pointConstraints >, MeshObject< fvMesh, TopologicalMeshObject, centredCPCCellToCellStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, centredCECCellToCellStencilObject >, MeshObject< polyMesh, GeometricMeshObject, meshSearchFACE_CENTRE_TRISMeshObject >, MeshObject< fvMesh, TopologicalMeshObject, centredCFCFaceToCellStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, upwindFECCellToFaceStencilObject >, MeshObject< fvMesh, MoveableMeshObject, LeastSquaresVectors< Stencil > >, MeshObject< fvMesh, TopologicalMeshObject, centredCFCCellToCellStencilObject >, MeshObject< fvMesh, MoveableMeshObject, leastSquaresVectors >, MeshObject< fvMesh, TopologicalMeshObject, upwindCECCellToFaceStencilObject >, MeshObject< fvMesh, UpdateableMeshObject, volPointInterpolation >, MeshObject< fvMesh, TopologicalMeshObject, upwindCFCCellToFaceStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, upwindCPCCellToFaceStencilObject >, MeshObject< lduMesh, GeometricMeshObject, GAMGAgglomeration >, MeshObject< fvMesh, TopologicalMeshObject, pureUpwindCFCCellToFaceStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, centredCECCellToFaceStencilObject >, MeshObject< fvMesh, MoveableMeshObject, UpwindFitData< Polynomial > >, MeshObject< polyMesh, TopologicalMeshObject, regionSplit >, MeshObject< fvMesh, MoveableMeshObject, skewCorrectionVectors >, MeshObject< polyMesh, UpdateableMeshObject, pointMesh >, MeshObject< fvMesh, TopologicalMeshObject, centredCFCCellToFaceStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, centredFECCellToFaceStencilObject >, MeshObject< fvMesh, MoveableMeshObject, CentredFitSnGradData< Polynomial > >, SLGThermo, polyTopoChanger, dragModel, dragModel, surfaceTensionModel, virtualMassModel, virtualMassModel, extendedFeatureEdgeMesh, decomposedBlockData, temperatureDependent, coordinateSystems, surfaceTensionModel, CompactIOList< T, BaseType >, CompactIOList< face, label >, liquidProperties, CompactIOField< T, BaseType >, constant, surfacePatchIOList, GlobalIOField< Type >, GlobalIOList< Type >, GlobalIOField< Foam::Vector >, baseIOdictionary, surfZoneIOList, UniformDimensionedField< Type >, UniformDimensionedField< scalar >, UniformDimensionedField< vector >, IOPtrList< T >, IOPtrList< coordinateSystem >, IOPosition< CloudType >, featureEdgeMesh, IOField< Type >, IOMap< T >, IOmapDistribute, IOList< T >, IOList< label >, IOList< reactingParcelInjectionData >, IOList< reactingMultiphaseParcelInjectionData >, IOList< kinematicParcelInjectionData >, IOList< labelList >, fieldDictionary, polyBoundaryMeshEntries, and solutionControl.
Referenced by collatedFileOperation::appendObject(), uncollatedFileOperation::read(), masterUncollatedFileOperation::read(), searchableSurfaceWithGaps::writeData(), collatedFileOperation::writeObject(), fileOperation::writeObject(), and masterUncollatedFileOperation::writeObject().
|
virtual |
Write using given format, version and compression.
uncomment this if you want to write global objects on master only
bool isGlobal = global();
Reimplemented in distributedTriSurfaceMesh, fvMesh, Time, triSurfaceMesh, Cloud< ParticleType >, Cloud< Foam::passiveParticle >, Cloud< indexedParticle >, Cloud< basicKinematicCollidingParcel >, Cloud< ParcelType >, Cloud< Foam::molecule >, Cloud< solidParticle >, Cloud< parcelType >, Cloud< molecule >, Cloud< typename CloudType::parcelType >, Cloud< passiveParticle >, Cloud< streamLineParticle >, dynamicRefineFvMesh, polyBoundaryMesh, objectRegistry, motionSolver, rigidBodyMeshMotion, faceZoneSet, rigidBodyMeshMotionSolver, pointZoneSet, cellZoneSet, decomposedBlockData, sixDoFRigidBodyMotionSolver, CompactIOList< T, BaseType >, CompactIOList< face, label >, and CompactIOField< T, BaseType >.
Definition at line 37 of file regIOobjectWrite.C.
References Foam::endl(), Foam::fileHandler(), IOobject::instance(), Foam::name(), Foam::Pout, SeriousErrorInFunction, fileOperation::setUnmodified(), Foam::system(), timeName, and fileOperation::writeObject().
Referenced by meshReader::warnDuplicates(), regIOobject::write(), CompactIOField< T, BaseType >::writeObject(), cellZoneSet::writeObject(), pointZoneSet::writeObject(), faceZoneSet::writeObject(), polyBoundaryMesh::writeObject(), and distributedTriSurfaceMesh::writeObject().
|
virtual |
Write using setting from DB.
Reimplemented in fvMesh, AveragingMethod< Type >, AveragingMethod< scalar >, AveragingMethod< Foam::Vector >, and IOPosition< CloudType >.
Definition at line 168 of file regIOobjectWrite.C.
References IOstream::currentVersion, IOobject::time(), and regIOobject::writeObject().
Referenced by snappyLayerDriver::addLayers(), rotorDiskSource::addSup(), hexRef8::consistentSlowRefinement2(), thixotropicViscosity::correct(), snappySnapDriver::doSnap(), dynamicRefineFvMesh::dynamicRefineFvMesh(), Foam::MapLagrangianFields(), meshRefinement::mergePatchFacesUndo(), polyMesh::movePoints(), polyMesh::polyMesh(), snappySnapDriver::scaleMesh(), hexRef8::setUnrefinement(), snappyRefineDriver::snappyRefineDriver(), surfMesh::surfZones(), IOPosition< CloudType >::write(), PatchCollisionDensity< CloudType >::write(), dsmcFields::write(), writeCellVolumes::write(), XiReactionRate::write(), AveragingMethod< Foam::Vector >::write(), regionSizeDistribution::write(), fvMesh::write(), hexRef8::write(), meshRefinement::write(), KinematicParcel< ParcelType >::writeFields(), streamLineParticle::writeFields(), MPPICParcel< ParcelType >::writeFields(), SprayParcel< ParcelType >::writeFields(), Time::writeNow(), regionFunctionObject::writeObject(), writeObjectsBase::writeObject(), cellZoneSet::writeObject(), pointZoneSet::writeObject(), faceZoneSet::writeObject(), dynamicRefineFvMesh::writeObject(), fvMesh::writeObject(), and volFieldValue::writeValues().
|
inlinevirtual |
Is object global.
Reimplemented in distributedTriSurfaceMesh, triSurfaceMesh, extendedFeatureEdgeMesh, baseIOdictionary, UniformDimensionedField< Type >, UniformDimensionedField< scalar >, UniformDimensionedField< vector >, featureEdgeMesh, IOMap< T >, GlobalIOField< Type >, GlobalIOList< Type >, GlobalIOField< Foam::Vector >, IOdictionary, localIOdictionary, and unwatchedIOdictionary.
Definition at line 299 of file regIOobject.H.
Referenced by regIOobject::addWatch(), regIOobject::read(), regIOobject::readHeaderOk(), masterUncollatedFileOperation::readStream(), and collatedFileOperation::writeObject().
| void operator= | ( | const IOobject & | io | ) |
Definition at line 451 of file regIOobject.C.
References regIOobject::checkIn(), regIOobject::checkOut(), IOobject::operator=(), and IOobject::registerObject().
|
friend |
Declare friendship with any classes that need access to.
masterOnlyReading
Definition at line 114 of file regIOobject.H.
|
friend |
Definition at line 115 of file regIOobject.H.
|
friend |
Definition at line 116 of file regIOobject.H.
|
staticprotected |
To flag master-only reading of objects.
Definition at line 78 of file regIOobject.H.
Referenced by uncollatedFileOperation::read().
|
static |
Definition at line 124 of file regIOobject.H.
Referenced by argList::parse(), and fileMonitorWatcher::removeWatch().
1.8.13
