OpenFOAM logo
Open Source CFD Toolkit

regIOobject Class Reference

Inheritance diagram for regIOobject:

Inheritance graph
[legend]
Collaboration diagram for regIOobject:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TypeName ("regIOobject")
 Runtime type information.
 regIOobject (const IOobject &)
 Construct from IOobject.
 regIOobject (const regIOobject &)
 Construct as copy.
 regIOobject (const regIOobject &, bool registerCopy)
 Construct as copy, and transfering registry registration to copy.
virtual ~regIOobject ()
void checkIn ()
 Register object with registry.
void checkOut ()
 Check-out object from registry.
bool registries () const
 Is this object owned by the registry.
void transferToRegistry ()
 Transfer ownership of this object to it's registry.
virtual void rename (const word &newName)
 Rename.
IstreamreadStream (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 readIfModified ()
 Read object if modified.
virtual bool writeData (Ostream &) const =0
 Pure virtual writaData function.
virtual bool write (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType cmp) const
 Write using given format, version and compression.
bool write () const
 Write using setting from DB.
void operator= (const IOobject &)

Static Public Attributes

int fileModificationSkew

Constructor & Destructor Documentation

regIOobject const IOobject  ) 
 

Construct from IOobject.

regIOobject const regIOobject  ) 
 

Construct as copy.

regIOobject const regIOobject ,
bool  registerCopy
 

Construct as copy, and transfering registry registration to copy.

if registerCopy is true

virtual ~regIOobject  )  [virtual]
 


Member Function Documentation

void checkIn  ) 
 

Register object with registry.

void checkOut  ) 
 

Check-out object from registry.

void close  ) 
 

Close Istream.

void operator= const IOobject  ) 
 

Reimplemented from IOobject.

virtual bool read  )  [virtual]
 

Read object.

Reimplemented in Time, solution, tolerances, fvSchemes, singlePhaseTransportModel, transportModel, basicThermo, hThermo, hhuMixtureThermo, hMixtureThermo, kEpsilon, LamBremhorstKE, laminar, LaunderGibsonRSTM, LaunderSharmaKE, LienCubicKE, LienCubicKELowRe, LienLeschzinerLowRe, LRR, NonlinearKEShih, QZeta, realizableKE, RNGkEpsilon, SpalartAllmaras, turbulenceModel, kEpsilon, laminar, LaunderGibsonRSTM, LaunderSharmaKE, LRR, realizableKE, RNGkEpsilon, turbulenceModel, DeardorffDiffStress, dynMixedSmagorinsky, dynOneEqEddy, dynSmagorinsky, GenEddyVisc, GenSGSStress, laminar, LESmodel, locDynOneEqEddy, LRRDiffStress, mixedSmagorinsky, oneEqEddy, scaleSimilarity, Smagorinsky, Smagorinsky2, SpalartAllmaras, spectEddyVisc, DeardorffDiffStress, dynOneEqEddy, GenEddyVisc, GenSGSStress, LESmodel, lowReOneEqEddy, oneEqEddy, Smagorinsky, SpalartAllmaras, faSchemes, and engineTime.

virtual bool readData Istream  )  [virtual]
 

Virtual readData function.

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

Reimplemented in IOdictionary.

virtual bool readIfModified  )  [virtual]
 

Read object if modified.

Reimplemented in objectRegistry.

Istream& readStream const word  ) 
 

Return Istream and check object type against that given.

bool registries  )  const [inline]
 

Is this object owned by the registry.

Definition at line 134 of file regIOobject.H.

virtual void rename const word newName  )  [virtual]
 

Rename.

Reimplemented from IOobject.

void transferToRegistry  )  [inline]
 

Transfer ownership of this object to it's registry.

Definition at line 140 of file regIOobject.H.

TypeName "regIOobject"   ) 
 

Runtime type information.

bool write  )  const
 

Write using setting from DB.

Reimplemented in objectRegistry, Time, and fvMesh.

virtual bool write IOstream::streamFormat  fmt,
IOstream::versionNumber  ver,
IOstream::compressionType  cmp
const [virtual]
 

Write using given format, version and compression.

Reimplemented in objectRegistry, Time, polyBoundaryMesh, fvMesh, and faMesh.

virtual bool writeData Ostream  )  const [pure virtual]
 

Pure virtual writaData function.

Must be defined in derived types

Implemented in IOdictionary, IOField, IOList, IOPtrList, objectRegistry, DimensionedField, GeometricField, polyBoundaryMesh, polyBoundaryMeshEntries, ZoneMesh, faBoundaryMesh, polyTopoChanger, surfacePatchIOList, Cloud, topoSet, IOField< scalar >, IOField< vector >, IOList< label >, IOList< face >, IOPtrList< injector >, DimensionedField< Type >, GeometricField< vector, fvPatchField, surfaceMesh >, GeometricField< scalar, fvPatchField, surfaceMesh >, GeometricField< Type, tetPolyPatchField, tetPointMesh >, GeometricField< Type, faPatchField, areaMesh >, GeometricField< vector, PatchField, surfaceMesh >, GeometricField< vector, PatchField, volMesh >, GeometricField< vector, faPatchField, edgeMesh >, GeometricField< tensor, fvPatchField, volMesh >, GeometricField< scalar, fvPatchField, volMesh >, GeometricField< scalar, faPatchField, edgeMesh >, GeometricField< Type, faPatchField, edgeMesh >, GeometricField< vector, faPatchField, areaMesh >, GeometricField< Type, fvPatchField, surfaceMesh >, GeometricField< Type, pointPatchField, pointMesh >, GeometricField< scalar, pointPatchField, pointMesh >, GeometricField< vector, fvPatchField, volMesh >, GeometricField< vector, tetPolyPatchField, tetPointMesh >, GeometricField< scalar, tetPolyPatchField, elementMesh >, GeometricField< vector, pointPatchField, pointMesh >, GeometricField< scalar, faPatchField, areaMesh >, GeometricField< Type, fvPatchField, volMesh >, ZoneMesh< pointZone >, ZoneMesh< cellZone >, ZoneMesh< faceZone >, Cloud< indexedParticle >, Cloud< parcel >, and Cloud< passiveParticle >.


Member Data Documentation

int fileModificationSkew [static]
 

Definition at line 100 of file regIOobject.H.


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org