Opm::RateConverter::Details::RegionAttributes< RegionId, Attributes > Class Template Reference

#include <RateConverter.hpp>

Public Types
using	RegionID = typename Select::RegionIDParameter< RegionId, std::is_integral< RegionId >::value >::type

Public Member Functions
template<class RMap >
	RegionAttributes (const RMap &rmap, const Attributes &attr)
int	cell (const RegionID reg) const
const Attributes &	attributes (const RegionID reg) const
Attributes &	attributes (const RegionID reg)

Detailed Description

template<typename RegionId, class Attributes>
class Opm::RateConverter::Details::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 std::hash<> . 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

template<typename RegionId , class Attributes >

using Opm::RateConverter::Details::RegionAttributes< RegionId, Attributes >::RegionID = typename Select::RegionIDParameter <RegionId, std::is_integral<RegionId>::value>::type

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

Constructor & Destructor Documentation

template<typename RegionId , class Attributes >

template<class RMap >

Opm::RateConverter::Details::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 Opm::RegionMapping<> .

Parameters

[in]	rmap	Specific region mapping that provides reverse lookup from regions to cells.
[in]	attr	Pre-constructed initialiser for Attributes.

Member Function Documentation

template<typename RegionId , class Attributes >

const Attributes& Opm::RateConverter::Details::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.

template<typename RegionId , class Attributes >

Attributes& Opm::RateConverter::Details::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.

template<typename RegionId , class Attributes >

int Opm::RateConverter::Details::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:

• RateConverter.hpp