regIOobject Class Referenceabstract

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

Inheritance diagram for regIOobject:
Collaboration diagram for regIOobject:

Public 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 fileNamecaseName () 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...
 
labeleventNo ()
 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...
 
IstreamreadStream (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 labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) More...
 
virtual bool dependenciesModified () const
 Return true if the object's dependencies have been modified. More...
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeData (Ostream &) const =0
 Pure virtual writaData function. More...
 
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
 Write using given format, version and compression. More...
 
virtual bool write (const bool write=true) const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 Assign to IOobject. More...
 
void operator= (const regIOobject &)=delete
 Disallow default assignment. More...
 
const fileNamecaseName (const bool global) const
 
fileName path (const bool global) const
 Return complete path including the processor sub-directory. More...
 
fileName objectPath (const bool global) const
 Return complete path + object name including the processor. More...
 
fileName filePath (const word &typeName, const bool global) const
 Return complete path + object name if the file exists. More...
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Construct from copy resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Construct from copy resetting name. More...
 
 IOobject (const IOobject &io)=default
 Copy constructor. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
wordheaderClassName ()
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () 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
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 
const fileNamecaseName (const bool global) const
 
fileNameinstance () 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 fileNamelocal () 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< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 

Static Public Member Functions

template<class Type >
static Type & store (Type *)
 Transfer ownership of the given object pointer to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &)
 Transfer ownership of the given object pointer to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class Name >
static word groupName (Name name, const word &group)
 
static word group (const word &name)
 Return group (extension part of name) More...
 
static word member (const word &name)
 Return member (name without the extension) More...
 
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider. More...
 
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider. More...
 

Static Public Attributes

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

Protected Member Functions

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

Additional Inherited Members

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

Detailed Description

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

Source files

Definition at line 52 of file regIOobject.H.

Constructor & Destructor Documentation

◆ regIOobject() [1/6]

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

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

top level regIOobject.

Definition at line 41 of file regIOobject.C.

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

Here is the call graph for this function:

◆ regIOobject() [2/6]

regIOobject ( const regIOobject rio)

Copy constructor.

Definition at line 62 of file regIOobject.C.

◆ regIOobject() [3/6]

regIOobject ( const regIOobject &&  rio)

Move constructor.

Registers copy if the object is registered

Definition at line 74 of file regIOobject.C.

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

Here is the call graph for this function:

◆ regIOobject() [4/6]

regIOobject ( const regIOobject rio,
bool  registerCopy 
)

Copy constructor, transferring registry registration to copy.

if registerCopy is true

Definition at line 90 of file regIOobject.C.

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

Here is the call graph for this function:

◆ regIOobject() [5/6]

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

Copy constructor with new name, transferring registry registration.

to copy as specified

Definition at line 109 of file regIOobject.C.

References regIOobject::checkIn().

Here is the call graph for this function:

◆ regIOobject() [6/6]

regIOobject ( const IOobject io,
const regIOobject rio 
)

Copy constructor with new IO parameters.

Definition at line 129 of file regIOobject.C.

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

Here is the call graph for this function:

◆ ~regIOobject()

~regIOobject ( )
virtual

Destructor.

Definition at line 150 of file regIOobject.C.

Member Function Documentation

◆ readHeaderOk()

◆ TypeName()

TypeName ( "regIOobject"  )

Runtime type information.

◆ global()

◆ globalFile()

bool globalFile ( ) const
virtual

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

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

Reimplemented in timeIOdictionary.

Definition at line 187 of file regIOobject.C.

Referenced by regIOobject::writeObject().

Here is the caller graph for this function:

◆ caseName() [1/2]

const Foam::fileName & caseName ( ) const

Definition at line 193 of file regIOobject.C.

References IOobject::caseName().

Here is the call graph for this function:

◆ path() [1/2]

Foam::fileName path ( ) const

Return complete path.

Definition at line 199 of file regIOobject.C.

References IOobject::path().

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

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

◆ objectPath() [1/2]

◆ filePath() [1/2]

Foam::fileName filePath ( ) const

Return complete path + object name if the file exists.

in the case directory otherwise null.

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

Definition at line 447 of file regIOobject.C.

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

Here is the call graph for this function:

◆ checkIn()

bool checkIn ( )

