Parameters that are necessary for the regularization of the Parker - van Genuchten capillary pressure model. More...

#include <dumux/material/fluidmatrixinteractions/3p/regularizedparkervangen3pparams.hh>

Inheritance diagram for Dumux::RegularizedParkerVanGen3PParams< ScalarT >:

Description

template<class ScalarT>
class Dumux::RegularizedParkerVanGen3PParams< ScalarT >

Parameters that are necessary for the regularization of the Parker - van Genuchten capillary pressure model.

Public Types
using	Scalar = ScalarT

Public Member Functions
	RegularizedParkerVanGen3PParams ()

	RegularizedParkerVanGen3PParams (Scalar vgAlpha, Scalar vgn, Scalar KdNAPL, Scalar rhoBulk, Dune::FieldVector< Scalar, 4 > residualSaturation, Scalar betaNw=1., Scalar betaGn=1., Scalar betaGw=1., bool regardSnr=false)

Scalar	pcLowS () const
	Threshold saturation below which the capillary pressure is regularized. More...

Scalar	pcHighS () const
	Threshold saturation above which the capillary pressure is regularized. More...

void	setPcLowS (const Scalar input)
	Set the lower saturation threshold value. More...

void	setPcHighS (const Scalar input)
	Set the upper saturation threshold value. More...

void	useConstRegularization (const bool input)
	Choose whether to use a constant value for regularization of the pc-S curves or not. More...

bool	constRegularization () const
	Returns whether to use a constant value for regularization of the pc-S curves or not. More...

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

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

Scalar	vgm () const
	Return the \(\mathrm{m}\) shape parameter of van Genuchten's curve. More...

void	setVgm (Scalar m)
	Set the \(\mathrm{m}\) shape parameter of van Genuchten's curve. More...

Scalar	vgn () const
	Return the \(\mathrm{n}\) shape parameter of van Genuchten's curve. More...

void	setVgn (Scalar n)
	Set the \(\mathrm{n}\) shape parameter of van Genuchten's curve. More...

Scalar	satResidual (int phaseIdx) const
	Return the residual saturation. More...

void	setResiduals (Dune::FieldVector< Scalar, 3 > residualSaturation)
	Set all residual saturations. 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
	Set the residual total liquid saturation. More...

void	setSwrx (Scalar v)
	Set the residual total liquid 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)

void	setBetaGw (Scalar input)

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

Scalar	betaGn () const

Scalar	betaGw () 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...

Scalar	rhoBulk () const
	Return the bulk density of the porous medium in \(\mathrm{[kg/m^3]}\). More...

void	setRhoBulk (Scalar input)
	Set the bulk density of the porous medium. More...

Scalar	KdNAPL () const
	Return the adsorption coefficient. More...

void	setKdNAPL (Scalar input)
	Set the adsorption coefficient. More...

Member Typedef Documentation

◆ Scalar

template<class ScalarT >

using Dumux::RegularizedParkerVanGen3PParams< ScalarT >::Scalar = ScalarT

Constructor & Destructor Documentation

◆ RegularizedParkerVanGen3PParams() [1/2]

template<class ScalarT >

Dumux::RegularizedParkerVanGen3PParams< ScalarT >::RegularizedParkerVanGen3PParams ( )

inline

◆ RegularizedParkerVanGen3PParams() [2/2]

template<class ScalarT >

Dumux::RegularizedParkerVanGen3PParams< ScalarT >::RegularizedParkerVanGen3PParams	(	Scalar	vgAlpha,
		Scalar	vgn,
		Scalar	KdNAPL,
		Scalar	rhoBulk,
		Dune::FieldVector< Scalar, 4 >	residualSaturation,
		Scalar	betaNw = `1.`,
		Scalar	betaGn = `1.`,
		Scalar	betaGw = `1.`,
		bool	regardSnr = `false`
	)

inline

Member Function Documentation

◆ betaGn()

template<class ScalarT >

Scalar Dumux::ParkerVanGen3PParams< ScalarT >::betaGn ( ) const

