regIOobject is an abstract class derived from IOobject to handle automatic object registration with the objectRegistry. More...
#include <OpenFOAM/regIOobject.H>
regIOobject is an abstract class derived from IOobject to handle automatic object registration with the objectRegistry.
Definition at line 55 of file regIOobject.H.
Inherits Foam::IOobject.
Inherited by DimensionedField< scalar, pointMesh >, DimensionedField< scalar, surfaceMesh >, DimensionedField< scalar, volMesh >, DimensionedField< symmTensor, volMesh >, DimensionedField< tensor, volMesh >, DimensionedField< Type, pointMesh >, DimensionedField< Type, surfaceMesh >, DimensionedField< Type, volMesh >, DimensionedField< vector, pointMesh >, DimensionedField< vector, volMesh >, AverageIOField< Type >, DimensionedField< Type, GeoMesh >, featureEdgeMesh, fieldDictionary, IOdictionary, IOField< Type >, IOList< T >, IOMap< T >, IOPosition< ParticleType >, IOPtrList< T >, MeshObject< Mesh, Type >, objectRegistry, PDRDragModel, polyBoundaryMesh, polyBoundaryMeshEntries, polyTopoChanger, refinementHistory, searchableSurface, SubDimensionedField< Type, GeoMesh >, surfacePatchIOList, surfZoneIOList, topoSet, UniformDimensionedField< Type >, ZoneMesh< ZoneType, MeshType >, IOField< vector >, IOList< face >, IOList< kinematicParcelInjectionData >, IOList< label >, IOList< reactingMultiphaseParcelInjectionData >, IOList< reactingParcelInjectionData >, IOPtrList< coordinateSystem >, IOPtrList< injector >, IOPtrList< MRFZone >, IOPtrList< porousZone >, IOPtrList< TimeActivatedExplicitSource< Type > >, MeshObject< fvMesh, centredCECCellToFaceStencilObject >, MeshObject< fvMesh, centredCFCCellToFaceStencilObject >, MeshObject< fvMesh, centredCFCFaceToCellStencilObject >, MeshObject< fvMesh, centredCPCCellToFaceStencilObject >, MeshObject< fvMesh, centredFECCellToFaceStencilObject >, MeshObject< fvMesh, CentredFitData< Polynomial > >, MeshObject< fvMesh, extendedLeastSquaresVectors >, MeshObject< fvMesh, FitDataType >, MeshObject< fvMesh, leastSquaresVectors >, MeshObject< fvMesh, pureUpwindCFCCellToFaceStencilObject >, MeshObject< fvMesh, quadraticFitSnGradData >, MeshObject< fvMesh, skewCorrectionVectors >, MeshObject< fvMesh, upwindCECCellToFaceStencilObject >, MeshObject< fvMesh, upwindCFCCellToFaceStencilObject >, MeshObject< fvMesh, upwindCPCCellToFaceStencilObject >, MeshObject< fvMesh, upwindFECCellToFaceStencilObject >, MeshObject< fvMesh, UpwindFitData< Polynomial > >, MeshObject< fvMesh, volPointInterpolation >, MeshObject< lduMesh, GAMGAgglomeration >, MeshObject< polyMesh, pointMesh >, ZoneMesh< cellZone, polyMesh >, ZoneMesh< faceZone, polyMesh >, and ZoneMesh< pointZone, polyMesh >.
Collaboration diagram for regIOobject:Public Member Functions | |
| TypeName ("regIOobject") | |
| Runtime type information.
| |
| regIOobject (const IOobject &, const bool isTime=false) | |
| Construct from IOobject. Optional flag for if IOobject is the.
| |
| regIOobject (const regIOobject &) | |
| Construct as copy.
| |
| regIOobject (const regIOobject &, bool registerCopy) | |
| Construct as copy, and transferring registry registration to copy.
| |
| virtual | ~regIOobject () |
| bool | checkIn () |
| Add object to registry.
| |
| bool | checkOut () |
| Remove object from registry.
| |
| bool | ownedByRegistry () const |
| Is this object owned by the registry?
| |
| void | store () |
| Transfer ownership of this object to its registry.
| |
| void | release () |
| Release ownership of this object from its registry.
| |
| label | eventNo () const |
| Event number at last update.
| |
| label & | eventNo () |
| Event number at last update.
| |
| bool | upToDate (const word &) const |
| Am I uptodate with respect to other regIOobjects.
| |
| bool | upToDate (const word &, const word &) const |
| bool | upToDate (const word &, const word &, const word &) const |
| bool | upToDate (const word &, const word &, const word &, const word &) const |
| void | setUpToDate () |
| Flag me as up to date.
| |
| virtual void | rename (const word &newName) |
| Rename.
| |
| Istream & | readStream (const word &) |
| Return Istream and check object type against that given.
| |
| void | close () |
| Close Istream.
| |
| virtual bool | readData (Istream &) |
| Virtual readData function.
| |
| virtual bool | read () |
| Read object.
| |
| virtual bool | modified () const |
| Return true if the object's file has been modified.
| |
| virtual bool | readIfModified () |
| Read object if modified.
| |
| virtual bool | writeData (Ostream &) const =0 |
| Pure virtual writaData function.
| |
| virtual bool | writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const |
| Write using given format, version and compression.
| |
| virtual bool | write () const |
| Write using setting from DB.
| |
| void | operator= (const IOobject &) |
Static Public Member Functions | |
| template<class Type > | |
| static Type & | store (Type *) |
| Transfer ownership of the given object pointer to its registry.
| |
| template<class Type > | |
| static Type & | store (autoPtr< Type > &) |
| Transfer ownership of the given object pointer to its registry.
| |
Static Public Attributes | |
| static int | fileModificationSkew |
| regIOobject | ( | const IOobject & | io, |
| const bool | isTime = false
|
||
| ) |
Construct from IOobject. Optional flag for if IOobject is the.
top level regIOobject.
Definition at line 43 of file regIOobject.C.
References regIOobject::checkIn(), and IOobject::registerObject().
| regIOobject | ( | const regIOobject & | rio ) |
Construct as copy.
Definition at line 66 of file regIOobject.C.
| regIOobject | ( | const regIOobject & | rio, |
| bool | registerCopy | ||
| ) |
Construct as copy, and transferring registry registration to copy.
if registerCopy is true
Definition at line 81 of file regIOobject.C.
References regIOobject::checkIn(), and regIOobject::checkOut().
| ~regIOobject | ( | ) | [virtual]
|
Definition at line 101 of file regIOobject.C.
References Foam::endl(), Foam::Info, Foam::name(), and Foam::type().
| TypeName | ( | "regIOobject" | ) |
Runtime type information.
| bool checkIn | ( | ) |
Add object to registry.
Definition at line 128 of file regIOobject.C.
References Foam::abort(), polyMesh::defaultRegion, Foam::endl(), Foam::FatalError, FatalErrorIn, Foam::name(), and WarningIn.
Referenced by regIOobject::regIOobject().
| bool checkOut | ( | ) |
Remove object from registry.
Definition at line 163 of file regIOobject.C.
Referenced by MeshObject< Mesh, Type >::Delete(), regIOobject::regIOobject(), and objectRegistry::~objectRegistry().
| bool ownedByRegistry | ( | ) | const [inline]
|
Is this object owned by the registry?
Definition at line 28 of file regIOobjectI.H.
Referenced by objectRegistry::checkOut().
| void store | ( | ) | [inline]
|
Transfer ownership of this object to its registry.
Definition at line 34 of file regIOobjectI.H.
Referenced by coordinateSystems::New(), and triSurfaceMesh::setField().
| Type & store | ( | Type * | tPtr ) | [inline, static]
|
Transfer ownership of the given object pointer to its registry.
and return reference to object.
Definition at line 41 of file regIOobjectI.H.
References Foam::abort(), Foam::FatalError, and FatalErrorIn.
| Type & store | ( | autoPtr< Type > & | atPtr ) | [inline, static]
|
Transfer ownership of the given object pointer to its registry.
and return reference to object.
Definition at line 57 of file regIOobjectI.H.
References Foam::abort(), Foam::FatalError, FatalErrorIn, and autoPtr< T >::ptr().
| void release | ( | ) | [inline]
|
Release ownership of this object from its registry.
Definition at line 76 of file regIOobjectI.H.
| Foam::label eventNo | ( | ) | const [inline]
|
Event number at last update.
Definition at line 82 of file regIOobjectI.H.
Referenced by objectRegistry::getEvent().
| Foam::label & eventNo | ( | ) | [inline]
|
Event number at last update.
Definition at line 87 of file regIOobjectI.H.
| bool upToDate | ( | const word & | a ) | const |
Am I uptodate with respect to other regIOobjects.
Definition at line 175 of file regIOobject.C.
Definition at line 188 of file regIOobject.C.
Definition at line 206 of file regIOobject.C.
Definition at line 229 of file regIOobject.C.
| void setUpToDate | ( | ) |
Flag me as up to date.
Definition at line 254 of file regIOobject.C.
| void rename | ( | const word & | newName ) | [virtual]
|
Rename.
Reimplemented from IOobject.
Reimplemented in objectRegistry.
Definition at line 261 of file regIOobject.C.
References IOobject::rename().
Referenced by reuseTmpTmpGeometricField< TypeR, TypeR, TypeR, TypeR, PatchField, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, TypeR, TypeR, Type2, PatchField, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, Type1, Type12, TypeR, PatchField, GeoMesh >::New(), reuseTmpGeometricField< TypeR, TypeR, PatchField, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, TypeR, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, Type2, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, Type1, Type12, TypeR, GeoMesh >::New(), reuseTmpDimensionedField< TypeR, TypeR, GeoMesh >::New(), and objectRegistry::rename().
| Foam::Istream & readStream | ( | const word & | expectName ) |
Return Istream and check object type against that given.
Definition at line 84 of file regIOobjectRead.C.
References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, Foam::Info, and Foam::name().
Referenced by featureEdgeMesh::featureEdgeMesh(), fieldDictionary::fieldDictionary(), IOdictionary::IOdictionary(), IOField< Type >::IOField(), IOList< T >::IOList(), IOMap< T >::IOMap(), IOPtrList< T >::IOPtrList(), polyBoundaryMeshEntries::polyBoundaryMeshEntries(), refinementHistory::refinementHistory(), and topoSet::topoSet().
| void close | ( | ) |
Close Istream.
Definition at line 121 of file regIOobjectRead.C.
References Foam::endl(), and Foam::Info.
Referenced by featureEdgeMesh::featureEdgeMesh(), fieldDictionary::fieldDictionary(), IOdictionary::IOdictionary(), IOField< Type >::IOField(), IOList< T >::IOList(), IOMap< T >::IOMap(), IOPtrList< T >::IOPtrList(), polyBoundaryMeshEntries::polyBoundaryMeshEntries(), refinementHistory::refinementHistory(), and topoSet::topoSet().
| bool readData | ( | Istream & | ) | [virtual]
|
Virtual readData function.
Must be defined in derived types for which re-reading is required
Reimplemented in refinementHistory, featureEdgeMesh, TimeActivatedExplicitSourceList< Type >, porousZones, and IOdictionary.
Definition at line 138 of file regIOobjectRead.C.
| bool read | ( | ) | [virtual]
|
Read object.
Reimplemented in engineTime, IObasicSourceList, rpm, SRFModel, fvSchemes, IOOutputFilter< OutputFilter >, Time, solution, tolerances, basicThermo, ePsiThermo< MixtureType >, hPsiThermo< MixtureType >, hsPsiThermo< MixtureType >, hRhoThermo< MixtureType >, hsRhoThermo< MixtureType >, fvDOM, noRadiation, P1, radiationModel, hhuMixtureThermo< MixtureType >, hPsiMixtureThermo< MixtureType >, hsPsiMixtureThermo< MixtureType >, hRhoMixtureThermo< MixtureType >, hsRhoMixtureThermo< MixtureType >, twoPhaseMixture, singlePhaseTransportModel, transportModel, DeardorffDiffStress, dynOneEqEddy, GenEddyVisc, GenSGSStress, LESModel, lowReOneEqEddy, oneEqEddy, Smagorinsky, SpalartAllmaras, kEpsilon, kOmegaSST, laminar, LaunderGibsonRSTM, LaunderSharmaKE, LRR, RASModel, realizableKE, RNGkEpsilon, SpalartAllmaras, DeardorffDiffStress, dynOneEqEddy, GenEddyVisc, GenSGSStress, homogeneousDynSmagorinsky, kOmegaSSTSAS, laminar, incompressible::LESModel, locDynOneEqEddy, LRRDiffStress, mixedSmagorinsky, oneEqEddy, scaleSimilarity, Smagorinsky, Smagorinsky2, SpalartAllmaras, SpalartAllmarasIDDES, spectEddyVisc, kEpsilon, kOmega, kOmegaSST, LamBremhorstKE, laminar, LaunderGibsonRSTM, LaunderSharmaKE, LienCubicKE, LienCubicKELowRe, LienLeschzinerLowRe, LRR, NonlinearKEShih, qZeta, incompressible::RASModel, realizableKE, RNGkEpsilon, SpalartAllmaras, PDRkEpsilon, threePhaseMixture, Kunz, Merkle, phaseChangeTwoPhaseMixture, SchnerrSauer, and multiphaseMixture.
Definition at line 144 of file regIOobjectRead.C.
References Foam::type().
Referenced by IOPtrList< T >::IOPtrList(), incompressible::RASModel::read(), RASModel::read(), incompressible::LESModel::read(), LESModel::read(), singlePhaseTransportModel::read(), radiationModel::read(), basicThermo::read(), tolerances::read(), solution::read(), fvSchemes::read(), SRFModel::read(), and IObasicSourceList::read().
| bool modified | ( | ) | const [virtual]
|
Return true if the object's file has been modified.
Reimplemented in objectRegistry.
Definition at line 152 of file regIOobjectRead.C.
References Foam::lastModified().
| bool readIfModified | ( | ) | [virtual]
|
Read object if modified.
Reimplemented in objectRegistry.
Definition at line 162 of file regIOobjectRead.C.
References Foam::endl(), Foam::Info, Foam::lastModified(), Foam::name(), Foam::nl, Pstream::parRun(), Foam::reduce(), and WarningIn.
| virtual bool writeData | ( | Ostream & | ) | const [pure virtual]
|
Pure virtual writaData function.
Must be defined in derived types
Implemented in refinementHistory, polyTopoChanger, featureEdgeMesh, TimeActivatedExplicitSourceList< Type >, AverageIOField< Type >, IOPosition< ParticleType >, searchableBox, searchableCylinder, searchablePlane, searchablePlate, searchableSphere, searchableSurfaceCollection, searchableSurfaceWithGaps, triSurfaceMesh, topoSet, IOdictionary, IOField< Type >, IOList< T >, IOMap< T >, IOPtrList< T >, objectRegistry, DimensionedField< Type, GeoMesh >, GeometricField< Type, PatchField, GeoMesh >, UniformDimensionedField< Type >, MeshObject< Mesh, Type >, polyBoundaryMesh, polyBoundaryMeshEntries, ZoneMesh< ZoneType, MeshType >, surfZoneIOList, surfacePatchIOList, fieldDictionary, PDRDragModel, IOField< vector >, IOList< label >, IOList< reactingParcelInjectionData >, IOList< reactingMultiphaseParcelInjectionData >, IOList< face >, IOList< kinematicParcelInjectionData >, IOPtrList< coordinateSystem >, IOPtrList< injector >, IOPtrList< MRFZone >, IOPtrList< porousZone >, IOPtrList< TimeActivatedExplicitSource< Type > >, DimensionedField< tensor, volMesh >, DimensionedField< scalar, volMesh >, DimensionedField< vector, pointMesh >, DimensionedField< scalar, pointMesh >, DimensionedField< Type, volMesh >, DimensionedField< symmTensor, volMesh >, DimensionedField< scalar, surfaceMesh >, DimensionedField< vector, volMesh >, DimensionedField< Type, surfaceMesh >, DimensionedField< Type, pointMesh >, GeometricField< symmTensor, fvPatchField, volMesh >, GeometricField< tensor, fvPatchField, volMesh >, GeometricField< scalar, fvPatchField, volMesh >, GeometricField< scalar, fvsPatchField, surfaceMesh >, GeometricField< Type, fvsPatchField, surfaceMesh >, GeometricField< Type, pointPatchField, pointMesh >, GeometricField< scalar, pointPatchField, pointMesh >, GeometricField< vector, fvPatchField, volMesh >, GeometricField< vector, pointPatchField, pointMesh >, GeometricField< Type, fvPatchField, volMesh >, MeshObject< polyMesh, pointMesh >, MeshObject< fvMesh, UpwindFitData< Polynomial > >, MeshObject< fvMesh, CentredFitData< Polynomial > >, MeshObject< fvMesh, skewCorrectionVectors >, MeshObject< fvMesh, centredFECCellToFaceStencilObject >, MeshObject< fvMesh, quadraticFitSnGradData >, MeshObject< fvMesh, centredCFCFaceToCellStencilObject >, MeshObject< fvMesh, upwindFECCellToFaceStencilObject >, MeshObject< fvMesh, pureUpwindCFCCellToFaceStencilObject >, MeshObject< fvMesh, upwindCPCCellToFaceStencilObject >, MeshObject< fvMesh, upwindCECCellToFaceStencilObject >, MeshObject< fvMesh, centredCPCCellToFaceStencilObject >, MeshObject< fvMesh, upwindCFCCellToFaceStencilObject >, MeshObject< fvMesh, leastSquaresVectors >, MeshObject< fvMesh, centredCFCCellToFaceStencilObject >, MeshObject< fvMesh, centredCECCellToFaceStencilObject >, MeshObject< fvMesh, extendedLeastSquaresVectors >, MeshObject< fvMesh, FitDataType >, MeshObject< fvMesh, volPointInterpolation >, MeshObject< lduMesh, GAMGAgglomeration >, ZoneMesh< faceZone, polyMesh >, ZoneMesh< pointZone, polyMesh >, and ZoneMesh< cellZone, polyMesh >.
Referenced by searchableSurfaceWithGaps::writeData().
| bool writeObject | ( | IOstream::streamFormat | fmt, |
| IOstream::versionNumber | ver, | ||
| IOstream::compressionType | cmp | ||
| ) | const [virtual]
|
Write using given format, version and compression.
Reimplemented in dynamicRefineFvMesh, Cloud< ParticleType >, distributedTriSurfaceMesh, triSurfaceMesh, cellZoneSet, faceZoneSet, pointZoneSet, objectRegistry, Time, polyBoundaryMesh, Cloud< BasicReactingMultiphaseParcel< ThermoType > >, Cloud< basicThermoParcel >, Cloud< indexedParticle >, Cloud< trackedParticle >, Cloud< ParcelType >, Cloud< parcel >, Cloud< basicKinematicParcel >, Cloud< solidParticle >, Cloud< CoalParcel< ThermoType > >, Cloud< molecule >, Cloud< passiveParticle >, Cloud< dsmcParcel >, and Cloud< BasicReactingParcel< ThermoType > >.
Definition at line 37 of file regIOobjectWrite.C.
References Foam::endl(), IOstream::good(), Foam::Info, IOobject::instance(), Foam::lastModified(), Foam::mkDir(), name(), SeriousErrorIn, Foam::system(), and timeName.
Referenced by globalMeshData::write(), regIOobject::write(), polyBoundaryMesh::writeObject(), pointZoneSet::writeObject(), faceZoneSet::writeObject(), and cellZoneSet::writeObject().
| bool write | ( | ) | const [virtual]
|
Write using setting from DB.
Reimplemented in fvMesh, IOPosition< ParticleType >, and IOdictionary.
Definition at line 126 of file regIOobjectWrite.C.
References IOstream::currentVersion, IOobject::time(), and regIOobject::writeObject().
Referenced by autoLayerDriver::addLayers(), meshRefinement::baffleAndSplitMesh(), hexRef8::consistentSlowRefinement2(), meshRefinement::dumpRefinementLevel(), meshRefinement::getDuplicateFaces(), Foam::MapConsistentVolFields(), Foam::MapLagrangianFields(), Foam::MapVolFields(), polyMesh::polyMesh(), quadraticFitSnGradData::quadraticFitSnGradData(), autoSnapDriver::scaleMesh(), removeFaces::setRefinement(), hexRef8::setUnrefinement(), autoSnapDriver::smoothDisplacement(), staticPressure::write(), dsmcFields::write(), writeRegisteredObject::write(), IOdictionary::write(), fvMesh::write(), meshRefinement::write(), components::writeComponentFields(), div::writeDivField(), molecule::writeFields(), ThermoParcel< ParcelType >::writeFields(), KinematicParcel< ParcelType >::writeFields(), parcel::writeFields(), Particle< ParticleType >::writeFields(), mag::writeMagField(), magGrad::writeMagGradField(), magSqr::writeMagSqrField(), pointZoneSet::writeObject(), faceZoneSet::writeObject(), cellZoneSet::writeObject(), dynamicRefineFvMesh::writeObject(), faceSource::writeValues(), and cellSource::writeValues().
| void operator= | ( | const IOobject & | io ) |
Reimplemented from IOobject.
Definition at line 277 of file regIOobject.C.
References IOobject::operator=().
int fileModificationSkew [static]
|
Definition at line 96 of file regIOobject.H.
