Opm::NullMaterial< TraitsT > Class Template Reference

Implements a dummy linear saturation-capillary pressure relation which just disables capillary pressure. More...

#include <NullMaterial.hpp>

Inheritance diagram for Opm::NullMaterial< TraitsT >:
Inheritance graph

Public Types

typedef TraitsT Traits
 
typedef NullMaterialParams
< TraitsT > 
Params
 
typedef Traits::Scalar Scalar
 

Static Public Member Functions

template<class ContainerT , class FluidState >
static void capillaryPressures (ContainerT &values, const Params &, const FluidState &)
 Returns constant 0 for all phases. More...
 
template<class ContainerT , class FluidState >
static void saturations (ContainerT &, const Params &, const FluidState &)
 The inverse of the capillary pressure. More...
 
template<class ContainerT , class FluidState >
static void relativePermeabilities (ContainerT &values, const Params &, const FluidState &fluidState)
 The relative permeability of all phases. More...
 
template<class FluidState , class Evaluation = typename FluidState::Scalar>
static std::enable_if
<(numPhases > 1), Evaluation >
::type 
pcnw (const Params &, const FluidState &)
 The difference between the pressures of the non-wetting and wetting phase. More...
 
template<class Evaluation >
static std::enable_if
< numPhases==2, Evaluation >
::type 
twoPhaseSatPcnw (const Params &, const Evaluation &)
 
template<class FluidState , class Evaluation = typename FluidState::Scalar>
static Scalar Sw (const Params &, const FluidState &)
 Calculate wetting phase saturation given that the rest of the fluid state has been initialized. More...
 
template<class Evaluation >
static std::enable_if
< numPhases==2, Evaluation >
::type 
twoPhaseSatSw (const Params &, const Evaluation &)
 
template<class FluidState , class Evaluation = typename FluidState::Scalar>
static Scalar Sn (const Params &, const FluidState &)
 Calculate non-wetting phase saturation given that the rest of the fluid state has been initialized. More...
 
template<class Evaluation >
static std::enable_if
< numPhases==2, Evaluation >
::type 
twoPhaseSatSn (const Params &, const Evaluation &)
 
template<class FluidState , class Evaluation = typename FluidState::Scalar>
static std::enable_if
< (numPhases > 2), Evaluation >
::type 
Sg (const Params &, const FluidState &)
 Calculate gas phase saturation given that the rest of the fluid state has been initialized. More...
 
template<class FluidState , class Evaluation = typename FluidState::Scalar>
static std::enable_if
<(numPhases > 1), Evaluation >
::type 
krw (const Params &, const FluidState &fluidState)
 The relative permability of the wetting phase. More...
 
template<class Evaluation >
static std::enable_if
< numPhases==2, Evaluation >
::type 
twoPhaseSatKrw (const Params &, const Evaluation &Sw)
 
template<class FluidState , class Evaluation = typename FluidState::Scalar>
static std::enable_if
<(numPhases > 1), Evaluation >
::type 
krn (const Params &, const FluidState &fluidState)
 The relative permability of the liquid non-wetting phase. More...
 
template<class Evaluation >
static std::enable_if
< numPhases==2, Evaluation >
::type 
twoPhaseSatKrn (const Params &, const Evaluation &Sw)
 
template<class FluidState , class Evaluation = typename FluidState::Scalar>
static std::enable_if
< (numPhases > 2), Evaluation >
::type 
krg (const Params &, const FluidState &fluidState)
 The relative permability of the gas phase. More...
 
template<class FluidState , class Evaluation = typename FluidState::Scalar>
static std::enable_if
< (Traits::numPhases >
2), Evaluation >::type 
pcgn (const Params &, const FluidState &)
 The difference between the pressures of the gas and the non-wetting phase. More...
 

Static Public Attributes

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

Detailed Description

template<class TraitsT>
class Opm::NullMaterial< TraitsT >

Implements a dummy linear saturation-capillary pressure relation which just disables capillary pressure.

Member Typedef Documentation

template<class TraitsT >
typedef NullMaterialParams<TraitsT> Opm::NullMaterial< TraitsT >::Params
template<class TraitsT >
typedef Traits::Scalar Opm::NullMaterial< TraitsT >::Scalar
template<class TraitsT >
typedef TraitsT Opm::NullMaterial< TraitsT >::Traits

Member Function Documentation

template<class TraitsT >
template<class ContainerT , class FluidState >
static void Opm::NullMaterial< TraitsT >::capillaryPressures ( ContainerT &  values,
const Params ,
const FluidState &   
)
inlinestatic

Returns constant 0 for all phases.

Parameters
valuesContainer for the return values
paramsParameters
stateThe fluid state

References Opm::NullMaterial< TraitsT >::numPhases.

template<class TraitsT >
template<class FluidState , class Evaluation = typename FluidState::Scalar>
static std::enable_if< (numPhases > 2), Evaluation>::type Opm::NullMaterial< TraitsT >::krg ( const Params ,
const FluidState &  fluidState 
)
inlinestatic

The relative permability of the gas phase.

This method is only available for at least three fluid phases

References Opm::LocalAd::max(), Opm::LocalAd::min(), and Opm::NullMaterial< TraitsT >::Sg().

