Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
regIOobject Class Referenceabstract

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< diffusiveMassTransferModel >, BlendedInterfacialModel< dragModel >, BlendedInterfacialModel< heatTransferModel >, BlendedInterfacialModel< liftModel >, BlendedInterfacialModel< phaseTransferModel >, BlendedInterfacialModel< turbulentDispersionModel >, BlendedInterfacialModel< virtualMassModel >, BlendedInterfacialModel< 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 >, BlendedInterfacialModel< ModelType >, CompactIOField< Type, BaseType >, CompactIOList< T, BaseType >, decomposedBlockData, populationBalanceModel, SecondaryPropertyModel< ModelType >, DimensionedField< Type, GeoMesh >, dragModel, extendedFeatureEdgeMesh, featureEdgeMesh, fieldDictionary, GlobalIOField< Type >, GlobalIOList< Type >, IOdictionary, IOdistributionMap, IOField< Type >, IOList< T >, IOMap< T >, IOPosition< CloudType >, IOPtrList< T >, meshObject, MeshZones< ZoneType, MeshType >, objectRegistry, PDRDragModel, phaseTransferModel, polyBoundaryMesh, polyBoundaryMeshEntries, polyTopoChanger, porosityModel, refinementHistory, saturationModel, searchableSurface, SidedInterfacialModel< ModelType >, solutionControl, surfacePatchIOList, surfaceTensionModel, surfZoneIOList, topoSet, UniformDimensionedField< Type >, virtualMassModel, GlobalIOField< Foam::Vector >, GlobalIOList< momentumParcelInjectionData >, GlobalIOList< reactingMultiphaseParcelInjectionData >, GlobalIOList< reactingParcelInjectionData >, GlobalIOList< thermoParcelInjectionData >, IOList< label >, IOList< labelList >, MeshZones< cellZone, polyMesh >, MeshZones< faceZone, polyMesh >, MeshZones< pointZone, polyMesh >, SecondaryPropertyModel< shapeModel >, SidedInterfacialModel< blendedDiffusiveMassTransferModel >, SidedInterfacialModel< blendedHeatTransferModel >, SidedInterfacialModel< interfaceCompositionModel >, UniformDimensionedField< scalar >, and UniformDimensionedField< vector >.

Collaboration diagram for regIOobject:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the. More...
 
 regIOobject (const regIOobject &)
 Copy constructor. More...
 
 regIOobject (const regIOobject &&)
 Move constructor. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Copy constructor, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Copy constructor with new name, transferring registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Copy constructor with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
virtual bool global () const
 Return true if object is global, i.e. same for all processors. More...
 
virtual bool globalFile () const
 Return true if object is global, i.e. same for all processors. More...
 
const fileName & caseName () const
 
fileName path () const
 Return complete path. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. More...
 
void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool registered () const
 Is this object registered with the registry? More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
void store ()
 Transfer ownership of this object to its registry. More...
 
void release ()
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
label & eventNo ()
 Event number at last update. More...
 
bool upToDate (const regIOobject &) const
 Return true if up-to-date with respect to given object. More...
 
bool upToDate (const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
void setUpToDate ()
 Set up to date (obviously) More...
 
virtual void rename (const word &newName)
 Rename. More...
 
bool headerOk ()
 Read and check header info. More...
 
Istream & readStream (const word &, const bool read=true)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
virtual bool readData (Istream &)
 Virtual readData function. More...
 
virtual bool read ()
 Read object. More...
 
const labelList & watchIndices () const
 Return file-monitoring handles. More...
 
labelList & watchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) More...
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeData (Ostream &) const =0
 Pure virtual writaData function. More...
 
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
 Write using given format, version and compression. More...
 
virtual bool write (const bool write=true) const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Construct from copy resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Construct from copy resetting name. More...
 
 IOobject (const IOobject &io)=default
 Copy constructor. More...
 
autoPtr< IOobject > clone () const
 Clone. More...
 
autoPtr< IOobject > clone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Time & time () const
 Return time. More...
 
const objectRegistry & db () const
 Return the local objectRegistry. More...
 
const word & name () const
 Return name. More...
 
const word & headerClassName () const
 Return name of the class name read from header. More...
 
word & headerClassName ()
 Return name of the class name read from header. More...
 
