Registry of regIOobjects. More...
#include <OpenFOAM/objectRegistry.H>
Registry of regIOobjects.
Definition at line 50 of file objectRegistry.H.
Inheritance diagram for objectRegistry: Collaboration diagram for objectRegistry:Public Member Functions | |
| TypeName ("objectRegistry") | |
| Declare type name for this IOobject.
| |
| objectRegistry (const Time &db, const label nIoObjects=128) | |
| Construct the time objectRegistry given an initial estimate.
| |
| objectRegistry (const IOobject &io, const label nIoObjects=128) | |
| Construct a sub-registry given an IObject to describe the registry.
| |
| virtual | ~objectRegistry () |
| const Time & | time () const |
| Return time.
| |
| const objectRegistry & | parent () const |
| Return the parent objectRegistry.
| |
| virtual const fileName & | dbDir () const |
| Local directory path of this objectRegistry relative to the time.
| |
| wordList | names () const |
| Return the list of names of the IOobjects.
| |
| wordList | names (const word &className) const |
| Return the list of names of the IOobjects of given class name.
| |
| template<class Type > | |
| wordList | names () const |
| Return the list of names of the IOobjects of given type.
| |
| const objectRegistry & | subRegistry (const word &name) const |
| Lookup and return a const sub-objectRegistry.
| |
| template<class Type > | |
| HashTable< const Type * > | lookupClass () const |
| Lookup and return all the object of the given Type.
| |
| template<class Type > | |
| bool | foundObject (const word &name) const |
| Is the named Type.
| |
| template<class Type > | |
| const Type & | lookupObject (const word &name) const |
| Lookup and return the object of the given Type.
| |
| label | getEvent () const |
| Return new event number.
| |
| virtual void | rename (const word &newName) |
| Rename.
| |
| bool | checkIn (regIOobject &) const |
| Add an regIOobject to registry.
| |
| bool | checkOut (regIOobject &) const |
| Remove an regIOobject from registry.
| |
| virtual bool | modified () const |
| Return true if any of the object's files have been modified.
| |
| void | readModifiedObjects () |
| Read the objects that have been modified.
| |
| virtual bool | readIfModified () |
| Read object if modified.
| |
| virtual bool | writeData (Ostream &) const |
| writeData function required by regIOobject but not used
| |
| virtual bool | writeObject (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType cmp) const |
| Write the objects.
| |
| objectRegistry | ( | const Time & | db, |
| const label | nIoObjects = 128
|
||
| ) | [explicit]
|
Construct the time objectRegistry given an initial estimate.
for the number of entries
Definition at line 37 of file objectRegistry.C.
| objectRegistry | ( | const IOobject & | io, |
| const label | nIoObjects = 128
|
||
| ) | [explicit]
|
Construct a sub-registry given an IObject to describe the registry.
and an initial estimate for the number of entries
Definition at line 64 of file objectRegistry.C.
| ~objectRegistry | ( | ) | [virtual]
|
Definition at line 82 of file objectRegistry.C.
References HashTable< regIOobject * >::begin(), regIOobject::checkOut(), HashTable< regIOobject * >::end(), HashTable< regIOobject * >::iterator, and HashTable< regIOobject * >::size().
| TypeName | ( | "objectRegistry" | ) |
Declare type name for this IOobject.
| const Time& time | ( | ) | const [inline]
|
Return time.
Reimplemented from IOobject.
Reimplemented in fvMesh.
Definition at line 114 of file objectRegistry.H.
Referenced by fieldMinMax::calcMinMaxFields(), fieldAverage::calculateMeanFields(), errorDrivenRefinement::changeTopology(), displacementFvMotionSolver::displacementFvMotionSolver(), displacementInterpolationFvMotionSolver::displacementInterpolationFvMotionSolver(), spray::inject(), IOobjectList::IOobjectList(), meshRefinement::makeDisplacementField(), solidParticle::move(), molecule::move(), KinematicParcel< ParcelType >::move(), DsmcParcel< ParcelType >::move(), trackedParticle::move(), motionSolver::New(), polyMesh::polyMesh(), Foam::polyMeshZipUpCells(), directMappedPatchBase::sampleMesh(), triSurfaceMesh::setField(), errorDrivenRefinement::setRefinement(), IOobject::time(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), surfaceDisplacementPointPatchVectorField::updateCoeffs(), oscillatingVelocityPointPatchVectorField::updateCoeffs(), oscillatingDisplacementPointPatchVectorField::updateCoeffs(), angularOscillatingVelocityPointPatchVectorField::updateCoeffs(), angularOscillatingDisplacementPointPatchVectorField::updateCoeffs(), polyMesh::updateMesh(), and molecule::writeFields().
| const objectRegistry& parent | ( | ) | const [inline]
|
Return the parent objectRegistry.
Definition at line 120 of file objectRegistry.H.
| virtual const fileName& dbDir | ( | ) | const [inline, virtual]
|
Local directory path of this objectRegistry relative to the time.
Reimplemented in Time, and polyMesh.
Definition at line 126 of file objectRegistry.H.
Referenced by polyMesh::dbDir(), IOobjectList::IOobjectList(), and surfMesh::surfMesh().
| Foam::wordList names | ( | ) | const |
Return the list of names of the IOobjects.
Definition at line 104 of file objectRegistry.C.
| Foam::wordList names | ( | const word & | className ) | const |
Return the list of names of the IOobjects of given class name.
Definition at line 118 of file objectRegistry.C.
References ClassName, and List< T >::setSize().
| wordList names | ( | ) | const |
Return the list of names of the IOobjects of given type.
| const Foam::objectRegistry & subRegistry | ( | const word & | name ) | const |
Lookup and return a const sub-objectRegistry.
Definition at line 138 of file objectRegistry.C.
References Foam::name().
| Foam::HashTable< const Type * > lookupClass | ( | ) | const |
Lookup and return all the object of the given Type.
Definition at line 54 of file objectRegistryTemplates.C.
References HashTable< T, Key, Hash >::insert(), and Foam::name().
Referenced by Foam::mapClouds().
| bool foundObject | ( | const word & | name ) | const |
Is the named Type.
Definition at line 75 of file objectRegistryTemplates.C.
References Foam::name().
Referenced by fieldMinMax::calcMinMaxFields(), errorDrivenRefinement::changeTopology(), forces::devRhoReff(), greyMeanAbsorptionEmission::greyMeanAbsorptionEmission(), MeshObjectMovePoints(), layeredEngineMesh::move(), fvMotionSolverEngineMesh::move(), GAMGAgglomeration::New(), coordinateSystems::New(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), polyMesh::updateMesh(), faceSource::validField(), cellSource::validField(), and wideBandAbsorptionEmission::wideBandAbsorptionEmission().
| const Type & lookupObject | ( | const word & | name ) | const |
Lookup and return the object of the given Type.
Definition at line 107 of file objectRegistryTemplates.C.
References Foam::abort(), Foam::FatalError, FatalErrorIn, Foam::name(), and Foam::nl.
Referenced by fieldMinMax::calcMinMaxFields(), fieldAverage::calculateMeanFields(), motionDirectionalDiffusivity::correct(), forces::devRhoReff(), wideBandAbsorptionEmission::ECont(), greyMeanAbsorptionEmission::greyMeanAbsorptionEmission(), MeshObjectMovePoints(), solidParticleCloud::move(), layeredEngineMesh::move(), fvMotionSolverEngineMesh::move(), GAMGAgglomeration::New(), coordinateSystems::New(), directMappedPatchBase::sampleMesh(), searchableSurfaceCollection::searchableSurfaceCollection(), searchableSurfaceWithGaps::searchableSurfaceWithGaps(), errorDrivenRefinement::setRefinement(), omegaWallFunctionFvPatchScalarField::updateCoeffs(), epsilonWallFunctionFvPatchScalarField::updateCoeffs(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), directMappedVelocityFluxFixedValueFvPatchField::updateCoeffs(), directMappedFixedValueFvPatchField< Type >::updateCoeffs(), polyMesh::updateMesh(), and wideBandAbsorptionEmission::wideBandAbsorptionEmission().
| Foam::label getEvent | ( | ) | const |
Return new event number.
Definition at line 146 of file objectRegistry.C.
References Foam::endl(), regIOobject::eventNo(), Foam::Pout, and WarningIn.
| void rename | ( | const word & | newName ) | [virtual]
|
Rename.
Reimplemented from regIOobject.
Definition at line 248 of file objectRegistry.C.
References regIOobject::rename(), and string::replace().
| bool checkIn | ( | regIOobject & | io ) | const |
Add an regIOobject to registry.
Definition at line 182 of file objectRegistry.C.
References Foam::endl(), HashTable< T, Key, Hash >::insert(), IOobject::name(), Foam::name(), and Foam::Pout.
| bool checkOut | ( | regIOobject & | io ) | const |
Remove an regIOobject from registry.
Definition at line 195 of file objectRegistry.C.
References Foam::endl(), HashTable< T, Key, Hash >::erase(), HashTable< T, Key, Hash >::find(), Foam::name(), IOobject::name(), regIOobject::ownedByRegistry(), Foam::Pout, and WarningIn.
Referenced by fieldAverage::resetFields().
| bool modified | ( | ) | const [virtual]
|
Return true if any of the object's files have been modified.
Reimplemented from regIOobject.
Definition at line 266 of file objectRegistry.C.
Referenced by Time::readModifiedObjects().
| void readModifiedObjects | ( | ) |
Read the objects that have been modified.
Reimplemented in Time.
Definition at line 280 of file objectRegistry.C.
References Foam::endl(), Foam::name(), and Foam::Pout.
Referenced by Time::readModifiedObjects().
| bool readIfModified | ( | ) | [virtual]
|
Read object if modified.
Reimplemented from regIOobject.
Definition at line 297 of file objectRegistry.C.
| virtual bool writeData | ( | Ostream & | ) | const [inline, virtual]
|
writeData function required by regIOobject but not used
for this class, write is used instead
Implements regIOobject.
Reimplemented in triSurfaceMesh.
Definition at line 188 of file objectRegistry.H.
References notImplemented.
| bool writeObject | ( | IOstream::streamFormat | fmt, |
| IOstream::versionNumber | ver, | ||
| IOstream::compressionType | cmp | ||
| ) | const [virtual]
|
Write the objects.
Reimplemented from regIOobject.
Reimplemented in dynamicRefineFvMesh, Cloud< ParticleType >, distributedTriSurfaceMesh, triSurfaceMesh, Time, 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 305 of file objectRegistry.C.
References Foam::endl(), Foam::name(), and Foam::Pout.
Referenced by meshReader::writeMesh(), Time::writeObject(), and fvMesh::writeObjects().
