List of IOobjects with searching and retrieving facilities. Implemented as a HashTable, so the various sorted methods should be used if traversing in parallel. More...

Inheritance diagram for IOobjectList:

[legend]

Collaboration diagram for IOobjectList:

[legend]

Public Member Functions
	IOobjectList () noexcept=default
	Default construct: empty without allocation (capacity=0). More...

	IOobjectList (const Foam::zero) noexcept
	Construct empty without allocation (capacity=0) More...

	IOobjectList (const label initialCapacity)
	Construct empty with initial table capacity. More...

	IOobjectList (const IOobjectList &list)
	Copy construct. More...

	IOobjectList (IOobjectList &&list)
	Move construct. More...

	IOobjectList (const objectRegistry &db, const fileName &instance, IOobjectOption ioOpt)
	Construct from registry, instance, io options. More...

	IOobjectList (const objectRegistry &db, const fileName &instance, const fileName &local, IOobjectOption ioOpt)
	Construct from registry, instance, local, io options. More...

	IOobjectList (const objectRegistry &db, const fileName &instance, IOobjectOption::registerOption=IOobjectOption::REGISTER)
	Construct from registry, instance, registration option with MUST_READ, NO_WRITE. More...

	IOobjectList (const objectRegistry &db, const fileName &instance, const fileName &local, IOobjectOption::registerOption=IOobjectOption::REGISTER)
	Construct from registry, instance, local, registration option with MUST_READ, NO_WRITE. More...

	~IOobjectList ()=default
	Destructor. More...

bool	add (autoPtr< IOobject > &objectPtr)
	Move insert IOobject into the list. More...

bool	add (autoPtr< IOobject > &&objectPtr)
	Move insert IOobject into the list. More...

autoPtr< IOobject >	remove (const IOobject &io)
	Remove object from the list by its IOobject::name(). More...

const IOobject *	cfindObject (const word &objName) const
	Return const pointer to the object found by name. More...

template<class Type >
const IOobject *	cfindObject (const word &objName) const
	Return const pointer to the object found by name that also has headerClassName == Type::typeName. More...

const IOobject *	findObject (const word &objName) const
	Return const pointer to the object found by name. More...

template<class Type >
const IOobject *	findObject (const word &objName) const
	Return const pointer to the object found by name that also has headerClassName == Type::typeName. More...

IOobject *	findObject (const word &objName)
	Return non-const pointer to the object found by name. More...

template<class Type >
IOobject *	findObject (const word &objName)
	Return non-const pointer to the object found by name that also has headerClassName == Type::typeName. More...

IOobject *	getObject (const word &objName) const
	Return non-const pointer to the object found by name, using a const-cast to have it behave like a mutable. More...

template<class Type >
IOobject *	getObject (const word &objName) const
	Return non-const pointer to the object found by name that also has headerClassName == Type::typeName, using a const-cast to have it behave like a mutable. More...

template<class MatchPredicate >
IOobjectList	lookup (const MatchPredicate &matchName) const
	The list of IOobjects that have a matching object name. More...

IOobjectList	lookupClass (const char *clsName) const
	The list of IOobjects with the given headerClassName. More...

template<class MatchPredicate >
IOobjectList	lookupClass (const MatchPredicate &matchClass) const
	The list of IOobjects with matching headerClassName. More...

