Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT > Class Template Reference

This material law takes a material law defined for unscaled saturation and converts it to a material law defined on scaled saturations. More...

#include <EclEpsTwoPhaseLaw.hpp>

Inheritance diagram for Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >:
Inheritance graph

Public Types

enum  { wettingPhaseIdx = Traits::wettingPhaseIdx }
 
enum  { nonWettingPhaseIdx = Traits::nonWettingPhaseIdx }
 
typedef EffLaw::Traits Traits
 
typedef ParamsT Params
 
typedef EffLaw::Scalar Scalar
 

Static Public Member Functions

template<class Container , class FluidState >
static void capillaryPressures (Container &, const Params &, const FluidState &)
 The capillary pressure-saturation curves depending on absolute saturations. More...
 
template<class Container , class FluidState >
static void relativePermeabilities (Container &, const Params &, const FluidState &)
 The relative permeability-saturation curves depending on absolute saturations. More...
 
template<class FluidState , class Evaluation = typename FluidState::Scalar>
static Evaluation pcnw (const Params &, const FluidState &)
 The capillary pressure-saturation curve. More...
 
template<class Evaluation >
static Evaluation twoPhaseSatPcnw (const Params &params, const Evaluation &SwScaled)
 
template<class Evaluation >
static Evaluation twoPhaseSatPcnwInv (const Params &params, const Evaluation &pcnwScaled)
 
template<class Container , class FluidState >
static void saturations (Container &, const Params &, const FluidState &)
 The saturation-capillary pressure curves. More...
 
template<class FluidState , class Evaluation = typename FluidState::Scalar>
static Evaluation Sw (const Params &, const FluidState &)
 Calculate wetting liquid phase saturation given that the rest of the fluid state has been initialized. More...
 
template<class Evaluation >
static Evaluation twoPhaseSatSw (const Params &, const Evaluation &)
 
template<class FluidState , class Evaluation = typename FluidState::Scalar>
static Evaluation Sn (const Params &, const FluidState &)
 Calculate non-wetting liquid phase saturation given that the rest of the fluid state has been initialized. More...
 
template<class Evaluation >
static Evaluation twoPhaseSatSn (const Params &, const Evaluation &)
 
template<class FluidState , class Evaluation = typename FluidState::Scalar>
static Evaluation krw (const Params &, const FluidState &)
 The relative permeability for the wetting phase. More...
 
template<class Evaluation >
static Evaluation twoPhaseSatKrw (const Params &params, const Evaluation &SwScaled)
 
template<class Evaluation >
static Evaluation twoPhaseSatKrwInv (const Params &params, const Evaluation &krwScaled)
 
template<class FluidState , class Evaluation = typename FluidState::Scalar>
static Evaluation krn (const Params &, const FluidState &)
 The relative permeability of the non-wetting phase. More...
 
template<class Evaluation >
static Evaluation twoPhaseSatKrn (const Params &params, const Evaluation &SwScaled)
 
template<class Evaluation >
static Evaluation twoPhaseSatKrnInv (const Params &params, const Evaluation &krnScaled)
 
template<class Evaluation >
static Evaluation scaledToUnscaledSatPc (const Params &params, const Evaluation &SwScaled)
 Convert an absolute saturation to an effective one for capillary pressure. More...
 
template<class Evaluation >
static Evaluation unscaledToScaledSatPc (const Params &params, const Evaluation &SwUnscaled)
 
template<class Evaluation >
static Evaluation scaledToUnscaledSatKrw (const Params &params, const Evaluation &SwScaled)
 Convert an absolute saturation to an effective one for the scaling of the relperm of the wetting phase. More...
 
template<class Evaluation >
static Evaluation unscaledToScaledSatKrw (const Params &params, const Evaluation &SwUnscaled)
 
template<class Evaluation >
static Evaluation scaledToUnscaledSatKrn (const Params &params, const Evaluation &SwScaled)
 Convert an absolute saturation to an effective one for the scaling of the relperm of the non-wetting phase. More...
 
template<class Evaluation >
static Evaluation unscaledToScaledSatKrn (const Params &params, const Evaluation &SwUnscaled)
 

