Implements the default three phase capillary pressure law used by the ECLipse simulator. More...

#include <EclDefaultMaterial.hpp>

Inheritance diagram for Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >:

Public Types
using	GasOilMaterialLaw = GasOilMaterialLawT

using	OilWaterMaterialLaw = OilWaterMaterialLawT

using	Traits = TraitsT

using	Params = ParamsT

using	Scalar = typename Traits::Scalar

Static Public Member Functions
template<class ContainerT , class FluidState >
static void	capillaryPressures (ContainerT &values, const Params &params, const FluidState &state)
	Implements the default three phase capillary pressure law used by the ECLipse simulator. More...

static void	oilWaterHysteresisParams (Scalar &pcSwMdc, Scalar &krnSwMdc, const Params &params)

static void	setOilWaterHysteresisParams (const Scalar &pcSwMdc, const Scalar &krnSwMdc, Params &params)

static void	gasOilHysteresisParams (Scalar &pcSwMdc, Scalar &krnSwMdc, const Params &params)

static void	setGasOilHysteresisParams (const Scalar &pcSwMdc, const Scalar &krnSwMdc, Params &params)

template<class FluidState , class Evaluation = typename FluidState::Scalar>
static Evaluation	pcgn (const Params &params, const FluidState &fs)
	Capillary pressure between the gas and the non-wetting liquid (i.e., oil) phase. More...

template<class FluidState , class Evaluation = typename FluidState::Scalar>
static Evaluation	pcnw (const Params &params, const FluidState &fs)
	Capillary pressure between the non-wetting liquid (i.e., oil) and the wetting liquid (i.e., water) phase. More...

template<class ContainerT , class FluidState >
static void	saturations (ContainerT &, const Params &, const FluidState &)
	The inverse of the capillary pressure. More...

template<class FluidState , class Evaluation = typename FluidState::Scalar>
static Evaluation	Sg (const Params &, const FluidState &)
	The saturation of the gas phase. More...

template<class FluidState , class Evaluation = typename FluidState::Scalar>
static Evaluation	Sn (const Params &, const FluidState &)
	The saturation of the non-wetting (i.e., oil) phase. More...

template<class FluidState , class Evaluation = typename FluidState::Scalar>
static Evaluation	Sw (const Params &, const FluidState &)
	The saturation of the wetting (i.e., water) phase. More...

template<class ContainerT , class FluidState >
static void	relativePermeabilities (ContainerT &values, const Params &params, const FluidState &fluidState)
	The relative permeability of all phases. More...

template<class FluidState , class Evaluation = typename FluidState::Scalar>
static Evaluation	krg (const Params &params, const FluidState &fluidState)
	The relative permeability of the gas phase. More...

template<class FluidState , class Evaluation = typename FluidState::Scalar>
static Evaluation	krw (const Params &params, const FluidState &fluidState)
	The relative permeability of the wetting phase. More...

template<class FluidState , class Evaluation = typename FluidState::Scalar>
static Evaluation	krn (const Params &params, const FluidState &fluidState)
	The relative permeability of the non-wetting (i.e., oil) phase. More...

template<class Evaluation , class FluidState >
static Evaluation	relpermOilInOilGasSystem (const Params &params, const FluidState &fluidState)
	The relative permeability of oil in oil/gas system. More...

template<class Evaluation , class FluidState >
static Evaluation	relpermOilInOilWaterSystem (const Params &params, const FluidState &fluidState)
	The relative permeability of oil in oil/water system. More...

template<class FluidState >
static void	updateHysteresis (Params &params, const FluidState &fluidState)
	Update the hysteresis parameters after a time step. More...

template<class FluidState >
static Scalar	clampSaturation (const FluidState &fluidState, const int phaseIndex)

Static Public Attributes
static constexpr int	numPhases = 3

static constexpr int	waterPhaseIdx = Traits::wettingPhaseIdx

static constexpr int	oilPhaseIdx = Traits::nonWettingPhaseIdx

static constexpr int	gasPhaseIdx = Traits::gasPhaseIdx

