objectRegistry Class Reference

Registry of regIOobjects. More...

Inheritance diagram for objectRegistry:
Collaboration diagram for objectRegistry:

Public Member Functions

 TypeName ("objectRegistry")
 Declare type name for this IOobject. More...
 
 objectRegistry (const Time &db, const label nIoObjects=128)
 Construct the time objectRegistry given an initial estimate. More...
 
 objectRegistry (const IOobject &io, const label nIoObjects=128)
 Construct a sub-registry given an IObject to describe the registry. More...
 
 objectRegistry (objectRegistry &&)=default
 Move constructor. More...
 
 objectRegistry (const objectRegistry &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~objectRegistry ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistryparent () const
 Return the parent objectRegistry. More...
 
virtual const fileNamedbDir () const
 Local directory path of this objectRegistry relative to the time. More...
 
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local. More...
 
wordList toc (const word &className) const
 Return the list of names of IOobjects of given class name. More...
 
wordList sortedToc (const word &className) const
 Return the sorted list of names of IOobjects of given class name. More...
 
template<class Type >
wordList toc () const
 Return the list of names of the IOobjects of given type. More...
 
template<class Type >
wordList toc (const wordRe &name) const
 Return the list of objects whose name matches the input regExp. More...
 
template<class Type >
wordList toc (const wordReList &name) const
 Return the list of objects whose name matches the input regExp. More...
 
const objectRegistrysubRegistry (const word &name, const bool forceCreate=false) const
 Lookup and return a const sub-objectRegistry. Optionally create. More...
 
template<class Type >
HashTable< const Type * > lookupClass (const bool strict=false) const
 Lookup and return all objects of the given Type. More...
 
template<class Type >
HashTable< Type * > lookupClass (const bool strict=false)
 Lookup and return all objects of the given Type. More...
 
template<class Type >
bool foundObject (const word &name) const
 Is the named Type in registry. More...
 
template<class Type >
const Type & lookupObject (const word &name) const
 Lookup and return the object of the given Type and name. More...
 
template<class Type >
Type & lookupObjectRef (const word &name) const
 Lookup and return the object reference of the given Type. More...
 
template<class Type >
bool foundType (const word &group=word::null) const
 Is the Type in registry. More...
 
template<class Type >
const Type & lookupType (const word &group=word::null) const
 Lookup and return the object of the given Type. More...
 
label getEvent () const
 Return new event number. More...
 
const objectRegistrythisDb () const
 Return the object registry. More...
 
virtual void rename (const word &newName)
 Rename. More...
 
bool checkIn (regIOobject &) const
 Add an regIOobject to registry. More...
 
bool checkOut (regIOobject &) const
 Remove an regIOobject from registry. More...
 
void clear ()
 Remove all regIOobject owned by the registry. More...
 
void addTemporaryObject (const word &name) const
 Add the given name to the set of temporary objects to cache. More...
 
bool cacheTemporaryObject (const word &name) const
 Return true if given name is in the cacheTemporaryObjects set. More...
 
template<class Object >
bool cacheTemporaryObject (Object &ob) const
 Cache the given object. More...
 
void resetCacheTemporaryObject (const regIOobject &ob) const
 Reset the cache state of the given object. More...
 
bool checkCacheTemporaryObjects () const
 Check that all objects in the cacheTemporaryObjects set. More...
 
virtual bool modified () const
 Return true if any of the object's files have been modified. More...
 
virtual bool dependenciesModified () const
 Cache pointers to objects who's dependencies have been modified. More...
 
virtual bool readIfModified ()
 Read object if modified. More...
 
virtual bool read ()
 Read dependent objects. More...
 
void readModifiedObjects ()
 Read the objects that have been modified. More...
 
void printToc (Ostream &os) const
 Print the list of object names and their type. More...
 
virtual bool writeData (Ostream &) const
 writeData function required by regIOobject but not used More...
 
virtual bool writeObject (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType cmp, const bool write) const
 Write the objects. More...
 
void operator= (const objectRegistry &)=delete
 Disallow default bitwise assignment. More...
 
template<class Type >
Foam::wordList toc () const
 
template<class Type >
Foam::wordList toc (const wordRe &name) const
 
template<class Type >
Foam::wordList toc (const wordReList &patterns) const
 
template<class Type >
Foam::HashTable< const Type * > lookupClass (const bool strict) const
 
template<class Type >
Foam::HashTable< Type * > lookupClass (const bool strict)
 
fileName path () const
 Return complete path. More...
 
- Public Member Functions inherited from regIOobject
 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...
 
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...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. 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)
 