string & note ()
 Return non-constant access to the optional note. More...
 
const string & note () const
 Return the optional note. More...
 
bool & registerObject ()
 Register object created from this IOobject with registry if true. More...
 
bool registerObject () const
 Register object created from this IOobject with registry if true. More...
 
readOption readOpt () const
 
readOption & readOpt ()
 
writeOption writeOpt () const
 
writeOption & writeOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
word modelName (const char *name) const
 Return the name of the object within this model. More...
 
const fileName & rootPath () const
 
const fileName & caseName (const bool global) const
 
fileName & instance () const
 Return the instance directory, constant, system, <time> etc. More...
 
void updateInstance () const
 If the instance is a time directory update to the current time. More...
 
const fileName & local () const
 
fileName path (const bool global) const
 Return complete path including the processor sub-directory. More...
 
fileName objectPath (const bool global) const
 Return complete path + object name including the processor. More...
 
fileName relativePath () const
 Return the path relative to the case directory. More...
 
fileName relativeObjectPath () const
 Return complete relativePath + object name. More...
 
fileName filePath (const word &typeName, const bool global) const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read header of local object without type-checking. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &) const
 Write header. More...
 
bool writeHeader (Ostream &, const word &objectType) const
 Write header. Allow override of type. More...
 
bool good () const
 
bool bad () const
 
InfoProxy< IOobject > info () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 
template<class Name >
Foam::word modelName (Name name, const word &model)
 

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 Name >
static word modelName (Name name, const word &model)
 Return the name of the object within the given model. More...
 
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider. More...
 
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider. More...
 

Static Public Attributes

static float fileModificationSkew
 
- Static Public Attributes inherited from IOobject
static constexpr const char * foamFile = "FoamFile"
 Keyword for the FoamFile header sub-dictionary. More...
 
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 

Protected Member Functions

bool readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
 Read header, check readOpt flags and read data if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &)
 Set the object state to bad. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType)
 Read header using typeGlobalFile to find file. More...
 

Additional Inherited Members