static constexpr bool	implementsTwoPhaseApi = false

static constexpr bool	implementsTwoPhaseSatApi = false

static constexpr bool	isSaturationDependent = true

static constexpr bool	isPressureDependent = false

static constexpr bool	isTemperatureDependent = false

static constexpr bool	isCompositionDependent = false

Detailed Description

template<class TraitsT, class GasOilMaterialLawT, class OilWaterMaterialLawT, class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>
class Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >

Implements the default three phase capillary pressure law used by the ECLipse simulator.

This material law is valid for three fluid phases and only depends on the saturations.

The required two-phase relations are supplied by means of template arguments and can be an arbitrary other material laws. (Provided that these only depend on saturation.)

Member Typedef Documentation

◆ GasOilMaterialLaw

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

using Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::GasOilMaterialLaw = GasOilMaterialLawT

◆ OilWaterMaterialLaw

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

using Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::OilWaterMaterialLaw = OilWaterMaterialLawT

◆ Params

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

using Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::Params = ParamsT

◆ Scalar

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

using Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::Scalar = typename Traits::Scalar

◆ Traits

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

using Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::Traits = TraitsT

Member Function Documentation

◆ capillaryPressures()

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

template<class ContainerT , class FluidState >

static void Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::capillaryPressures	(	ContainerT &	values,
		const Params &	params,
		const FluidState &	state
	)

inlinestatic

Implements the default three phase capillary pressure law used by the ECLipse simulator.

This material law is valid for three fluid phases and only depends on the saturations.

The required two-phase relations are supplied by means of template arguments and can be an arbitrary other material laws.

Parameters

values	Container for the return values
params	Parameters
state	The fluid state

References Opm::Valgrind::CheckDefined(), Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::gasPhaseIdx, Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::oilPhaseIdx, and Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::waterPhaseIdx.

Referenced by Opm::EclMultiplexerMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, GasWaterMaterialLawT, ParamsT >::capillaryPressures().

◆ clampSaturation()

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

template<class FluidState >

static Scalar Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::clampSaturation	(	const FluidState &	fluidState,
		const int	phaseIndex
	)

inlinestatic

References Opm::scalarValue().

Referenced by Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::updateHysteresis().

◆ gasOilHysteresisParams()

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

static void Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::gasOilHysteresisParams	(	Scalar &	pcSwMdc,
		Scalar &	krnSwMdc,
		const Params &	params
	)

inlinestatic

References Opm::Valgrind::CheckDefined(), and Opm::min().

Referenced by Opm::EclMultiplexerMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, GasWaterMaterialLawT, ParamsT >::gasOilHysteresisParams().

◆ krg()

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

template<class FluidState , class Evaluation = typename FluidState::Scalar>

static Evaluation Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::krg	(	const Params &	params,
		const FluidState &	fluidState
	)

inlinestatic

The relative permeability of the gas phase.

References Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::gasPhaseIdx, and Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::Sw().

◆ krn()

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

template<class FluidState , class Evaluation = typename FluidState::Scalar>

static Evaluation Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::krn	(	const Params &	params,
		const FluidState &	fluidState
	)

inlinestatic

The relative permeability of the non-wetting (i.e., oil) phase.

References Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::gasPhaseIdx, Opm::max(), Opm::scalarValue(), Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::Sg(), Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::Sw(), and Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::waterPhaseIdx.

◆ krw()

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

template<class FluidState , class Evaluation = typename FluidState::Scalar>

static Evaluation Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::krw	(	const Params &	params,
		const FluidState &	fluidState
	)

inlinestatic

The relative permeability of the wetting phase.

References Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::Sw(), and Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::waterPhaseIdx.

◆ oilWaterHysteresisParams()

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

static void Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::oilWaterHysteresisParams	(	Scalar &	pcSwMdc,
		Scalar &	krnSwMdc,
		const Params &	params
	)

inlinestatic

References Opm::Valgrind::CheckDefined().

Referenced by Opm::EclMultiplexerMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, GasWaterMaterialLawT, ParamsT >::oilWaterHysteresisParams().

◆ pcgn()

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

template<class FluidState , class Evaluation = typename FluidState::Scalar>

