Opm::RegionAttributeHelpers::PhaseUsed Namespace Reference

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

Detailed Description

Convenience functions for querying presence/absence of active phases.

Function Documentation

gas()

bool Opm::RegionAttributeHelpers::PhaseUsed::gas ( const PhaseUsage &  pu )

inline

Active gas predicate.

Parameters

[in]

pu

Active phase object.

Returns

Whether or not gas is an active phase.

References Opm::PhaseUsage::phase_used, and Opm::BlackoilPhases::Vapour.

Referenced by Opm::RateConverter::SurfaceToReservoirVoidage< FluidSystem, Region >::defineState(), Opm::RegionAverageCalculator::AverageRegionalPressure< FluidSystem, Region >::defineState(), Opm::RegionAttributeHelpers::PhasePos::gas(), and Opm::GasLiftSingleWellGeneric< Scalar >::BasicRates::operator[]().

oil()

bool Opm::RegionAttributeHelpers::PhaseUsed::oil ( const PhaseUsage &  pu )

inline

Active oil predicate.

Parameters

[in]

pu

Active phase object.

Returns

Whether or not oil is an active phase.

References Opm::BlackoilPhases::Liquid, and Opm::PhaseUsage::phase_used.

Referenced by Opm::RateConverter::SurfaceToReservoirVoidage< FluidSystem, Region >::defineState(), Opm::RegionAverageCalculator::AverageRegionalPressure< FluidSystem, Region >::defineState(), Opm::RegionAttributeHelpers::PhasePos::oil(), and Opm::GasLiftSingleWellGeneric< Scalar >::BasicRates::operator[]().

water()

bool Opm::RegionAttributeHelpers::PhaseUsed::water ( const PhaseUsage &  pu )

inline

Active water predicate.

Parameters

[in]

pu

Active phase object.

Returns

Whether or not water is an active phase.

References Opm::BlackoilPhases::Aqua, and Opm::PhaseUsage::phase_used.

Referenced by Opm::RateConverter::SurfaceToReservoirVoidage< FluidSystem, Region >::defineState(), Opm::RegionAverageCalculator::AverageRegionalPressure< FluidSystem, Region >::defineState(), Opm::GasLiftSingleWellGeneric< Scalar >::BasicRates::operator[](), and Opm::RegionAttributeHelpers::PhasePos::water().