- Public Types inherited from IOobject
enum  objectState { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
enum  fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Enumeration defining the file checking options. More...
 

Detailed Description

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

Source files

Definition at line 52 of file regIOobject.H.

Constructor & Destructor Documentation

◆ regIOobject() [1/6]

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

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

top level regIOobject.

Definition at line 41 of file regIOobject.C.

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

Referenced by regIOobject::regIOobject().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ regIOobject() [2/6]

regIOobject ( const regIOobject &  rio)

Copy constructor.

Definition at line 62 of file regIOobject.C.

◆ regIOobject() [3/6]

regIOobject ( const regIOobject &&  rio)

Move constructor.

Registers copy if the object is registered

Definition at line 74 of file regIOobject.C.

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

Here is the call graph for this function:

◆ regIOobject() [4/6]

regIOobject ( const regIOobject &  rio,
bool  registerCopy 
)

Copy constructor, transferring registry registration to copy.

if registerCopy is true

Definition at line 90 of file regIOobject.C.

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

Here is the call graph for this function:

◆ regIOobject() [5/6]

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

Copy constructor with new name, transferring registry registration.

to copy as specified

Definition at line 110 of file regIOobject.C.

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

Here is the call graph for this function:

◆ regIOobject() [6/6]

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

Copy constructor with new IO parameters.

Definition at line 130 of file regIOobject.C.

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

Here is the call graph for this function:

◆ ~regIOobject()

~regIOobject ( )
virtual

Destructor.

Definition at line 150 of file regIOobject.C.

References regIOobject::caseName(), regIOobject::checkOut(), IOobject::db(), Foam::endl(), IOobject::instance(), IOobject::name(), regIOobject::path(), Foam::Pout, objectRegistry::resetCacheTemporaryObject(), and IOobject::rootPath().

Here is the call graph for this function:

Member Function Documentation

◆ readHeaderOk()

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

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

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

Definition at line 33 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, regIOobject::objectPath(), Foam::Pout, Foam::blockMeshTools::read(), fileOperation::read(), IOobject::readOpt(), fileOperation::readStream(), List< T >::size(), and Foam::type().

Referenced by IOdictionary::IOdictionary().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ TypeName()

TypeName ( "regIOobject"  )

Runtime type information.

◆ global()

bool global ( ) const
virtual

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

Defaults to false, must be overridden by global IO classes

Reimplemented in distributedTriSurfaceMesh, triSurfaceMesh, extendedFeatureEdgeMesh, coordinateSystems, fvModels, fvConstraints, IOdictionary, UniformDimensionedField< Type >, UniformDimensionedField< scalar >, UniformDimensionedField< vector >, IOMap< T >, featureEdgeMesh, GlobalIOField< Type >, GlobalIOList< Type >, GlobalIOField< Foam::Vector >, GlobalIOList< momentumParcelInjectionData >, GlobalIOList< reactingParcelInjectionData >, GlobalIOList< reactingMultiphaseParcelInjectionData >, GlobalIOList< thermoParcelInjectionData >, and localIOdictionary.

Definition at line 181 of file regIOobject.C.

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

Here is the caller graph for this function:

◆ globalFile()

bool globalFile ( ) const
virtual

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

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

Reimplemented in timeIOdictionary.

Definition at line 187 of file regIOobject.C.

References regIOobject::global().

Referenced by regIOobject::caseName(), regIOobject::filePath(), and regIOobject::path().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ caseName()

const Foam::fileName & caseName ( ) const

Definition at line 193 of file regIOobject.C.

References IOobject::caseName(), and regIOobject::globalFile().

Referenced by regIOobject::~regIOobject().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ path()

Foam::fileName path ( ) const

Return complete path.

Definition at line 199 of file regIOobject.C.

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

Referenced by objectRegistry::dbDir(), odeChemistryModel::logFile(), regIOobject::objectPath(), collatedFileOperation::writeObject(), Time::writeObject(), objectRegistry::~objectRegistry(), and regIOobject::~regIOobject().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ objectPath()

fileName objectPath ( ) const
inline

Return complete path + object name.

Definition at line 159 of file regIOobject.H.

References regIOobject::addWatch(), regIOobject::checkIn(), regIOobject::checkOut(), regIOobject::close(), regIOobject::eventNo(), regIOobject::filePath(), IOobject::filePath(), regIOobject::headerOk(), regIOobject::modified(), IOobject::name(), regIOobject::ownedByRegistry(), regIOobject::path(), regIOobject::read(), regIOobject::readData(), regIOobject::readIfModified(), regIOobject::registered(), regIOobject::release(), regIOobject::rename(), regIOobject::setUpToDate(), regIOobject::store(), regIOobject::upToDate(), regIOobject::watchIndices(), regIOobject::write(), regIOobject::writeData(), and regIOobject::writeObject().

Referenced by regIOobject::addWatch(), collatedFileOperation::appendObject(), regIOobject::checkIn(), hexRef8::consistentSlowRefinement2(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), regIOobject::headerOk(), hexRef8::hexRef8(), IOdictionary::IOdictionary(), mappedFixedValueFvPatchField< Type >::mapper(), meshRefinement::mergePatchFacesUndo(), uncollatedFileOperation::read(), masterUncollatedFileOperation::read(), IOdictionary::readData(), regIOobject::readHeaderOk(), uncollatedFileOperation::readObjects(), fileOperation::readObjects(), masterUncollatedFileOperation::readObjects(), uncollatedFileOperation::readStream(), masterUncollatedFileOperation::readStream(), polyMesh::readUpdate(), hexRef8::setUnrefinement(), meshReader::warnDuplicates(), boundaryRegion::writeDict(), cellTable::writeDict(), collatedFileOperation::writeObject(), triSurfaceMesh::writeObject(), fileOperation::writeObject(), distributedTriSurfaceMesh::writeObject(), and masterUncollatedFileOperation::writeObject().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ filePath()

Foam::fileName filePath ( ) const

Return complete path + object name if the file exists.

in the case directory otherwise null.

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

Definition at line 437 of file regIOobject.C.

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

Referenced by regIOobject::addWatch(), regIOobject::headerOk(), regIOobject::objectPath(), regIOobject::readHeaderOk(), and Time::writeObject().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ checkIn()

bool checkIn ( )

Add object to registry.

Definition at line 205 of file regIOobject.C.

References Foam::abort(), objectRegistry::checkIn(), IOobject::db(), polyMesh::defaultRegion, Foam::endl(), Foam::FatalError, FatalErrorInFunction, IOobject::name(), regIOobject::objectPath(), HashTable< T, Key, Hash >::sortedToc(), and WarningInFunction.

Referenced by regIOobject::objectPath(), regIOobject::operator=(), regIOobject::regIOobject(), regIOobject::rename(), regIOobject::store(), objectRegistry::thisDb(), and rigidBodyMeshMotion::topoChange().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ checkOut()

bool checkOut ( )

Remove object from registry.

Definition at line 241 of file regIOobject.C.

References objectRegistry::checkOut(), List< T >::clear(), IOobject::db(), Foam::fileHandler(), forAllReverse, and fileOperation::removeWatch().

Referenced by regionFunctionObject::clearObject(), regIOobject::objectPath(), regIOobject::operator=(), regIOobject::regIOobject(), regIOobject::rename(), objectRegistry::thisDb(), and regIOobject::~regIOobject().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ addWatch()

void addWatch ( )

Add file watch on object (if registered and READ_IF_MODIFIED)

Definition at line 259 of file regIOobject.C.

References Foam::abort(), 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, regIOobject::objectPath(), UPstream::parRun(), IOobject::readOpt(), fileOperation::removeWatch(), Pstream::scatter(), List< T >::setSize(), List< T >::size(), IOobject::time(), IOobject::timeStampMaster, and Foam::type().

Referenced by IOdictionary::IOdictionary(), IOMap< T >::IOMap(), IOPtrList< T >::IOPtrList(), regIOobject::objectPath(), and regIOobject::read().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ registered()

bool registered ( ) const
inline

Is this object registered with the registry?

Definition at line 28 of file regIOobjectI.H.

Referenced by regIOobject::objectPath().

Here is the caller graph for this function:

◆ ownedByRegistry()

bool ownedByRegistry ( ) const
inline

Is this object owned by the registry?

Definition at line 34 of file regIOobjectI.H.

Referenced by objectRegistry::checkIn(), objectRegistry::checkOut(), regionFunctionObject::clearObject(), removeRegisteredObject::execute(), and regIOobject::objectPath().

Here is the caller graph for this function:

◆ store() [1/3]

void store ( )
inline

Transfer ownership of this object to its registry.

Definition at line 40 of file regIOobjectI.H.

References regIOobject::checkIn().

Referenced by fieldAverage::addMeanFieldType(), fieldAverage::addPrime2MeanFieldType(), objectRegistry::cacheTemporaryObject(), CrankNicolsonDdtScheme< Type >::ddt0_(), volPointInterpolation::interpolate(), volPointInterpolation::interpolateUnconstrained(), basicThermo::lookupOrConstruct(), NamedEnum< compressibleField, 8 >::names(), optionalCpuLoad::New(), waveSuperposition::New(), regIOobject::objectPath(), objectRegistry::subRegistry(), vtkUnstructuredReader::vtkUnstructuredReader(), and waveSuperposition::waveSuperposition().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ store() [2/3]

Type & store ( Type *  tPtr)
inlinestatic

Transfer ownership of the given object pointer to its registry.

and return reference to object.

Definition at line 48 of file regIOobjectI.H.

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

Here is the call graph for this function:

◆ store() [3/3]

Type & store ( autoPtr< Type > &  atPtr)
inlinestatic

Transfer ownership of the given object pointer to its registry.

and return reference to object.

Definition at line 65 of file regIOobjectI.H.

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

Here is the call graph for this function:

◆ release()

void release ( )
inline

Release ownership of this object from its registry.

Definition at line 83 of file regIOobjectI.H.

Referenced by removeRegisteredObject::execute(), and regIOobject::objectPath().

Here is the caller graph for this function:

◆ eventNo() [1/2]

Foam::label eventNo ( ) const
inline

Event number at last update.

Definition at line 89 of file regIOobjectI.H.

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

Here is the caller graph for this function:

◆ eventNo() [2/2]

Foam::label & eventNo ( )
inline

Event number at last update.

Definition at line 94 of file regIOobjectI.H.

◆ upToDate() [1/4]

bool upToDate ( const regIOobject &  a) const

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

otherwise false

Definition at line 329 of file regIOobject.C.

References regIOobject::eventNo().

Referenced by regIOobject::objectPath(), regIOobject::upToDate(), and polyMesh::upToDatePoints().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ upToDate() [2/4]

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

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

otherwise false

Definition at line 343 of file regIOobject.C.

References regIOobject::eventNo(), and regIOobject::upToDate().

Here is the call graph for this function:

◆ upToDate() [3/4]

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

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

otherwise false

Definition at line 364 of file regIOobject.C.

References regIOobject::eventNo(), and regIOobject::upToDate().

Here is the call graph for this function:

◆ upToDate() [4/4]

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

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

otherwise false

Definition at line 387 of file regIOobject.C.

References regIOobject::eventNo().

Here is the call graph for this function:

◆ setUpToDate()

void setUpToDate ( )

Set up to date (obviously)

Definition at line 411 of file regIOobject.C.

References IOobject::db(), and objectRegistry::getEvent().

Referenced by regIOobject::objectPath().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ rename()

void rename ( const word &  newName)
virtual

Rename.

Reimplemented from IOobject.

Reimplemented in objectRegistry.

Definition at line 417 of file regIOobject.C.

References regIOobject::checkIn(), regIOobject::checkOut(), IOobject::name(), IOobject::registerObject(), and IOobject::rename().

Referenced by ReynoldsStress< LESModel< BasicMomentumTransportModel > >::k(), Foam::New(), reuseTmpDimensionedField< TypeR, TypeR, GeoMesh >::New(), reuseTmpGeometricField< TypeR, TypeR, PatchField, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, Type1, TypeR, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, Type2, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, Type1, TypeR, PatchField, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, TypeR, Type2, PatchField, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, TypeR, TypeR, PatchField, GeoMesh >::New(), regIOobject::objectPath(), objectRegistry::rename(), and rigidBodyMeshMotion::topoChange().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ headerOk()

bool headerOk ( )

Read and check header info.

Definition at line 443 of file regIOobject.C.

References Foam::endl(), Foam::fileHandler(), regIOobject::filePath(), IOobject::headerClassName(), IOWarningInFunction, regIOobject::objectPath(), fileOperation::readHeader(), and Foam::type().

Referenced by CompactIOField< Type, BaseType >::CompactIOField(), extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), featureEdgeMesh::featureEdgeMesh(), hexRef8::hexRef8(), IOdistributionMap::IOdistributionMap(), IOField< Type >::IOField(), IOMap< T >::IOMap(), IOPtrList< T >::IOPtrList(), regIOobject::objectPath(), boundaryRegion::readDict(), cellTable::readDict(), and refinementHistory::refinementHistory().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ readStream()

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