static Evaluation Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::pcgn	(	const Params &	params,
		const FluidState &	fs
	)

inlinestatic

Capillary pressure between the gas and the non-wetting liquid (i.e., oil) phase.

This is defined as

$p_{c,gn} = p_g - p_n$

References Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::gasPhaseIdx, and Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::Sw().

◆ pcnw()

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

template<class FluidState , class Evaluation = typename FluidState::Scalar>

static Evaluation Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::pcnw	(	const Params &	params,
		const FluidState &	fs
	)

inlinestatic

Capillary pressure between the non-wetting liquid (i.e., oil) and the wetting liquid (i.e., water) phase.

This is defined as

$p_{c,nw} = p_n - p_w$

References Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::Sw(), and Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::waterPhaseIdx.

◆ relativePermeabilities()

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

template<class ContainerT , class FluidState >

static void Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::relativePermeabilities	(	ContainerT &	values,
		const Params &	params,
		const FluidState &	fluidState
	)

inlinestatic

The relative permeability of all phases.

The relative permeability of the water phase it uses the same value as the relative permeability for water in the water-oil law with $S_o = 1 - S_w$ . The gas relative permebility is taken from the gas-oil material law, but with $S_o = 1 -
S_g$ . The relative permeability of the oil phase is calculated using the relative permeabilities of the oil phase in the two two-phase systems.

A more detailed description can be found in the "Three phase oil relative permeability models" section of the ECLipse technical description.

References Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::gasPhaseIdx, Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::oilPhaseIdx, and Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::waterPhaseIdx.

Referenced by Opm::EclMultiplexerMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, GasWaterMaterialLawT, ParamsT >::relativePermeabilities().

◆ relpermOilInOilGasSystem()

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

template<class Evaluation , class FluidState >

static Evaluation Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::relpermOilInOilGasSystem	(	const Params &	params,
		const FluidState &	fluidState
	)

inlinestatic

The relative permeability of oil in oil/gas system.

References Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::gasPhaseIdx, Opm::max(), Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::Sg(), Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::Sw(), and Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::waterPhaseIdx.

◆ relpermOilInOilWaterSystem()

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

template<class Evaluation , class FluidState >

static Evaluation Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::relpermOilInOilWaterSystem	(	const Params &	params,
		const FluidState &	fluidState
	)

inlinestatic

The relative permeability of oil in oil/water system.

References Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::gasPhaseIdx, Opm::max(), Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::Sg(), Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::Sw(), and Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::waterPhaseIdx.

◆ saturations()

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

template<class ContainerT , class FluidState >

static void Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::saturations	(	ContainerT &	,
		const Params &	,
		const FluidState &
	)

inlinestatic

The inverse of the capillary pressure.

◆ setGasOilHysteresisParams()

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

static void Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::setGasOilHysteresisParams	(	const Scalar &	pcSwMdc,
		const Scalar &	krnSwMdc,
		Params &	params
	)

inlinestatic

Referenced by Opm::EclMultiplexerMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, GasWaterMaterialLawT, ParamsT >::setGasOilHysteresisParams().

◆ setOilWaterHysteresisParams()

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

static void Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::setOilWaterHysteresisParams	(	const Scalar &	pcSwMdc,
		const Scalar &	krnSwMdc,
		Params &	params
	)

inlinestatic

Referenced by Opm::EclMultiplexerMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, GasWaterMaterialLawT, ParamsT >::setOilWaterHysteresisParams().

◆ Sg()

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

template<class FluidState , class Evaluation = typename FluidState::Scalar>

static Evaluation Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::Sg	(	const Params &	,
		const FluidState &
	)

inlinestatic

The saturation of the gas phase.

Referenced by Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::krn(), Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::relpermOilInOilGasSystem(), Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::relpermOilInOilWaterSystem(), and Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::updateHysteresis().

◆ Sn()

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

template<class FluidState , class Evaluation = typename FluidState::Scalar>

static Evaluation Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::Sn	(	const Params &	,
		const FluidState &
	)

inlinestatic

The saturation of the non-wetting (i.e., oil) phase.

◆ Sw()

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

