regIOobject is an abstract class derived from IOobject to handle automatic object registration with the objectRegistry. More...
Inherits IOobject.
Inherited by BlendedInterfacialModel< dragModel >, BlendedInterfacialModel< Foam::dragModel >, BlendedInterfacialModel< Foam::heatTransferModel >, BlendedInterfacialModel< Foam::liftModel >, BlendedInterfacialModel< Foam::turbulentDispersionModel >, BlendedInterfacialModel< Foam::virtualMassModel >, BlendedInterfacialModel< Foam::wallLubricationModel >, BlendedInterfacialModel< heatTransferModel >, BlendedInterfacialModel< liftModel >, BlendedInterfacialModel< phaseTransferModel >, BlendedInterfacialModel< turbulentDispersionModel >, BlendedInterfacialModel< virtualMassModel >, BlendedInterfacialModel< wallLubricationModel >, adjointSolverManager, ATCModel, baseIOdictionary, BlendedInterfacialModel< ModelType >, coordinateSystems, decomposedBlockData, populationBalanceModel, dragModel, exprDriverWriter, exprResultGlobals, extendedFeatureEdgeMesh, faBoundaryMesh, featureEdgeMesh, fieldDictionary, GlobalIOField< Type >, GlobalIOList< Type >, adjointTurbulenceModel, IOList< T >, IOMap< T >, IOmapDistribute, IOmapDistributePolyMesh, IOPtrList< T >, lumpedPointIOMovement, meshObject, objectiveManager, objectRegistry, PDRDragModel, polyBoundaryMesh, polyBoundaryMeshEntries, polyTopoChanger, porosityModel, porousModel, refinementHistory, searchableSurface, SLGThermo, solutionControl, SubDimensionedField< Type, GeoMesh >, surfaceTensionModel, surfZoneIOList, topoSet, UniformDimensionedField< Type >, virtualMassModel, GlobalIOField< vector >, GlobalIOList< kinematicParcelInjectionData >, GlobalIOList< reactingMultiphaseParcelInjectionData >, GlobalIOList< reactingParcelInjectionData >, IOList< label >, IOList< labelList >, IOPtrList< Foam::entry >, UniformDimensionedField< scalar >, and UniformDimensionedField< vector >.
Public Member Functions | |
TypeName ("regIOobject") | |
Runtime type information. More... | |
regIOobject (const IOobject &io, const bool isTime=false) | |
regIOobject (const regIOobject &rio) | |
Copy construct. More... | |
regIOobject (const regIOobject &rio, bool registerCopy) | |
regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
regIOobject (const IOobject &io, const regIOobject &rio) | |
Copy construct with new IO parameters. More... | |
virtual | ~regIOobject () |
Destructor. More... | |
bool | checkIn () |
Add object to registry, if not already registered. More... | |
bool | checkOut () |
Remove all file watches and 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 (const bool unregister=false) |
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 as up-to-date. 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 writeData 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 as copy resetting registry. More... | |
IOobject (const IOobject &io, const word &name) | |
Construct as copy resetting name. More... | |
autoPtr< IOobject > | clone () const |
Clone. More... | |
autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
Clone resetting registry. More... | |
virtual | ~IOobject ()=default |
Destructor. More... | |
const objectRegistry & | db () const |
Return the local objectRegistry. More... | |
const Time & | time () const |
Return time. 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 non-constant access to the class name read from header. More... | |
const string & | note () const |
Return the optional note. More... | |
string & | note () |
Return non-constant access to the optional note. More... | |
bool | registerObject () const |
Should object created with this IOobject be registered? More... | |
bool & | registerObject () |
Should object created with this IOobject be registered? More... | |
bool | globalObject () const |
Is object same for all processors? More... | |
bool & | globalObject () |
Is object same for all processors? More... | |
unsigned | labelByteSize () const |
The label byte-size, possibly read from the header. More... | |
unsigned | scalarByteSize () const |
The scalar byte-size, possibly read from the header. More... | |
bool | isHeaderClassName (const word &clsName) const |
Test if headerClassName() equals the given class name. More... | |
template<class Type > | |
bool | isHeaderClassName () const |
Test if headerClassName() equals Type::typeName. More... | |
readOption | readOpt () const |
The read option. More... | |
readOption & | readOpt () |
Non-constant access to the read option. More... | |
writeOption | writeOpt () const |
The write option. More... | |
writeOption & | writeOpt () |
Non-constant access to the write option. More... | |
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 |
The complete path. More... | |
fileName | path (const word &instance, const fileName &local=fileName::null) const |
The complete path with alternative instance and local. More... | |
fileName | objectPath () const |
The complete path + object name. More... | |
fileName | localFilePath (const word &typeName, const bool search=true) const |
Helper for filePath that searches locally. More... | |
fileName | globalFilePath (const word &typeName, const bool search=true) const |
Helper for filePath that searches up if in parallel. More... | |
bool | readHeader (Istream &is) |
Read header. More... | |
template<class Type > | |
bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
Read header (uses typeFilePath to find file) and check its info. More... | |
template<class Type > | |
void | warnNoRereading () const |
Helper: warn that type does not support re-reading. More... | |
bool | writeHeader (Ostream &os) const |
Write header. More... | |
bool | writeHeader (Ostream &os, 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 &io) |
template<> | |
bool | isHeaderClassName () const |
Specialization for void always returns true (no headerClassName check). More... | |
template<class StringType > | |
Foam::word | groupName (StringType name, const word &group) |
Static Public Member Functions | |
template<class Type > | |
static Type & | store (Type *p) |
Transfer ownership of the given object pointer to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &aptr) |
Transfer ownership of the given object pointer to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &&aptr) |
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 StringType > | |
static word | groupName (StringType name, const word &group) |
Create dot-delimited name.group. More... | |
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... | |
static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
Return the IOobject, but also consider an alternative file name. More... | |
static Ostream & | writeBanner (Ostream &os, bool noHint=false) |
Write the standard OpenFOAM file/dictionary banner. More... | |
static Ostream & | writeDivider (Ostream &os) |
Write the standard file section divider. More... | |
static Ostream & | writeEndDivider (Ostream &os) |
Write the standard end file divider. More... | |
Static Public Attributes | |
static float | fileModificationSkew |
static int | maxFileModificationPolls |
Static Public Attributes inherited from IOobject | |
static const Enum< fileCheckTypes > | fileCheckTypesNames |
Names for the fileCheckTypes. More... | |
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... | |
Istream * | objectStream () |
Construct and return an IFstream for the object. More... | |
Protected Member Functions inherited from IOobject | |
void | setBad (const string &s) |
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 : char { GOOD, BAD } |
Enumeration defining the valid states of an IOobject. More... | |
enum | readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ } |
Enumeration defining the read options. More... | |
enum | writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 } |
Enumeration defining the write options. More... | |
enum | fileCheckTypes : char { 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 67 of file regIOobject.H.
regIOobject | ( | const IOobject & | io, |
const bool | isTime = false |
||
) |
Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time).
Definition at line 70 of file regIOobject.C.
References regIOobject::checkIn(), and IOobject::registerObject().
regIOobject | ( | const regIOobject & | rio | ) |
Copy construct.
Definition at line 86 of file regIOobject.C.
regIOobject | ( | const regIOobject & | rio, |
bool | registerCopy | ||
) |
Copy construct, transferring registry registration to the copy if registerCopy is true
Definition at line 99 of file regIOobject.C.
References regIOobject::checkIn(), and regIOobject::checkOut().
regIOobject | ( | const word & | newName, |
const regIOobject & | rio, | ||
bool | registerCopy | ||
) |
Copy construct with new name, transferring registry registration to the copy f registerCopy is true
Definition at line 120 of file regIOobject.C.
regIOobject | ( | const IOobject & | io, |
const regIOobject & | rio | ||
) |
Copy construct with new IO parameters.
Definition at line 141 of file regIOobject.C.
|
virtual |
Destructor.
Definition at line 162 of file regIOobject.C.
References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::name(), path(), Foam::Pout, and Foam::type().
|
protected |
Helper: check readOpt flags and read if necessary.
Definition at line 39 of file regIOobjectRead.C.
References Foam::fileHandler(), format(), and fileOperation::read().
Referenced by IOdictionary::IOdictionary(), localIOdictionary::localIOdictionary(), and unwatchedIOdictionary::unwatchedIOdictionary().
|
protected |
Construct and return an IFstream for the object.
The results is NULL if the stream construction failed
TypeName | ( | "regIOobject" | ) |
Runtime type information.
bool checkIn | ( | ) |
Add object to registry, if not already registered.
Definition at line 201 of file regIOobject.C.
References Foam::abort(), Foam::expressions::patchExpr::debug, polyMesh::defaultRegion, Foam::endl(), Foam::FatalError, FatalErrorInFunction, Foam::name(), and WarningInFunction.
Referenced by regIOobject::regIOobject().
bool checkOut | ( | ) |
Remove all file watches and remove object from registry.
Definition at line 237 of file regIOobject.C.
References Foam::fileHandler(), forAllReverse, and fileOperation::removeWatch().
Referenced by regionFunctionObject::clearObject(), regionFunctionObject::clearObjects(), removeRegisteredObject::execute(), and regIOobject::regIOobject().
|
virtual |
Add file watch on object (if registered and READ_IF_MODIFIED)
Reimplemented in unwatchedIOdictionary.
Definition at line 280 of file regIOobject.C.
References Foam::abort(), f(), Foam::FatalError, FatalErrorInFunction, Foam::fileHandler(), IOobject::fileModificationChecking, fileOperation::findWatch(), forAll, forAllReverse, fileOperation::getFile(), UPstream::master(), UPstream::parRun(), fileOperation::removeWatch(), Pstream::scatter(), List< T >::setSize(), and Foam::type().
Referenced by includeEntry::execute(), IOdictionary::IOdictionary(), IOMap< T >::IOMap(), and localIOdictionary::localIOdictionary().
|
inline |
Is this object owned by the registry?
Definition at line 31 of file regIOobjectI.H.
Referenced by objectRegistry::clear(), regionFunctionObject::clearObject(), regionFunctionObject::clearObjects(), objectRegistry::erase(), and removeRegisteredObject::execute().
|
inline |
Transfer ownership of this object to its registry.
Definition at line 37 of file regIOobjectI.H.
Referenced by CrankNicolsonDdtScheme< Type >::ddt0_(), volPointInterpolation::interpolate(), lumpedPointDisplacementPointPatchVectorField::movement(), options::New(), coordinateSystems::New(), polySurface::polySurface(), discreteSurface::sampleType(), sampledSurface::storeSurfMesh(), objectRegistry::subRegistry(), and cellCellStencil::zoneID().
|
inlinestatic |
Transfer ownership of the given object pointer to its registry.
Definition at line 44 of file regIOobjectI.H.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and p.
|
inlinestatic |
Transfer ownership of the given object pointer to its registry.
Definition at line 60 of file regIOobjectI.H.
References autoPtr< T >::ptr().
|
inlinestatic |
Transfer ownership of the given object pointer to its registry.
Definition at line 67 of file regIOobjectI.H.
|
inline |
Release ownership of this object from its registry.
unregister | optionally set as non-registered |
Definition at line 73 of file regIOobjectI.H.
Referenced by objectRegistry::clear(), and objectRegistry::erase().
|
inline |
Event number at last update.
Definition at line 83 of file regIOobjectI.H.
Referenced by triSurfaceMesh::movePoints(), polyMesh::setUpToDatePoints(), and regIOobject::upToDate().
|
inline |
Event number at last update.
Definition at line 88 of file regIOobjectI.H.
bool upToDate | ( | const regIOobject & | a | ) | const |
Return true if up-to-date with respect to given object.
Definition at line 350 of file regIOobject.C.
References regIOobject::eventNo(), and Foam::labelMax.
Referenced by polyMesh::upToDatePoints().
bool upToDate | ( | const regIOobject & | a, |
const regIOobject & | b | ||
) | const |
Return true if up-to-date with respect to given objects.
Definition at line 390 of file regIOobject.C.
References Foam::constant::physicoChemical::b.
bool upToDate | ( | const regIOobject & | a, |
const regIOobject & | b, | ||
const regIOobject & | c | ||
) | const |
Return true if up-to-date with respect to given objects.
Definition at line 400 of file regIOobject.C.
References Foam::constant::physicoChemical::b, and Foam::constant::universal::c.
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.
Definition at line 411 of file regIOobject.C.
References Foam::constant::physicoChemical::b, and Foam::constant::universal::c.
void setUpToDate | ( | ) |
Set as up-to-date.
Definition at line 422 of file regIOobject.C.
|
virtual |
Rename.
Reimplemented from IOobject.
Reimplemented in objectRegistry.
Definition at line 428 of file regIOobject.C.
References IOobject::rename().
Referenced by 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 baseIOdictionary, distributedTriSurfaceMesh, triSurfaceMesh, porosityModel, searchableSurface, extendedFeatureEdgeMesh, UniformDimensionedField< Type >, UniformDimensionedField< scalar >, UniformDimensionedField< vector >, GlobalIOField< Type >, IOMap< T >, GlobalIOField< vector >, featureEdgeMesh, GlobalIOList< Type >, GlobalIOList< reactingParcelInjectionData >, GlobalIOList< reactingMultiphaseParcelInjectionData >, GlobalIOList< kinematicParcelInjectionData >, IOdictionary, localIOdictionary, and unwatchedIOdictionary.
Definition at line 443 of file regIOobject.C.
References Foam::type().
bool headerOk | ( | ) |
Read and check header info.
Definition at line 449 of file regIOobject.C.
References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::fileHandler(), IOWarningInFunction, fileOperation::readHeader(), and Foam::type().
Referenced by extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), faSchemes::faSchemes(), featureEdgeMesh::featureEdgeMesh(), fvSchemes::fvSchemes(), IOMap< T >::IOMap(), IOmapDistribute::IOmapDistribute(), IOmapDistributePolyMesh::IOmapDistributePolyMesh(), polyBoundaryMeshEntries::polyBoundaryMeshEntries(), boundaryRegion::readDict(), cellTable::readDict(), refinementHistory::refinementHistory(), and topoSet::topoSet().
Foam::Istream & readStream | ( | const word & | expectName, |
const bool | valid = true |
||
) |
Return Istream and check object type against that given.
Definition at line 140 of file regIOobjectRead.C.
References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::name(), Foam::Pout, and Foam::type().
Referenced by extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), featureEdgeMesh::featureEdgeMesh(), fieldDictionary::fieldDictionary(), IOMap< T >::IOMap(), IOmapDistribute::IOmapDistribute(), IOmapDistributePolyMesh::IOmapDistributePolyMesh(), polyBoundaryMeshEntries::polyBoundaryMeshEntries(), refinementHistory::refinementHistory(), and topoSet::topoSet().
void close | ( | ) |
Close Istream.
Definition at line 182 of file regIOobjectRead.C.
References Foam::expressions::patchExpr::debug, Foam::endl(), and Foam::Pout.
Referenced by extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), featureEdgeMesh::featureEdgeMesh(), fieldDictionary::fieldDictionary(), IOMap< T >::IOMap(), IOmapDistribute::IOmapDistribute(), IOmapDistributePolyMesh::IOmapDistributePolyMesh(), uncollatedFileOperation::read(), adjointRASModel::read(), masterUncollatedFileOperation::read(), refinementHistory::refinementHistory(), and topoSet::topoSet().
Virtual readData function.
Must be defined in derived types for which re-reading is required
Reimplemented in exprResultGlobals, lumpedPointIOMovement, GlobalIOField< Type >, GlobalIOField< vector >, GlobalIOList< Type >, GlobalIOList< reactingParcelInjectionData >, GlobalIOList< reactingMultiphaseParcelInjectionData >, GlobalIOList< kinematicParcelInjectionData >, exprDriverWriter, IOmapDistributePolyMesh, refinementHistory, extendedFeatureEdgeMesh, UniformDimensionedField< Type >, UniformDimensionedField< scalar >, UniformDimensionedField< vector >, baseIOdictionary, featureEdgeMesh, and IOmapDistribute.
Definition at line 196 of file regIOobjectRead.C.
Referenced by uncollatedFileOperation::read(), and masterUncollatedFileOperation::read().
|
virtual |
Read object.
Reimplemented in radiationModel, adjointTurbulenceModel, phaseChangeTwoPhaseMixture, turbulenceModel, phaseSystem, phaseSystem, basicThermo, refinementHistory, Time, adjointSpalartAllmaras, twoPhaseMixtureThermo, multiphaseSystem, adjointRASModel, twoPhaseMixtureEThermo, multiphaseMixture, laserDTRM, fvDOM, kinematicSingleLayer, incompressibleThreePhaseMixture, diffusionMulticomponent< ReactionThermo, ThermoType >, solarLoad, EDC< ReactionThermo >, thermoSingleLayer, crankConRod, incompressibleTwoPhaseInteractingMixture, faSchemes, viewFactor, solidThermo, motionSolver, twoPhaseSystem, rigidBodyMeshMotion, reactingOneDim, rigidBodyMeshMotionSolver, engineTime, incompressibleTwoPhaseMixture, multiphaseSystem, FSD< ReactionThermo, ThermoType >, combustionModel, temperaturePhaseChangeTwoPhaseMixture, fvSchemes, solution, sixDoFRigidBodyMotionSolver, SRFModel, thermoIncompressibleTwoPhaseMixture, regionModel, SIMPLEControl, CombustionModel< ReactionThermo >, decomposedBlockData, adjointLaminar, solutionControl, optimisationManager, SchnerrSauer, zoneCombustion< ReactionThermo >, P1, Kunz, laminar< ReactionThermo >, eddyDissipationDiffusionModel< ReactionThermo, ThermoType >, PaSR< ReactionThermo >, eddyDissipationModelBase< ReactionThermo, ThermoType >, thermalBaffle, Merkle, singleStepCombustion< ReactionThermo, ThermoType >, diffusion< ReactionThermo, ThermoType >, singlePhaseTransportModel, infinitelyFastChemistry< ReactionThermo, ThermoType >, constant, regionModel1D, IOMRFZoneList, noCombustion< ReactionThermo >, pimpleControl, options, thermalBaffleModel, opaqueSolid, noRadiation, tolerances, rpm, singleLayerRegion, IOoptionListAdjoint, pyrolysisModel, IOporosityModelList, immiscibleIncompressibleTwoPhaseMixture, surfaceFilmRegionModel, thermo, noPyrolysis, noThermo, SIMPLEControlOpt, SIMPLEControlSingleRun, and simpleControl.
Definition at line 202 of file regIOobjectRead.C.
References IOstreamOption::BINARY, Foam::fileHandler(), IOobject::fileModificationChecking, forAll, forAllReverse, fileOperation::getFile(), fileOperation::read(), fileOperation::removeWatch(), List< T >::setSize(), and Foam::type().
Referenced by IOporosityModelList::read(), IOoptionListAdjoint::read(), tolerances::read(), IOMRFZoneList::read(), singlePhaseTransportModel::read(), turbulenceModel::read(), optimisationManager::read(), regionModel::read(), SRFModel::read(), solution::read(), fvSchemes::read(), combustionModel::read(), incompressibleTwoPhaseMixture::read(), motionSolver::read(), solidThermo::read(), faSchemes::read(), radiationModel::read(), basicThermo::read(), and phaseSystem::read().
|
virtual |
Add file watch for fileName on object if not yet watched. Return.
index of watch
Reimplemented in unwatchedIOdictionary.
Definition at line 256 of file regIOobject.C.
References f(), Foam::fileHandler(), and fileOperation::findWatch().
|
inline |
Return file-monitoring handles.
Definition at line 94 of file regIOobjectI.H.
Referenced by fileOperation::addWatches(), masterUncollatedFileOperation::addWatches(), and Time::readDict().
|
inline |
Return file-monitoring handles.
Definition at line 100 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 248 of file regIOobjectRead.C.
References Foam::fileHandler(), forAllReverse, and fileMonitor::UNMODIFIED.
|
virtual |
Read object if modified (as set by call to modified)
Reimplemented in objectRegistry.
Definition at line 262 of file regIOobjectRead.C.
References Foam::endl(), Foam::fileHandler(), forAllReverse, fileOperation::getFile(), InfoInFunction, Foam::name(), Foam::read(), and fileMonitor::UNMODIFIED.
Pure virtual writeData function.
Must be defined in derived types
Implemented in surfaceTensionModel, searchableSurfaceWithGaps, polyBoundaryMesh, porosityModel, profiling, solidification, powerLawLopesdaCosta, BlendedInterfacialModel< ModelType >, BlendedInterfacialModel< virtualMassModel >, BlendedInterfacialModel< liftModel >, BlendedInterfacialModel< Foam::wallLubricationModel >, BlendedInterfacialModel< Foam::dragModel >, BlendedInterfacialModel< Foam::heatTransferModel >, BlendedInterfacialModel< Foam::virtualMassModel >, BlendedInterfacialModel< dragModel >, BlendedInterfacialModel< Foam::liftModel >, BlendedInterfacialModel< heatTransferModel >, BlendedInterfacialModel< Foam::turbulentDispersionModel >, BlendedInterfacialModel< phaseTransferModel >, BlendedInterfacialModel< turbulentDispersionModel >, BlendedInterfacialModel< wallLubricationModel >, DarcyForchheimer, exprResultGlobals, coordinateSystems, adjointSimple, powerLaw, fixedCoeff, dragModel, dragModel, simple, virtualMassModel, virtualMassModel, temperatureDependent, MeshObject< fvMesh, MoveableMeshObject, FitDataType >, MeshObject< fvMesh, TopologicalMeshObject, centredCPCCellToFaceStencilObject >, MeshObject< polyMesh, UpdateableMeshObject, decompositionModel >, MeshObject< fvMesh, MoveableMeshObject, CentredFitData< Polynomial > >, MeshObject< polyMesh, GeometricMeshObject, meshSearchMeshObject >, MeshObject< polyMesh, UpdateableMeshObject, twoDPointCorrector >, MeshObject< fvMesh, UpdateableMeshObject, wallDist >, MeshObject< faMesh, Foam::MoveableMeshObject, leastSquaresFaVectors >, MeshObject< pointMesh, UpdateableMeshObject, pointConstraints >, MeshObject< fvMesh, TopologicalMeshObject, centredCFCFaceToCellStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, upwindFECCellToFaceStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, centredCECCellToCellStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, centredCPCCellToCellStencilObject >, MeshObject< polyMesh, GeometricMeshObject, meshSearchFACE_CENTRE_TRISMeshObject >, MeshObject< fvMesh, MoveableMeshObject, LeastSquaresVectors< Stencil > >, MeshObject< fvMesh, TopologicalMeshObject, centredCFCCellToCellStencilObject >, MeshObject< fvMesh, MoveableMeshObject, leastSquaresVectors >, MeshObject< fvMesh, Foam::GeometricMeshObject, boundaryRadiationProperties >, MeshObject< fvMesh, UpdateableMeshObject, volPointInterpolation >, MeshObject< fvMesh, TopologicalMeshObject, upwindCFCCellToFaceStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, upwindCECCellToFaceStencilObject >, MeshObject< lduMesh, GeometricMeshObject, GAMGAgglomeration >, MeshObject< fvMesh, TopologicalMeshObject, upwindCPCCellToFaceStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, pureUpwindCFCCellToFaceStencilObject >, MeshObject< fvMesh, UpdateableMeshObject, volBSplinesBase >, MeshObject< fvMesh, TopologicalMeshObject, centredCECCellToFaceStencilObject >, MeshObject< fvMesh, MoveableMeshObject, UpwindFitData< Polynomial > >, MeshObject< fvMesh, MoveableMeshObject, skewCorrectionVectors >, MeshObject< polyMesh, Foam::UpdateableMeshObject, faMesh >, MeshObject< polyMesh, TopologicalMeshObject, regionSplit >, MeshObject< polyMesh, UpdateableMeshObject, pointMesh >, MeshObject< fvMesh, TopologicalMeshObject, centredCFCCellToFaceStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, centredFECCellToFaceStencilObject >, MeshObject< Time, TopologicalMeshObject, gravity >, MeshObject< fvMesh, MoveableMeshObject, CentredFitSnGradData< Polynomial > >, surfaceTensionModel, RASTurbulenceModel, liquidProperties, surfaceTensionModel, porousModel, lumpedPointIOMovement, GlobalIOField< Type >, GlobalIOField< vector >, constant, GlobalIOList< Type >, GlobalIOList< reactingParcelInjectionData >, GlobalIOList< reactingMultiphaseParcelInjectionData >, GlobalIOList< kinematicParcelInjectionData >, exprDriverWriter, IOmapDistributePolyMesh, IOPtrList< T >, IOPtrList< Foam::entry >, surfZoneIOList, IOMap< T >, IOList< T >, IOList< label >, IOList< labelList >, fieldDictionary, objectRegistry, populationBalanceModel, refinementHistory, topoSet, triSurfaceMesh, searchableCone, searchableSurfaceCollection, searchableRotatedBox, searchableBox, searchableCylinder, searchableDisk, searchableSphere, searchablePlate, searchableExtrudedCircle, searchablePlane, ATCModel, adjointTurbulenceModel, faSchemes, solver, objectiveManager, adjointSolverManager, solutionControl, PDRDragModel, faBoundaryMesh, polyTopoChanger, extendedFeatureEdgeMesh, decomposedBlockData, UniformDimensionedField< Type >, UniformDimensionedField< scalar >, UniformDimensionedField< vector >, baseIOdictionary, featureEdgeMesh, IOmapDistribute, polyBoundaryMeshEntries, and SLGThermo.
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 Time, dynamicOversetFvMesh, faceZoneSet, pointZoneSet, cellZoneSet, decomposedBlockData, coordinateSystems, profiling, distributedTriSurfaceMesh, objectRegistry, fvMesh, polySurface, triSurfaceMesh, surfMesh, polyBoundaryMesh, dynamicRefineFvMesh, motionSolver, rigidBodyMeshMotion, rigidBodyMeshMotionSolver, and sixDoFRigidBodyMotionSolver.
Definition at line 39 of file regIOobjectWrite.C.
References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::fileHandler(), IOobject::instance(), Foam::name(), Foam::Pout, SeriousErrorInFunction, fileOperation::setUnmodified(), Foam::system(), timeName, and fileOperation::writeObject().
Referenced by regIOobject::write(), CompactIOField< T, BaseType >::writeObject(), cellZoneSet::writeObject(), pointZoneSet::writeObject(), faceZoneSet::writeObject(), coordinateSystems::writeObject(), profiling::writeObject(), and polyBoundaryMesh::writeObject().
Write using setting from DB.
Reimplemented in SIMPLEControl, faMesh, fvMesh, solver, incompressibleAdjointSolver, incompressiblePrimalSolver, objectiveManager, SIMPLEControlOpt, and SIMPLEControlSingleRun.
Definition at line 170 of file regIOobjectWrite.C.
References IOstreamOption::currentVersion, IOobject::time(), and regIOobject::writeObject().
Referenced by columnFvMesh::columnFvMesh(), hexRef8::consistentSlowRefinement2(), dynamicRefineFvMesh::dynamicRefineFvMesh(), SIMPLEControlOpt::loop(), meshRefinement::mergePatchFacesUndo(), polyMesh::movePoints(), polyMesh::polyMesh(), removeFaces::setRefinement(), hexRef8::setUnrefinement(), SIMPLEControlSingleRun::write(), columnAverage::write(), surfaceInterpolate::write(), zeroGradient::write(), ddt2::write(), writeObjects::write(), regionSizeDistribution::write(), fvMesh::write(), isoAdvection::writeBoundedCells(), regionFunctionObject::writeObject(), and isoAdvection::writeSurfaceCells().
|
inlinevirtual |
Is object global.
Reimplemented in baseIOdictionary, distributedTriSurfaceMesh, triSurfaceMesh, porosityModel, searchableSurface, extendedFeatureEdgeMesh, UniformDimensionedField< Type >, UniformDimensionedField< scalar >, UniformDimensionedField< vector >, GlobalIOField< Type >, IOMap< T >, GlobalIOField< vector >, featureEdgeMesh, GlobalIOList< Type >, GlobalIOList< reactingParcelInjectionData >, GlobalIOList< reactingMultiphaseParcelInjectionData >, GlobalIOList< kinematicParcelInjectionData >, IOdictionary, localIOdictionary, and unwatchedIOdictionary.
Definition at line 313 of file regIOobject.H.
Referenced by masterUncollatedFileOperation::readStream(), and collatedFileOperation::writeObject().
void operator= | ( | const IOobject & | io | ) |
Definition at line 470 of file regIOobject.C.
References IOobject::operator=().
|
friend |
Declare friendship with any classes that need access to.
masterOnlyReading
Definition at line 121 of file regIOobject.H.
|
friend |
Definition at line 122 of file regIOobject.H.
|
friend |
Definition at line 123 of file regIOobject.H.
|
staticprotected |
To flag master-only reading of objects.
Definition at line 85 of file regIOobject.H.
|
static |
Definition at line 131 of file regIOobject.H.
Referenced by argList::parse().
|
static |
Definition at line 133 of file regIOobject.H.
Referenced by argList::parse().