Return Istream and check object type against that given.

Definition at line 135 of file regIOobjectRead.C.

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

Referenced by extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), featureEdgeMesh::featureEdgeMesh(), fieldDictionary::fieldDictionary(), IOdistributionMap::IOdistributionMap(), IOField< Type >::IOField(), IOMap< T >::IOMap(), IOPtrList< T >::IOPtrList(), polyBoundaryMeshEntries::polyBoundaryMeshEntries(), refinementHistory::read(), and refinementHistory::refinementHistory().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ close()

void close ( )

Close Istream.

Definition at line 182 of file regIOobjectRead.C.

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

Referenced by extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), featureEdgeMesh::featureEdgeMesh(), fieldDictionary::fieldDictionary(), IOdistributionMap::IOdistributionMap(), IOField< Type >::IOField(), IOMap< T >::IOMap(), IOPtrList< T >::IOPtrList(), regIOobject::objectPath(), polyBoundaryMeshEntries::polyBoundaryMeshEntries(), uncollatedFileOperation::read(), refinementHistory::read(), masterUncollatedFileOperation::read(), and refinementHistory::refinementHistory().

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, fvModels, fvConstraints, coordinateSystems, extendedFeatureEdgeMesh, IOdictionary, GlobalIOField< Type >, GlobalIOList< Type >, GlobalIOField< Foam::Vector >, GlobalIOList< momentumParcelInjectionData >, GlobalIOList< reactingParcelInjectionData >, GlobalIOList< reactingMultiphaseParcelInjectionData >, GlobalIOList< thermoParcelInjectionData >, featureEdgeMesh, and IOdistributionMap.

