walberla::domain_decomposition::IBlockID Class Referenceabstract
Detailed Description
Interface/base class for block IDs (unique identifiers for blocks)
Just as 'IBlock' serves as a base class for all blocks and 'BlockStorage' serves as a base class for all data structures that manage these blocks, 'IBlockID' serves as a base class for all block IDs. The single purpose of block IDs is to uniquely identify blocks within their corresponding block structure (see class 'BlockStorage').
#include <IBlockID.h>
Inheritance diagram for walberla::domain_decomposition::IBlockID:
Public Types | |
| using | IDType = uint64_t |
| ID type which can be used as a key in a map. More... | |
Public Member Functions | |
| virtual | ~IBlockID ()=default |
| virtual bool | operator< (const IBlockID &rhs) const =0 |
| virtual bool | operator== (const IBlockID &rhs) const =0 |
| virtual bool | operator!= (const IBlockID &rhs) const =0 |
| virtual IDType | getID () const =0 |
| returns a somehow simplified ID which can be used in maps More... | |
| virtual std::ostream & | toStream (std::ostream &os) const =0 |
Member Typedef Documentation
◆ IDType
ID type which can be used as a key in a map.
Constructor & Destructor Documentation
◆ ~IBlockID()
|
virtualdefault |
Member Function Documentation
◆ getID()
|
pure virtual |
returns a somehow simplified ID which can be used in maps
Implemented in walberla::blockforest::BlockID.
◆ operator!=()
|
pure virtual |
Implemented in walberla::blockforest::BlockID.
◆ operator<()
|
pure virtual |
Implemented in walberla::blockforest::BlockID.
◆ operator==()
|
pure virtual |
Implemented in walberla::blockforest::BlockID.
◆ toStream()
|
pure virtual |
Implemented in walberla::blockforest::BlockID.
The documentation for this class was generated from the following file:
- /builds/administration/walberla-website/walberla/src/domain_decomposition/IBlockID.h