- Public Member Functions inherited from HashTable< regIOobject * >
bool set (const word &, const regIOobject * &newElmt)
 Set a new hashedEntry, overwriting existing entries. More...
 
void set (const HashTable< regIOobject *, word, string::hash > &)
 Insert all the entries from the given HashTable,. More...
 
 HashTable (const label size=128)
 Construct given initial table size. More...
 
 HashTable (Istream &, const label size=128)
 Construct from Istream. More...
 
 HashTable (const UList< word > &keyList, const UList< regIOobject * > &elmtList)
 Construct from a list of keys and list of elements. More...
 
 HashTable (const HashTable< regIOobject *, word, string::hash > &)
 Copy constructor. More...
 
 HashTable (HashTable< regIOobject *, word, string::hash > &&)
 Move constructor. More...
 
 HashTable (std::initializer_list< Tuple2< word, regIOobject * >>)
 Construct from an initialiser list. More...
 
 ~HashTable ()
 Destructor. More...
 
label capacity () const
 The size of the underlying table. More...
 
label size () const
 Return number of elements in table. More...
 
bool empty () const
 Return true if the hash table is empty. More...
 
bool found (const word &) const
 Return true if hashedEntry is found in table. More...
 
iterator find (const word &)
 Find and return an iterator set at the hashedEntry. More...
 
const_iterator find (const word &) const
 Find and return an const_iterator set at the hashedEntry. More...
 
List< wordtoc () const
 Return the table of contents. More...
 
List< wordsortedToc () const
 Return the table of contents as a sorted list. More...
 
List< const_iteratorsorted () const
 Return a sorted list of constant iterators. More...
 
OstreamprintInfo (Ostream &) const
 Print information. More...
 
bool insert (const word &, const regIOobject * &newElmt)
 Insert a new hashedEntry. More...
 
void insert (const HashTable< regIOobject *, word, string::hash > &)
 Insert all the entries from the given HashTable. More...
 
bool erase (const iterator &)
 Erase a hashedEntry specified by given iterator. More...
 
bool erase (const word &)
 Erase a hashedEntry specified by the given key. More...
 
label erase (const UList< word > &)
 Remove entries given by the listed keys from this HashTable. More...
 
label erase (const HashTable< AnyType, word, AnyHash > &)
 Remove entries given by the given keys from this HashTable. More...
 
Foam::label erase (const HashTable< AnyType, word, AnyHash > &rhs)
 
void resize (const label newSize)
 Resize the hash table for efficiency. More...
 
void clear ()
 Clear all entries from table. More...
 
void clearStorage ()
 Clear the table entries and the table itself. More...
 
void shrink ()
 Shrink the allocated table to approx. twice number of elements. More...
 
void transfer (HashTable< regIOobject *, word, string::hash > &)
 Transfer the contents of the argument table into this table. More...
 
regIOobject * & operator[] (const word &)
 Find and return a hashedEntry. More...
 
const regIOobject * & operator[] (const word &) const
 Find and return a hashedEntry. More...
 
regIOobject * & operator() (const word &)
 Find and return a hashedEntry, create it null if not present. More...
 
void operator= (const HashTable< regIOobject *, word, string::hash > &)
 Assignment operator. More...
 