inlineinherited

◆ betaGw()

template<class ScalarT >

Scalar Dumux::ParkerVanGen3PParams< ScalarT >::betaGw ( ) const

inlineinherited

◆ betaNw()

template<class ScalarT >

Scalar Dumux::ParkerVanGen3PParams< ScalarT >::betaNw ( ) const

inlineinherited

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

◆ constRegularization()

template<class ScalarT >

bool Dumux::RegularizedParkerVanGen3PParams< ScalarT >::constRegularization ( ) const

inline

Returns whether to use a constant value for regularization of the pc-S curves or not.

◆ KdNAPL()

template<class ScalarT >

Scalar Dumux::ParkerVanGen3PParams< ScalarT >::KdNAPL ( ) const

inlineinherited

Return the adsorption coefficient.

◆ krRegardsSnr()

template<class ScalarT >

bool Dumux::ParkerVanGen3PParams< ScalarT >::krRegardsSnr ( ) const

inlineinherited

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

◆ pcHighS()

template<class ScalarT >

Scalar Dumux::RegularizedParkerVanGen3PParams< ScalarT >::pcHighS ( ) const

inline

Threshold saturation above which the capillary pressure is regularized.

This is just 99%. If you need a different value, overload this class.

◆ pcLowS()

template<class ScalarT >

Scalar Dumux::RegularizedParkerVanGen3PParams< ScalarT >::pcLowS ( ) const

inline

Threshold saturation below which the capillary pressure is regularized.

This is just 1%. If you need a different value, overload this class.

◆ rhoBulk()

template<class ScalarT >

Scalar Dumux::ParkerVanGen3PParams< ScalarT >::rhoBulk ( ) const

inlineinherited

Return the bulk density of the porous medium in \(\mathrm{[kg/m^3]}\).

◆ satResidual()

template<class ScalarT >

Scalar Dumux::ParkerVanGen3PParams< ScalarT >::satResidual ( int phaseIdx ) const

inlineinherited

Return the residual saturation.

Parameters

phaseIdx Indicator, The saturation of phases

◆ setBetaGn()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setBetaGn ( Scalar input )

inlineinherited

◆ setBetaGw()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setBetaGw ( Scalar input )

inlineinherited

◆ setBetaNw()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setBetaNw ( Scalar input )

inlineinherited

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

◆ setKdNAPL()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setKdNAPL ( Scalar input )

inlineinherited

Set the adsorption coefficient.

Parameters

input Set the adsorption coefficient

◆ setKrRegardsSnr()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setKrRegardsSnr ( bool input )

inlineinherited

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

Parameters

input Regard residual n-phase saturation

◆ setPcHighS()

template<class ScalarT >

void Dumux::RegularizedParkerVanGen3PParams< ScalarT >::setPcHighS ( const Scalar input )

inline

Set the upper saturation threshold value.

Parameters

input The saturation threshold value

◆ setPcLowS()

template<class ScalarT >

void Dumux::RegularizedParkerVanGen3PParams< ScalarT >::setPcLowS ( const Scalar input )

inline

Set the lower saturation threshold value.

Parameters

input The saturation threshold value

◆ setResiduals()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setResiduals ( Dune::FieldVector< Scalar, 3 > residualSaturation )

inlineinherited

Set all residual saturations.

◆ setRhoBulk()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setRhoBulk ( Scalar input )

inlineinherited

Set the bulk density of the porous medium.

Parameters

input Density of the porous medium in \(\mathrm{[kg/m^3]}\)

◆ setSgr()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setSgr ( Scalar input )

inlineinherited

Set the residual gas saturation.

Parameters

input Set the resiudal gas saturation

◆ setSnr()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setSnr ( Scalar input )

inlineinherited

Set the residual non-wetting saturation.

Parameters

input Set the resiudal non-wetting saturation

◆ setSwr()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setSwr ( Scalar input )

inlineinherited

Set the residual wetting saturation.

Parameters

