regionProperties Class Reference

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 components. More...
 
 regionProperties (const regionProperties &)=delete
 Disallow default bitwise copy construction. More...
 
 ~regionProperties ()
 Destructor. More...
 
void operator= (const regionProperties &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from HashTable< wordList >
bool set (const word &, const wordList &newElmt)
 Assign a new hashedEntry, overwriting existing entries. More...
 
 HashTable (const label size=128)
 Construct given initial table size. More...
 
 HashTable (Istream &, const label size=128)
 Construct from Istream. More...
 
 HashTable (const HashTable< wordList, word, string::hash > &)
 Copy constructor. More...
 
 HashTable (HashTable< wordList, word, string::hash > &&)
 Move constructor. More...
 
 HashTable (std::initializer_list< Tuple2< word, wordList >>)
 Construct from an initialiser list. More...
 
 ~HashTable ()
 Destructor. More...
 
label capacity () const
 The size of the underlying table. More...
 
label size () const
 Return number of elements in table. More...
 
bool empty () const
 Return true if the hash table is empty. More...
 
bool found (const word &) const
 Return true if hashedEntry is found in table. More...
 
iterator find (const word &)
 Find and return an iterator set at the hashedEntry. More...
 
const_iterator find (const word &) const
 Find and return an const_iterator set at the hashedEntry. More...
 
List< wordtoc () const
 Return the table of contents. More...
 
List< wordsortedToc () const
 Return the table of contents as a sorted list. More...
 
OstreamprintInfo (Ostream &) const
 Print information. More...
 
bool insert (const word &, const wordList &newElmt)
 Insert a new hashedEntry. More...
 
bool erase (const iterator &)
 Erase a hashedEntry specified by given iterator. More...
 
bool erase (const word &)
 Erase a hashedEntry specified by the given key. More...
 
label erase (const UList< word > &)
 Remove entries given by the listed keys from this HashTable. More...
 
label erase (const HashTable< AnyType, word, AnyHash > &)
 Remove entries given by the given keys from this HashTable. More...
 
Foam::label erase (const HashTable< AnyType, word, AnyHash > &rhs)
 
void resize (const label newSize)
 Resize the hash table for efficiency. More...
 
void clear ()
 Clear all entries from table. More...
 
void clearStorage ()
 Clear the table entries and the table itself. More...
 
void shrink ()
 Shrink the allocated table to approx. twice number of elements. More...
 
void transfer (HashTable< wordList, word, string::hash > &)
 Transfer the contents of the argument table into this table. More...
 
wordListoperator[] (const word &)
 Find and return a hashedEntry. More...
 
const wordListoperator[] (const word &) const
 Find and return a hashedEntry. More...
 
wordListoperator() (const word &)
 Find and return a hashedEntry, create it null if not present. More...
 
void operator= (const HashTable< wordList, word, string::hash > &)
 Assignment operator. More...
 
void operator= (HashTable< wordList, word, string::hash > &&)
 Move assignment operator. More...
 
void operator= (std::initializer_list< Tuple2< word, wordList >>)
 Assignment to an initialiser list. More...
 
bool operator== (const HashTable< wordList, word, string::hash > &) const
 Equality. Hash tables are equal if the keys and values are equal. More...
 
bool operator!= (const HashTable< wordList, word, string::hash > &) const
 The opposite of the equality operation. Takes linear time. More...
 
iterator begin ()
 Iterator set to the beginning of the HashTable. More...
 
const_iterator begin () const
 const_iterator set to the beginning of the HashTable More...
 
const_iterator cbegin () const
 const_iterator set to the beginning of the HashTable More...
 
- Public Member Functions inherited from HashTableCore
 HashTableCore ()
 Construct null. More...
 
 ClassName ("HashTable")
 Define template name and debug. More...
 

Additional Inherited Members

- Public Types inherited from HashTable< wordList >
typedef wordList value_type
 Type of values the HashTable contains. More...
 
typedef wordListreference
 Type that can be used for storing into HashTable::value_type. More...
 
typedef const wordListconst_reference
 Type that can be used for storing into constant. More...
 
typedef label size_type
 The type that can represent the size of a HashTable. More...
 
- Static Public Member Functions inherited from HashTableCore
static label canonicalSize (const label)
 Return a canonical (power-of-two) size. More...
 
static iteratorEnd cend ()
 iteratorEnd set to beyond the end of any HashTable More...
 
static iteratorEnd end ()
 iteratorEnd set to beyond the end of any HashTable More...
 
- Static Public Attributes inherited from HashTableCore
static const label maxTableSize
 Maximum allowable table size. 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 one region should only have one set of physics.

Source files

Definition at line 53 of file regionProperties.H.

Constructor & Destructor Documentation

◆ regionProperties() [1/2]

regionProperties ( const Time runTime)

Construct from components.

Definition at line 33 of file regionProperties.C.

◆ regionProperties() [2/2]

regionProperties ( const regionProperties )
delete

Disallow default bitwise copy construction.

◆ ~regionProperties()

Destructor.

Definition at line 54 of file regionProperties.C.

Member Function Documentation

◆ operator=()

void operator= ( const regionProperties )
delete

Disallow default bitwise assignment.


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