Opm::RegionAttributeHelpers::RegionAttributes< RegionId, Attributes > Class Template Reference

Provide mapping from Region IDs to user-specified collection of per-region attributes. More...

#include <RegionAttributeHelpers.hpp>

Classes
struct	Value
	Aggregate per-region attributes along with region's representative cell. More...

Public Types
using	RegionID
	Expose RegionId as a vocabulary type for use in query methods.
using	ID
using	AttributeMap

Public Member Functions
template<class RMap>
	RegionAttributes (const RMap &rmap, const Attributes &attr)
	Constructor.
int	cell (const RegionID reg) const
	Retrieve representative cell in region.
bool	has (const RegionID reg) const
void	insert (const RegionID r, const Attributes &attr)
const AttributeMap &	attributes () const
	Request read-only access to region's attributes.
const Attributes &	attributes (const RegionID reg) const
	Request read-only access to region's attributes.
Attributes &	attributes (const RegionID reg)
	Request modifiable access to region's attributes.

Detailed Description

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.

Member Typedef Documentation

AttributeMap

template<typename RegionId, class Attributes>

using Opm::RegionAttributeHelpers::RegionAttributes< RegionId, Attributes >::AttributeMap

Initial value:

ID

template<typename RegionId, class Attributes>

using Opm::RegionAttributeHelpers::RegionAttributes< RegionId, Attributes >::ID

Initial value:

RegionID

template<typename RegionId, class Attributes>

using Opm::RegionAttributeHelpers::RegionAttributes< RegionId, Attributes >::RegionID

Initial value:

Expose RegionId as a vocabulary type for use in query methods.

Constructor & Destructor Documentation

RegionAttributes()

template<typename RegionId, class Attributes>

template<class RMap>

Opm::RegionAttributeHelpers::RegionAttributes< RegionId, Attributes >::RegionAttributes ( const RMap & rmap, const Attributes & attr )

inline

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.

Member Function Documentation

attributes() [1/3]

template<typename RegionId, class Attributes>

const AttributeMap & Opm::RegionAttributeHelpers::RegionAttributes< RegionId, Attributes >::attributes ( ) const

inline

Request read-only access to region's attributes.

Returns

Read-only access to all regions attributes.

attributes() [2/3]

template<typename RegionId, class Attributes>

Attributes & Opm::RegionAttributeHelpers::RegionAttributes< RegionId, Attributes >::attributes ( const RegionID reg )

inline

Request modifiable access to region's attributes.

Parameters

[in]

reg

Specific region.

Returns

Read-write access to region reg's per-region attributes.

attributes() [3/3]

template<typename RegionId, class Attributes>

const Attributes & Opm::RegionAttributeHelpers::RegionAttributes< RegionId, Attributes >::attributes ( const RegionID reg ) const

inline

Request read-only access to region's attributes.

Parameters

[in]

reg

Specific region.

Returns

Read-only access to region reg's per-region attributes.

cell()

template<typename RegionId, class Attributes>

int Opm::RegionAttributeHelpers::RegionAttributes< RegionId, Attributes >::cell ( const RegionID reg ) const

inline

Retrieve representative cell in region.

Parameters

[in]

reg

Specific region.

Returns

Representative cell in region reg.

---

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

• opm/simulators/wells/RegionAttributeHelpers.hpp