Definition at line 196 of file regIOobjectRead.C.

Referenced by regIOobject::objectPath(), uncollatedFileOperation::read(), masterUncollatedFileOperation::read(), and IOPosition< CloudType >::type().

Here is the caller graph for this function:

◆ read()

bool read ( )
virtual

Read object.

Reimplemented in phaseSystem, basicThermo::implementation, solidDisplacementThermo, refinementHistory, Time, fvModels, multiphaseMixture, phaseModel, incompressibleThreePhaseMixture, kinematicSingleLayer, EDC, radiationModel, compressibleTwoPhaseMixture, kineticTheoryModel, singleStepCombustion, combustionModel, incompressibleTwoPhaseInteractingMixture, fvDOM, twoPhaseChangeModel, RASModel< compressible::momentumTransportModel >, RASModel< phaseCompressible::momentumTransportModel >, thermoSingleLayer, fvConstraints, viewFactor, twoPhaseChangeModel, FSD, fvSchemes, kEpsilon< compressible::momentumTransportModel >, solution, incompressibleTwoPhaseMixture, SRFModel, decomposedBlockData, SchnerrSauer, momentumTransportModel, phasePressureModel, cavitationModel, SchnerrSauer, twoPhaseMixture, cavitationModel, IOOutputFilter< OutputFilter >, regionModel, PDRkEpsilon, laminar, Kunz, noPhaseChange, noPhaseChange, viscosityModel, Kunz, Quemada, zoneCombustion, pimpleMultiRegionControl, Merkle, P1, Merkle, pimpleNoLoopControl, PaSR, plastic, thermalBaffle, pimpleControl, regionModel1D, fluidSolutionControl, solutionControl, constant, BinghamPlastic, slurry, eddyViscosity< RASModel< compressible::momentumTransportModel > >, eddyViscosity< RASModel< phaseCompressible::momentumTransportModel > >, diffusion, solidNoLoopControl, IOMRFZoneList, infinitelyFastChemistry, noCombustion, simpleControl, pisoControl, thermophysicalTransportModel, nonOrthogonalSolutionControl, noRadiation, thermalBaffleModel, rpm, tolerances, physicalProperties, opaqueSolid, immiscibleIncompressibleTwoPhaseMixture, linearViscousStress< RASModel< compressible::momentumTransportModel > >, linearViscousStress< RASModel< phaseCompressible::momentumTransportModel > >, IOporosityModelList, surfaceFilmRegionModel, and noThermo.