template<class MatchPredicate1 , class MatchPredicate2 >
IOobjectList	lookupClass (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
	The list of IOobjects with matching headerClassName that also have a matching object name. More...

template<class Type >
IOobjectList	lookupClass () const
	The list of IOobjects with headerClassName == Type::typeName. More...

template<class Type , class MatchPredicate >
IOobjectList	lookupClass (const MatchPredicate &matchName) const
	The list of IOobjects with headerClassName == Type::typeName that also have a matching object name. 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...

template<class Type >
UPtrList< const IOobject >	cobjects () const
	The unsorted list of IOobjects with headerClassName == Type::typeName. More...

template<class Type , class MatchPredicate >
UPtrList< const IOobject >	cobjects (const MatchPredicate &matchName) const
	The unsorted list of IOobjects with headerClassName == Type::typeName that also have a matching object name. More...

template<class Type >
UPtrList< const IOobject >	csorted () const
	The sorted list of IOobjects with headerClassName == Type::typeName. More...

template<class Type >
UPtrList< const IOobject >	csorted (const bool syncPar) const
	The sorted names of the IOobjects with optional check for parallel consistency. More...

UPtrList< const IOobject >	csorted () const
	The sorted list of IOobjects. More...

UPtrList< const IOobject >	csorted (const bool syncPar) const
	The sorted list of IOobjects with optional check for parallel consistency. More...

template<class Type , class MatchPredicate >
UPtrList< const IOobject >	csorted (const MatchPredicate &matchName) const
	The sorted list of IOobjects with headerClassName == Type::typeName that also have a matching object name. More...

template<class Type , class MatchPredicate >
UPtrList< const IOobject >	csorted (const MatchPredicate &matchName, const bool syncPar) const
	The sorted list of IOobjects with headerClassName == Type::typeName that also have a matching object name. More...

label	count (const char *clsName) const
	The number of objects of the given headerClassName. More...

template<class MatchPredicate >
label	count (const MatchPredicate &matchClass) const
	The number of objects of the given headerClassName. More...

template<class MatchPredicate1 , class MatchPredicate2 >
label	count (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
	The number of objects of the given headerClassName that also have a matching object name. More...

template<class Type >
label	count () const
	The number of objects with headerClassName == Type::typeName. More...

template<class Type , class MatchPredicate >
label	count (const MatchPredicate &matchName) const
	The number of objects with headerClassName == Type::typeName that also have a matching object name. More...

wordList	names () const
	The unsorted names of the IOobjects. More...

wordList	names (const bool syncPar) const
	The sorted names of the IOobjects with optional check for parallel consistency. More...

wordList	names (const char *clsName) const
	The unsorted names of IOobjects with the given headerClassName. More...

wordList	names (const char *clsName, const bool syncPar) const
	The sorted names of the IOobjects with the given headerClassName. More...

template<class MatchPredicate >
wordList	names (const MatchPredicate &matchClass) const
	The unsorted names of IOobjects with the given headerClassName. More...

template<class MatchPredicate >
wordList	names (const MatchPredicate &matchClass, const bool syncPar) const
	The sorted names of the IOobjects with the given headerClassName. More...

template<class MatchPredicate1 , class MatchPredicate2 >
wordList	names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
	The unsorted names of IOobjects with the given headerClassName that also have a matching object name. More...

template<class MatchPredicate1 , class MatchPredicate2 >
wordList	names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName, const bool syncPar) const
	The sorted names of the IOobjects with the given headerClassName that also have a matching object name. More...

template<class Type >
wordList	names () const
	The unsorted names of objects with headerClassName == Type::typeName. More...

template<class Type >
wordList	names (bool syncPar) const
	The sorted names of objects with headerClassName == Type::typeName. More...

template<class Type , class MatchPredicate >
wordList	names (const MatchPredicate &matchName) const
	The unsorted names of objects with headerClassName == Type::typeName and a matching object name. More...

template<class Type , class MatchPredicate >
wordList	names (const MatchPredicate &matchName, const bool syncPar) const
	The sorted names of objects with headerClassName == Type::typeName and a matching object name. More...

wordList	sortedNames () const
	The sorted names of the IOobjects. More...

wordList	sortedNames (const bool syncPar) const
	The sorted names of the IOobjects with optional check for parallel consistency. More...

wordList	sortedNames (const char *clsName) const
	The sorted names of IOobjects with the given headerClassName. More...

wordList	sortedNames (const char *clsName, const bool syncPar) const
	The sorted names of the IOobjects with the given headerClassName. More...

template<class MatchPredicate >
wordList	sortedNames (const MatchPredicate &matchClass) const
	The sorted names of IOobjects with the given headerClassName. More...

template<class MatchPredicate >
wordList	sortedNames (const MatchPredicate &matchClass, const bool syncPar) const
	The sorted names of the IOobjects with the given headerClassName. More...

template<class MatchPredicate1 , class MatchPredicate2 >
wordList	sortedNames (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
	The sorted names of IOobjects with the given headerClassName that also have a matching object name. More...

template<class MatchPredicate1 , class MatchPredicate2 >
wordList	sortedNames (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName, const bool syncPar) const
	The sorted names of the IOobjects with the given headerClassName that also have a matching object name. More...

template<class Type >
wordList	sortedNames () const
	The sorted names of objects with headerClassName == Type::typeName. More...

template<class Type >
wordList	sortedNames (bool syncPar) const
	The sorted names of objects with headerClassName == Type::typeName. More...

template<class Type , class MatchPredicate >
wordList	sortedNames (const MatchPredicate &matchName) const
	The sorted names of objects with headerClassName == Type::typeName that also have a matching object name. More...

template<class Type , class MatchPredicate >
wordList	sortedNames (const MatchPredicate &matchName, const bool syncPar) const
	The sorted names of objects with headerClassName == Type::typeName that also have a matching object name. More...

template<class UnaryPredicate >
label	filterClasses (const UnaryPredicate &pred, const bool pruning=false)
	Filter to retain or prune given classes. More...

template<class UnaryPredicate >
label	filterObjects (const UnaryPredicate &pred, const bool pruning=false)
	Filter to retain or prune given object names. More...

label	prune_0 ()
	Remove objects with names ending with "_0" (restart fields) More...

wordList	allNames () const
	The sorted names of all objects (synchronised across processors) More...

template<class Type >
wordList	allNames () const
	The sorted names of all objects (synchronised across processors) with headerClassName == Type::typeName. More...

void	checkNames (const bool syncPar=true) const
	Verify that object names are synchronised across processors. More...

void	operator= (const IOobjectList &)=delete
	No copy assignment. More...

void	operator= (IOobjectList &&list)
	Move assignment. More...

	IOobjectList (const objectRegistry &db, const fileName &instance, const fileName &local, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true)
	Construct from registry, instance, local, io options. More...

IOobject *	lookup (const char *objName) const
	Deprecated(2018-11) Locate an object by name (c-string). Disambiguated from multiple-lookup version by calling parameter. More...

IOobject *	lookup (const word &objName) const
	Deprecated(2018-11) Locate an object by name (const word&). Disambiguated from multiple-lookup version by calling parameter. More...

template<class Type >
UPtrList< const IOobject >	sorted () const
	Deprecated(2023-07) use csorted() method. More...

template<class Type >
UPtrList< const IOobject >	sorted (const bool syncPar) const
	Deprecated(2023-07) use csorted() method. More...

UPtrList< const IOobject >	sorted () const
	Deprecated(2023-07) use csorted() method. More...

UPtrList< const IOobject >	sorted (const bool syncPar) const
	Deprecated(2023-07) use csorted() method. More...

template<class Type , class MatchPredicate >
UPtrList< const IOobject >	sorted (const MatchPredicate &matchName) const
	Deprecated(2023-07) use csorted() method. More...

template<class Type , class MatchPredicate >
UPtrList< const IOobject >	sorted (const MatchPredicate &matchName, const bool syncPar) const
	Deprecated(2023-07) use csorted() method. More...

template<class MatchPredicate >
Foam::HashTable< Foam::wordHashSet >	classesImpl (const IOobjectList &list, const MatchPredicate &matchName)

template<class MatchPredicate1 , class MatchPredicate2 >
Foam::label	countImpl (const IOobjectList &list, const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName)

template<class Type , class MatchPredicate >
Foam::label	countTypeImpl (const IOobjectList &list, const MatchPredicate &matchName)

template<class MatchPredicate1 , class MatchPredicate2 >
Foam::wordList	namesImpl (const IOobjectList &list, const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName, const bool doSort)

template<class Type , class MatchPredicate >
Foam::wordList	namesTypeImpl (const IOobjectList &list, const MatchPredicate &matchName, const bool doSort)

template<class Type , class MatchPredicate >
Foam::UPtrList< const Foam::IOobject >	objectsTypeImpl (const IOobjectList &list, const MatchPredicate &matchName, const bool doSort)

template<class MatchPredicate >
Foam::IOobjectList	lookupImpl (const IOobjectList &list, const MatchPredicate &matchName)

template<class MatchPredicate1 , class MatchPredicate2 >
Foam::IOobjectList	lookupClassImpl (const IOobjectList &list, const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName)

template<class Type , class MatchPredicate >
Foam::IOobjectList	lookupClassTypeImpl (const IOobjectList &list, const MatchPredicate &matchName)

template<class Type >
const Foam::IOobject *	cfindObject (const word &objName) const

template<class Type >
const Foam::IOobject *	findObject (const word &objName) const

template<class Type >
Foam::IOobject *	findObject (const word &objName)

template<class Type >
Foam::IOobject *	getObject (const word &objName) const

template<class MatchPredicate >
Foam::IOobjectList	lookup (const MatchPredicate &matchName) const

template<class MatchPredicate >
Foam::IOobjectList	lookupClass (const MatchPredicate &matchClass) const

template<class MatchPredicate1 , class MatchPredicate2 >
Foam::IOobjectList	lookupClass (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const

template<class Type >
Foam::IOobjectList	lookupClass () const

template<class Type , class MatchPredicate >
Foam::IOobjectList	lookupClass (const MatchPredicate &matchName) const

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 >
Foam::label	count () const

template<class Type , class MatchPredicate >
Foam::label	count (const MatchPredicate &matchName) const

template<class Type >
Foam::UPtrList< const Foam::IOobject >	cobjects () const

template<class Type >
Foam::UPtrList< const Foam::IOobject >	csorted () const

template<class Type >
Foam::UPtrList< const Foam::IOobject >	csorted (const bool syncPar) const

template<class Type , class MatchPredicate >
Foam::UPtrList< const Foam::IOobject >	cobjects (const MatchPredicate &matchName) const

template<class Type , class MatchPredicate >
Foam::UPtrList< const Foam::IOobject >	csorted (const MatchPredicate &matchName) const

template<class Type , class MatchPredicate >
Foam::UPtrList< const Foam::IOobject >	csorted (const MatchPredicate &matchName, const bool syncPar) const

template<class MatchPredicate >
Foam::wordList	names (const MatchPredicate &matchClass) const

template<class MatchPredicate >
Foam::wordList	names (const MatchPredicate &matchClass, const bool syncPar) const

template<class MatchPredicate1 , class MatchPredicate2 >
Foam::wordList	names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const

template<class MatchPredicate1 , class MatchPredicate2 >
Foam::wordList	names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName, const bool syncPar) const

template<class Type >
Foam::wordList	names () const

template<class Type >
Foam::wordList	names (const bool syncPar) const

template<class Type , class MatchPredicate >
Foam::wordList	names (const MatchPredicate &matchName) const

template<class Type , class MatchPredicate >
Foam::wordList	names (const MatchPredicate &matchName, const bool syncPar) const

template<class MatchPredicate >
Foam::wordList	sortedNames (const MatchPredicate &matchClass) const

template<class MatchPredicate >
Foam::wordList	sortedNames (const MatchPredicate &matchClass, const bool syncPar) const

template<class MatchPredicate1 , class MatchPredicate2 >
Foam::wordList	sortedNames (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const

template<class MatchPredicate1 , class MatchPredicate2 >
Foam::wordList	sortedNames (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName, const bool syncPar) const

template<class Type >
Foam::wordList	sortedNames () const

template<class Type >
Foam::wordList	sortedNames (const bool syncPar) const

template<class Type , class MatchPredicate >
Foam::wordList	sortedNames (const MatchPredicate &matchName) const

template<class Type , class MatchPredicate >
Foam::wordList	sortedNames (const MatchPredicate &matchName, const bool syncPar) const

template<class UnaryPredicate >
Foam::label	filterClasses (const UnaryPredicate &pred, const bool pruning)

template<class UnaryPredicate >
Foam::label	filterObjects (const UnaryPredicate &pred, const bool pruning)

template<class Type >
Foam::wordList	allNames () const

Public Member Functions inherited from HashPtrTable< IOobject >
	HashPtrTable ()=default
	Default construct with default table capacity. More...

	HashPtrTable (const Foam::zero) noexcept
	Construct with zero table capacity. More...

	HashPtrTable (const label initialCapacity)
	Construct given initial table capacity. More...

	HashPtrTable (const this_type &rhs)
	Copy construct, making a copy of each element. More...

	HashPtrTable (this_type &&rhs) noexcept
	Move construct. More...

	HashPtrTable (Istream &is, const INew &inew)
	Construct from Istream using given Istream constructor class. More...

	HashPtrTable (Istream &is)
	Construct from Istream using default Istream constructor class. More...

	HashPtrTable (const dictionary &dict)
	Construct from dictionary with default dictionary constructor class. More...

	~HashPtrTable ()
	Destructor. More...

const IOobject *	test (const word &key) const
	Return const pointer associated with given entry or a nullptr if the key does not exist in the table. More...

const IOobject *	get (const word &key) const
	Return const pointer associated with given entry or a nullptr if the key does not exist in the table. More...

autoPtr< IOobject >	release (iterator &iter)
	Release ownership of the pointer and replace with a nullptr. More...

autoPtr< IOobject >	release (const word &key)
	Release ownership of the pointer and replace with a nullptr. More...

autoPtr< IOobject >	remove (iterator &iter)
	Remove entry specified by given iterator. More...

autoPtr< IOobject >	remove (const word &key)
	Remove entry specified by given key. More...

bool	erase (iterator &iter)
	Erase entry specified by given iterator and delete the allocated pointer. More...

bool	erase (const word &key)
	Erase entry specified by given key and delete the allocated pointer. More...

void	clear ()
	Clear all entries from table and delete any allocated pointers. More...

void	merge (HashPtrTable< IOobject, word, Foam::Hash< word > > &source)
	Attempts to extract entries from source parameter and insert them into `this`, does not overwrite existing entries. The source will contains any items that could not be merged. More...

void	merge (HashPtrTable< IOobject, word, Foam::Hash< word > > &&source)
	Attempts to extract entries from source parameter and insert them into `this`, does not overwrite existing entries. The source will contains any items that could not be merged. More...

void	write (Ostream &os) const
	Invoke write() on each non-null entry. More...

void	operator= (const this_type &rhs)
	Copy assignment. More...

void	operator= (this_type &&rhs)
	Move assignment. More...

bool	emplace (const word &key, Args &&... args)
	Emplace insert a new entry, not overwriting existing entries. More...

IOobject &	emplace_set (const word &key, Args &&... args)
	Emplace set an entry, overwriting any existing entries. More...

IOobject &	try_emplace (const word &key, Args &&... args)
	Like emplace_set() but will not overwrite an occupied (non-null) location. More...

bool	insert (const word &, IOobject *)=delete
	No insert() with raw pointers (potential memory leaks). Use insert() with autoPtr or set() More...

bool	insert (const word &key, std::unique_ptr< IOobject > &&ptr)
	Insert a new entry, not overwriting existing entries. More...

bool	insert (const word &key, autoPtr< IOobject > &&ptr)
	Insert a new entry, not overwriting existing entries. More...

bool	insert (const word &key, autoPtr< IOobject > &ptr)
	Insert a new entry, not overwriting existing entries. More...

bool	set (const word &key, IOobject *ptr)
	Assign a new entry, overwrites existing. More...

bool	set (const word &key, std::unique_ptr< IOobject > &&ptr)
	Assign a new entry, overwrites existing. More...

bool	set (const word &key, autoPtr< IOobject > &&ptr)
	Assign a new entry, overwrites existing. More...

bool	set (const word &key, const refPtr< IOobject > &ptr)
	Assign a new entry from refPtr (move or clone), overwrites existing. More...

bool	set (const word &key, const tmp< IOobject > &ptr)
	Assign a new entry from tmp (move or clone), overwrites existing. More...

bool	set (const word &key, autoPtr< IOobject > &ptr)
	Assign a new entry, overwrites existing. More...

Public Member Functions inherited from HashTable< T, Key, Hash >
	HashTable () noexcept
	Default construct: empty without allocation (capacity=0) More...

	HashTable (const Foam::zero) noexcept
	Construct empty without allocation (capacity=0) More...

	HashTable (const label initialCapacity)
	Construct empty with initial table capacity. More...

	HashTable (Istream &is)
	Construct from Istream. More...

	HashTable (const this_type &ht)
	Copy construct. More...

	HashTable (this_type &&rhs) noexcept
	Move construct. More...

	HashTable (std::initializer_list< std::pair< Key, T >> list)
	Construct from an initializer list. More...

	~HashTable ()
	Destructor. More...

bool	empty () const noexcept
	True if the hash table is empty. More...

label	size () const noexcept
	The number of elements in table. More...

label	capacity () const noexcept
	The size of the underlying table (the number of buckets) More...

T &	at (const Key &key)
	Find and return a hashed entry. FatalError if it does not exist. More...

const T &	at (const Key &key) const
	Find and return a hashed entry. FatalError if it does not exist. More...

bool	contains (const Key &key) const
	True if hashed key is contained (found) in table. More...

iterator	find (const Key &key)
	Find and return an iterator set at the hashed entry. More...

const_iterator	find (const Key &key) const
	Find and return an const_iterator set at the hashed entry. More...

const_iterator	cfind (const Key &key) const
	Find and return an const_iterator set at the hashed entry. More...

const T &	lookup (const Key &key, const T &deflt) const
	Return hashed entry if it exists, or return the given default. More...

List< Key >	toc () const
	The table of contents (the keys) in unsorted order. More...

List< Key >	sortedToc () const
	The table of contents (the keys) in sorted order. More...

template<class Compare >
List< Key >	sortedToc (const Compare &comp) const
	The table of contents (the keys) sorted according to the specified comparator. More...

template<class UnaryPredicate >
List< Key >	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...

template<class UnaryPredicate >
List< Key >	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...

template<class BinaryPredicate >
List< Key >	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...

UPtrList< const node_type >	csorted () 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...

template<class UnaryPredicate >
label	countKeys (const UnaryPredicate &pred, const bool invert=false) const
	Count the number of keys that satisfy the unary predicate. More...

template<class UnaryPredicate >
label	countValues (const UnaryPredicate &pred, const bool invert=false) const
	Count the number of values that satisfy the unary predicate. More...

template<class BinaryPredicate >
label	countEntries (const BinaryPredicate &pred, const bool invert=false) const
	Count the number of entries that satisfy the binary predicate. More...

template<class... Args>
bool	emplace (const Key &key, Args &&... args)
	Emplace insert a new entry, not overwriting existing entries. More...

template<class... Args>
bool	emplace_set (const Key &key, Args &&... args)
	Emplace set an entry, overwriting any existing entries. More...

bool	insert (const Key &key, const T &obj)
	Copy insert a new entry, not overwriting existing entries. More...

bool	insert (const Key &key, T &&obj)
	Move insert a new entry, not overwriting existing entries. More...

bool	set (const Key &key, const T &obj)
	Copy assign a new entry, overwriting existing entries. More...

bool	set (const Key &key, T &&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 Key &key)
	Erase an entry specified by the given key. More...

template<class AnyType , class AnyHash >
label	erase (const HashTable< AnyType, Key, AnyHash > &other)
	Remove table entries given by keys of the other hash-table. More...

label	erase (std::initializer_list< Key > keys)
	Remove table entries given by the listed keys. More...

template<class InputIter >
label	erase (InputIter first, InputIter last)
	Remove multiple entries using an iterator range of keys. More...

template<unsigned N>
label	erase (const FixedList< Key, N > &keys)
	Remove table entries given by the listed keys. More...

label	erase (const UList< Key > &keys)
	Remove table entries given by the listed keys. More...

template<class AnyType , class AnyHash >
label	retain (const HashTable< AnyType, Key, AnyHash > &other)
	Retain table entries given by keys of the other hash-table. More...

template<class UnaryPredicate >
label	filterKeys (const UnaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their keys. More...

template<class UnaryPredicate >
label	filterValues (const UnaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their values. More...

template<class BinaryPredicate >
label	filterEntries (const BinaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their key/value. More...

void	clear ()
	Remove all entries from table. More...

void	clearStorage ()
	Remove all entries from table and the table itself. More...

void	setCapacity (label newCapacity)
	Change the hash table capacity (number of buckets). More...

void	resize (label newCapacity)
	Rehash the hash table with new number of buckets. Currently identical to setCapacity() More...

void	reserve (label numEntries)
	Reserve space for at least the specified number of elements (not the number of buckets) and regenerates the hash table. More...

void	swap (HashTable< T, Key, Hash > &rhs) noexcept
	Swap contents into this table. More...

void	transfer (HashTable< T, Key, Hash > &rhs)
	Transfer contents into this table. More...

void	merge (HashTable< T, Key, Hash > &source)
	Attempts to extract entries from source parameter and insert them into `this`, does not overwrite existing entries. The source will contains any items that could not be merged. More...

void	merge (HashTable< T, Key, Hash > &&source)
	Attempts to extract entries from source parameter and insert them into `this`, does not overwrite existing entries. The source will contains any items that could not be merged. More...

T &	operator[] (const Key &key)
	Find and return a hashed entry. FatalError if it does not exist. More...

const T &	operator[] (const Key &key) const
	Find and return a hashed entry. FatalError if it does not exist. More...

T &	operator() (const Key &key)
	Return existing entry or create a new entry. More...

T &	operator() (const Key &key, const T &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< Key, T >> 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...

bool	found (const Key &key) const
	Same as contains() More...

UPtrList< const node_type >	sorted () const
	Deprecated(2023-07) use csorted() method. More...

template<class Compare >
Foam::List< Key >	sortedToc (const Compare &comp) const

template<class UnaryPredicate >
Foam::List< Key >	tocKeys (const UnaryPredicate &pred, const bool invert) const

template<class UnaryPredicate >
Foam::List< Key >	tocValues (const UnaryPredicate &pred, const bool invert) const

template<class BinaryPredicate >
Foam::List< Key >	tocEntries (const BinaryPredicate &pred, const bool invert) const

template<class UnaryPredicate >
Foam::label	countKeys (const UnaryPredicate &pred, const bool invert) const

template<class UnaryPredicate >
Foam::label	countValues (const UnaryPredicate &pred, const bool invert) const

template<class BinaryPredicate >
Foam::label	countEntries (const BinaryPredicate &pred, const bool invert) const

template<class InputIter>
Foam::label	erase (InputIter first, InputIter last)

template<unsigned N>
Foam::label	erase (const FixedList< Key, N > &keys)

template<class AnyType, class AnyHash >
Foam::label	erase (const HashTable< AnyType, Key, AnyHash > &other)

template<class AnyType , class AnyHash >
Foam::label	retain (const HashTable< AnyType, Key, AnyHash > &other)

template<class UnaryPredicate >
Foam::label	filterKeys (const UnaryPredicate &pred, const bool pruning)

template<class UnaryPredicate >
Foam::label	filterValues (const UnaryPredicate &pred, const bool pruning)

template<class BinaryPredicate >
Foam::label	filterEntries (const BinaryPredicate &pred, const bool pruning)

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 HashPtrTable< IOobject >
typedef HashPtrTable< IOobject, word, Foam::Hash< word > >	this_type
	The template instance used for this table. More...

typedef HashTable< IOobject *, word, Foam::Hash< word > >	parent_type
	The template instance used for the parent HashTable. More...

using	iterator = typename parent_type::iterator

using	const_iterator = typename parent_type::const_iterator

Public Types inherited from HashTable< T, Key, Hash >
typedef HashTable< T, Key, Hash >	this_type
	The template instance used for this HashTable. More...

typedef std::conditional< std::is_same< Foam::zero, typename std::remove_cv< T >::type >::value, Detail::HashTableSingle< Key >, Detail::HashTablePair< Key, T > >::type	node_type
	A table entry (node) that encapsulates the key/val tuple with an additional linked-list entry for hash collisions. More...

typedef Key	key_type
	The second template parameter, type of keys used. More...

typedef T	mapped_type
	The first template parameter, type of objects contained. More...

typedef T	value_type
	Same as mapped_type for OpenFOAM HashTables. More...

typedef Hash	hasher
	The third template parameter, the hash index method. More...

typedef T *	pointer
	Pointer type for storing into value_type objects. More...

typedef T &	reference
	Reference to the stored value_type. More...

typedef const T *	const_pointer
	Const pointer type for the stored value_type. More...

typedef const T &	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 HashTableCore
static label	canonicalSize (const label requested_size)
	Return a canonical (power-of-two) of the requested size. More...

Static Public Attributes inherited from HashTableCore
static const label	maxTableSize
	Maximum allowable internal table size. Approximately labelMax/4. More...

Detailed Description

List of IOobjects with searching and retrieving facilities. Implemented as a HashTable, so the various sorted methods should be used if traversing in parallel.

Source files

Definition at line 55 of file IOobjectList.H.

Constructor & Destructor Documentation

◆ IOobjectList() [1/10]

IOobjectList ( )

defaultnoexcept

Default construct: empty without allocation (capacity=0).

◆ IOobjectList() [2/10]

IOobjectList ( const Foam::zero )

inlineexplicitnoexcept

Construct empty without allocation (capacity=0)

Definition at line 23 of file IOobjectListI.H.

◆ IOobjectList() [3/10]

IOobjectList ( const label initialCapacity )

inlineexplicit

Construct empty with initial table capacity.

Definition at line 29 of file IOobjectListI.H.

◆ IOobjectList() [4/10]

IOobjectList ( const IOobjectList & list )

inline

Copy construct.

Definition at line 35 of file IOobjectListI.H.

◆ IOobjectList() [5/10]

IOobjectList ( IOobjectList && list )

inline

Move construct.

Definition at line 41 of file IOobjectListI.H.

◆ IOobjectList() [6/10]

IOobjectList	(	const objectRegistry &	db,
		const fileName &	instance,
		IOobjectOption	ioOpt
	)

inline

Construct from registry, instance, io options.

Definition at line 48 of file IOobjectListI.H.

◆ IOobjectList() [7/10]

IOobjectList	(	const objectRegistry &	db,
		const fileName &	instance,
		const fileName &	local,
		IOobjectOption	ioOpt
	)

Construct from registry, instance, local, io options.

Definition at line 91 of file IOobjectList.C.

References Foam::endl(), Foam::FatalIOError, Foam::fileHandler, insert(), local, autoPtr< T >::New(), Foam::nl, error::throwing(), and Foam::Warning.

Here is the call graph for this function:

◆ IOobjectList() [8/10]

IOobjectList	(	const objectRegistry &	db,
		const fileName &	instance,
		IOobjectOption::registerOption	registerObject = `IOobjectOption::REGISTER`
	)

inline

Construct from registry, instance, registration option with MUST_READ, NO_WRITE.

Definition at line 59 of file IOobjectListI.H.

◆ IOobjectList() [9/10]

IOobjectList	(	const objectRegistry &	db,
		const fileName &	instance,
		const fileName &	local,
		IOobjectOption::registerOption	registerObject = `IOobjectOption::REGISTER`
	)

inline

Construct from registry, instance, local, registration option with MUST_READ, NO_WRITE.

Definition at line 81 of file IOobjectListI.H.

◆ ~IOobjectList()

~IOobjectList ( )

default

Destructor.

◆ IOobjectList() [10/10]

IOobjectList	(	const objectRegistry &	db,
		const fileName &	instance,
		const fileName &	local,
		IOobjectOption::readOption	rOpt,
		IOobjectOption::writeOption	wOpt = `IOobjectOption::NO_WRITE`,
		bool	registerObject = `true`
	)

inline

Construct from registry, instance, local, io options.

Deprecated:: (2022-11) prefer IOobjectOption or registerOption

Definition at line 981 of file IOobjectList.H.

Member Function Documentation

◆ add() [1/2]

bool add ( autoPtr< IOobject > & objectPtr )

inline

Move insert IOobject into the list.

Definition at line 105 of file IOobjectListI.H.

References insert(), and IOobject::name().

Here is the call graph for this function:

◆ add() [2/2]

bool add ( autoPtr< IOobject > && objectPtr )

inline

Move insert IOobject into the list.

Definition at line 116 of file IOobjectListI.H.

References insert().

Here is the call graph for this function:

◆ remove()

autoPtr<IOobject> remove ( const IOobject & io )

inline

Remove object from the list by its IOobject::name().

Returns: autoPtr<IOobject>

Definition at line 297 of file IOobjectList.H.

References io().

Here is the call graph for this function:

◆ cfindObject() [1/3]

const Foam::IOobject * cfindObject ( const word & objName ) const

Return const pointer to the object found by name.

Returns: IOobject ptr if found else nullptr

Definition at line 146 of file IOobjectList.C.

References Foam::ensightOutput::debug, Foam::endl(), InfoInFunction, and io().

Here is the call graph for this function:

◆ cfindObject() [2/3]

const IOobject* cfindObject ( const word & objName ) const

Return const pointer to the object found by name that also has headerClassName == Type::typeName.

Returns: IOobject ptr if found and the correct type, else nullptr

Note: If Type is void, no headerClassName check is used (always true).

◆ findObject() [1/6]

const Foam::IOobject * findObject ( const word & objName ) const

Return const pointer to the object found by name.

Returns: IOobject ptr if found else nullptr

Definition at line 176 of file IOobjectList.C.

Referenced by Foam::getField(), Foam::lumpedPointTools::lumpedPointPatchList(), Foam::lumpedPointTools::setInterpolators(), and Foam::lumpedPointTools::setPatchControls().

Here is the caller graph for this function:

◆ findObject() [2/6]

const IOobject* findObject ( const word & objName ) const

Return const pointer to the object found by name that also has headerClassName == Type::typeName.

Returns: IOobject ptr if found and the correct type, else nullptr

Note: If Type is void, no headerClassName check is used (always true).

◆ findObject() [3/6]

Foam::IOobject * findObject ( const word & objName )

Return non-const pointer to the object found by name.

Returns: IOobject ptr if found else nullptr

Definition at line 184 of file IOobjectList.C.

◆ findObject() [4/6]

IOobject* findObject ( const word & objName )

Return non-const pointer to the object found by name that also has headerClassName == Type::typeName.

Returns: IOobject ptr if found and the correct type, else nullptr

Note: If Type is void, no headerClassName check is used (always true).

◆ getObject() [1/3]

Foam::IOobject * getObject ( const word & objName ) const

Return non-const pointer to the object found by name, using a const-cast to have it behave like a mutable.

Exercise caution when using.

Returns: IOobject ptr if found else nullptr

Definition at line 190 of file IOobjectList.C.

Referenced by IOobjectList::lookup().

Here is the caller graph for this function:

◆ getObject() [2/3]

IOobject* getObject ( const word & objName ) const

Return non-const pointer to the object found by name that also has headerClassName == Type::typeName, using a const-cast to have it behave like a mutable.

Exercise caution when using.

Returns: IOobject ptr if found and the correct type, else nullptr

Note: If Type is void, no headerClassName check is used (always true).

◆ lookup() [1/4]

IOobjectList lookup ( const MatchPredicate & matchName ) const

The list of IOobjects that have a matching object name.

◆ lookupClass() [1/9]

Foam::IOobjectList lookupClass ( const char * clsName ) const

The list of IOobjects with the given headerClassName.

Definition at line 196 of file IOobjectList.C.

◆ lookupClass() [2/9]

IOobjectList lookupClass ( const MatchPredicate & matchClass ) const

The list of IOobjects with matching headerClassName.

◆ lookupClass() [3/9]

IOobjectList lookupClass	(	const MatchPredicate1 &	matchClass,
		const MatchPredicate2 &	matchName
	)		const

The list of IOobjects with matching headerClassName that also have a matching object name.

◆ lookupClass() [4/9]

IOobjectList lookupClass ( ) const

The list of IOobjects with headerClassName == Type::typeName.

Note: If Type is void, no headerClassName check is used (always true).

◆ lookupClass() [5/9]

IOobjectList lookupClass ( const MatchPredicate & matchName ) const

The list of IOobjects with headerClassName == Type::typeName that also have a matching object name.

◆ classes() [1/3]

Foam::HashTable< Foam::wordHashSet > classes ( ) const

A summary hash of classes used and their associated object names.

The HashTable representation allows us to leverage various HashTable methods. This hashed summary view can be useful when querying particular aspects. For example,

IOobjectList objects(runTime, runTime.timeName());
HashTable<wordHashSet> classes = objects.classes();
// How many volScalarField?
word checkType = volScalarField::typeName;
Info<< checkType << "="
    << (classes.contains(checkType) ? classes[checkType].size() : 0)
    << nl;

Using the two-parameter HashTable::lookup method lets us avoid the '?' ternary, but still looks fairly ugly:

Info<< checkType << "="

<< classes.lookup(checkType, wordHashSet()).size() << nl;

If we have non-const access to the hash table, and don't mind incidentally creating empty entries, we can use the HashTable::operator() directly:

Info<< checkType << "=" << classes(checkType).size() << nl;

Of course, for a single query it would have been easier and simpler to have used a direct query of the names:

Info<< checkType << "=" << objects.names(checkType).size() << nl;

The summary hash, however, becomes most useful when reducing the objects in consideration to a particular subset. For example,

const wordHashSet interestingTypes
{
    volScalarField::typeName,
    volVectorField::typeName
};
classes.retain(interestingTypes);

Or do just the opposite:

classes.erase(unsupportedTypes);

This also works with a hashedWordList, since it provides the expected '()' operator. But in this case the more general HashTable::filterKeys is required:

const hashedWordList interestingTypes
{
    volScalarField::typeName,
    volVectorField::typeName
};
classes.filterKeys(interestingTypes);

Of course, there are many other ways to use and manipulate the summary information.

Returns: HashTable of class-names for keys and wordHashSet of of object-names for the values.

Definition at line 203 of file IOobjectList.C.

Referenced by areaWrite::write().

Here is the caller graph for this function:

◆ classes() [2/3]

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.

◆ cobjects() [1/4]

UPtrList<const IOobject> cobjects ( ) const

The unsorted list of IOobjects with headerClassName == Type::typeName.

Note: If Type is void, no headerClassName check is used (always true). The lifetime of the returned content cannot exceed the parent!

Referenced by lagrangianFieldDecomposer::readFieldFields().

Here is the caller graph for this function:

◆ cobjects() [2/4]

UPtrList<const IOobject> cobjects ( const MatchPredicate & matchName ) const

The unsorted list of IOobjects with headerClassName == Type::typeName that also have a matching object name.

The lifetime of the returned content cannot exceed the parent!

◆ csorted() [1/10]

UPtrList<const IOobject> csorted ( ) const

The sorted list of IOobjects with headerClassName == Type::typeName.

Note: If Type is void, no headerClassName check is used (always true). The lifetime of the returned content cannot exceed the parent!

Here is the caller graph for this function:

◆ csorted() [2/10]

UPtrList<const IOobject> csorted ( const bool syncPar ) const

The sorted names of the IOobjects with optional check for parallel consistency.

FatalError if syncPar = true and names are not consistent on all processors. The lifetime of the returned content cannot exceed the parent!

◆ csorted() [3/10]

UPtrList<const IOobject> csorted ( ) const

inline

The sorted list of IOobjects.

The lifetime of the returned content cannot exceed the parent!

Definition at line 576 of file IOobjectList.H.

◆ csorted() [4/10]

UPtrList<const IOobject> csorted ( const bool syncPar ) const

inline

The sorted list of IOobjects with optional check for parallel consistency.

FatalError if syncPar = true and names are not consistent on all processors. The lifetime of the returned content cannot exceed the parent!

Definition at line 589 of file IOobjectList.H.

◆ csorted() [5/10]

UPtrList<const IOobject> csorted ( const MatchPredicate & matchName ) const

The sorted list of IOobjects with headerClassName == Type::typeName that also have a matching object name.

The lifetime of the returned content cannot exceed the parent!

◆ csorted() [6/10]

UPtrList<const IOobject> csorted	(	const MatchPredicate &	matchName,
		const bool	syncPar
	)		const

The sorted list of IOobjects with headerClassName == Type::typeName that also have a matching object name.

FatalError if syncPar = true and names are not consistent on all processors. The lifetime of the returned content cannot exceed the parent!

◆ count() [1/9]

Foam::label count ( const char * clsName ) const

The number of objects of the given headerClassName.

Note: uses the class type() method

Definition at line 209 of file IOobjectList.C.

References Foam::BitOps::count().

Here is the call graph for this function:

◆ count() [2/9]

label count ( const MatchPredicate & matchClass ) const

The number of objects of the given headerClassName.

◆ count() [3/9]

label count	(	const MatchPredicate1 &	matchClass,
		const MatchPredicate2 &	matchName
	)		const

The number of objects of the given headerClassName that also have a matching object name.

◆ count() [4/9]

label count ( ) const

The number of objects with headerClassName == Type::typeName.

◆ count() [5/9]

label count ( const MatchPredicate & matchName ) const

The number of objects with headerClassName == Type::typeName that also have a matching object name.

Note: If Type is void, no headerClassName check is used (always true).

◆ names() [1/20]

Foam::wordList names ( ) const

The unsorted names of the IOobjects.

Definition at line 218 of file IOobjectList.C.

References HashTable< T *, Key, Hash >::toc().

Referenced by areaWrite::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ names() [2/20]

Foam::wordList names ( const bool syncPar ) const

The sorted names of the IOobjects with optional check for parallel consistency.

FatalError if syncPar = true and names are not consistent on all processors.

Note: Output is always sorted - for consistent serial/parallel behaviour.

Definition at line 224 of file IOobjectList.C.

◆ names() [3/20]

Foam::wordList names ( const char * clsName ) const

The unsorted names of IOobjects with the given headerClassName.

Definition at line 230 of file IOobjectList.C.

References Foam::PtrListOps::names().

Here is the call graph for this function:

◆ names() [4/20]

Foam::wordList names	(	const char *	clsName,
		const bool	syncPar
	)		const

The sorted names of the IOobjects with the given headerClassName.

FatalError if syncPar = true and names are not consistent on all processors.

Note: Output is always sorted - for consistent serial/parallel behaviour.

Definition at line 238 of file IOobjectList.C.

◆ names() [5/20]

wordList names ( const MatchPredicate & matchClass ) const

The unsorted names of IOobjects with the given headerClassName.

◆ names() [6/20]

wordList names	(	const MatchPredicate &	matchClass,
		const bool	syncPar
	)		const

The sorted names of the IOobjects with the given headerClassName.

FatalError if syncPar = true and names are not consistent on all processors.

Note: Output is always sorted - for consistent serial/parallel behaviour.

◆ names() [7/20]

wordList names	(	const MatchPredicate1 &	matchClass,
		const MatchPredicate2 &	matchName
	)		const

The unsorted names of IOobjects with the given headerClassName that also have a matching object name.

◆ names() [8/20]

wordList names	(	const MatchPredicate1 &	matchClass,
		const MatchPredicate2 &	matchName,
		const bool	syncPar
	)		const

The sorted names of the IOobjects with the given headerClassName that also have a matching object name.

FatalError if syncPar = true and names are not consistent on all processors.

Note: Output is always sorted - for consistent serial/parallel behaviour.

◆ names() [9/20]

wordList names ( ) const

The unsorted names of objects with headerClassName == Type::typeName.

◆ names() [10/20]

wordList names ( bool syncPar ) const

The sorted names of objects with headerClassName == Type::typeName.

FatalError if syncPar = true and names are not consistent on all processors.

Note: Output is always sorted - for consistent serial/parallel behaviour.

◆ names() [11/20]

wordList names ( const MatchPredicate & matchName ) const

The unsorted names of objects with headerClassName == Type::typeName and a matching object name.

◆ names() [12/20]

wordList names	(	const MatchPredicate &	matchName,
		const bool	syncPar
	)		const

The sorted names of objects with headerClassName == Type::typeName and a matching object name.

FatalError if syncPar = true and names are not consistent on all processors.

Note: Output is always sorted - for consistent serial/parallel behaviour.

◆ sortedNames() [1/20]

Foam::wordList sortedNames ( ) const

The sorted names of the IOobjects.

Definition at line 250 of file IOobjectList.C.

References HashTable< T *, Key, Hash >::sortedToc().

Referenced by foamToVtkReportFields::print(), Foam::writeAreaFields(), Foam::writeDimFields(), Foam::writePointFields(), and Foam::writeVolFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sortedNames() [2/20]

Foam::wordList sortedNames ( const bool syncPar ) const

The sorted names of the IOobjects with optional check for parallel consistency.

FatalError if syncPar = true and names are not consistent on all processors.

Definition at line 256 of file IOobjectList.C.

◆ sortedNames() [3/20]

Foam::wordList sortedNames ( const char * clsName ) const

The sorted names of IOobjects with the given headerClassName.

Definition at line 265 of file IOobjectList.C.

◆ sortedNames() [4/20]

Foam::wordList sortedNames	(	const char *	clsName,
		const bool	syncPar
	)		const

The sorted names of the IOobjects with the given headerClassName.

FatalError if syncPar = true and names are not consistent on all processors.

Definition at line 273 of file IOobjectList.C.

◆ sortedNames() [5/20]

wordList sortedNames ( const MatchPredicate & matchClass ) const

The sorted names of IOobjects with the given headerClassName.

◆ sortedNames() [6/20]

wordList sortedNames	(	const MatchPredicate &	matchClass,
		const bool	syncPar
	)		const

The sorted names of the IOobjects with the given headerClassName.

FatalError if syncPar = true and names are not consistent on all processors.

◆ sortedNames() [7/20]

wordList sortedNames	(	const MatchPredicate1 &	matchClass,
		const MatchPredicate2 &	matchName
	)		const

The sorted names of IOobjects with the given headerClassName that also have a matching object name.

◆ sortedNames() [8/20]

wordList sortedNames	(	const MatchPredicate1 &	matchClass,
		const MatchPredicate2 &	matchName,
		const bool	syncPar
	)		const

The sorted names of the IOobjects with the given headerClassName that also have a matching object name.

FatalError if syncPar = true and names are not consistent on all processors.

◆ sortedNames() [9/20]

wordList sortedNames ( ) const

The sorted names of objects with headerClassName == Type::typeName.

◆ sortedNames() [10/20]

wordList sortedNames ( bool syncPar ) const

The sorted names of objects with headerClassName == Type::typeName.

FatalError if syncPar = true and names are not consistent on all processors.

◆ sortedNames() [11/20]

wordList sortedNames ( const MatchPredicate & matchName ) const

The sorted names of objects with headerClassName == Type::typeName that also have a matching object name.

◆ sortedNames() [12/20]

wordList sortedNames	(	const MatchPredicate &	matchName,
		const bool	syncPar
	)		const

The sorted names of objects with headerClassName == Type::typeName that also have a matching object name.

FatalError if syncPar = true and names are not consistent on all processors.

◆ filterClasses() [1/2]

label filterClasses	(	const UnaryPredicate &	pred,
		const bool	pruning = `false`
	)

Filter to retain or prune given classes.

Returns: The number of items changed (removed)

◆ filterObjects() [1/2]

label filterObjects	(	const UnaryPredicate &	pred,
		const bool	pruning = `false`
	)

Filter to retain or prune given object names.

Returns: The number of items changed (removed)

◆ prune_0()

Foam::label prune_0 ( )

Remove objects with names ending with "_0" (restart fields)

Returns: The number of items changed (removed)

Definition at line 285 of file IOobjectList.C.

References HashTable< T *, Key, Hash >::filterKeys(), and k.

Here is the call graph for this function:

◆ allNames() [1/3]

Foam::wordList allNames ( ) const

The sorted names of all objects (synchronised across processors)

Definition at line 296 of file IOobjectList.C.

Referenced by lagrangianWriter::writeFields().

Here is the caller graph for this function:

◆ allNames() [2/3]

wordList allNames ( ) const

The sorted names of all objects (synchronised across processors) with headerClassName == Type::typeName.

◆ checkNames()

void checkNames ( const bool syncPar = true ) const

Verify that object names are synchronised across processors.

FatalError if the names are not consistent on all processors.

Definition at line 305 of file IOobjectList.C.

References UPstream::is_parallel().

Here is the call graph for this function:

◆ operator=() [1/2]

void operator= ( const IOobjectList & )

delete

No copy assignment.

◆ operator=() [2/2]

void operator= ( IOobjectList && list )

inline

Move assignment.

Definition at line 129 of file IOobjectListI.H.

◆ lookup() [2/4]

IOobject* lookup ( const char * objName ) const

inline

Deprecated(2018-11) Locate an object by name (c-string). Disambiguated from multiple-lookup version by calling parameter.

Deprecated:: (2018-11) use findObject() for non-ambiguous resolution

Definition at line 1005 of file IOobjectList.H.

References IOobjectList::getObject().

Here is the call graph for this function:

◆ lookup() [3/4]

IOobject* lookup ( const word & objName ) const

inline

Deprecated(2018-11) Locate an object by name (const word&). Disambiguated from multiple-lookup version by calling parameter.

Deprecated:: (2018-11) use findObject() for non-ambiguous resolution

Definition at line 1016 of file IOobjectList.H.

References IOobjectList::getObject().

Here is the call graph for this function:

◆ sorted() [1/6]

UPtrList<const IOobject> sorted ( ) const

inline

Deprecated(2023-07) use csorted() method.

Deprecated:: (2023-07) - use csorted() method

Definition at line 1029 of file IOobjectList.H.

◆ sorted() [2/6]

UPtrList<const IOobject> sorted ( const bool syncPar ) const

inline

Deprecated(2023-07) use csorted() method.

Deprecated:: (2023-07) - use csorted() method

Definition at line 1041 of file IOobjectList.H.

◆ sorted() [3/6]

UPtrList<const IOobject> sorted ( ) const

inline

Deprecated(2023-07) use csorted() method.

Deprecated:: (2023-07) - use csorted() method

Definition at line 1052 of file IOobjectList.H.

◆ sorted() [4/6]

UPtrList<const IOobject> sorted ( const bool syncPar ) const

inline

Deprecated(2023-07) use csorted() method.

Deprecated:: (2023-07) - use csorted() method

Definition at line 1063 of file IOobjectList.H.

◆ sorted() [5/6]

UPtrList<const IOobject> sorted ( const MatchPredicate & matchName ) const

inline

Deprecated(2023-07) use csorted() method.

Deprecated:: (2023-07) - use csorted() method

Definition at line 1075 of file IOobjectList.H.

◆ sorted() [6/6]

UPtrList<const IOobject> sorted	(	const MatchPredicate &	matchName,
		const bool	syncPar
	)		const

inline

Deprecated(2023-07) use csorted() method.

Deprecated:: (2023-07) - use csorted() method

Definition at line 1088 of file IOobjectList.H.

◆ classesImpl()

Foam::HashTable<Foam::wordHashSet> classesImpl	(	const IOobjectList &	list,
		const MatchPredicate &	matchName
	)

Definition at line 29 of file IOobjectListTemplates.C.

References forAllConstIters(), insert(), io(), Foam::glTF::key(), and HashTable< T, Key, Hash >::size().

Here is the call graph for this function:

◆ countImpl()

Foam::label countImpl	(	const IOobjectList &	list,
		const MatchPredicate1 &	matchClass,
		const MatchPredicate2 &	matchName
	)

Definition at line 56 of file IOobjectListTemplates.C.

References Foam::BitOps::count(), forAllConstIters(), and io().

Here is the call graph for this function:

◆ countTypeImpl()

Foam::label countTypeImpl	(	const IOobjectList &	list,
		const MatchPredicate &	matchName
	)

Definition at line 81 of file IOobjectListTemplates.C.

References Foam::BitOps::count(), forAllConstIters(), and io().

Here is the call graph for this function:

◆ namesImpl()

Foam::wordList namesImpl	(	const IOobjectList &	list,
		const MatchPredicate1 &	matchClass,
		const MatchPredicate2 &	matchName,
		const bool	doSort
	)

Definition at line 105 of file IOobjectListTemplates.C.

References Foam::BitOps::count(), forAllConstIters(), io(), Foam::glTF::key(), HashTable< T, Key, Hash >::size(), and Foam::sort().

Here is the call graph for this function:

◆ namesTypeImpl()

Foam::wordList namesTypeImpl	(	const IOobjectList &	list,
		const MatchPredicate &	matchName,
		const bool	doSort
	)

Definition at line 141 of file IOobjectListTemplates.C.

References Foam::BitOps::count(), forAllConstIters(), io(), Foam::glTF::key(), HashTable< T, Key, Hash >::size(), and Foam::sort().

Here is the call graph for this function:

◆ objectsTypeImpl()

Foam::UPtrList<const Foam::IOobject> objectsTypeImpl	(	const IOobjectList &	list,
		const MatchPredicate &	matchName,
		const bool	doSort
	)

Definition at line 177 of file IOobjectListTemplates.C.

References Foam::BitOps::count(), forAllConstIters(), io(), Foam::glTF::key(), HashTable< T, Key, Hash >::size(), and Foam::sort().

Here is the call graph for this function:

◆ lookupImpl()

Foam::IOobjectList lookupImpl	(	const IOobjectList &	list,
		const MatchPredicate &	matchName
	)

Definition at line 212 of file IOobjectListTemplates.C.

References Foam::ensightOutput::debug, Foam::endl(), forAllConstIters(), InfoInFunction, io(), Foam::glTF::key(), and HashTable< T, Key, Hash >::size().

Here is the call graph for this function:

◆ lookupClassImpl()

Foam::IOobjectList lookupClassImpl	(	const IOobjectList &	list,
		const MatchPredicate1 &	matchClass,
		const MatchPredicate2 &	matchName
	)

Definition at line 242 of file IOobjectListTemplates.C.

References Foam::ensightOutput::debug, Foam::endl(), forAllConstIters(), InfoInFunction, io(), Foam::glTF::key(), and HashTable< T, Key, Hash >::size().

Here is the call graph for this function:

◆ lookupClassTypeImpl()

Foam::IOobjectList lookupClassTypeImpl	(	const IOobjectList &	list,
		const MatchPredicate &	matchName
	)

Definition at line 273 of file IOobjectListTemplates.C.

References Foam::ensightOutput::debug, Foam::endl(), forAllConstIters(), InfoInFunction, io(), Foam::glTF::key(), and HashTable< T, Key, Hash >::size().

Here is the call graph for this function:

◆ cfindObject() [3/3]

const Foam::IOobject* cfindObject ( const word & objName ) const

Definition at line 304 of file IOobjectListTemplates.C.

References Foam::ensightOutput::debug, Foam::endl(), InfoInFunction, and io().

Here is the call graph for this function:

◆ findObject() [5/6]

const Foam::IOobject* findObject ( const word & objName ) const

Definition at line 348 of file IOobjectListTemplates.C.

◆ findObject() [6/6]

Foam::IOobject* findObject ( const word & objName )

Definition at line 357 of file IOobjectListTemplates.C.

◆ getObject() [3/3]

Foam::IOobject* getObject ( const word & objName ) const

Definition at line 364 of file IOobjectListTemplates.C.

◆ lookup() [4/4]

Foam::IOobjectList lookup ( const MatchPredicate & matchName ) const

Definition at line 372 of file IOobjectListTemplates.C.

◆ lookupClass() [6/9]

Foam::IOobjectList lookupClass ( const MatchPredicate & matchClass ) const

Definition at line 382 of file IOobjectListTemplates.C.

◆ lookupClass() [7/9]

Foam::IOobjectList lookupClass	(	const MatchPredicate1 &	matchClass,
		const MatchPredicate2 &	matchName
	)		const

Definition at line 392 of file IOobjectListTemplates.C.

◆ lookupClass() [8/9]

Foam::IOobjectList lookupClass ( ) const

Definition at line 402 of file IOobjectListTemplates.C.

◆ lookupClass() [9/9]

Foam::IOobjectList lookupClass ( const MatchPredicate & matchName ) const

Definition at line 410 of file IOobjectListTemplates.C.

◆ classes() [3/3]

Foam::HashTable<Foam::wordHashSet> classes ( const MatchPredicate & matchName ) const

Definition at line 421 of file IOobjectListTemplates.C.

◆ count() [6/9]

Foam::label count ( const MatchPredicate & matchClass ) const

Definition at line 431 of file IOobjectListTemplates.C.

◆ count() [7/9]

Foam::label count	(	const MatchPredicate1 &	matchClass,
		const MatchPredicate2 &	matchName
	)		const

Definition at line 441 of file IOobjectListTemplates.C.

◆ count() [8/9]

Foam::label count ( ) const

Definition at line 451 of file IOobjectListTemplates.C.

◆ count() [9/9]

Foam::label count ( const MatchPredicate & matchName ) const

Definition at line 459 of file IOobjectListTemplates.C.

◆ cobjects() [3/4]

Foam::UPtrList<const Foam::IOobject> cobjects ( ) const

Definition at line 472 of file IOobjectListTemplates.C.

◆ csorted() [7/10]

Foam::UPtrList<const Foam::IOobject> csorted ( ) const

Definition at line 481 of file IOobjectListTemplates.C.

◆ csorted() [8/10]

Foam::UPtrList<const Foam::IOobject> csorted ( const bool syncPar ) const

Definition at line 490 of file IOobjectListTemplates.C.

◆ cobjects() [4/4]

Foam::UPtrList<const Foam::IOobject> cobjects ( const MatchPredicate & matchName ) const

Definition at line 507 of file IOobjectListTemplates.C.

◆ csorted() [9/10]

Foam::UPtrList<const Foam::IOobject> csorted ( const MatchPredicate & matchName ) const

Definition at line 519 of file IOobjectListTemplates.C.

◆ csorted() [10/10]

Foam::UPtrList<const Foam::IOobject> csorted	(	const MatchPredicate &	matchName,
		const bool	syncPar
	)		const

Definition at line 531 of file IOobjectListTemplates.C.

◆ names() [13/20]

Foam::wordList names ( const MatchPredicate & matchClass ) const

Definition at line 552 of file IOobjectListTemplates.C.

◆ names() [14/20]

Foam::wordList names	(	const MatchPredicate &	matchClass,
		const bool	syncPar
	)		const

Definition at line 563 of file IOobjectListTemplates.C.

◆ names() [15/20]

Foam::wordList names	(	const MatchPredicate1 &	matchClass,
		const MatchPredicate2 &	matchName
	)		const

Definition at line 574 of file IOobjectListTemplates.C.

◆ names() [16/20]

Foam::wordList names	(	const MatchPredicate1 &	matchClass,
		const MatchPredicate2 &	matchName,
		const bool	syncPar
	)		const

Definition at line 586 of file IOobjectListTemplates.C.

◆ names() [17/20]

Foam::wordList names ( ) const

Definition at line 597 of file IOobjectListTemplates.C.

◆ names() [18/20]

Foam::wordList names ( const bool syncPar ) const

Definition at line 605 of file IOobjectListTemplates.C.

◆ names() [19/20]

Foam::wordList names ( const MatchPredicate & matchName ) const

Definition at line 613 of file IOobjectListTemplates.C.

◆ names() [20/20]

Foam::wordList names	(	const MatchPredicate &	matchName,
		const bool	syncPar
	)		const

Definition at line 624 of file IOobjectListTemplates.C.

◆ sortedNames() [13/20]

Foam::wordList sortedNames ( const MatchPredicate & matchClass ) const

Definition at line 637 of file IOobjectListTemplates.C.

◆ sortedNames() [14/20]

Foam::wordList sortedNames	(	const MatchPredicate &	matchClass,
		const bool	syncPar
	)		const

Definition at line 647 of file IOobjectListTemplates.C.

◆ sortedNames() [15/20]

Foam::wordList sortedNames	(	const MatchPredicate1 &	matchClass,
		const MatchPredicate2 &	matchName
	)		const

Definition at line 664 of file IOobjectListTemplates.C.

◆ sortedNames() [16/20]

Foam::wordList sortedNames	(	const MatchPredicate1 &	matchClass,
		const MatchPredicate2 &	matchName,
		const bool	syncPar
	)		const

Definition at line 675 of file IOobjectListTemplates.C.

◆ sortedNames() [17/20]

Foam::wordList sortedNames ( ) const

Definition at line 689 of file IOobjectListTemplates.C.

◆ sortedNames() [18/20]

Foam::wordList sortedNames ( const bool syncPar ) const

Definition at line 696 of file IOobjectListTemplates.C.

◆ sortedNames() [19/20]

Foam::wordList sortedNames ( const MatchPredicate & matchName ) const

Definition at line 707 of file IOobjectListTemplates.C.

◆ sortedNames() [20/20]

Foam::wordList sortedNames	(	const MatchPredicate &	matchName,
		const bool	syncPar
	)		const

Definition at line 717 of file IOobjectListTemplates.C.

◆ filterClasses() [2/2]

Foam::label filterClasses	(	const UnaryPredicate &	pred,
		const bool	pruning
	)

Definition at line 733 of file IOobjectListTemplates.C.

References stdFoam::begin(), stdFoam::end(), and erase().

Here is the call graph for this function:

◆ filterObjects() [2/2]

Foam::label filterObjects	(	const UnaryPredicate &	pred,
		const bool	pruning
	)

Definition at line 770 of file IOobjectListTemplates.C.

References stdFoam::begin(), stdFoam::end(), and erase().

Here is the call graph for this function:

◆ allNames() [3/3]

Foam::wordList allNames ( ) const

Definition at line 802 of file IOobjectListTemplates.C.

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

src/OpenFOAM/db/IOobjectList/IOobjectList.H
src/OpenFOAM/db/IOobjectList/IOobjectList.C
src/OpenFOAM/db/IOobjectList/IOobjectListI.H
src/OpenFOAM/db/IOobjectList/IOobjectListTemplates.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IOobjectList() [1/10]

◆ IOobjectList() [2/10]

◆ IOobjectList() [3/10]

◆ IOobjectList() [4/10]

◆ IOobjectList() [5/10]

◆ IOobjectList() [6/10]

◆ IOobjectList() [7/10]

◆ IOobjectList() [8/10]

◆ IOobjectList() [9/10]

◆ ~IOobjectList()

◆ IOobjectList() [10/10]

Member Function Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ remove()

◆ cfindObject() [1/3]

◆ cfindObject() [2/3]

◆ findObject() [1/6]

◆ findObject() [2/6]

◆ findObject() [3/6]

◆ findObject() [4/6]

◆ getObject() [1/3]

◆ getObject() [2/3]

◆ lookup() [1/4]

◆ lookupClass() [1/9]

◆ lookupClass() [2/9]

◆ lookupClass() [3/9]

◆ lookupClass() [4/9]

◆ lookupClass() [5/9]

◆ classes() [1/3]

◆ classes() [2/3]

◆ cobjects() [1/4]

◆ cobjects() [2/4]

◆ csorted() [1/10]

◆ csorted() [2/10]

◆ csorted() [3/10]

◆ csorted() [4/10]

◆ csorted() [5/10]

◆ csorted() [6/10]

◆ count() [1/9]

◆ count() [2/9]

◆ count() [3/9]

◆ count() [4/9]

◆ count() [5/9]

◆ names() [1/20]

◆ names() [2/20]

◆ names() [3/20]

◆ names() [4/20]

◆ names() [5/20]

◆ names() [6/20]

◆ names() [7/20]

◆ names() [8/20]

◆ names() [9/20]

◆ names() [10/20]

◆ names() [11/20]

◆ names() [12/20]

◆ sortedNames() [1/20]

◆ sortedNames() [2/20]

◆ sortedNames() [3/20]

◆ sortedNames() [4/20]

◆ sortedNames() [5/20]

◆ sortedNames() [6/20]

◆ sortedNames() [7/20]

◆ sortedNames() [8/20]

◆ sortedNames() [9/20]

◆ sortedNames() [10/20]

◆ sortedNames() [11/20]

◆ sortedNames() [12/20]

◆ filterClasses() [1/2]

◆ filterObjects() [1/2]

◆ prune_0()

◆ allNames() [1/3]

◆ allNames() [2/3]

◆ checkNames()

◆ operator=() [1/2]

◆ operator=() [2/2]