void operator= (HashTable< regIOobject *, word, string::hash > &&)
 Move assignment operator. More...
 
void operator= (std::initializer_list< Tuple2< word, regIOobject * >>)
 Assignment to an initialiser list. More...
 
bool operator== (const HashTable< regIOobject *, word, string::hash > &) const
 Equality. Hash tables are equal if the keys and values are equal. More...
 
bool operator!= (const HashTable< regIOobject *, word, string::hash > &) const
 The opposite of the equality operation. Takes linear time. More...
 
iterator begin ()
 Iterator set to the beginning of the HashTable. More...
 
const_iterator begin () const
 const_iterator set to the beginning of the HashTable More...
 
const_iterator cbegin () const
 const_iterator set to the beginning of the HashTable More...
 
- Public Member Functions inherited from HashTableCore
 HashTableCore ()
 Construct null. More...
 
 ClassName ("HashTable")
 Define template name and debug. 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...
 
- Public Types inherited from HashTable< regIOobject * >
typedef regIOobjectvalue_type
 Type of values the HashTable contains. More...
 
typedef regIOobject * & reference
 Type that can be used for storing into HashTable::value_type. More...
 
typedef const regIOobject * & const_reference
 Type that can be used for storing into constant. More...
 
typedef label size_type
 The type that can represent the size of a HashTable. More...
 
- Static Public Member Functions inherited from regIOobject
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 Member Functions inherited from HashTableCore
static label canonicalSize (const label)
 Return a canonical (power-of-two) size. More...
 
static iteratorEnd cend ()
 iteratorEnd set to beyond the end of any HashTable More...
 
static iteratorEnd end ()
 iteratorEnd set to beyond the end of any HashTable More...
 
- Static Public Attributes inherited from regIOobject
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...
 
- Static Public Attributes inherited from HashTableCore
static const label maxTableSize
 Maximum allowable table size. More...
 
- Protected Member Functions inherited from regIOobject
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...
 

Detailed Description

Registry of regIOobjects.

Source files

Definition at line 52 of file objectRegistry.H.

Constructor & Destructor Documentation

◆ objectRegistry() [1/4]

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 97 of file objectRegistry.C.

◆ objectRegistry() [2/4]

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 125 of file objectRegistry.C.

References IOobject::AUTO_WRITE, and IOobject::writeOpt().

Here is the call graph for this function:

◆ objectRegistry() [3/4]

objectRegistry ( objectRegistry &&  )
default

Move constructor.

◆ objectRegistry() [4/4]

objectRegistry ( const objectRegistry )
delete

Disallow default bitwise copy construction.

◆ ~objectRegistry()

~objectRegistry ( )
virtual

Destructor.

Definition at line 145 of file objectRegistry.C.

References clear().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "objectRegistry"  )

Declare type name for this IOobject.

◆ time()

const Time& time ( ) const
inline

Return time.

Definition at line 138 of file objectRegistry.H.