Definition at line 202 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 regIOobject::objectPath(), PDRDragModel::on(), porosityModel::iNew::operator()(), IOporosityModelList::read(), tolerances::read(), physicalProperties::read(), thermophysicalTransportModel::read(), IOMRFZoneList::read(), regionModel::read(), twoPhaseMixture::read(), momentumTransportModel::read(), SRFModel::read(), solution::read(), fvSchemes::read(), twoPhaseChangeModel::read(), combustionModel::read(), radiationModel::read(), basicThermo::implementation::read(), regIOobject::readIfModified(), and phase::rho().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ watchIndices() [1/2]

const Foam::labelList & watchIndices ( ) const
inline

Return file-monitoring handles.

Definition at line 100 of file regIOobjectI.H.

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

Here is the caller graph for this function:

◆ watchIndices() [2/2]

Foam::labelList & watchIndices ( )
inline

Return file-monitoring handles.

Definition at line 106 of file regIOobjectI.H.

◆ modified()

bool modified ( ) const
virtual

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

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

Reimplemented in objectRegistry.

Definition at line 248 of file regIOobjectRead.C.

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

Referenced by regIOobject::objectPath(), and regIOobject::readIfModified().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ readIfModified()

bool readIfModified ( )
virtual

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

Reimplemented in objectRegistry.

Definition at line 262 of file regIOobjectRead.C.

References Foam::endl(), Foam::fileHandler(), forAllReverse, fileOperation::getFile(), Foam::Info, UList< T >::last(), regIOobject::modified(), IOobject::name(), Foam::nl, regIOobject::read(), and fileMonitor::UNMODIFIED.

Referenced by regIOobject::objectPath(), and Time::readModifiedObjects().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ writeData()