Static Public Attributes

static const int numPhases = EffLaw::numPhases
 The number of fluid phases. More...
 
static const bool implementsTwoPhaseApi = true
 
static const bool implementsTwoPhaseSatApi = true
 
static const bool isSaturationDependent = true
 
static const bool isPressureDependent = false
 
static const bool isTemperatureDependent = false
 
static const bool isCompositionDependent = false
 

Detailed Description

template<class EffLawT, class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
class Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >

This material law takes a material law defined for unscaled saturation and converts it to a material law defined on scaled saturations.

In ECL, simulations "live" in scaled space, while the saturation functions operate on and produce unscaled quantities. This class implements the "impedance adaption" layer between the two worlds. The basic purpose of it is thus the same as the one of EffToAbsLaw, but it is quite a bit more complex.

Member Typedef Documentation

◆ Params

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
typedef ParamsT Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::Params

◆ Scalar

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
typedef EffLaw::Scalar Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::Scalar

◆ Traits

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
typedef EffLaw::Traits Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::Traits

Member Enumeration Documentation

◆ anonymous enum

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
anonymous enum
Enumerator
wettingPhaseIdx 

◆ anonymous enum

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
anonymous enum
Enumerator
nonWettingPhaseIdx 

Member Function Documentation

◆ capillaryPressures()

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
template<class Container , class FluidState >
static void Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::capillaryPressures ( Container &  ,
const Params ,
const FluidState &   
)
inlinestatic

The capillary pressure-saturation curves depending on absolute saturations.

Parameters
valuesA random access container which stores the relative pressure of each fluid phase.
paramsThe parameter object expressing the coefficients required by the van Genuchten law.
fsThe fluid state for which the capillary pressure ought to be calculated

◆ krn()

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
template<class FluidState , class Evaluation = typename FluidState::Scalar>
static Evaluation Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::krn ( const Params ,
const FluidState &   
)
inlinestatic

The relative permeability of the non-wetting phase.

◆ krw()

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
template<class FluidState , class Evaluation = typename FluidState::Scalar>
static Evaluation Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::krw ( const Params ,
const FluidState &   
)
inlinestatic

The relative permeability for the wetting phase.

Parameters
paramsA container object that is populated with the appropriate coefficients for the respective law. Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container is constructed accordingly. Afterwards the values are set there, too.
Returns
Relative permeability of the wetting phase calculated as implied by EffLaw e.g. Brooks & Corey, van Genuchten, linear... .

◆ pcnw()

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
template<class FluidState , class Evaluation = typename FluidState::Scalar>
static Evaluation Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::pcnw ( const Params ,
const FluidState &   
)
inlinestatic

The capillary pressure-saturation curve.

Parameters
paramsA object that stores the appropriate coefficients for the respective law.
Returns
Capillary pressure [Pa] calculated by specific constitutive relation (e.g. Brooks & Corey, van Genuchten, linear...)

◆ relativePermeabilities()

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
template<class Container , class FluidState >
static void Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::relativePermeabilities ( Container &  ,
const Params ,
const FluidState &   
)
inlinestatic

The relative permeability-saturation curves depending on absolute saturations.

Parameters
valuesA random access container which stores the relative permeability of each fluid phase.
paramsThe parameter object expressing the coefficients required by the van Genuchten law.
fsThe fluid state for which the relative permeabilities ought to be calculated

◆ saturations()

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
template<class Container , class FluidState >
static void Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::saturations ( Container &  ,
const Params ,
const FluidState &   
)
inlinestatic

The saturation-capillary pressure curves.

◆ scaledToUnscaledSatKrn()

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
template<class Evaluation >
static Evaluation Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::scaledToUnscaledSatKrn ( const Params params,
const Evaluation &  SwScaled 
)
inlinestatic

Convert an absolute saturation to an effective one for the scaling of the relperm of the non-wetting phase.

Referenced by Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::twoPhaseSatKrn().

◆ scaledToUnscaledSatKrw()

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
template<class Evaluation >
static Evaluation Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::scaledToUnscaledSatKrw ( const Params params,
const Evaluation &  SwScaled 
)
inlinestatic

Convert an absolute saturation to an effective one for the scaling of the relperm of the wetting phase.

