Opm::RegionAttributeHelpers::PhasePos Namespace Reference

Functions
int	water (const PhaseUsage &pu)
int	oil (const PhaseUsage &pu)
int	gas (const PhaseUsage &pu)

Detailed Description

Convenience functions for querying numerical IDs ("positions") of active phases.

Function Documentation

gas()

int Opm::RegionAttributeHelpers::PhasePos::gas ( const PhaseUsage &  pu )

inline

Numerical ID of active gas phase.

Parameters

[in]

pu

Active phase object.

Returns

Non-negative index/position of gas if active, -1 if not.

References Opm::RegionAttributeHelpers::PhaseUsed::gas(), Opm::PhaseUsage::phase_pos, and Opm::BlackoilPhases::Vapour.

oil()

int Opm::RegionAttributeHelpers::PhasePos::oil ( const PhaseUsage &  pu )

inline

Numerical ID of active oil phase.

Parameters

[in]

pu

Active phase object.

Returns

Non-negative index/position of oil if active, -1 if not.

References Opm::BlackoilPhases::Liquid, Opm::RegionAttributeHelpers::PhaseUsed::oil(), and Opm::PhaseUsage::phase_pos.

water()

int Opm::RegionAttributeHelpers::PhasePos::water ( const PhaseUsage &  pu )

inline

Numerical ID of active water phase.

Parameters

[in]

pu

Active phase object.

Returns

Non-negative index/position of water if active, -1 if not.

References Opm::BlackoilPhases::Aqua, Opm::PhaseUsage::phase_pos, and Opm::RegionAttributeHelpers::PhaseUsed::water().