Registry of regIOobjects. More...
Public Member Functions | |
TypeName ("objectRegistry") | |
Declare type name for this IOobject. More... | |
objectRegistry (const Time &db, const label nObjects=128) | |
Construct the time objectRegistry, with estimated table capacity (default: 128) More... | |
objectRegistry (const IOobject &io, const label nObjects=128) | |
Construct sub-registry given an IObject to describe the registry, with estimated table capacity (default: 128) More... | |
virtual | ~objectRegistry () |
Destructor, with checkOut() for all objects that are ownedByRegistry. More... | |
const objectRegistry & | thisDb () const noexcept |
Return the object registry. More... | |
const objectRegistry & | parent () const noexcept |
Return the parent objectRegistry. More... | |
const Time & | time () const noexcept |
Return time registry. More... | |
bool | isTimeDb () const noexcept |
True if the registry is Time. More... | |
virtual const fileName & | dbDir () const |
Local directory path of this objectRegistry relative to the time. More... | |
HashTable< wordHashSet > | classes () const |
A summary hash of classes used and their associated object names. More... | |
template<class MatchPredicate > | |
HashTable< wordHashSet > | classes (const MatchPredicate &matchName) const |
A summary hash of classes used and their associated object names, restricted to objects that have a matching object name. More... | |
UPtrList< const regIOobject > | csorted () const |
Return sorted list of objects. More... | |
UPtrList< const regIOobject > | sorted () const |
Return sorted list of objects. More... | |
UPtrList< regIOobject > | sorted () |
Return sorted list of objects. More... | |
template<class Type > | |
UPtrList< const Type > | csorted () const |
Return sorted list of objects with a class satisfying isA<Type> More... | |
template<class Type > | |
UPtrList< const Type > | sorted () const |
Return sorted list of objects with a class satisfying isA<Type> More... | |
template<class Type > | |
UPtrList< Type > | sorted () |
Return sorted list of objects with a class satisfying isA<Type> More... | |
template<class Type , class MatchPredicate > | |
UPtrList< const Type > | csorted (const MatchPredicate &matchName) const |
Return sorted list of objects with a class satisfying isA<Type> that also have a matching object name. More... | |
template<class Type , class MatchPredicate > | |
UPtrList< const Type > | sorted (const MatchPredicate &matchName) const |
Return sorted list of objects with a class satisfying isA<Type> that also have a matching object name. More... | |
template<class Type , class MatchPredicate > | |
UPtrList< Type > | sorted (const MatchPredicate &matchName) |
Return sorted list of objects with a class satisfying isA<Type> that also have a matching object name. More... | |
label | count (const char *clsName) const |
The number of objects of the given class name. More... | |
template<class MatchPredicate > | |
label | count (const MatchPredicate &matchClass) const |
The number of objects of the given class name. More... | |
template<class MatchPredicate1 , class MatchPredicate2 > | |
label | count (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
The number of objects of the given class name. More... | |
template<class Type > | |
label | count (const bool strict=false) const |
The names of objects with a class satisfying isA<Type> More... | |
template<class Type , class MatchPredicate > | |
label | count (const MatchPredicate &matchName) const |
The names of objects with a class satisfying isA<Type> that also have a matching object name. More... | |
wordList | names () const |
The unsorted names of all objects. More... | |
wordList | names (const char *clsName) const |
The unsorted names of objects with the given class name. More... | |
template<class MatchPredicate > | |
wordList | names (const MatchPredicate &matchClass) const |
The unsorted names of objects with a matching class name. More... | |
template<class MatchPredicate1 , class MatchPredicate2 > | |
wordList | names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
The unsorted names of objects with a matching class name that also have a matching object name. More... | |
template<class Type > | |
wordList | names () const |
The unsorted names of objects with a class satisfying isA<Type> . More... | |
template<class Type , class MatchPredicate > | |
wordList | names (const MatchPredicate &matchName) const |
The unsorted names of objects with a class satisfying isA<Type> that also have a matching object name. More... | |
wordList | sortedNames () const |
The sorted names of all objects. More... | |
wordList | sortedNames (const char *clsName) const |
The sorted names of objects with the given class name. More... | |
template<class MatchPredicate > | |
wordList | sortedNames (const MatchPredicate &matchClass) const |
The sorted names objects with a matching class name. More... | |
template<class MatchPredicate1 , class MatchPredicate2 > | |
wordList | sortedNames (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
The sorted names of objects with a matching class name that also have a matching object name. More... | |
template<class Type > | |
wordList | sortedNames () const |
The sorted names of objects with a class satisfying isA<Type> More... | |
template<class Type , class MatchPredicate > | |
wordList | sortedNames (const MatchPredicate &matchName) const |
The sorted names of objects with a class satisfying isA<Type> that also have a matching object name. More... | |
const objectRegistry & | subRegistry (const word &name, const bool forceCreate=false, const bool recursive=false) const |
Lookup and return a const sub-objectRegistry. More... | |
template<class Type > | |
HashTable< const Type * > | lookupClass (const bool strict=false) const |
Return all objects with a class satisfying isA<Type> More... | |
template<class Type > | |
HashTable< Type * > | lookupClass (const bool strict=false) |
Return all objects with a class satisfying isA<Type> More... | |
const regIOobject * | cfindIOobject (const word &name, const bool recursive=false) const |
Return const pointer to the regIOobject. More... | |
bool | found (const word &name, const bool recursive=false) const |
Can the regIOobject object be found (by name). More... | |
template<class Type > | |
bool | foundObject (const word &name, const bool recursive=false) const |
Is the named Type found? More... | |
template<class Type > | |
const Type * | cfindObject (const word &name, const bool recursive=false) const |
Return const pointer to the object of the given Type. More... | |
template<class Type > | |
const Type * | findObject (const word &name, const bool recursive=false) const |
Return const pointer to the object of the given Type. More... | |
template<class Type > | |
Type * | findObject (const word &name, const bool recursive=false) |
Return non-const pointer to the object of the given Type. More... | |
template<class Type > | |
Type * | getObjectPtr (const word &name, const bool recursive=false) const |
Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable. More... | |
template<class Type > | |
const Type & | lookupObject (const word &name, const bool recursive=false) const |
Lookup and return const reference to the object of the given Type. Fatal if not found or the wrong type. More... | |
template<class Type > | |
Type & | lookupObjectRef (const word &name, const bool recursive=false) const |
Lookup and return non-const reference to the object of the given Type. Fatal if not found or the wrong type. More... | |
label | getEvent () const |
Return new event number. More... | |
bool | checkIn (regIOobject *io) const |
Add a regIOobject to registry. A nullptr is ignored. More... | |
bool | checkIn (regIOobject &io) const |
Add a regIOobject to registry. More... | |
bool | checkOut (regIOobject *io) const |
Remove a regIOobject from registry and free memory if the object is ownedByRegistry. A nullptr is ignored. More... | |
bool | checkOut (regIOobject &io) const |
Remove a regIOobject from registry and free memory if the object is ownedByRegistry. More... | |
bool | checkOut (const word &key) const |
Remove a regIOobject by name from registry and free memory if the object is ownedByRegistry. More... | |
void | clear () |
Clear all entries from the registry. More... | |
void | clearStorage () |
Clear all entries from the registry and the table itself. More... | |
bool | erase (const iterator &iter) |
Erase an entry specified by the given iterator. More... | |
bool | erase (const word &key) |
Erase an entry specified by the given key. More... | |
label | erase (std::initializer_list< word > keys) |
Remove entries given by the listed keys. More... | |
label | erase (const UList< word > &keys) |
Remove entries given by the listed keys. More... | |
virtual void | rename (const word &newName) |
Rename. More... | |
virtual bool | modified () const |
Return true if any of the object's files have been modified. More... | |
void | readModifiedObjects () |
Read the objects that have been modified. More... | |
virtual bool | readIfModified () |
Read object if modified. More... | |
virtual bool | writeData (Ostream &) const |
writeData function required by regIOobject but not used. More... | |
virtual bool | writeObject (IOstreamOption streamOpt, const bool valid) const |
Write the objects using stream options. More... | |
template<class Type > | |
const Type * | lookupObjectPtr (const word &name, bool recursive=false) const |
Deprecated(2018-10) find object. More... | |
template<class Type > | |
Type * | lookupObjectRefPtr (const word &name, bool recursive=false) const |
Deprecated(2018-10) get object pointer, ignoring constness. More... | |
template<class MatchPredicate > | |
Foam::HashTable< Foam::wordHashSet > | classesImpl (const objectRegistry &list, const MatchPredicate &matchName) |
template<class MatchPredicate1 , class MatchPredicate2 > | |
Foam::label | countImpl (const objectRegistry &list, const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) |
template<class Type , class MatchPredicate > | |
Foam::label | countTypeImpl (const objectRegistry &list, const MatchPredicate &matchName) |
template<class MatchPredicate1 , class MatchPredicate2 > | |
Foam::wordList | namesImpl (const objectRegistry &list, const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName, const bool doSort) |
template<class Type , class MatchPredicate > | |
Foam::wordList | namesTypeImpl (const objectRegistry &list, const MatchPredicate &matchName, const bool doSort) |
template<class Type , class MatchPredicate > | |
Foam::UPtrList< Type > | objectsTypeImpl (const objectRegistry &list, const MatchPredicate &matchName) |
template<class MatchPredicate > | |
Foam::HashTable< Foam::wordHashSet > | classes (const MatchPredicate &matchName) const |
template<class MatchPredicate > | |
Foam::label | count (const MatchPredicate &matchClass) const |
template<class MatchPredicate1 , class MatchPredicate2 > | |
Foam::label | count (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
template<class Type , class MatchPredicate > | |
Foam::label | count (const MatchPredicate &matchName) const |
template<class Type > | |
Foam::label | count (const bool strict) const |
template<class Type > | |
Foam::UPtrList< const Type > | csorted () const |
template<class Type > | |
Foam::UPtrList< const Type > | sorted () const |
template<class Type > | |
Foam::UPtrList< Type > | sorted () |
template<class Type , class MatchPredicate > | |
Foam::UPtrList< const Type > | csorted (const MatchPredicate &matchName) const |
template<class Type , class MatchPredicate > | |
Foam::UPtrList< const Type > | sorted (const MatchPredicate &matchName) const |
template<class Type , class MatchPredicate > | |
Foam::UPtrList< Type > | sorted (const MatchPredicate &matchName) |
template<class MatchPredicate > | |
Foam::wordList | names (const MatchPredicate &matchClass) const |
template<class MatchPredicate1 , class MatchPredicate2 > | |
Foam::wordList | names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
template<class Type > | |
Foam::wordList | names () const |
template<class Type , class MatchPredicate > | |
Foam::wordList | names (const MatchPredicate &matchName) const |
template<class MatchPredicate > | |
Foam::wordList | sortedNames (const MatchPredicate &matchClass) const |
template<class MatchPredicate1 , class MatchPredicate2 > | |
Foam::wordList | sortedNames (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
template<class Type > | |
Foam::wordList | sortedNames () const |
template<class Type , class MatchPredicate > | |
Foam::wordList | sortedNames (const MatchPredicate &matchName) const |
template<class Type > | |
Foam::HashTable< const Type * > | lookupClass (const bool strict) const |
template<class Type > | |
Foam::HashTable< Type * > | lookupClass (const bool strict) |
Public Member Functions inherited from regIOobject | |
TypeName ("regIOobject") | |
Runtime type information. More... | |
regIOobject (const IOobject &io, const bool isTimeObject=false) | |
Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time). More... | |
regIOobject (const regIOobject &rio) | |
Copy construct. More... | |
regIOobject (const regIOobject &rio, bool registerCopy) | |
Copy construct, transferring registry registration to the copy if registerCopy is true. More... | |
regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
Copy construct with new name, transferring registry registration to the copy f registerCopy is true. More... | |
regIOobject (const IOobject &io, const regIOobject &rio) | |
Copy construct with new IO parameters. More... | |
virtual | ~regIOobject () |
Destructor. More... | |
bool | checkIn () |
Add object to registry, if not already registered. More... | |
bool | checkOut () |
Remove all file watches and remove object from registry. More... | |
virtual void | addWatch () |
Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
bool | registered () const noexcept |
Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference. More... | |
bool | ownedByRegistry () const noexcept |
Is this object owned by the registry? More... | |
bool | store () |
Register object with its registry and transfer ownership to the registry. More... | |
void | release (const bool unregister=false) noexcept |
Set object as not ownedByRegistry. More... | |
label | eventNo () const noexcept |
Event number at last update. More... | |
label & | eventNo () noexcept |
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 as up-to-date. More... | |
const dictionary * | findMetaData () const noexcept |
Return pointer to meta-data or nullptr. More... | |
dictionary & | getMetaData () noexcept |
Get or create meta-data. More... | |
void | removeMetaData () |
Remove meta-data. More... | |
virtual void | updateMetaData () |
Update internal meta-data (eg, prior to writing) More... | |
virtual fileName | filePath () const |
Return complete path + object name if the file exists. More... | |
bool | headerOk () |
Read and check header info. Does not check the headerClassName. More... | |
Istream & | readStream (const word &, const bool valid=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... | |
virtual label | addWatch (const fileName &) |
Add file watch for fileName on object if not yet watched. More... | |
const labelList & | watchIndices () const noexcept |
Read access to file-monitoring handles. More... | |
labelList & | watchIndices () noexcept |
Write access to file-monitoring handles. More... | |
virtual bool | write (const bool valid=true) const |
Write using setting from DB. More... | |
virtual bool | global () const |
Is object global. More... | |
void | operator= (const IOobject &io) |
Copy assignment. More... | |
virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool valid) const |
Write using given format, version and compression. More... | |
Public Member Functions inherited from IOobject | |
TypeName ("IOobject") | |
Declare type-name, virtual type (with debug switch) More... | |
IOobject (const IOobject &)=default | |
Copy construct. More... | |
virtual | ~IOobject ()=default |
Destructor. More... | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from name, instance, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from path, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from name, instance, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from path, registry, io options. More... | |
IOobject (const IOobject &io, const objectRegistry ®istry) | |
Copy construct, resetting registry. More... | |
IOobject (const IOobject &io, const word &name) | |
Copy construct, resetting name. More... | |
IOobject (const IOobject &io, const word &name, const fileName &local) | |
Copy construct, resetting name and local component. More... | |
IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt) | |
Copy construct, resetting read/write options. More... | |
autoPtr< IOobject > | clone () const |
Clone. More... | |
autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
Clone resetting registry. More... | |
const objectRegistry & | db () const noexcept |
Return the local objectRegistry. More... | |
const Time & | time () const |
Return Time associated with the objectRegistry. More... | |
const word & | name () const noexcept |
Return the object name. More... | |
const word & | headerClassName () const noexcept |
Return name of the class name read from header. More... | |
word & | headerClassName () noexcept |
Return non-constant access to the class name read from header. More... | |
const string & | note () const noexcept |
Return the optional note. More... | |
string & | note () noexcept |
Modifiable access to the optional note. More... | |
unsigned | labelByteSize () const noexcept |
The sizeof (label) in bytes, possibly read from the header. More... | |
unsigned | scalarByteSize () const noexcept |
The sizeof (scalar) in bytes, possibly read from the header. More... | |
bool | hasHeaderClass () const noexcept |
True if headerClassName() is non-empty (after reading) More... | |
template<class Type > | |
bool | isHeaderClass () const |
Check if headerClassName() equals Type::typeName. More... | |
template<class Type > | |
bool | isHeaderClassName () const |
Same as isHeaderClass() More... | |
word | group () const |
Return group (extension part of name) More... | |
word | member () const |
Return member (name without the extension) More... | |
const fileName & | rootPath () const |
Return the Time::rootPath() More... | |
const fileName & | caseName () const |
Return the Time::caseName() More... | |
const fileName & | instance () const noexcept |
Read access to instance path component. More... | |
fileName & | instance () noexcept |
Write access to instance path component. More... | |
const fileName & | local () const noexcept |
Read access to local path component. More... | |
fileName | path () const |
The complete path. More... | |
fileName | path (const word &instance, const fileName &local=fileName::null) const |
The complete path with alternative instance and local. More... | |
fileName | objectPath () const |
The complete path + object name. More... | |
fileName | objectRelPath () const |
The object path relative to the root. More... | |
fileName | localFilePath (const word &typeName, const bool search=true) const |
Redirect to fileHandler filePath, searching locally. More... | |
fileName | globalFilePath (const word &typeName, const bool search=true) const |
Redirect to fileHandler filePath, searching up if in parallel. More... | |
IOstreamOption | parseHeader (const dictionary &headerDict) |
Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. More... | |
bool | readHeader (Istream &is) |
Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. More... | |
bool | readHeader (dictionary &headerDict, Istream &is) |
Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. More... | |
template<class Type > | |
bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
Read header (uses typeFilePath to find file) and check its info. More... | |
template<class Type > | |
void | warnNoRereading () const |
Helper: warn that type does not support re-reading. More... | |
bool | writeHeader (Ostream &os) const |
Write header with current type() More... | |
bool | writeHeader (Ostream &os, const word &objectType) const |
Write header with override of type. More... | |
void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
Write header into a dictionary with current type() and given output format. More... | |
void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
Write header into a dictionary with override of type and given output format. More... | |
bool | good () const noexcept |
Did last readHeader() succeed? More... | |
bool | bad () const noexcept |
Did last readHeader() fail? More... | |
InfoProxy< IOobject > | info () const |
Return info proxy, for printing information to a stream. More... | |
void | operator= (const IOobject &io) |
Copy assignment, copies all values (except the registry) More... | |
template<> | |
bool | isHeaderClass () const |
Specialization for void always returns true (no headerClassName check). More... | |
template<class StringType > | |
Foam::word | groupName (StringType base, const word &group) |
Public Member Functions inherited from IOobjectOption | |
constexpr | IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Default construct (NO_READ, NO_WRITE, register, non-global) or construct with specified options. More... | |
constexpr | IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Construct NO_WRITE with specified read/register options. More... | |
constexpr | IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Construct NO_READ with specified write/register options. More... | |
constexpr | IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept |
Construct (NO_READ, NO_WRITE) with specified register option. More... | |
constexpr | IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept |
Construct from components with specified register option as bool. More... | |
constexpr | IOobjectOption (bool registerObject, bool globalObject=false) noexcept |
Construct (NO_READ, NO_WRITE) with specified register option as bool. More... | |
readOption | readOpt () const noexcept |
Get the read option. More... | |
readOption | readOpt (readOption opt) noexcept |
Set the read option. More... | |
writeOption | writeOpt () const noexcept |
Get the write option. More... | |
writeOption | writeOpt (writeOption opt) noexcept |
Set the write option. More... | |
bool | registerObject () const noexcept |
Should objects created with this IOobject be registered? More... | |
bool | registerObject (bool on) noexcept |
Change registration preference. More... | |
bool | globalObject () const noexcept |
True if object is treated the same for all processors. More... | |
bool | globalObject (bool on) noexcept |
Change global-object status. More... | |
bool | isReadRequired () const noexcept |
True if (MUST_READ | MUST_READ_IF_MODIFIED) bits are set. More... | |
bool | isReadOptional () const noexcept |
True if (READ_IF_PRESENT) bits are set. More... | |
readOption & | readOpt () noexcept |
Access to the read option. More... | |
writeOption & | writeOpt () noexcept |
Access to the write option. More... | |
bool & | registerObject () noexcept |
Access to the register object option. More... | |
bool & | globalObject () noexcept |
Access to the global object option. More... | |
Public Member Functions inherited from HashTable< regIOobject *> | |
HashTable () | |
Default construct with default (128) table capacity. More... | |
HashTable (const label size) | |
Construct given initial table capacity. More... | |
HashTable (Istream &is, const label size=128) | |
Construct from Istream with default table capacity. More... | |
HashTable (const this_type &ht) | |
Copy construct. More... | |
HashTable (this_type &&rhs) | |
Move construct. More... | |
HashTable (std::initializer_list< std::pair< word, regIOobject * >> list) | |
Construct from an initializer list. More... | |
~HashTable () | |
Destructor. More... | |
label | capacity () const noexcept |
The size of the underlying table. More... | |
label | size () const noexcept |
The number of elements in table. More... | |
bool | empty () const noexcept |
True if the hash table is empty. More... | |
regIOobject * & | at (const word &key) |
Find and return a hashed entry. FatalError if it does not exist. More... | |
const regIOobject * & | at (const word &key) const |
Find and return a hashed entry. FatalError if it does not exist. More... | |
bool | found (const word &key) const |
True if hashed key is found in table. More... | |
iterator | find (const word &key) |
Find and return an iterator set at the hashed entry. More... | |
const_iterator | find (const word &key) const |
Find and return an const_iterator set at the hashed entry. More... | |
const_iterator | cfind (const word &key) const |
Find and return an const_iterator set at the hashed entry. More... | |
const regIOobject * & | lookup (const word &key, const regIOobject * &deflt) const |
Return hashed entry if it exists, or return the given default. More... | |
List< word > | toc () const |
The table of contents (the keys) in unsorted order. More... | |
List< word > | sortedToc () const |
The table of contents (the keys) in sorted order. More... | |
List< word > | sortedToc (const Compare &comp) const |
The table of contents (the keys) sorted according to the specified comparator. More... | |
Foam::List< word > | sortedToc (const Compare &comp) const |
List< word > | tocKeys (const UnaryPredicate &pred, const bool invert=false) const |
The table of contents (the keys) selected according to the unary predicate applied to the keys. More... | |
Foam::List< word > | tocKeys (const UnaryPredicate &pred, const bool invert) const |
List< word > | tocValues (const UnaryPredicate &pred, const bool invert=false) const |
The table of contents (the keys) selected according to the unary predicate applied to the values. More... | |
Foam::List< word > | tocValues (const UnaryPredicate &pred, const bool invert) const |
List< word > | tocEntries (const BinaryPredicate &pred, const bool invert=false) const |
The table of contents (the keys) selected according to the binary predicate applied to the keys and values. More... | |
Foam::List< word > | tocEntries (const BinaryPredicate &pred, const bool invert) const |
UPtrList< const node_type > | csorted () const |
Const access to the hash-table contents in sorted order (sorted by keys). More... | |
UPtrList< const node_type > | sorted () const |
Const access to the hash-table contents in sorted order (sorted by keys). More... | |
UPtrList< node_type > | sorted () |
Non-const access to the hash-table contents in sorted order (sorted by keys). More... | |
label | countKeys (const UnaryPredicate &pred, const bool invert=false) const |
Count the number of keys that satisfy the unary predicate. More... | |
Foam::label | countKeys (const UnaryPredicate &pred, const bool invert) const |
label | countValues (const UnaryPredicate &pred, const bool invert=false) const |
Count the number of values that satisfy the unary predicate. More... | |
Foam::label | countValues (const UnaryPredicate &pred, const bool invert) const |
label | countEntries (const BinaryPredicate &pred, const bool invert=false) const |
Count the number of entries that satisfy the binary predicate. More... | |
Foam::label | countEntries (const BinaryPredicate &pred, const bool invert) const |
bool | emplace (const word &key, Args &&... args) |
Emplace insert a new entry, not overwriting existing entries. More... | |
bool | emplace_set (const word &key, Args &&... args) |
Emplace set an entry, overwriting any existing entries. More... | |
bool | insert (const word &key, const regIOobject * &obj) |
Copy insert a new entry, not overwriting existing entries. More... | |
bool | insert (const word &key, regIOobject * &&obj) |
Move insert a new entry, not overwriting existing entries. More... | |
bool | set (const word &key, const regIOobject * &obj) |
Copy assign a new entry, overwriting existing entries. More... | |
bool | set (const word &key, regIOobject * &&obj) |
Move assign a new entry, overwriting existing entries. More... | |
bool | erase (const iterator &iter) |
Erase an entry specified by given iterator. More... | |
bool | erase (const word &key) |
Erase an entry specified by the given key. More... | |
label | erase (const HashTable< AnyType, word, AnyHash > &other) |
Remove table entries given by keys of the other hash-table. More... | |
label | erase (std::initializer_list< word > keys) |
Remove table entries given by the listed keys. More... | |
label | erase (InputIter first, InputIter last) |
Remove multiple entries using an iterator range of keys. More... | |
label | erase (const FixedList< word, N > &keys) |
Remove table entries given by the listed keys. More... | |
label | erase (const UList< word > &keys) |
Remove table entries given by the listed keys. More... | |
Foam::label | erase (InputIter first, InputIter last) |
Foam::label | erase (const FixedList< word, N > &keys) |
Foam::label | erase (const HashTable< AnyType, word, AnyHash > &other) |
label | retain (const HashTable< AnyType, word, AnyHash > &other) |
Retain table entries given by keys of the other hash-table. More... | |
Foam::label | retain (const HashTable< AnyType, word, AnyHash > &other) |
label | filterKeys (const UnaryPredicate &pred, const bool pruning=false) |
Generalized means to filter table entries based on their keys. More... | |
Foam::label | filterKeys (const UnaryPredicate &pred, const bool pruning) |
label | filterValues (const UnaryPredicate &pred, const bool pruning=false) |
Generalized means to filter table entries based on their values. More... | |
Foam::label | filterValues (const UnaryPredicate &pred, const bool pruning) |
label | filterEntries (const BinaryPredicate &pred, const bool pruning=false) |
Generalized means to filter table entries based on their key/value. More... | |
Foam::label | filterEntries (const BinaryPredicate &pred, const bool pruning) |
void | resize (const label sz) |
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 | swap (HashTable< regIOobject *, word, Foam::Hash< word > > &rhs) |
Swap contents into this table. More... | |
void | transfer (HashTable< regIOobject *, word, Foam::Hash< word > > &rhs) |
Transfer contents into this table. More... | |
regIOobject * & | operator[] (const word &key) |
Find and return a hashed entry. FatalError if it does not exist. More... | |
const regIOobject * & | operator[] (const word &key) const |
Find and return a hashed entry. FatalError if it does not exist. More... | |
regIOobject * & | operator() (const word &key) |
Return existing entry or create a new entry. More... | |
regIOobject * & | operator() (const word &key, const regIOobject * &deflt) |
Return existing entry or insert a new entry. More... | |
void | operator= (const this_type &rhs) |
Copy assign. More... | |
void | operator= (std::initializer_list< std::pair< word, regIOobject * >> rhs) |
Copy assign from an initializer list. More... | |
void | operator= (this_type &&rhs) |
Move assign. More... | |
bool | operator== (const this_type &rhs) const |
Equality. Tables are equal if all keys and values are equal, independent of order or underlying storage size. More... | |
bool | operator!= (const this_type &rhs) const |
The opposite of the equality operation. More... | |
this_type & | operator+= (const this_type &rhs) |
Add entries into this HashTable. More... | |
const_iterator_pair< const_key_iterator, this_type > | keys () const |
A const iterator begin/end pair for iterating over keys. 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... | |
iterator | end () noexcept |
iterator to signal the end (for any HashTable) More... | |
const_iterator | end () const noexcept |
const_iterator to signal the end (for any HashTable) More... | |
constexpr const_iterator | cend () const noexcept |
const_iterator to signal the end (for any HashTable) More... | |
Ostream & | printInfo (Ostream &os) const |
Print information. More... | |
Ostream & | writeKeys (Ostream &os, const label shortLen=0) const |
Write unordered keys (list), with line-breaks when length exceeds shortLen. More... | |
Public Member Functions inherited from HashTableCore | |
ClassName ("HashTable") | |
Declare type-name (with debug switch) More... | |
HashTableCore () noexcept=default | |
Default construct. More... | |
Additional Inherited Members | |
Public Types inherited from IOobject | |
enum | objectState : char { GOOD, BAD } |
Enumeration defining the valid states of an IOobject. More... | |
enum | fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster } |
Enumeration defining the file checking options. More... | |
Public Types inherited from IOobjectOption | |
enum | readOption : unsigned char { NO_READ = 0, MUST_READ = 0x1, MUST_READ_IF_MODIFIED = 0x3, READ_IF_PRESENT = 0x4 } |
Enumeration defining read preferences. More... | |
enum | writeOption : unsigned char { NO_WRITE = 0, AUTO_WRITE = 0x10 } |
Enumeration defining write preferences. More... | |
enum | registerOption : unsigned char { NO_REGISTER = 0, REGISTER = 1 } |
Enumeration for use with registerObject(). Values map to bool (false/true) More... | |
Public Types inherited from HashTable< regIOobject *> | |
typedef HashTable< regIOobject *, word, Foam::Hash< word > > | this_type |
The template instance used for this HashTable. More... | |
typedef std::conditional< std::is_same< zero::null, typename std::remove_cv< regIOobject * >::type >::value, Detail::HashTableSingle< word >, Detail::HashTablePair< word, regIOobject * > >::type | node_type |
A table entry (node) that encapsulates the key/val tuple with an additional linked-list entry for hash collisions. More... | |
typedef word | key_type |
The second template parameter, type of keys used. More... | |
typedef regIOobject * | mapped_type |
The first template parameter, type of objects contained. More... | |
typedef regIOobject * | value_type |
Same as mapped_type for OpenFOAM HashTables. More... | |
typedef Foam::Hash< word > | hasher |
The third template parameter, the hash index method. More... | |
typedef regIOobject * * | pointer |
Pointer type for storing into value_type objects. More... | |
typedef regIOobject * & | reference |
Reference to the stored value_type. More... | |
typedef const regIOobject * * | const_pointer |
Const pointer type for the stored value_type. More... | |
typedef const regIOobject * & | const_reference |
Const reference to the stored value_type. More... | |
typedef label | difference_type |
The type to represent the difference between two iterators. More... | |
typedef label | size_type |
The type that can represent the size of a HashTable. More... | |
using | key_iterator = key_iterator_base< iterator > |
Forward iterator returning the key. More... | |
using | const_key_iterator = key_iterator_base< const_iterator > |
Forward const iterator returning the key. More... | |
Static Public Member Functions inherited from regIOobject | |
template<class Type > | |
static Type & | store (Type *p) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (refPtr< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (refPtr< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (tmp< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (tmp< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
Static Public Member Functions inherited from IOobject | |
static bool | bannerEnabled () noexcept |
Status of output file banner. More... | |
static bool | bannerEnabled (bool on) noexcept |
Enable/disable output file banner. More... | |
static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
Split path into instance, local, name components. More... | |
template<class StringType > | |
static word | groupName (StringType base, const word &group) |
Create dot-delimited name.group string. More... | |
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... | |
static word | scopedName (const std::string &scope, const word &name) |
Create scope:name or scope_name string. More... | |
static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
Return the IOobject, but also consider an alternative file name. More... | |
static Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
Write the standard OpenFOAM file/dictionary banner. More... | |
static Ostream & | writeDivider (Ostream &os) |
Write the standard file section divider. More... | |
static Ostream & | writeEndDivider (Ostream &os) |
Write the standard end file divider. More... | |
Static Public Member Functions inherited from IOobjectOption | |
static bool | isReadRequired (readOption opt) noexcept |
True if (MUST_READ | MUST_READ_IF_MODIFIED) bits are set. More... | |
static bool | isReadOptional (readOption opt) noexcept |
True if (READ_IF_PRESENT) bits are set. More... | |
Static Public Member Functions inherited from HashTableCore | |
static label | canonicalSize (const label requested_size) |
Return a canonical (power-of-two) of the requested size. More... | |
Static Public Attributes inherited from IOobject | |
static const Enum< fileCheckTypes > | fileCheckTypesNames |
Names for the fileCheckTypes. More... | |
static char | scopeSeparator |
Character for scoping object names (':' or '_') More... | |
static fileCheckTypes | fileModificationChecking |
Type of file modification checking. More... | |
static float | fileModificationSkew |
Time skew (seconds) for file modification checks. More... | |
static int | maxFileModificationPolls |
Max number of times to poll for file modification changes. More... | |
Static Public Attributes inherited from HashTableCore | |
static const label | maxTableSize |
Maximum allowable internal table size. Approximately labelMax/4. More... | |
Protected Member Functions inherited from regIOobject | |
bool | readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName) |
Helper: check readOpt flags and read if necessary. More... | |
Protected Member Functions inherited from IOobject | |
void | setBad (const string &s) |
Set the object state to bad. More... | |
Protected Member Functions inherited from HashTable< regIOobject *> | |
bool | iterator_erase (node_type *&entry, label &index) |
Low-level entry erasure using iterator internals. More... | |
Static Protected Member Functions inherited from IOobject | |
static void | writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr) |
Helper: write content for FoamFile IOobject header with optional meta information. More... | |
static void | writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr) |
Helper: write dictionary content for FoamFile header with optional meta information. More... | |
Static Protected Attributes inherited from regIOobject | |
static bool | masterOnlyReading = false |
To flag master-only reading of objects. More... | |
|
explicit |
Construct the time objectRegistry, with estimated table capacity (default: 128)
Definition at line 75 of file objectRegistry.C.
|
explicit |
Construct sub-registry given an IObject to describe the registry, with estimated table capacity (default: 128)
Definition at line 98 of file objectRegistry.C.
References IOobjectOption::AUTO_WRITE, and IOobjectOption::writeOpt().
|
virtual |
Destructor, with checkOut() for all objects that are ownedByRegistry.
Definition at line 113 of file objectRegistry.C.
References objectRegistry::clear().
TypeName | ( | "objectRegistry" | ) |
Declare type name for this IOobject.
|
inlinenoexcept |
Return the object registry.
Definition at line 212 of file objectRegistry.H.
|
inlinenoexcept |
Return the parent objectRegistry.
Definition at line 220 of file objectRegistry.H.
|
inlinenoexcept |
Return time registry.
Definition at line 228 of file objectRegistry.H.
Referenced by mappedPatchBase::addWorldConnection(), minTimeStepCondition::apply(), equationMaxIterCondition::apply(), maxDurationCondition::apply(), SprayParcel< ParcelType >::calcAtomization(), fieldAverageItem::calculateMeanField(), fieldAverageItem::calculatePrime2MeanField(), cyclicAMIPolyPatch::canResetAMI(), codedBase::codeDict(), logFiles::createFiles(), cloud::createIOField(), exprResultGlobals::Delete(), IATEsource::Eo(), equationInitialResidualCondition::equationInitialResidualCondition(), moleculeCloud::evolve(), fieldAverageItem::evolve(), faMesh::faMesh(), coupleGroupIdentifier::findOtherPatchID(), mappedPatchBase::getWorldCommunicator(), DSMCParcel< ParcelType >::hitWallPatch(), surfaceNoise::initialise(), codedPoints0MotionSolver::libs(), mappedPatchBase::lookupMesh(), mappedVariableThicknessWallFvPatch::makeDeltaCoeffs(), Foam::MapLagrangianFields(), Foam::MapMesh(), meshReader::mesh(), IATEsource::Mo(), triSurfaceMesh::movePoints(), lumpedPointIOMovement::New(), exprResultGlobals::New(), GAMGAgglomeration::New(), objectiveManager::objectiveManager(), motionSolver::iNew::operator()(), points0MotionSolver::points0IO(), polyMesh::polyMesh(), areaWrite::read(), uncollatedFileOperation::readObjects(), masterUncollatedFileOperation::readObjects(), polyMesh::readUpdate(), regionProperties::regionProperties(), triSurfaceMesh::setField(), twoPhaseSystem::solve(), multiphaseSystem::solve(), RASTurbulenceModel::solveIter(), patchFunction1Base::time(), fvMesh::time(), IOobject::time(), MPPICParcel< ParcelType >::trackingData::updateAverages(), KinematicParcel< ParcelType >::trackingData::updateAverages(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), velocityFilmShellFvPatchVectorField::updateCoeffs(), porousBafflePressureFvPatchField< Type >::updateCoeffs(), polyMesh::updateMesh(), FIREMeshWriter::write(), areaWrite::write(), PDRblock::writeBlockMeshDict(), and molecule::writeFields().
|
noexcept |
True if the registry is Time.
Definition at line 121 of file objectRegistry.C.
|
inlinevirtual |
Local directory path of this objectRegistry relative to the time.
Reimplemented in polyMesh, and Time.
Definition at line 241 of file objectRegistry.H.
Referenced by polyMesh::dbDir(), fileOperation::processorsPath(), fileOperation::readObjects(), surfMesh::surfMesh(), decomposedBlockData::writeHeader(), and IOobject::writeHeaderContent().
Foam::HashTable< Foam::wordHashSet > classes | ( | ) | const |
A summary hash of classes used and their associated object names.
Behaviour and usage as per IOobjectList::classes
Definition at line 127 of file objectRegistry.C.
Referenced by areaWrite::write().
HashTable<wordHashSet> classes | ( | const MatchPredicate & | matchName | ) | const |
A summary hash of classes used and their associated object names, restricted to objects that have a matching object name.
Foam::UPtrList< const Foam::regIOobject > csorted | ( | ) | const |
Return sorted list of objects.
The lifetime of the returned content cannot exceed the parent!
Definition at line 141 of file objectRegistry.C.
Foam::UPtrList< const Foam::regIOobject > sorted | ( | ) | const |
Return sorted list of objects.
The lifetime of the returned content cannot exceed the parent!
Definition at line 148 of file objectRegistry.C.
Referenced by vtkWrite::writeVolFieldsImpl(), and ensightWrite::writeVolFieldsImpl().
Foam::UPtrList< Foam::regIOobject > sorted | ( | ) |
Return sorted list of objects.
The lifetime of the returned content cannot exceed the parent!
Definition at line 155 of file objectRegistry.C.
UPtrList<const Type> csorted | ( | ) | const |
Return sorted list of objects with a class satisfying isA<Type>
The lifetime of the returned content cannot exceed the parent!
UPtrList<const Type> sorted | ( | ) | const |
Return sorted list of objects with a class satisfying isA<Type>
The lifetime of the returned content cannot exceed the parent!
UPtrList<Type> sorted | ( | ) |
Return sorted list of objects with a class satisfying isA<Type>
The lifetime of the returned content cannot exceed the parent!
UPtrList<const Type> csorted | ( | const MatchPredicate & | matchName | ) | const |
Return sorted list of objects with a class satisfying isA<Type>
that also have a matching object name.
The lifetime of the returned content cannot exceed the parent!
UPtrList<const Type> sorted | ( | const MatchPredicate & | matchName | ) | const |
Return sorted list of objects with a class satisfying isA<Type>
that also have a matching object name.
The lifetime of the returned content cannot exceed the parent!
UPtrList<Type> sorted | ( | const MatchPredicate & | matchName | ) |
Return sorted list of objects with a class satisfying isA<Type>
that also have a matching object name.
The lifetime of the returned content cannot exceed the parent!
Foam::label count | ( | const char * | clsName | ) | const |
The number of objects of the given class name.
Definition at line 133 of file objectRegistry.C.
References Foam::BitOps::count().
Referenced by vtkWrite::write().
label count | ( | const MatchPredicate & | matchClass | ) | const |
The number of objects of the given class name.
label count | ( | const MatchPredicate1 & | matchClass, |
const MatchPredicate2 & | matchName | ||
) | const |
The number of objects of the given class name.
label count | ( | const bool | strict = false | ) | const |
The names of objects with a class satisfying isA<Type>
strict | use isType<Type> instead of isA<Type> |
count<Type>
() and count(Type::typeName)
may be inconsistent, since they use different mechanisms for testing the class type. void
, no isA check is used (always true). label count | ( | const MatchPredicate & | matchName | ) | const |
The names of objects with a class satisfying isA<Type>
that also have a matching object name.
void
, no isA check is used (always true). Foam::wordList names | ( | ) | const |
The unsorted names of all objects.
Definition at line 161 of file objectRegistry.C.
References HashTable< T, Key, Hash >::toc().
Referenced by dynamicMultiMotionSolverFvMesh::init(), areaWrite::write(), vtkWrite::write(), and vtkCloud::writeFields().
Foam::wordList names | ( | const char * | clsName | ) | const |
The unsorted names of objects with the given class name.
Definition at line 173 of file objectRegistry.C.
References Foam::PtrListOps::names().
wordList names | ( | const MatchPredicate & | matchClass | ) | const |
The unsorted names of objects with a matching class name.
wordList names | ( | const MatchPredicate1 & | matchClass, |
const MatchPredicate2 & | matchName | ||
) | const |
The unsorted names of objects with a matching class name that also have a matching object name.
wordList names | ( | ) | const |
The unsorted names of objects with a class satisfying isA<Type>
.
void
, no isA check is used (always true). wordList names | ( | const MatchPredicate & | matchName | ) | const |
The unsorted names of objects with a class satisfying isA<Type>
that also have a matching object name.
void
, no isA check is used (always true). Foam::wordList sortedNames | ( | ) | const |
The sorted names of all objects.
Definition at line 167 of file objectRegistry.C.
References HashTable< T, Key, Hash >::sortedToc().
Referenced by parseDriver::getField(), parseDriver::patchInternalField(), parseDriver::patchNeighbourField(), parseDriver::patchNormalField(), vtkUnstructuredReader::printFieldStats(), multiRegion::read(), and areaWrite::read().
Foam::wordList sortedNames | ( | const char * | clsName | ) | const |
The sorted names of objects with the given class name.
Definition at line 180 of file objectRegistry.C.
wordList sortedNames | ( | const MatchPredicate & | matchClass | ) | const |
The sorted names objects with a matching class name.
wordList sortedNames | ( | const MatchPredicate1 & | matchClass, |
const MatchPredicate2 & | matchName | ||
) | const |
The sorted names of objects with a matching class name that also have a matching object name.
wordList sortedNames | ( | ) | const |
The sorted names of objects with a class satisfying isA<Type>
void
, no isA check is used (always true). wordList sortedNames | ( | const MatchPredicate & | matchName | ) | const |
The sorted names of objects with a class satisfying isA<Type>
that also have a matching object name.
void
, no isA check is used (always true). const Foam::objectRegistry & subRegistry | ( | const word & | name, |
const bool | forceCreate = false , |
||
const bool | recursive = false |
||
) | const |
Lookup and return a const sub-objectRegistry.
forceCreate | create it if it does not exist. |
recursive | search parent registries. |
Definition at line 188 of file objectRegistry.C.
References Foam::name(), IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, and regIOobject::store().
Referenced by polySurface::pointData(), mappedPatchBase::readDict(), mappedPatchBase::subRegistry(), and uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs().
HashTable<const Type*> lookupClass | ( | const bool | strict = false | ) | const |
Return all objects with a class satisfying isA<Type>
strict | use isType<Type> instead of isA<Type> |
Referenced by meshObject::clear(), meshObject::clearUpto(), coupleGroupIdentifier::findOtherPatchID(), cellCellStencil::interpolate(), surfaceInterpolate::interpolateFields(), basicThermo::lookupThermo(), Foam::mapClouds(), meshObject::movePoints(), areaWrite::read(), and meshObject::updateMesh().
HashTable<Type*> lookupClass | ( | const bool | strict = false | ) |
Return all objects with a class satisfying isA<Type>
strict | use isType<Type> instead of isA<Type> |
const Foam::regIOobject * cfindIOobject | ( | const word & | name, |
const bool | recursive = false |
||
) | const |
Return const pointer to the regIOobject.
recursive | search parent registries |
Definition at line 425 of file objectRegistry.C.
References Foam::name().
Referenced by parseDriver::getField(), parseDriver::patchInternalField(), parseDriver::patchNeighbourField(), and parseDriver::patchNormalField().
bool found | ( | const word & | name, |
const bool | recursive = false |
||
) | const |
Can the regIOobject object be found (by name).
recursive | search parent registries |
Definition at line 446 of file objectRegistry.C.
References Foam::name().
Referenced by simplifiedFvMesh::fvPatchFieldExists(), turbulenceFields::initialise(), surfaceInterpolate::interpolateFields(), polySurface::queryFieldAssociation(), and polySurface::whichRegistry().
bool foundObject | ( | const word & | name, |
const bool | recursive = false |
||
) | const |
Is the named Type found?
recursive | search parent registries |
Definition at line 480 of file objectRegistryTemplates.C.
References Foam::name().
Referenced by relaxedSnGrad< Type >::correction(), filmTurbulenceModel::devRhoReff(), phaseSystem::foundBlendedSubModel(), phaseSystem::foundSubModel(), LimitedScheme< Type, Limiter, LimitFunc >::limiter(), phaseSystem::lookupSubModel(), regionModel::mapRegionPatchField(), regionModel::mapRegionPatchInternalField(), solutionControl::maxTypeResidual(), particleDistribution::processField(), heatTransferCoeffModel::q(), ReynoldsAnalogy::rho(), adjointBoundaryCondition< Type >::setBoundaryContributionPtr(), rigidBodyMeshMotionSolver::solve(), rigidBodyMeshMotion::solve(), thermalBaffleFvPatchScalarField::thermalBaffleFvPatchScalarField(), objectivePowerDissipation::update_dJdv(), objectiveNutSqr::update_dJdv(), and cellCellStencil::zoneID().
const Type * cfindObject | ( | const word & | name, |
const bool | recursive = false |
||
) | const |
Return const pointer to the object of the given Type.
recursive | search parent registries |
Definition at line 491 of file objectRegistryTemplates.C.
References Foam::name().
Referenced by DEShybrid< Type >::blendingFactor(), fvExprDriver::evaluateVariableRemote(), polySurface::findFieldObject(), cloud::findIOField(), cloud::findIOPosition(), sampledSets::getOrLoadField(), probes::getOrLoadField(), fluxSummary::initialiseSurface(), fluxSummary::initialiseSurfaceAndDirection(), GAMGAgglomeration::New(), regionFunctionObject::obr(), cloudInfo::performAction(), lumpedPointDisplacementPointPatchVectorField::points0(), heatTransferCoeffModel::q(), propellerInfo::setRotationalSpeed(), and triSurfaceMeshPointSet::triSurfaceMeshPointSet().
const Type * findObject | ( | const word & | name, |
const bool | recursive = false |
||
) | const |
Return const pointer to the object of the given Type.
recursive | search parent registries |
Definition at line 502 of file objectRegistryTemplates.C.
References Foam::name().
Referenced by Foam::calc_pTotal(), Foam::calc_rhoU(), ObukhovLength::calcOL(), parcelSelection::calculateFilter(), fieldAverageItem::calculateMeanField(), fieldAverageItem::calculatePrime2MeanField(), mappedPatchBase::constructIOField(), Arrhenius< ViscousModel >::correct(), multiphaseStabilizedTurbulence::correct(), DispersionRASModel< CloudType >::epsilonModel(), lumpedPointMovement::forcesAndMoments(), liquidFilmThermo::initLiquid(), DispersionRASModel< CloudType >::kModel(), basicThermo::lookupThermo(), coordinateSystems::New(), uniformBin::processField(), VTKsurfaceFormat< Face >::read(), lduMatrix::setResidualField(), mappedPatchBase::storeField(), filmPyrolysisTemperatureCoupledFvPatchScalarField::updateCoeffs(), filmPyrolysisVelocityCoupledFvPatchVectorField::updateCoeffs(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::updateCoeffs(), and vtkCloud::writeFields().
Type * findObject | ( | const word & | name, |
const bool | recursive = false |
||
) |
Return non-const pointer to the object of the given Type.
recursive | search parent registries |
Definition at line 513 of file objectRegistryTemplates.C.
References Foam::name().
Type * getObjectPtr | ( | const word & | name, |
const bool | recursive = false |
||
) | const |
Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable.
Exercise caution when using.
recursive | search parent registries. |
Definition at line 524 of file objectRegistryTemplates.C.
References Foam::name().
Referenced by Foam::calc_pTotal(), Foam::calc_rhoU(), ObukhovLength::calcOL(), codedBase::codeDict(), exprResultGlobals::Delete(), filmFlux::execute(), forces::force(), lumpedPointIOMovement::getMovementObject(), sampledSurface::getRegistrySurface(), zoneCPCStencil::New(), exprResultGlobals::New(), zoneDistribute::New(), regionFaModel::regionMesh(), regionModel::regionMesh(), searchableSurfaceWithGaps::searchableSurfaceWithGaps(), lduMatrix::setResidualField(), surfMesh::storeField(), polySurface::storeField(), regionFunctionObject::storeInDb(), and areaWrite::write().
const Type & lookupObject | ( | const word & | name, |
const bool | recursive = false |
||
) | const |
Lookup and return const reference to the object of the given Type. Fatal if not found or the wrong type.
recursive | search parent registries. |
Definition at line 535 of file objectRegistryTemplates.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::name(), and Foam::nl.
Referenced by solidAbsorption::a(), interRegionHeatTransferModel::addSup(), adjointSimple::adjointSimple(), objectiveIncompressible::allocatedJdTurbulence(), DEShybrid< Type >::blendingFactor(), Foam::calc_pTotal(), Foam::calc_rhoU(), ObukhovLength::calcOL(), parcelSelection::calculateFilter(), tabulatedHeatTransfer::calculateHtc(), variableHeatTransfer::calculateHtc(), fieldAverageItem::calculateMeanField(), fieldAverageItem::calculatePrime2MeanField(), kOmegaSST::computeG(), motionDirectionalDiffusivity::correct(), isothermal::d(), filmTurbulenceModel::devRhoReff(), solidAbsorption::e(), IATEsource::Eo(), interfaceTrackingFvMesh::freeSurfacePressureJump(), interfaceTrackingFvMesh::freeSurfaceSnGradU(), adjointSolver::getPrimalSolver(), interRegionExplicitPorositySource::initialise(), phaseSystem::lookupBlendedSubModel(), cloud::lookupIOField(), mappedPatchBase::lookupMesh(), twoPhaseSystem::lookupSubModel(), phaseSystem::lookupSubModel(), basicThermo::lookupThermo(), mappedVariableThicknessWallFvPatch::makeDeltaCoeffs(), regionModel::mapRegionPatchField(), regionModel::mapRegionPatchInternalField(), function1Base::mesh(), IATEsource::Mo(), solidParticleCloud::move(), displacementMotionSolverMeshMover::move(), medialAxisMeshMover::move(), solidAbsorption::nBands(), surfaceFieldValue::obr(), enthalpySorptionFvPatchScalarField::patchSource(), pointHistory::pointHistory(), hydrostaticPressure::pRef(), vtkUnstructuredReader::printFieldStats(), particleDistribution::processField(), heatTransferCoeffModel::q(), filmTurbulenceModel::rho(), ReynoldsAnalogy::rho(), VollerPrakash::S(), interRegionOption::setMapper(), interRegionHeatTransferModel::setNbrModel(), sixDoFRigidBodyMotionSolver::solve(), rigidBodyMeshMotionSolver::solve(), rigidBodyMeshMotion::solve(), liquidFilmBase::Up(), objectivePowerDissipation::update_dJdv(), objectiveNutSqr::update_dJdv(), freeSurfaceVelocityFvPatchVectorField::updateCoeffs(), inclinedFilmNusseltHeightFvPatchScalarField::updateCoeffs(), inclinedFilmNusseltInletVelocityFvPatchVectorField::updateCoeffs(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), vibrationShellFvPatchScalarField::updateCoeffs(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), freeSurfacePressureFvPatchScalarField::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), porousBafflePressureFvPatchField< Type >::updateCoeffs(), momentumError::write(), and cellCellStencil::zoneID().
Type & lookupObjectRef | ( | const word & | name, |
const bool | recursive = false |
||
) | const |
Lookup and return non-const reference to the object of the given Type. Fatal if not found or the wrong type.
recursive | search parent registries. |
Definition at line 579 of file objectRegistryTemplates.C.
References Foam::name(), and ref().
Referenced by heatTransferCoeff::calc(), momentumError::calcMomentError(), fieldAverageItem::calculateMeanField(), fieldAverageItem::calculatePrime2MeanField(), relaxedSnGrad< Type >::correction(), surfaceDistance::execute(), wallBoiling::R(), searchableSurfaceCollection::searchableSurfaceCollection(), and uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs().
Foam::label getEvent | ( | ) | const |
Return new event number.
Definition at line 214 of file objectRegistry.C.
References Foam::ensightOutput::debug, Foam::endl(), Foam::labelMax, Foam::nl, and WarningInFunction.
bool checkIn | ( | regIOobject * | io | ) | const |
Add a regIOobject to registry. A nullptr is ignored.
Definition at line 240 of file objectRegistry.C.
References Foam::ensightOutput::debug, Foam::endl(), HashTable< T, Key, Hash >::insert(), io(), Foam::name(), IOobject::name(), Foam::Pout, and WarningInFunction.
bool checkIn | ( | regIOobject & | io | ) | const |
Add a regIOobject to registry.
Definition at line 314 of file objectRegistry.C.
References io().
bool checkOut | ( | regIOobject * | io | ) | const |
Remove a regIOobject from registry and free memory if the object is ownedByRegistry. A nullptr is ignored.
Definition at line 268 of file objectRegistry.C.
References Foam::ensightOutput::debug, Foam::endl(), objectRegistry::erase(), HashTable< T, Key, Hash >::find(), io(), Foam::name(), IOobject::name(), Foam::Pout, and WarningInFunction.
Referenced by meshObject::clear(), fieldAverageItem::clear(), timeFunctionObject::clearOutputObjects(), meshObject::clearUpto(), exprResultGlobals::Delete(), fieldAverageItem::evolve(), meshObject::movePoints(), sampledSurface::removeRegistrySurface(), faMeshTools::unregisterMesh(), and meshObject::updateMesh().
bool checkOut | ( | regIOobject & | io | ) | const |
Remove a regIOobject from registry and free memory if the object is ownedByRegistry.
Definition at line 320 of file objectRegistry.C.
References io().
bool checkOut | ( | const word & | key | ) | const |
Remove a regIOobject by name from registry and free memory if the object is ownedByRegistry.
Definition at line 326 of file objectRegistry.C.
References objectRegistry::erase(), and Foam::glTF::key().
void clear | ( | ) |
Clear all entries from the registry.
Performs a checkOut() for all objects that are ownedByRegistry
Definition at line 332 of file objectRegistry.C.
References stdFoam::begin(), HashTable< T, Key, Hash >::clear(), Foam::ensightOutput::debug, stdFoam::end(), IOobject::name(), Foam::nl, regIOobject::ownedByRegistry(), Foam::Pout, and regIOobject::release().
Referenced by surfMesh::clearFields(), polySurface::clearFields(), objectRegistry::clearStorage(), extendedEdgeMesh::transfer(), objectRegistry::~objectRegistry(), and Time::~Time().
void clearStorage | ( | ) |
Clear all entries from the registry and the table itself.
Definition at line 358 of file objectRegistry.C.
References objectRegistry::clear(), and HashTable< T, Key, Hash >::clearStorage().
bool erase | ( | const iterator & | iter | ) |
Erase an entry specified by the given iterator.
Performs a checkOut() if the object was ownedByRegistry.
Definition at line 365 of file objectRegistry.C.
References HashTable< T, Key, Hash >::erase(), regIOobject::ownedByRegistry(), and regIOobject::release().
Referenced by objectRegistry::checkOut(), and Foam::eraseImpl().
bool erase | ( | const word & | key | ) |
Erase an entry specified by the given key.
Performs a checkOut() if the object was ownedByRegistry.
Definition at line 388 of file objectRegistry.C.
References erase(), Foam::ListOps::find(), and Foam::glTF::key().
Foam::label erase | ( | std::initializer_list< word > | keys | ) |
Remove entries given by the listed keys.
Performs a checkOut() for all objects that are ownedByRegistry.
Definition at line 394 of file objectRegistry.C.
References Foam::eraseImpl().
Remove entries given by the listed keys.
Performs a checkOut() for all objects that are ownedByRegistry.
Definition at line 400 of file objectRegistry.C.
References UList< T >::begin(), UList< T >::end(), and Foam::eraseImpl().
|
virtual |
Rename.
Reimplemented from regIOobject.
Definition at line 406 of file objectRegistry.C.
References regIOobject::rename(), and string::replace().
|
virtual |
Return true if any of the object's files have been modified.
Reimplemented from regIOobject.
Definition at line 455 of file objectRegistry.C.
References stdFoam::cbegin(), and stdFoam::cend().
Referenced by Time::readModifiedObjects().
void readModifiedObjects | ( | ) |
Read the objects that have been modified.
Definition at line 469 of file objectRegistry.C.
References stdFoam::begin(), Foam::ensightOutput::debug, stdFoam::end(), Foam::endl(), Foam::name(), and Foam::Pout.
Referenced by Time::readModifiedObjects().
|
virtual |
Read object if modified.
Reimplemented from regIOobject.
Definition at line 485 of file objectRegistry.C.
|
inlinevirtual |
writeData function required by regIOobject but not used.
For this class, write is used instead
Implements regIOobject.
Reimplemented in triSurfaceMesh.
Definition at line 778 of file objectRegistry.H.
References NotImplemented.
|
virtual |
Write the objects using stream options.
Reimplemented from regIOobject.
Reimplemented in distributedTriSurfaceMesh, fvMesh, Time, polySurface, surfMesh, triSurfaceMesh, dynamicRefineFvMesh, Cloud< ParticleType >, Cloud< Foam::passiveParticle >, Cloud< wallBoundedStreamLineParticle >, Cloud< indexedParticle >, Cloud< basicKinematicCollidingParcel >, Cloud< ParcelType >, Cloud< Foam::molecule >, Cloud< solidParticle >, Cloud< parcelType >, Cloud< molecule >, Cloud< typename CloudType::parcelType >, Cloud< passiveParticle >, Cloud< injectedParticle >, Cloud< Foam::DTRMParticle >, Cloud< streamLineParticle >, Cloud< passivePositionParticle >, dynamicOversetFvMesh, staticOversetFvMesh, and unmappedPassivePositionParticleCloud.
Definition at line 493 of file objectRegistry.C.
References stdFoam::cbegin(), stdFoam::cend(), Foam::ensightOutput::debug, Foam::endl(), Foam::name(), IOobjectOption::NO_WRITE, IOobject::objectRelPath(), Foam::Pout, and IOobjectOption::writeOpt().
Referenced by Time::writeObject(), and fvMesh::writeObject().
|
inline |
Deprecated(2018-10) find object.
Definition at line 804 of file objectRegistry.H.
References IOobject::name().
|
inline |
Deprecated(2018-10) get object pointer, ignoring constness.
Definition at line 820 of file objectRegistry.H.
References IOobject::name().
Foam::HashTable<Foam::wordHashSet> classesImpl | ( | const objectRegistry & | list, |
const MatchPredicate & | matchName | ||
) |
Definition at line 31 of file objectRegistryTemplates.C.
References forAllConstIters(), insert(), IOobject::name(), and HashTable< T, Key, Hash >::size().
Foam::label countImpl | ( | const objectRegistry & | list, |
const MatchPredicate1 & | matchClass, | ||
const MatchPredicate2 & | matchName | ||
) |
Definition at line 57 of file objectRegistryTemplates.C.
References Foam::BitOps::count(), forAllConstIters(), and IOobject::name().
Foam::label countTypeImpl | ( | const objectRegistry & | list, |
const MatchPredicate & | matchName | ||
) |
Definition at line 82 of file objectRegistryTemplates.C.
References Foam::BitOps::count(), forAllConstIters(), and IOobject::name().
Foam::wordList namesImpl | ( | const objectRegistry & | list, |
const MatchPredicate1 & | matchClass, | ||
const MatchPredicate2 & | matchName, | ||
const bool | doSort | ||
) |
Definition at line 110 of file objectRegistryTemplates.C.
References Foam::BitOps::count(), forAllConstIters(), IOobject::name(), HashTable< T, Key, Hash >::size(), and Foam::sort().
Foam::wordList namesTypeImpl | ( | const objectRegistry & | list, |
const MatchPredicate & | matchName, | ||
const bool | doSort | ||
) |
Definition at line 145 of file objectRegistryTemplates.C.
References Foam::BitOps::count(), forAllConstIters(), IOobject::name(), HashTable< T, Key, Hash >::size(), and Foam::sort().
Foam::UPtrList<Type> objectsTypeImpl | ( | const objectRegistry & | list, |
const MatchPredicate & | matchName | ||
) |
Definition at line 184 of file objectRegistryTemplates.C.
References Foam::BitOps::count(), forAllConstIters(), HashTable< T, Key, Hash >::size(), and Foam::sort().
Foam::HashTable<Foam::wordHashSet> classes | ( | const MatchPredicate & | matchName | ) | const |
Definition at line 218 of file objectRegistryTemplates.C.
Foam::label count | ( | const MatchPredicate & | matchClass | ) | const |
Definition at line 228 of file objectRegistryTemplates.C.
Foam::label count | ( | const MatchPredicate1 & | matchClass, |
const MatchPredicate2 & | matchName | ||
) | const |
Definition at line 238 of file objectRegistryTemplates.C.
Foam::label count | ( | const MatchPredicate & | matchName | ) | const |
Definition at line 249 of file objectRegistryTemplates.C.
Foam::label count | ( | const bool | strict | ) | const |
Definition at line 259 of file objectRegistryTemplates.C.
References forAllConstIters().
Foam::UPtrList<const Type> csorted | ( | ) | const |
Definition at line 292 of file objectRegistryTemplates.C.
Foam::UPtrList<const Type> sorted | ( | ) | const |
Definition at line 300 of file objectRegistryTemplates.C.
Foam::UPtrList<Type> sorted | ( | ) |
Definition at line 308 of file objectRegistryTemplates.C.
Foam::UPtrList<const Type> csorted | ( | const MatchPredicate & | matchName | ) | const |
Definition at line 317 of file objectRegistryTemplates.C.
Foam::UPtrList<const Type> sorted | ( | const MatchPredicate & | matchName | ) | const |
Definition at line 328 of file objectRegistryTemplates.C.
Foam::UPtrList<Type> sorted | ( | const MatchPredicate & | matchName | ) |
Definition at line 338 of file objectRegistryTemplates.C.
Foam::wordList names | ( | const MatchPredicate & | matchClass | ) | const |
Definition at line 350 of file objectRegistryTemplates.C.
Foam::wordList names | ( | const MatchPredicate1 & | matchClass, |
const MatchPredicate2 & | matchName | ||
) | const |
Definition at line 360 of file objectRegistryTemplates.C.
Foam::wordList names | ( | ) | const |
Definition at line 370 of file objectRegistryTemplates.C.
Foam::wordList names | ( | const MatchPredicate & | matchName | ) | const |
Definition at line 378 of file objectRegistryTemplates.C.
Foam::wordList sortedNames | ( | const MatchPredicate & | matchClass | ) | const |
Definition at line 388 of file objectRegistryTemplates.C.
Foam::wordList sortedNames | ( | const MatchPredicate1 & | matchClass, |
const MatchPredicate2 & | matchName | ||
) | const |
Definition at line 398 of file objectRegistryTemplates.C.
Foam::wordList sortedNames | ( | ) | const |
Definition at line 408 of file objectRegistryTemplates.C.
Foam::wordList sortedNames | ( | const MatchPredicate & | matchName | ) | const |
Definition at line 416 of file objectRegistryTemplates.C.
Foam::HashTable<const Type*> lookupClass | ( | const bool | strict | ) | const |
Definition at line 426 of file objectRegistryTemplates.C.
References forAllConstIters(), HashTable< T, Key, Hash >::insert(), and IOobject::name().
Foam::HashTable<Type*> lookupClass | ( | const bool | strict | ) |
Definition at line 453 of file objectRegistryTemplates.C.
References forAllIters, HashTable< T, Key, Hash >::insert(), and IOobject::name().
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.