Add object to registry.

Definition at line 205 of file regIOobject.C.

References Foam::abort(), polyMesh::defaultRegion, Foam::endl(), Foam::FatalError, FatalErrorInFunction, Foam::name(), and WarningInFunction.

Referenced by regIOobject::regIOobject().

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

◆ checkOut()

bool checkOut ( )

Remove object from registry.

Definition at line 241 of file regIOobject.C.

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

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

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

◆ addWatch()

◆ registered()

bool registered ( ) const
inline

Is this object registered with the registry?

Definition at line 28 of file regIOobjectI.H.

◆ ownedByRegistry()

bool ownedByRegistry ( ) const
inline

Is this object owned by the registry?

Definition at line 34 of file regIOobjectI.H.

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

Here is the caller graph for this function:

◆ store() [1/3]

◆ store() [2/3]

Type & store ( Type *  tPtr)
inlinestatic

Transfer ownership of the given object pointer to its registry.

and return reference to object.

Definition at line 48 of file regIOobjectI.H.

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

Here is the call graph for this function:

◆ store() [3/3]

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

Transfer ownership of the given object pointer to its registry.

and return reference to object.

Definition at line 65 of file regIOobjectI.H.

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

Here is the call graph for this function:

◆ release()

void release ( )
inline

Release ownership of this object from its registry.

Definition at line 83 of file regIOobjectI.H.

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

Here is the caller graph for this function:

◆ eventNo() [1/2]

Foam::label eventNo ( ) const
inline

Event number at last update.

Definition at line 89 of file regIOobjectI.H.

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

Here is the caller graph for this function:

◆ eventNo() [2/2]

Foam::label & eventNo ( )
inline

Event number at last update.

Definition at line 94 of file regIOobjectI.H.

◆ upToDate() [1/4]

bool upToDate ( const regIOobject a) const

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

otherwise false

Definition at line 329 of file regIOobject.C.

References regIOobject::eventNo().

Referenced by volPointInterpolation::interpolate(), and polyMesh::upToDatePoints().

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

◆ upToDate() [2/4]

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

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

otherwise false

Definition at line 342 of file regIOobject.C.

References b, and regIOobject::eventNo().

Here is the call graph for this function:

◆ upToDate() [3/4]

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

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

otherwise false

Definition at line 363 of file regIOobject.C.

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

Here is the call graph for this function:

◆ upToDate() [4/4]

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

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

otherwise false

Definition at line 386 of file regIOobject.C.

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

Here is the call graph for this function:

◆ setUpToDate()

void setUpToDate ( )

Set up to date (obviously)

Definition at line 411 of file regIOobject.C.

◆ rename()

◆ headerOk()

◆ readStream()

◆ close()

◆ readData()

bool readData ( Istream )
virtual

Virtual readData function.

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

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

Definition at line 196 of file regIOobjectRead.C.

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

Here is the caller graph for this function:

◆ read()

bool read ( )
virtual

Read object.

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

Definition at line 202 of file regIOobjectRead.C.

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

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

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

◆ watchIndices() [1/2]

const Foam::labelList & watchIndices ( ) const
inline

Return file-monitoring handles.

Definition at line 100 of file regIOobjectI.H.

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

Here is the caller graph for this function:

◆ watchIndices() [2/2]

Foam::labelList & watchIndices ( )
inline

Return file-monitoring handles.

Definition at line 106 of file regIOobjectI.H.

◆ modified()

bool modified ( ) const
virtual

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

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

Reimplemented in objectRegistry.

Definition at line 248 of file regIOobjectRead.C.

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

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

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

◆ dependenciesModified()

virtual bool dependenciesModified ( ) const
inlinevirtual

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

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

Definition at line 286 of file regIOobject.H.

◆ readIfModified()

bool readIfModified ( )
virtual

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

Reimplemented in objectRegistry.

Definition at line 262 of file regIOobjectRead.C.

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

Here is the call graph for this function:

◆ writeData()

virtual bool writeData ( Ostream ) const
pure virtual

Pure virtual writaData function.

Must be defined in derived types