virtual bool writeData ( Ostream &  ) const
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< Type, pointPatchField, pointMesh >, GeometricField< scalar, Foam::pointPatchField, Foam::pointMesh >, GeometricField< Type, Foam::fvsPatchField, Foam::surfaceMesh >, GeometricField< Foam::Vector, Foam::fvPatchField, Foam::volMesh >, GeometricField< vector, pointPatchField, pointMesh >, populationBalanceModel, refinementHistory, 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 >, searchableSurfaceCollection, topoSet, searchableSurfaceWithGaps, searchableBox, objectRegistry, searchableCylinder, fvModels, searchableDisk, polyBoundaryMesh, searchablePlane, searchablePlate, searchableExtrudedCircle, searchableSphere, porosityModel, solidification, powerLawLopesdaCosta, BlendedInterfacialModel< ModelType >, BlendedInterfacialModel< virtualMassModel >, BlendedInterfacialModel< liftModel >, BlendedInterfacialModel< dragModel >, BlendedInterfacialModel< heatTransferModel >, BlendedInterfacialModel< phaseTransferModel >, BlendedInterfacialModel< turbulentDispersionModel >, BlendedInterfacialModel< wallLubricationModel >, BlendedInterfacialModel< diffusiveMassTransferModel >, DarcyForchheimer, MeshZones< ZoneType, MeshType >, MeshZones< faceZone, polyMesh >, MeshZones< pointZone, polyMesh >, MeshZones< cellZone, polyMesh >, AveragingMethod< Type >, AveragingMethod< scalar >, AveragingMethod< Foam::Vector >, SecondaryPropertyModel< ModelType >, SecondaryPropertyModel< shapeModel >, powerLaw, fvConstraints, PDRDragModel, fixedCoeff, surfaceTensionModel, polyTopoChanger, MeshObject< polyMesh, PatchMeshObject, pointMesh >, MeshObject< objectRegistry, GeometricMeshObject, coordinateSystems >, MeshObject< fvMesh, MoveableMeshObject, FitDataType >, MeshObject< polyMesh, MoveableMeshObject, nonConformalBoundary >, MeshObject< polyMesh, GeometricMeshObject, meshSearchMeshObject >, 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< fvMesh, UpdateableMeshObject, fvModels >, MeshObject< polyMesh, GeometricMeshObject, meshSearchFACE_CENTRE_TRISMeshObject >, MeshObject< polyMesh, GeometricMeshObject, Residuals< Type > >, 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< fvMesh, UpdateableMeshObject, fvConstraints >, MeshObject< lduMesh, GeometricMeshObject, GAMGAgglomeration >, MeshObject< fvMesh, TopologicalMeshObject, pureUpwindCFCCellToFaceStencilObject >, MeshObject< fvMesh, UpdateableMeshObject, nearWallDist >, MeshObject< fvMesh, TopologicalMeshObject, centredCECCellToFaceStencilObject >, MeshObject< fvMesh, MoveableMeshObject, UpwindFitData< Polynomial > >, MeshObject< polyMesh, TopologicalMeshObject, regionSplit >, MeshObject< fvMesh, MoveableMeshObject, skewCorrectionVectors >, MeshObject< fvMesh, TopologicalMeshObject, centredCFCCellToFaceStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, centredFECCellToFaceStencilObject >, MeshObject< fvMesh, MoveableMeshObject, CentredFitSnGradData< Polynomial > >, coordinateSystems, saturationModel, extendedFeatureEdgeMesh, decomposedBlockData, temperatureDependent, phaseTransferModel, dragModel, virtualMassModel, CompactIOField< Type, BaseType >, liquidProperties, IOdictionary, UniformDimensionedField< Type >, UniformDimensionedField< scalar >, UniformDimensionedField< vector >, SidedInterfacialModel< ModelType >, SidedInterfacialModel< blendedDiffusiveMassTransferModel >, SidedInterfacialModel< interfaceCompositionModel >, SidedInterfacialModel< blendedHeatTransferModel >, CompactIOList< T, BaseType >, constant, CompactIOList< face, label >, GlobalIOField< Type >, GlobalIOList< Type >, GlobalIOField< Foam::Vector >, GlobalIOList< momentumParcelInjectionData >, GlobalIOList< reactingParcelInjectionData >, GlobalIOList< reactingMultiphaseParcelInjectionData >, GlobalIOList< thermoParcelInjectionData >, IOPosition< CloudType >, IOField< Type >, surfZoneIOList, IOPtrList< T >, IOList< T >, IOList< label >, IOList< labelList >, surfacePatchIOList, IOMap< T >, featureEdgeMesh, IOdistributionMap, fieldDictionary, polyBoundaryMeshEntries, and solutionControl.

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