Referenced by Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::twoPhaseSatKrw().

◆ scaledToUnscaledSatPc()

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
template<class Evaluation >
static Evaluation Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::scaledToUnscaledSatPc ( const Params params,
const Evaluation &  SwScaled 
)
inlinestatic

Convert an absolute saturation to an effective one for capillary pressure.

The effective saturation is then feed into the "raw" capillary pressure law.

Referenced by Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::twoPhaseSatPcnw().

◆ Sn()

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
template<class FluidState , class Evaluation = typename FluidState::Scalar>
static Evaluation Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::Sn ( const Params ,
const FluidState &   
)
inlinestatic

Calculate non-wetting liquid phase saturation given that the rest of the fluid state has been initialized.

◆ Sw()

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
template<class FluidState , class Evaluation = typename FluidState::Scalar>
static Evaluation Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::Sw ( const Params ,
const FluidState &   
)
inlinestatic

Calculate wetting liquid phase saturation given that the rest of the fluid state has been initialized.

◆ twoPhaseSatKrn()

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
template<class Evaluation >
static Evaluation Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::twoPhaseSatKrn ( const Params params,
const Evaluation &  SwScaled 
)
inlinestatic

◆ twoPhaseSatKrnInv()

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
template<class Evaluation >
static Evaluation Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::twoPhaseSatKrnInv ( const Params params,
const Evaluation &  krnScaled 
)
inlinestatic

◆ twoPhaseSatKrw()

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
template<class Evaluation >
static Evaluation Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::twoPhaseSatKrw ( const Params params,
const Evaluation &  SwScaled 
)
inlinestatic

◆ twoPhaseSatKrwInv()

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
template<class Evaluation >
static Evaluation Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::twoPhaseSatKrwInv ( const Params params,
const Evaluation &  krwScaled 
)
inlinestatic

◆ twoPhaseSatPcnw()

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
template<class Evaluation >
static Evaluation Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::twoPhaseSatPcnw ( const Params params,
const Evaluation &  SwScaled 
)
inlinestatic

◆ twoPhaseSatPcnwInv()

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
template<class Evaluation >
static Evaluation Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::twoPhaseSatPcnwInv ( const Params params,
const Evaluation &  pcnwScaled 
)
inlinestatic

◆ twoPhaseSatSn()

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
template<class Evaluation >
static Evaluation Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::twoPhaseSatSn ( const Params ,
const Evaluation &   
)
inlinestatic

◆ twoPhaseSatSw()

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
template<class Evaluation >
static Evaluation Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::twoPhaseSatSw ( const Params ,
const Evaluation &   
)
inlinestatic

◆ unscaledToScaledSatKrn()

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
template<class Evaluation >
static Evaluation Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::unscaledToScaledSatKrn ( const Params params,
const Evaluation &  SwUnscaled 
)
inlinestatic

◆ unscaledToScaledSatKrw()

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
template<class Evaluation >
static Evaluation Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::unscaledToScaledSatKrw ( const Params params,
const Evaluation &  SwUnscaled 
)
inlinestatic

◆ unscaledToScaledSatPc()

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
template<class Evaluation >
static Evaluation Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::unscaledToScaledSatPc ( const Params params,
const Evaluation &  SwUnscaled 
)
inlinestatic

Member Data Documentation

◆ implementsTwoPhaseApi

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
const bool Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::implementsTwoPhaseApi = true
static

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

◆ implementsTwoPhaseSatApi

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
const bool Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::implementsTwoPhaseSatApi = true
static

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

◆ isCompositionDependent

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
const bool Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::isCompositionDependent = false
static

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

◆ isPressureDependent

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
const bool Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::isPressureDependent = false
static

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

◆ isSaturationDependent

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
const bool Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::isSaturationDependent = true
static

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

◆ isTemperatureDependent

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
const bool Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::isTemperatureDependent = false
static

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

◆ numPhases

template<class EffLawT , class ParamsT = EclEpsTwoPhaseLawParams<EffLawT>>
const int Opm::EclEpsTwoPhaseLaw< EffLawT, ParamsT >::numPhases = EffLaw::numPhases
static

The number of fluid phases.


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