Simple class to hold region information for coupled region simulations. More...

Inheritance diagram for regionProperties:

Collaboration diagram for regionProperties:

Public Member Functions
	regionProperties (const Time &runTime)
	Construct from Time. More...

	regionProperties (const Time &runTime, IOobjectOption::readOption rOpt)
	Construct from Time with specified read option. More...

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

label	count () const
	Total count of all region names. More...

wordList	names () const
	The region names. Sorted by region type. More...

wordList	sortedNames () const
	The region names in sorted order. More...

Public Member Functions inherited from HashTable< wordList >
	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< word, wordList >> list, const bool overwrite=false)
	Construct from key/value pairs in initializer list. More...

	HashTable (const UList< word > &keys, const UList< wordList > &values, const bool overwrite=false)
	Construct from key/value pairs. 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...

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

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

bool	contains (const word &key) const
	True if hashed key is contained (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 wordList &	lookup (const word &key, const wordList &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< node_type >	sorted ()
	Non-const access to the hash-table contents in sorted order (sorted by keys). More...

UPtrList< const node_type >	sorted () const
	Deprecated(2023-07) use csorted() method. 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 wordList &obj)
	Copy insert a new entry, not overwriting existing entries. More...

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

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

bool	set (const word &key, wordList &&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	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< wordList, word, Foam::Hash< word > > &rhs) noexcept
	Swap contents into this table. More...

void	transfer (HashTable< wordList, word, Foam::Hash< word > > &rhs)
	Transfer contents into this table. More...

void	merge (HashTable< wordList, 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 (HashTable< wordList, 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...

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

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

wordList &	operator() (const word &key)
	Return existing entry or create a new entry. More...

wordList &	operator() (const word &key, const wordList &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, wordList >> 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 word &key) const
	Same as contains() 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 HashTable< wordList >
typedef HashTable< wordList, word, Foam::Hash< word > >	this_type
	The template instance used for this HashTable. More...

typedef std::conditional< std::is_same< Foam::zero, typename std::remove_cv< wordList >::type >::value, Detail::HashTableSingle< word >, Detail::HashTablePair< word, wordList > >::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 wordList	mapped_type
	The first template parameter, type of objects contained. More...

typedef wordList	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 wordList *	pointer
	Pointer type for storing into value_type objects. More...

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

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

typedef const wordList &	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

Simple class to hold region information for coupled region simulations.

Gives per physics ('fluid', 'solid') the names of the regions. There is no assumption on this level that a region should only have a single set of physics.

Source files

Definition at line 56 of file regionProperties.H.