Implemented in surfaceTensionModel, temperatureDependent, constant, liquidProperties, searchableSurfaceWithGaps, IOPosition< CloudType >, fieldDictionary, solidification, powerLaw, porosityModel, fixedCoeff, DarcyForchheimer, fvModels, fvConstraints, powerLawLopesdaCosta, wallBoilingHeatTransfer, SidedInterfacialModel< ModelType >, SidedInterfacialModel< blendedDiffusiveMassTransferModel >, SidedInterfacialModel< interfaceCompositionModel >, SidedInterfacialModel< blendedHeatTransferModel >, BlendedInterfacialModel< ModelType >, BlendedInterfacialModel< virtualMassModel >, BlendedInterfacialModel< liftModel >, BlendedInterfacialModel< dragModel >, BlendedInterfacialModel< heatTransferModel >, BlendedInterfacialModel< phaseTransferModel >, BlendedInterfacialModel< turbulentDispersionModel >, BlendedInterfacialModel< wallLubricationModel >, BlendedInterfacialModel< diffusiveMassTransferModel >, virtualMassModel, phaseTransferModel, interfaceSaturationTemperatureModel, heatTransferModel, dragModel, surfacePatchIOList, surfZoneIOList, refinementHistory, ZoneList< ZoneType, ZonesType, MeshType >, ZoneList< pointZone, pointZoneList, polyMesh >, ZoneList< faceZone, faceZoneList, polyMesh >, ZoneList< cellZone, cellZoneList, polyMesh >, IOdistributionMap, polyBoundaryMeshEntries, polyBoundaryMesh, UniformDimensionedField< Type >, UniformDimensionedField< scalar >, UniformDimensionedField< vector >, GeometricField< Type, PatchField, GeoMesh >, GeometricField< symmTensor >, GeometricField< scalar >, GeometricField< vector >, GeometricField< Type >, GeometricField< Type, pointPatchField, pointMesh >, DimensionedField< Type, GeoMesh >, DimensionedField< scalar, Foam::volMesh >, DimensionedField< Type, Foam::surfaceMesh >, DimensionedField< Type, Foam::volMesh >, DimensionedField< Type, Foam::pointMesh >, DimensionedField< Type, Foam::GeoMesh >, objectRegistry, IOListBase< Container, IOContainer, Type >, IOListBase< List, IOList, Type >, IOListBase< PtrList, IOPtrList, Type >, IOListBase< Map, IOMap, Type >, IOListBase< Field, IOField, Type >, IOdictionary, GlobalIOListBase< Container, IOContainer, Type >, GlobalIOListBase< List, GlobalIOList, Type >, GlobalIOListBase< Field, GlobalIOField, Type >, decomposedBlockData, CompactIOListBase< Container, IOContainer, CompactIOContainer, Type >, CompactIOListBase< List, IOList, CompactIOList, Type >, CompactIOListBase< Field, IOField, CompactIOField, Type >, solutionControl, topoSet, triSurfaceMesh, searchableSurfaceCollection, searchableSphere, searchablePlate, searchablePlane, searchableExtrudedCircle, searchableDisk, searchableCylinder, searchableBox, featureEdgeMesh, extendedFeatureEdgeMesh, coordinateSystems, AveragingMethod< Type >, AveragingMethod< scalar >, AveragingMethod< Foam::Vector >, populationBalanceModel, populationBalanceModel::groups, SecondaryPropertyModel< ModelType >, SecondaryPropertyModel< shapeModel >, PDRDragModel, DemandDrivenMeshObject< Mesh, MeshObjectType, Type >, DemandDrivenMeshObject< pointMesh, TopoChangeableMeshObject, pointConstraints >, DemandDrivenMeshObject< polyMesh, DeletableMeshObject, meshSearchMeshObject >, DemandDrivenMeshObject< polyMesh, TopoChangeableMeshObject, Residuals< Type > >, DemandDrivenMeshObject< fvMesh, MoveableMeshObject, FitDataType >, DemandDrivenMeshObject< polyMesh, MoveableMeshObject, nonConformalBoundary >, DemandDrivenMeshObject< fvMesh, MoveableMeshObject, centredCPCCellToFaceStencilObject >, DemandDrivenMeshObject< fvMesh, MoveableMeshObject, centredCECCellToCellStencilObject >, DemandDrivenMeshObject< polyMesh, TopoChangeableMeshObject, cellEdgeAddressingList >, DemandDrivenMeshObject< lduMesh, DeletableMeshObject, GAMGAgglomeration >, DemandDrivenMeshObject< polyMesh, TopoChangeableMeshObject, twoDPointCorrector >, DemandDrivenMeshObject< polyMesh, TopoChangeableMeshObject, cpuLoad >, DemandDrivenMeshObject< fvMesh, MoveableMeshObject, centredCPCCellToCellStencilObject >, DemandDrivenMeshObject< fvMesh, MoveableMeshObject, LeastSquaresVectors< Stencil > >, DemandDrivenMeshObject< fvMesh, MoveableMeshObject, centredCFCCellToCellStencilObject >, DemandDrivenMeshObject< fvMesh, MoveableMeshObject, leastSquaresVectors >, DemandDrivenMeshObject< objectRegistry, DeletableMeshObject, coordinateSystems >, DemandDrivenMeshObject< fvMesh, MoveableMeshObject, upwindFECCellToFaceStencilObject >, DemandDrivenMeshObject< fvMesh, TopoChangeableMeshObject, parcelClouds >, DemandDrivenMeshObject< fvMesh, DeletableMeshObject, nearWallDist >, DemandDrivenMeshObject< fvMesh, MoveableMeshObject, pureUpwindCFCCellToFaceStencilObject >, DemandDrivenMeshObject< fvMesh, MoveableMeshObject, centredCECCellToFaceStencilObject >, DemandDrivenMeshObject< polyMesh, DeletableMeshObject, meshSearchFACE_CENTRE_TRISMeshObject >, DemandDrivenMeshObject< fvMesh, TopoChangeableMeshObject, fvModels >, DemandDrivenMeshObject< fvMesh, DeletableMeshObject, volPointInterpolation >, DemandDrivenMeshObject< fvMesh, MoveableMeshObject, upwindCFCCellToFaceStencilObject >, DemandDrivenMeshObject< fvMesh, MoveableMeshObject, upwindCECCellToFaceStencilObject >, DemandDrivenMeshObject< fvMesh, MoveableMeshObject, skewCorrectionVectors >, DemandDrivenMeshObject< fvMesh, MoveableMeshObject, centredFECCellToFaceStencilObject >, DemandDrivenMeshObject< fvMesh, MoveableMeshObject, upwindCPCCellToFaceStencilObject >, DemandDrivenMeshObject< polyMesh, RepatchableMeshObject, pointMesh >, DemandDrivenMeshObject< fvMesh, MoveableMeshObject, centredCFCFaceToCellStencilObject >, DemandDrivenMeshObject< fvMesh, MoveableMeshObject, centredCFCCellToFaceStencilObject >, DemandDrivenMeshObject< fvMesh, TopoChangeableMeshObject, fvConstraints >, and DemandDrivenMeshObject< fvMesh, DeletableMeshObject, wallDist >.

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