template<class TraitsT >
template<class FluidState , class Evaluation = typename FluidState::Scalar>
static std::enable_if<(numPhases > 1), Evaluation>::type Opm::NullMaterial< TraitsT >::krn ( const Params ,
const FluidState &  fluidState 
)
inlinestatic

The relative permability of the liquid non-wetting phase.

References Opm::LocalAd::max(), Opm::LocalAd::min(), and Opm::NullMaterial< TraitsT >::Sn().

template<class TraitsT >
template<class FluidState , class Evaluation = typename FluidState::Scalar>
static std::enable_if<(numPhases > 1), Evaluation>::type Opm::NullMaterial< TraitsT >::krw ( const Params ,
const FluidState &  fluidState 
)
inlinestatic

The relative permability of the wetting phase.

References Opm::LocalAd::max(), Opm::LocalAd::min(), and Opm::NullMaterial< TraitsT >::Sw().

template<class TraitsT >
template<class FluidState , class Evaluation = typename FluidState::Scalar>
static std::enable_if< (Traits::numPhases > 2), Evaluation>::type Opm::NullMaterial< TraitsT >::pcgn ( const Params ,
const FluidState &   
)
inlinestatic

The difference between the pressures of the gas and the non-wetting phase.

This method is only available for at least three fluid phases

template<class TraitsT >
template<class FluidState , class Evaluation = typename FluidState::Scalar>
static std::enable_if<(numPhases > 1), Evaluation>::type Opm::NullMaterial< TraitsT >::pcnw ( const Params ,
const FluidState &   
)
inlinestatic

The difference between the pressures of the non-wetting and wetting phase.

template<class TraitsT >
template<class ContainerT , class FluidState >
static void Opm::NullMaterial< TraitsT >::relativePermeabilities ( ContainerT &  values,
const Params ,
const FluidState &  fluidState 
)
inlinestatic

The relative permeability of all phases.

References Opm::LocalAd::max(), Opm::LocalAd::min(), and Opm::NullMaterial< TraitsT >::numPhases.

template<class TraitsT >
template<class ContainerT , class FluidState >
static void Opm::NullMaterial< TraitsT >::saturations ( ContainerT &  ,
const Params ,
const FluidState &   
)
inlinestatic

The inverse of the capillary pressure.

template<class TraitsT >
template<class FluidState , class Evaluation = typename FluidState::Scalar>
static std::enable_if< (numPhases > 2), Evaluation>::type Opm::NullMaterial< TraitsT >::Sg ( const Params ,
const FluidState &   
)
inlinestatic

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

This method is only available for at least three fluid phases

Referenced by Opm::NullMaterial< TraitsT >::krg().

template<class TraitsT >
template<class FluidState , class Evaluation = typename FluidState::Scalar>
static Scalar Opm::NullMaterial< TraitsT >::Sn ( const Params ,
const FluidState &   
)
inlinestatic

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

Referenced by Opm::NullMaterial< TraitsT >::krn().

template<class TraitsT >
template<class FluidState , class Evaluation = typename FluidState::Scalar>
static Scalar Opm::NullMaterial< TraitsT >::Sw ( const Params ,
const FluidState &   
)
inlinestatic

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

Referenced by Opm::NullMaterial< TraitsT >::krw().

template<class TraitsT >
template<class Evaluation >
static std::enable_if<numPhases == 2, Evaluation>::type Opm::NullMaterial< TraitsT >::twoPhaseSatKrn ( const Params ,
const Evaluation &  Sw 
)
inlinestatic
template<class TraitsT >
template<class Evaluation >
static std::enable_if<numPhases == 2, Evaluation>::type Opm::NullMaterial< TraitsT >::twoPhaseSatKrw ( const Params ,
const Evaluation &  Sw 
)
inlinestatic
template<class TraitsT >
template<class Evaluation >
static std::enable_if<numPhases == 2, Evaluation>::type Opm::NullMaterial< TraitsT >::twoPhaseSatPcnw ( const Params ,
const Evaluation &   
)
inlinestatic
template<class TraitsT >
template<class Evaluation >
static std::enable_if<numPhases == 2, Evaluation>::type Opm::NullMaterial< TraitsT >::twoPhaseSatSn ( const Params ,
const Evaluation &   
)
inlinestatic
template<class TraitsT >
template<class Evaluation >
static std::enable_if<numPhases == 2, Evaluation>::type Opm::NullMaterial< TraitsT >::twoPhaseSatSw ( const Params ,
const Evaluation &   
)
inlinestatic

Member Data Documentation

template<class TraitsT >
const bool Opm::NullMaterial< TraitsT >::implementsTwoPhaseApi = (numPhases == 2)
static

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

template<class TraitsT >
const bool Opm::NullMaterial< TraitsT >::implementsTwoPhaseSatApi = (numPhases == 2)
static

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

template<class TraitsT >
const bool Opm::NullMaterial< TraitsT >::isCompositionDependent = false
static

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

template<class TraitsT >
const bool Opm::NullMaterial< TraitsT >::isPressureDependent = false
static

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

template<class TraitsT >
const bool Opm::NullMaterial< TraitsT >::isSaturationDependent = true
static

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

In this law, the relative permeabilities are saturation dependent, even if capillary pressure is always zero

template<class TraitsT >
const bool Opm::NullMaterial< TraitsT >::isTemperatureDependent = false
static

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

template<class TraitsT >
const int Opm::NullMaterial< TraitsT >::numPhases = Traits::numPhases
static

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