template<class FluidState , class Evaluation = typename FluidState::Scalar>

static Evaluation Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::Sw	(	const Params &	,
		const FluidState &
	)

inlinestatic

The saturation of the wetting (i.e., water) phase.

◆ updateHysteresis()

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

template<class FluidState >

static void Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::updateHysteresis	(	Params &	params,
		const FluidState &	fluidState
	)

inlinestatic

Update the hysteresis parameters after a time step.

This assumes that the nested two-phase material laws are parameters for EclHysteresisLaw. If they are not, calling this methid will cause a compiler error. (But not calling it will still work.)

References Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::clampSaturation(), Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::gasPhaseIdx, Opm::max(), Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::oilPhaseIdx, Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::Sg(), Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::Sw(), and Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::waterPhaseIdx.

Referenced by Opm::EclMultiplexerMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, GasWaterMaterialLawT, ParamsT >::updateHysteresis().

Member Data Documentation

◆ gasPhaseIdx

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

constexpr int Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::gasPhaseIdx = Traits::gasPhaseIdx

staticconstexpr

◆ implementsTwoPhaseApi

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

constexpr bool Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::implementsTwoPhaseApi = false

staticconstexpr

Specify whether this material law implements the two-phase convenience API

◆ implementsTwoPhaseSatApi

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

constexpr bool Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::implementsTwoPhaseSatApi = false

staticconstexpr

Specify whether this material law implements the two-phase convenience API which only depends on the phase saturations

◆ isCompositionDependent

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

constexpr bool Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::isCompositionDependent = false

staticconstexpr

Specify whether the quantities defined by this material law are dependent on the phase composition

◆ isPressureDependent

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

constexpr bool Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::isPressureDependent = false

staticconstexpr

Specify whether the quantities defined by this material law are dependent on the absolute pressure

◆ isSaturationDependent

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

constexpr bool Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::isSaturationDependent = true

staticconstexpr

Specify whether the quantities defined by this material law are saturation dependent

◆ isTemperatureDependent

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

constexpr bool Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::isTemperatureDependent = false

staticconstexpr

Specify whether the quantities defined by this material law are temperature dependent

◆ numPhases

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

constexpr int Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::numPhases = 3

staticconstexpr

◆ oilPhaseIdx

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

constexpr int Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::oilPhaseIdx = Traits::nonWettingPhaseIdx

staticconstexpr

Referenced by Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::capillaryPressures(), Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::relativePermeabilities(), and Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::updateHysteresis().

◆ waterPhaseIdx

template<class TraitsT , class GasOilMaterialLawT , class OilWaterMaterialLawT , class ParamsT = EclDefaultMaterialParams<TraitsT, typename GasOilMaterialLawT::Params, typename OilWaterMaterialLawT::Params>>

constexpr int Opm::EclDefaultMaterial< TraitsT, GasOilMaterialLawT, OilWaterMaterialLawT, ParamsT >::waterPhaseIdx = Traits::wettingPhaseIdx

staticconstexpr

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

EclDefaultMaterial.hpp

Public Types

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ GasOilMaterialLaw

◆ OilWaterMaterialLaw

◆ Params

◆ Scalar

◆ Traits

Member Function Documentation

◆ capillaryPressures()

◆ clampSaturation()

◆ gasOilHysteresisParams()

◆ krg()

◆ krn()

◆ krw()

◆ oilWaterHysteresisParams()

◆ pcgn()

◆ pcnw()

◆ relativePermeabilities()

◆ relpermOilInOilGasSystem()

◆ relpermOilInOilWaterSystem()

◆ saturations()

◆ setGasOilHysteresisParams()

◆ setOilWaterHysteresisParams()

◆ Sg()

◆ Sn()

◆ Sw()

◆ updateHysteresis()

Member Data Documentation

◆ gasPhaseIdx

◆ implementsTwoPhaseApi

◆ implementsTwoPhaseSatApi

◆ isCompositionDependent

◆ isPressureDependent

◆ isSaturationDependent

◆ isTemperatureDependent

◆ numPhases

◆ oilPhaseIdx

◆ waterPhaseIdx