Referenced by Flux< CloudType, Derived >::accumulate(), Residuals< Type >::append(), SprayParcel< ParcelType >::calcAtomisation(), Foam::meshCheck::checkGeometry(), Foam::meshCheck::checkMeshOutputDir(), Foam::meshCheck::checkTopology(), componentDisplacementMotionSolver::componentDisplacementMotionSolver(), logFiles::createFiles(), CrankNicolsonDdtScheme< Type >::ddt0_(), cellsToCells::distributeMesh(), PairSpringSliderDashpot< CloudType >::evaluatePair(), triSurfaceMesh::extractCloseness(), triSurfaceMesh::extractPointCloseness(), tetIndices::faceTriIs(), physicalProperties::findModelDict(), coupleGroupIdentifier::findOtherPatchID(), mappedPatchBaseBase::haveNbr(), DSMCParcel< ParcelType >::hitWallPatch(), FreeStream< CloudType >::inflow(), InjectionModel< CloudType >::inject(), InjectionModel< CloudType >::InjectionModel(), meshReader::mesh(), molecule::move(), solidParticle::move(), DSMCParcel< ParcelType >::move(), multiSolidBodyMotionSolver::multiSolidBodyMotionSolver(), mappedInternalPatchBase::nbrMesh(), mappedPatchBaseBase::nbrMesh(), waveSuperposition::New(), points0MotionSolver::points0MotionSolver(), polyMesh::polyMesh(), Foam::polyMeshZipUpCells(), ReactingCloud< CloudType >::ReactingCloud(), InjectionModel< CloudType >::readDuration(), momentumTransportModel::readModelDict(), masterUncollatedFileOperation::readObjects(), uncollatedFileOperation::readObjects(), points0MotionSolver::readPoints0(), triSurfaceMesh::setField(), rigidBodyMeshMotion::solve(), rigidBodyMeshMotionSolver::solve(), sixDoFRigidBodyMotionSolver::solve(), Foam::systemDictIO(), ThermoCloud< CloudType >::ThermoCloud(), fvMesh::time(), IOobject::time(), meshToMesh::timeToNextMesh(), cellsToCells::trimLocalTgt(), uniformFixedValuePointPatchField< Type >::uniformFixedValuePointPatchField(), meshToMesh::update(), MPPICParcel< ParcelType >::trackingData::updateAverages(), angularOscillatingDisplacementPointPatchVectorField::updateCoeffs(), angularOscillatingVelocityPointPatchVectorField::updateCoeffs(), oscillatingDisplacementPointPatchVectorField::updateCoeffs(), oscillatingVelocityPointPatchVectorField::updateCoeffs(), surfaceDisplacementPointPatchVectorField::updateCoeffs(), waveDisplacementPointPatchVectorField::updateCoeffs(), waveSuperposition::waveSuperposition(), molecule::writeFields(), and Foam::zeroDimensionalFvMesh().

Here is the caller graph for this function:

◆ parent()

const objectRegistry& parent ( ) const
inline

Return the parent objectRegistry.

Definition at line 144 of file objectRegistry.H.

◆ dbDir()

virtual const fileName& dbDir ( ) const
inlinevirtual

Local directory path of this objectRegistry relative to the time.

Reimplemented in polyMesh, and Time.

Definition at line 150 of file objectRegistry.H.

Referenced by polyMesh::dbDir(), masterUncollatedFileOperation::filePathInfo(), fileOperation::processorsPath(), masterUncollatedFileOperation::relativeObjectPath(), surfMesh::surfMesh(), and IOobject::writeHeader().

Here is the caller graph for this function:

◆ path() [1/2]

Foam::fileName path ( const word instance,
const fileName local = "" 
) const

Return complete path with alternative instance and local.

Definition at line 154 of file objectRegistry.C.

Referenced by fileOperation::readObjects(), and motionSmootherAlgo::setDisplacement().

Here is the caller graph for this function:

◆ toc() [1/7]

Foam::wordList toc ( const word className) const

Return the list of names of IOobjects of given class name.

Definition at line 165 of file objectRegistry.C.

References ClassName, Foam::count(), and List< T >::setSize().

Referenced by dynamicMeshPointInterpolator::curPointField(), and vtkUnstructuredReader::printFieldStats().

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

◆ sortedToc()

Foam::wordList sortedToc ( const word className) const

Return the sorted list of names of IOobjects of given class name.

Definition at line 184 of file objectRegistry.C.

References ClassName, and Foam::sort().

Referenced by DispersionRASModel< CloudType >::epsilonModel(), and DispersionRASModel< CloudType >::kModel().

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

◆ toc() [2/7]

wordList toc ( ) const

Return the list of names of the IOobjects of given type.

◆ toc() [3/7]

wordList toc ( const wordRe name) const