input Set residual wetting saturation

◆ setSwrx()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setSwrx ( Scalar v )

inlineinherited

Set the residual total liquid saturation.

Parameters

v	Set the resiudal gas saturation

◆ setVgAlpha()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setVgAlpha ( Scalar v )

inlineinherited

Set the \(\mathrm{\alpha}\) shape parameter of van Genuchten's curve.

Parameters

v	Set shape parameter

◆ setVgm()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setVgm ( Scalar m )

inlineinherited

Set the \(\mathrm{m}\) shape parameter of van Genuchten's curve.

Parameters

m	Set shape parameter

The \(\mathrm{n}\) shape parameter is set to \(n = \frac{1}{1 - m}\)

◆ setVgn()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setVgn ( Scalar n )

inlineinherited

Set the \(\mathrm{n}\) shape parameter of van Genuchten's curve.

Parameters

n	Set shape parameter

The \(\mathrm{n}\) shape parameter is set to \(\mathrm{m = 1 - \frac{1}{n}}\)

◆ sgr()

template<class ScalarT >

Scalar Dumux::ParkerVanGen3PParams< ScalarT >::sgr ( ) const

inlineinherited

Return the residual gas saturation.

◆ snr()

template<class ScalarT >

Scalar Dumux::ParkerVanGen3PParams< ScalarT >::snr ( ) const

inlineinherited

Return the residual non-wetting saturation.

◆ swr()

template<class ScalarT >

Scalar Dumux::ParkerVanGen3PParams< ScalarT >::swr ( ) const

inlineinherited

Return the residual wetting saturation.

◆ swrx()

template<class ScalarT >

Scalar Dumux::ParkerVanGen3PParams< ScalarT >::swrx ( ) const

inlineinherited

Set the residual total liquid saturation.

◆ useConstRegularization()

template<class ScalarT >

void Dumux::RegularizedParkerVanGen3PParams< ScalarT >::useConstRegularization ( const bool input )

inline

Choose whether to use a constant value for regularization of the pc-S curves or not.

Parameters

input True or false

◆ vgAlpha()

template<class ScalarT >

Scalar Dumux::ParkerVanGen3PParams< ScalarT >::vgAlpha ( ) const

inlineinherited

Return the \(\mathrm{\alpha}\) shape parameter of van Genuchten's curve.

◆ vgm()

template<class ScalarT >

Scalar Dumux::ParkerVanGen3PParams< ScalarT >::vgm ( ) const

inlineinherited

Return the \(\mathrm{m}\) shape parameter of van Genuchten's curve.

◆ vgn()

template<class ScalarT >

Scalar Dumux::ParkerVanGen3PParams< ScalarT >::vgn ( ) const

inlineinherited

Return the \(\mathrm{n}\) shape parameter of van Genuchten's curve.

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

regularizedparkervangen3pparams.hh

Description

Public Types

Public Member Functions

Member Typedef Documentation

◆ Scalar

Constructor & Destructor Documentation

◆ RegularizedParkerVanGen3PParams() [1/2]

◆ RegularizedParkerVanGen3PParams() [2/2]

Member Function Documentation

◆ betaGn()

◆ betaGw()

◆ betaNw()

◆ constRegularization()

◆ KdNAPL()

◆ krRegardsSnr()

◆ pcHighS()

◆ pcLowS()

◆ rhoBulk()

◆ satResidual()

◆ setBetaGn()

◆ setBetaGw()

◆ setBetaNw()

◆ setKdNAPL()

◆ setKrRegardsSnr()

◆ setPcHighS()

◆ setPcLowS()

◆ setResiduals()

◆ setRhoBulk()

◆ setSgr()

◆ setSnr()

◆ setSwr()

◆ setSwrx()

◆ setVgAlpha()

◆ setVgm()

◆ setVgn()

◆ sgr()

◆ snr()

◆ swr()

◆ swrx()

◆ useConstRegularization()

◆ vgAlpha()

◆ vgm()

◆ vgn()