Here is the caller graph for this function:

◆ writeObject()

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

Write using given format, version and compression.

Reimplemented in polyMesh, fvMesh, distributedTriSurfaceMesh, triSurfaceMesh, Time, Cloud< ParticleType >, Cloud< Foam::passiveParticle >, Cloud< indexedParticle >, Cloud< ParcelType >, Cloud< Foam::molecule >, Cloud< solidParticle >, Cloud< parcelType >, Cloud< molecule >, Cloud< sampledSetParticle >, Cloud< typename CloudType::parcelType >, Cloud< streamlinesParticle >, Cloud< passiveParticle >, objectRegistry, polyBoundaryMesh, faceZoneSet, pointZoneSet, cellZoneSet, decomposedBlockData, CompactIOField< Type, BaseType >, CompactIOList< T, BaseType >, and CompactIOList< face, label >.

Definition at line 37 of file regIOobjectWrite.C.

References Foam::endl(), Foam::fileHandler(), Foam::name(), Foam::Pout, SeriousErrorInFunction, fileOperation::setUnmodified(), and fileOperation::writeObject().

Referenced by regIOobject::objectPath(), meshReader::warnDuplicates(), regIOobject::write(), CompactIOField< Type, BaseType >::writeObject(), cellZoneSet::writeObject(), pointZoneSet::writeObject(), faceZoneSet::writeObject(), polyBoundaryMesh::writeObject(), and distributedTriSurfaceMesh::writeObject().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ write()

bool write ( const bool  write = true) const
virtual

Write using setting from DB.

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

Definition at line 93 of file regIOobjectWrite.C.

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

Referenced by snappyLayerDriver::addLayers(), cellZoneSet::addressing(), pointZoneSet::addressing(), rotorDiskSource::addSup(), polyMesh::cellZones(), Cloud< passiveParticle >::clear(), hexRef8::consistentSlowRefinement2(), snappySnapDriver::doSnap(), faceZoneSet::flipMap(), Foam::hydrostaticInitialisation(), if(), Foam::MapLagrangianFields(), meshRefinement::mergePatchFacesUndo(), polyBoundaryMesh::mesh(), polyMesh::movePoints(), NamedEnum< compressibleField, 8 >::names(), regIOobject::objectPath(), polyMesh::polyMesh(), refiner::refiner(), Time::runTimeModifiable(), snappySnapDriver::scaleMesh(), hexRef8::setUnrefinement(), snappyRefineDriver::snappyRefineDriver(), surfMesh::surfZones(), objectRegistry::thisDb(), RelativeVelocity< CloudType >::write(), IOPosition< CloudType >::write(), PatchCollisionDensity< CloudType >::write(), dsmcFields::write(), XiReactionRate::write(), writeCellVolumes::write(), AveragingMethod< Foam::Vector >::write(), regionSizeDistribution::write(), refiner::write(), hexRef8::write(), fvMesh::write(), meshRefinement::write(), domainDecomposition::writeAddressing(), MPPICParcel< ParcelType >::writeFields(), Time::writeNow(), regionFunctionObject::writeObject(), writeObjectsBase::writeObject(), cellZoneSet::writeObject(), pointZoneSet::writeObject(), faceZoneSet::writeObject(), and fvMesh::writeObject().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator=()

void operator= ( const IOobject &  io)

Definition at line 464 of file regIOobject.C.

References regIOobject::checkIn(), regIOobject::checkOut(), IOobject::operator=(), and IOobject::registerObject().

Here is the call graph for this function:

Member Data Documentation

◆ fileModificationSkew

float fileModificationSkew
static

Definition at line 101 of file regIOobject.H.

Referenced by codedBase::description(), argList::parse(), and fileMonitorWatcher::removeWatch().

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