Return the list of objects whose name matches the input regExp.

◆ toc() [4/7]

wordList toc ( const wordReList name) const

Return the list of objects whose name matches the input regExp.

◆ subRegistry()

const Foam::objectRegistry & subRegistry ( const word name,
const bool  forceCreate = false 
) const

Lookup and return a const sub-objectRegistry. Optionally create.

it if it does not exist.

Definition at line 193 of file objectRegistry.C.

References Foam::name(), IOobject::NO_READ, IOobject::NO_WRITE, and regIOobject::store().

Referenced by dynamicMeshPointInterpolator::curPointField().

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

◆ lookupClass() [1/4]

◆ lookupClass() [2/4]

HashTable<Type*> lookupClass ( const bool  strict = false)

Lookup and return all objects of the given Type.

◆ foundObject()

◆ lookupObject()

const Type & lookupObject ( const word name) const

Lookup and return the object of the given Type and name.

Definition at line 165 of file objectRegistryTemplates.C.

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

Referenced by refinementHistoryConstraint::add(), refinementHistoryConstraint::apply(), Relaxation< CloudType >::cacheFields(), Explicit< CloudType >::cacheFields(), Implicit< CloudType >::cacheFields(), Stochastic< CloudType >::calculate(), Cole::calculate(), KocamustafaogullariIshiiDepartureFrequency::calculate(), KocamustafaogullariIshiiDepartureDiameter::calculate(), XiEqModel::calculateSchelkinEffect(), dispersedTurbulentDispersionModel::continuousTurbulence(), PDRkEpsilon::correct(), VoFFilmTransfer::correct(), transport::correct(), gravitational::cosTheta(), basicSubGrid::Db(), instabilityG::Db(), basic::Dcu(), filmFvPatch::deltaCoeffs(), radiationCoupledBase::emissivity(), IATEsource::Eo(), PatchFlowRateInjection< CloudType >::flowRate(), basicSubGrid::G(), coupledMultiphaseTemperatureFvPatchScalarField::getNbr(), coupledMultiphaseTemperatureFvPatchScalarField::getThis(), basic::Gk(), interfaceCompressionNew::interpolate(), interRegionPorosityForce::interRegionPorosityForce(), mixtureFraction::mixtureFraction(), IATEsource::Mo(), MRFPatchField::MRFzone(), mappedFvPatchBaseBase::nbrMesh(), interRegionModel::nbrMesh(), mappedInternalPatchBase::nbrMesh(), mappedPatchBaseBase::nbrMesh(), interRegionModel::nbrModel(), GAMGAgglomeration::New(), waveSuperposition::New(), massTransfer::otherField(), phaseChange::p(), velocityGroup::popBal(), LiaoBase::precompute(), ParticleTrap< CloudType >::preEvolve(), vtkUnstructuredReader::printFieldStats(), VTKsurfaceFormat< Face >::read(), sampledSets::sampleLocalType(), sampledSurfaces::sampleLocalType(), scalarTransport::scalarTransport(), searchableSurfaceCollection::searchableSurfaceCollection(), searchableSurfaceWithGaps::searchableSurfaceWithGaps(), MPLIC::surfaceAlpha(), specieTransferMassFractionFvPatchScalarField::thermo(), waveSuperposition::transformation(), IATEsource::Ur(), waveSuperposition::waveSuperposition(), cloudInfo::write(), and basicSubGrid::XiEq().

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

◆ lookupObjectRef()

◆ foundType()

bool foundType ( const word group = word::null) const

Is the Type in registry.

the name is derived from the type name and given group

Definition at line 227 of file objectRegistryTemplates.C.

References Foam::constant::atomic::group, and IOobject::groupName().

Referenced by DispersionRASModel< CloudType >::epsilonModel(), solutionControl::finalIteration(), and DispersionRASModel< CloudType >::kModel().

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

◆ lookupType()

const Type & lookupType ( const word group = word::null) const

