Specification of the material params for the three-phase van Genuchten capillary pressure model. More...

#include <ThreePhaseParkerVanGenuchtenParams.hpp>

Public Types
typedef TraitsT	Traits

typedef Traits::Scalar	Scalar

Public Member Functions
	ThreePhaseParkerVanGenuchtenParams ()

void	finalize ()
	Finish the initialization of the parameter object. More...

Scalar	vgAlpha () const
	Return the $\alpha$ shape parameter of van Genuchten's curve. More...

void	setVgAlpha (Scalar v)
	Set the $\alpha$ shape parameter of van Genuchten's curve. More...

Scalar	vgM () const
	Return the shape parameter of van Genuchten's curve. More...

void	setVgM (Scalar m)
	Set the shape parameter of van Genuchten's curve. More...

Scalar	vgN () const
	Return the shape parameter of van Genuchten's curve. More...

void	setVgN (Scalar n)
	Set the shape parameter of van Genuchten's curve. More...

Scalar	Swr () const
	Return the residual wetting saturation. More...

void	setSwr (Scalar input)
	Set the residual wetting saturation. More...

Scalar	Snr () const
	Return the residual non-wetting saturation. More...

void	setSnr (Scalar input)
	Set the residual non-wetting saturation. More...

Scalar	Sgr () const
	Return the residual gas saturation. More...

void	setSgr (Scalar input)
	Set the residual gas saturation. More...

Scalar	Swrx () const

void	setSwrx (Scalar input)
	Set the residual gas saturation. More...

void	setBetaNW (Scalar input)
	defines the scaling parameters of capillary pressure between the phases (=1 for Gas-Water) More...

void	setBetaGN (Scalar input)

Scalar	betaNW () const
	Return the values for the beta scaling parameters of capillary pressure between the phases. More...

Scalar	betaGN () const

void	setkrRegardsSnr (bool input)
	defines if residual n-phase saturation should be regarded in its relative permeability. More...

bool	krRegardsSnr () const
	Calls if residual n-phase saturation should be regarded in its relative permeability. More...

void	checkDefined () const

Detailed Description

template<class TraitsT>
class Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >

Specification of the material params for the three-phase van Genuchten capillary pressure model.

In comparison to the two-phase version, this parameter object also includes the residual saturations, as their handling is very model-specific.

Member Typedef Documentation

template<class TraitsT >

typedef Traits::Scalar Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::Scalar

template<class TraitsT >

typedef TraitsT Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::Traits

Constructor & Destructor Documentation

template<class TraitsT >

Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::ThreePhaseParkerVanGenuchtenParams ( )

inline

Member Function Documentation

template<class TraitsT >

Scalar Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::betaGN ( ) const

inline

template<class TraitsT >

Scalar Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::betaNW ( ) const

inline

Return the values for the beta scaling parameters of capillary pressure between the phases.

template<class TraitsT >

void Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::checkDefined ( ) const

inline

References Valgrind::CheckDefined().

template<class TraitsT >

void Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::finalize ( )

inline

Finish the initialization of the parameter object.

template<class TraitsT >

bool Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::krRegardsSnr ( ) const

inline

Calls if residual n-phase saturation should be regarded in its relative permeability.

template<class TraitsT >

void Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::setBetaGN ( Scalar input )

inline

template<class TraitsT >

void Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::setBetaNW ( Scalar input )

inline

defines the scaling parameters of capillary pressure between the phases (=1 for Gas-Water)

template<class TraitsT >

void Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::setkrRegardsSnr ( bool input )

inline

defines if residual n-phase saturation should be regarded in its relative permeability.

template<class TraitsT >

void Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::setSgr ( Scalar input )

inline

Set the residual gas saturation.

template<class TraitsT >

void Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::setSnr ( Scalar input )

inline

Set the residual non-wetting saturation.

template<class TraitsT >

void Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::setSwr ( Scalar input )

inline

Set the residual wetting saturation.

template<class TraitsT >

void Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::setSwrx ( Scalar input )

inline

Set the residual gas saturation.

template<class TraitsT >

void Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::setVgAlpha ( Scalar v )

inline

Set the $\alpha$ shape parameter of van Genuchten's curve.

template<class TraitsT >

void Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::setVgM ( Scalar m )

inline

Set the $m$ shape parameter of van Genuchten's curve.

The $n$ shape parameter is set to $n = \frac{1}{1 - m}$

template<class TraitsT >

void Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::setVgN ( Scalar n )

inline

Set the $n$ shape parameter of van Genuchten's curve.

The $n$ shape parameter is set to $m = 1 - \frac{1}{n}$

template<class TraitsT >

Scalar Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::Sgr ( ) const

inline

Return the residual gas saturation.

template<class TraitsT >

Scalar Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::Snr ( ) const

inline

Return the residual non-wetting saturation.

template<class TraitsT >

Scalar Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::Swr ( ) const

inline

Return the residual wetting saturation.

template<class TraitsT >

Scalar Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::Swrx ( ) const

inline

template<class TraitsT >

Scalar Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::vgAlpha ( ) const

inline

Return the $\alpha$ shape parameter of van Genuchten's curve.

template<class TraitsT >

Scalar Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::vgM ( ) const

inline

Return the $m$ shape parameter of van Genuchten's curve.

template<class TraitsT >

Scalar Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::vgN ( ) const

inline

Return the $n$ shape parameter of van Genuchten's curve.

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

ThreePhaseParkerVanGenuchtenParams.hpp

Public Types

Public Member Functions

Detailed Description

template<class TraitsT> class Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<class TraitsT>
class Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >