Provide mapping from Region IDs to user-specified collection of per-region attributes.
More...
#include <RegionAttributeHelpers.hpp>
|
struct | Value |
| Aggregate per-region attributes along with region's representative cell. More...
|
|
|
using | RegionID = typename Select::RegionIDParameter< RegionId, std::is_integral< RegionId >::value >::type |
| Expose RegionId as a vocabulary type for use in query methods.
|
|
using | ID = typename std::remove_reference< RegionId >::type |
|
using | AttributeMap = std::unordered_map< ID, std::unique_ptr< Value > > |
|
template<typename RegionId, class Attributes>
class Opm::RegionAttributeHelpers::RegionAttributes< RegionId, Attributes >
Provide mapping from Region IDs to user-specified collection of per-region attributes.
- Template Parameters
-
RegionId | Region identifier type. Must be hashable by . Typically a built-in integer type–e.g., int . |
Attributes | User-defined type that represents collection of attributes that have meaning in a per-region aggregate sense. Must be copy-constructible. |
◆ RegionAttributes()
template<typename RegionId , class Attributes >
template<class RMap >
Constructor.
- Template Parameters
-
RMap | Class type that implements the RegionMapping protocol. Typically an instantiation of. |
- Parameters
-
[in] | rmap | Specific region mapping that provides reverse lookup from regions to cells. |
[in] | attr | Pre-constructed initialiser for Attributes . |
◆ attributes() [1/3]
template<typename RegionId , class Attributes >
Request read-only access to region's attributes.
- Returns
- Read-only access to all regions attributes.
◆ attributes() [2/3]
template<typename RegionId , class Attributes >
Request modifiable access to region's attributes.
- Parameters
-
- Returns
- Read-write access to region
reg's
per-region attributes.
◆ attributes() [3/3]
template<typename RegionId , class Attributes >
Request read-only access to region's attributes.
- Parameters
-
- Returns
- Read-only access to region
reg's
per-region attributes.
◆ cell()
template<typename RegionId , class Attributes >
Retrieve representative cell in region.
- Parameters
-
- Returns
- Representative cell in region
reg
.
The documentation for this class was generated from the following file: