Dumux::EffToAbsLawParams< EffLawParamsT > Class Template Reference

A default implementation of the parameters for the adapter class to convert material laws from effective to absolute saturations. More...

#include <dumux/material/fluidmatrixinteractions/2p/efftoabslawparams.hh>

Inheritance diagram for Dumux::EffToAbsLawParams< EffLawParamsT >:

Description

template<class EffLawParamsT>
class Dumux::EffToAbsLawParams< EffLawParamsT >

A default implementation of the parameters for the adapter class to convert material laws from effective to absolute saturations.

Public Types
using	Scalar = typename EffLawParams::Scalar
using	Scalar = typename EffLawParams::Scalar

Public Member Functions
	EffToAbsLawParams ()
template<class OtherParams>
bool	operator== (const OtherParams &otherParams) const
	Equality comparison with another set of params.
Scalar	swr () const
	Return the residual wetting saturation.
void	setSwr (Scalar v)
	Set the residual wetting saturation.
Scalar	snr () const
	Return the residual non-wetting saturation.
void	setSnr (Scalar v)
	Set the residual non-wetting saturation.
	EffToAbsLawParams ()
Scalar	swr () const
	Return the residual wetting saturation.
void	setSwr (Scalar v)
	Set the residual wetting saturation.
Scalar	snr () const
	Return the residual non-wetting saturation.
void	setSnr (Scalar v)
	Set the residual non-wetting saturation.
Scalar	sgr () const
	Return the residual gas saturation.
void	setSgr (Scalar v)
	Set the residual gas saturation.
Scalar	swrx () const
	Set the residual total liquid saturation.
void	setSwrx (Scalar v)
	Set the residual total liquid saturation.

Member Typedef Documentation

Scalar [1/2]

template<class EffLawParamsT>

using Dumux::EffToAbsLawParams< EffLawParamsT >::Scalar = typename EffLawParams::Scalar

Scalar [2/2]

template<class EffLawParamsT>

using Dumux::EffToAbsLawParams< EffLawParamsT >::Scalar = typename EffLawParams::Scalar

Constructor & Destructor Documentation

EffToAbsLawParams() [1/2]

template<class EffLawParamsT>

Dumux::EffToAbsLawParams< EffLawParamsT >::EffToAbsLawParams ( )

inline

EffToAbsLawParams() [2/2]

template<class EffLawParamsT>

Dumux::EffToAbsLawParams< EffLawParamsT >::EffToAbsLawParams ( )

inline

Member Function Documentation

operator==()

template<class EffLawParamsT>

template<class OtherParams>

bool Dumux::EffToAbsLawParams< EffLawParamsT >::operator== ( const OtherParams & otherParams ) const

inline

Equality comparison with another set of params.

setSgr()

template<class EffLawParamsT>

void Dumux::EffToAbsLawParams< EffLawParamsT >::setSgr ( Scalar v )

inline

Set the residual gas saturation.

Parameters

v	Set the resiudal gas saturation

setSnr() [1/2]

template<class EffLawParamsT>

void Dumux::EffToAbsLawParams< EffLawParamsT >::setSnr ( Scalar v )

inline

Set the residual non-wetting saturation.

setSnr() [2/2]

template<class EffLawParamsT>

void Dumux::EffToAbsLawParams< EffLawParamsT >::setSnr ( Scalar v )

inline

Set the residual non-wetting saturation.

setSwr() [1/2]

template<class EffLawParamsT>

void Dumux::EffToAbsLawParams< EffLawParamsT >::setSwr ( Scalar v )

inline

Set the residual wetting saturation.

setSwr() [2/2]

template<class EffLawParamsT>

void Dumux::EffToAbsLawParams< EffLawParamsT >::setSwr ( Scalar v )

inline

Set the residual wetting saturation.

setSwrx()

template<class EffLawParamsT>

void Dumux::EffToAbsLawParams< EffLawParamsT >::setSwrx ( Scalar v )

inline

Set the residual total liquid saturation.

Parameters

v	Set the resiudal gas saturation

sgr()

template<class EffLawParamsT>

Scalar Dumux::EffToAbsLawParams< EffLawParamsT >::sgr ( ) const

inline

Return the residual gas saturation.

snr() [1/2]

template<class EffLawParamsT>

Scalar Dumux::EffToAbsLawParams< EffLawParamsT >::snr ( ) const

inline

Return the residual non-wetting saturation.

snr() [2/2]

template<class EffLawParamsT>

Scalar Dumux::EffToAbsLawParams< EffLawParamsT >::snr ( ) const

inline

Return the residual non-wetting saturation.

swr() [1/2]

template<class EffLawParamsT>

Scalar Dumux::EffToAbsLawParams< EffLawParamsT >::swr ( ) const

inline

Return the residual wetting saturation.

swr() [2/2]

template<class EffLawParamsT>

Scalar Dumux::EffToAbsLawParams< EffLawParamsT >::swr ( ) const

inline

Return the residual wetting saturation.

swrx()

template<class EffLawParamsT>

Scalar Dumux::EffToAbsLawParams< EffLawParamsT >::swrx ( ) const

inline

Set the residual total liquid saturation.

---

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

• 2p/efftoabslawparams.hh
• 3p/efftoabslawparams.hh