Here is the caller graph for this function:

◆ writeObject()

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

Write using given format, version and compression.

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

Definition at line 36 of file regIOobjectWrite.C.

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

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

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

◆ write()

bool write ( const bool  write = true) const
virtual

Write using setting from DB.

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

Definition at line 93 of file regIOobjectWrite.C.

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

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

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

◆ operator=() [1/2]

void operator= ( const IOobject io)

Assign to IOobject.

Definition at line 474 of file regIOobject.C.

References IOobject::operator=().

Here is the call graph for this function:

◆ operator=() [2/2]

void operator= ( const regIOobject )
delete

Disallow default assignment.

◆ caseName() [2/2]

const Foam::fileName & caseName

Definition at line 391 of file IOobject.C.

◆ path() [2/2]

Return complete path including the processor sub-directory.

for a parallel run if global is set false

Definition at line 407 of file IOobject.C.

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

Here is the call graph for this function:

◆ objectPath() [2/2]

fileName objectPath
inline

Return complete path + object name including the processor.

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

Definition at line 411 of file IOobject.H.

◆ filePath() [2/2]

Foam::fileName filePath

Return complete path + object name if the file exists.

in the case directory otherwise null.

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

Definition at line 430 of file IOobject.C.

Member Data Documentation

◆ fileModificationSkew

float fileModificationSkew
static

Definition at line 100 of file regIOobject.H.

Referenced by argList::parse().


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