Lookup and return the object of the given Type.

the name is derived from the type name and given group

Definition at line 234 of file objectRegistryTemplates.C.

References Foam::constant::atomic::group, and IOobject::groupName().

Referenced by DispersionRASModel< CloudType >::epsilonModel(), solutionControl::finalIteration(), DispersionRASModel< CloudType >::kModel(), filmSurfaceVelocityFvPatchVectorField::updateCoeffs(), fWallFunctionFvPatchScalarField::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), and v2WallFunctionFvPatchScalarField::updateCoeffs().

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

◆ getEvent()

Foam::label getEvent ( ) const

Return new event number.

Definition at line 218 of file objectRegistry.C.

References Foam::endl(), regIOobject::eventNo(), Foam::labelMax, Foam::nl, Foam::Pout, and WarningInFunction.

Here is the call graph for this function:

◆ thisDb()

const objectRegistry& thisDb ( ) const
inline

Return the object registry.

Definition at line 227 of file objectRegistry.H.

◆ rename()

void rename ( const word newName)
virtual

Rename.

Reimplemented from regIOobject.

Definition at line 463 of file objectRegistry.C.

References regIOobject::rename(), and string::replace().

Here is the call graph for this function:

◆ checkIn()

bool checkIn ( regIOobject io) const

Add an regIOobject to registry.

Definition at line 257 of file objectRegistry.C.

References HashTableCore::end(), Foam::endl(), HashTable< T, Key, Hash >::find(), HashTable< T, Key, Hash >::insert(), IOobject::name(), Foam::name(), and Foam::Pout.

Here is the call graph for this function:

◆ checkOut()

bool checkOut ( regIOobject io) const

Remove an regIOobject from registry.

Definition at line 299 of file objectRegistry.C.

References Foam::endl(), HashTable< T, Key, Hash >::erase(), HashTable< T, Key, Hash >::find(), IOobject::name(), Foam::name(), regIOobject::ownedByRegistry(), Foam::Pout, and WarningInFunction.

Here is the call graph for this function:

◆ clear()

void clear ( )

Remove all regIOobject owned by the registry.

Definition at line 353 of file objectRegistry.C.

◆ addTemporaryObject()

void addTemporaryObject ( const word name) const

Add the given name to the set of temporary objects to cache.

Definition at line 373 of file objectRegistry.C.

References Foam::name().

Here is the call graph for this function:

◆ cacheTemporaryObject() [1/2]

bool cacheTemporaryObject ( const word name) const

Return true if given name is in the cacheTemporaryObjects set.

Definition at line 385 of file objectRegistry.C.

References Foam::name().

Referenced by DimensionedField< Type, GeoMesh >::New().

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

◆ cacheTemporaryObject() [2/2]

bool cacheTemporaryObject ( Object &  ob) const

Cache the given object.

Definition at line 241 of file objectRegistryTemplates.C.

References HashTableCore::end(), Foam::endl(), Foam::first(), and Foam::Info.

Here is the call graph for this function:

◆ resetCacheTemporaryObject()

void resetCacheTemporaryObject ( const regIOobject ob) const

Reset the cache state of the given object.

in the cacheTemporaryObjects set

Definition at line 394 of file objectRegistry.C.

References HashTableCore::end(), and IOobject::name().

Here is the call graph for this function:

◆ checkCacheTemporaryObjects()

bool checkCacheTemporaryObjects ( ) const

Check that all objects in the cacheTemporaryObjects set.

were cached

Definition at line 416 of file objectRegistry.C.

References objectRegistry::checkCacheTemporaryObjects(), Foam::endl(), forAllConstIter, forAllIter, Foam::name(), Foam::nl, Foam::second(), and Foam::Warning.

Referenced by objectRegistry::checkCacheTemporaryObjects().

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

◆ modified()

bool modified ( ) const
virtual

Return true if any of the object's files have been modified.

Reimplemented from regIOobject.

Definition at line 481 of file objectRegistry.C.

References forAllConstIter.

◆ dependenciesModified()

bool dependenciesModified ( ) const
virtual

Cache pointers to objects who's dependencies have been modified.

Reimplemented from regIOobject.

Definition at line 495 of file objectRegistry.C.

References Foam::count(), and forAllConstIter.

Here is the call graph for this function:

◆ readIfModified()

bool readIfModified ( )
virtual

Read object if modified.

Reimplemented from regIOobject.

Definition at line 513 of file objectRegistry.C.

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

Here is the call graph for this function:

◆ read()

bool read ( )
virtual

Read dependent objects.

Reimplemented from regIOobject.

Definition at line 533 of file objectRegistry.C.

References forAll.

Referenced by objectRegistry::readModifiedObjects().

Here is the caller graph for this function:

◆ readModifiedObjects()

void readModifiedObjects ( )

Read the objects that have been modified.

Definition at line 546 of file objectRegistry.C.

References objectRegistry::read().

Referenced by Time::readModifiedObjects().

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

◆ printToc()

void printToc ( Ostream os) const

Print the list of object names and their type.

to the given stream

Definition at line 560 of file objectRegistry.C.

References Foam::endl(), forAll, Foam::setf(), Foam::setw(), and Foam::type().

Here is the call graph for this function:

◆ writeData()

virtual bool writeData ( Ostream ) const
inlinevirtual

writeData function required by regIOobject but not used

for this class, writeObject is used instead

Implements regIOobject.

Reimplemented in triSurfaceMesh.

Definition at line 292 of file objectRegistry.H.

◆ writeObject()

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

Write the objects.

Reimplemented from regIOobject.

Reimplemented in Time, distributedTriSurfaceMesh, polyMesh, triSurfaceMesh, Cloud< ParticleType >, Cloud< ParcelType >, Cloud< solidParticle >, Cloud< molecule >, Cloud< sampledSetParticle >, Cloud< streamlinesParticle >, Cloud< passiveParticle >, and fvMesh.

Definition at line 577 of file objectRegistry.C.

References Foam::endl(), forAllConstIter, Foam::name(), Foam::Pout, and Foam::vtkWriteOps::write().

Referenced by polyMesh::writeObject(), and Time::writeObject().

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

◆ operator=()

void operator= ( const objectRegistry )
delete

Disallow default bitwise assignment.

◆ toc() [5/7]

Foam::wordList toc ( ) const

Definition at line 32 of file objectRegistryTemplates.C.

References Foam::count(), forAllConstIter, List< T >::setSize(), and HashTable< regIOobject * >::size().

Here is the call graph for this function:

◆ toc() [6/7]

Foam::wordList toc ( const wordRe name) const

Definition at line 52 of file objectRegistryTemplates.C.

References Foam::count(), forAllConstIter, string::match(), Foam::name(), and List< T >::setSize().

Here is the call graph for this function:

◆ toc() [7/7]

Foam::wordList toc ( const wordReList patterns) const

Definition at line 77 of file objectRegistryTemplates.C.

References Foam::findStrings().

Here is the call graph for this function:

◆ lookupClass() [3/4]

Foam::HashTable<const Type*> lookupClass ( const bool  strict) const

Definition at line 86 of file objectRegistryTemplates.C.

References forAllConstIter, HashTable< T, Key, Hash >::insert(), and Foam::name().

Here is the call graph for this function:

◆ lookupClass() [4/4]

Foam::HashTable<Type*> lookupClass ( const bool  strict)

Definition at line 114 of file objectRegistryTemplates.C.

References forAllIter, HashTable< T, Key, Hash >::insert(), and Foam::name().

Here is the call graph for this function:

◆ path() [2/2]

Return complete path.

Definition at line 153 of file regIOobject.C.

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

Referenced by Time::writeObject().

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

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