Dumux::FluidMatrix::ParkerVanGenuchten3PEffToAbsPolicy::Params< Scalar > Struct Template Reference

The parameter type. More...

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

Description

template<class Scalar>
struct Dumux::FluidMatrix::ParkerVanGenuchten3PEffToAbsPolicy::Params< Scalar >

The parameter type.

Template Parameters

Scalar

The scalar type

Note

The efftoabs policy need two parameters: \(\mathrm{S_{w,r}}, \mathrm{S_{n,r}}\). For the respective formulas check out the description of the free function.

Public Member Functions
	Params (const Scalar swr=0.0, const Scalar snr=0.0, const Scalar sgr=0.0)
Scalar	swr () const
	Return the residual wetting saturation. More...
void	setSwr (Scalar v)
	Set the residual wetting saturation. More...
Scalar	snr () const
	Return the residual nonwetting saturation. More...
void	setSnr (Scalar v)
	Set the residual nonwetting saturation. More...
Scalar	sgr () const
	Return the residual gas phase saturation. More...
void	setSgr (Scalar v)
	Set the residual gas phase saturation. More...
bool	operator== (const Params &p) const

Constructor & Destructor Documentation

Params()

template<class Scalar >

Dumux::FluidMatrix::ParkerVanGenuchten3PEffToAbsPolicy::Params< Scalar >::Params ( const Scalar  swr = 0.0, const Scalar  snr = 0.0, const Scalar  sgr = 0.0  )

inline

Member Function Documentation

operator==()

template<class Scalar >

bool Dumux::FluidMatrix::ParkerVanGenuchten3PEffToAbsPolicy::Params< Scalar >::operator== ( const Params< Scalar > &  p ) const

inline

setSgr()

template<class Scalar >

void Dumux::FluidMatrix::ParkerVanGenuchten3PEffToAbsPolicy::Params< Scalar >::setSgr ( Scalar  v )

inline

Set the residual gas phase saturation.

setSnr()

template<class Scalar >

void Dumux::FluidMatrix::ParkerVanGenuchten3PEffToAbsPolicy::Params< Scalar >::setSnr ( Scalar  v )

inline

Set the residual nonwetting saturation.

setSwr()

template<class Scalar >

void Dumux::FluidMatrix::ParkerVanGenuchten3PEffToAbsPolicy::Params< Scalar >::setSwr ( Scalar  v )

inline

Set the residual wetting saturation.

sgr()

template<class Scalar >

Scalar Dumux::FluidMatrix::ParkerVanGenuchten3PEffToAbsPolicy::Params< Scalar >::sgr ( ) const

inline

Return the residual gas phase saturation.

snr()

template<class Scalar >

Scalar Dumux::FluidMatrix::ParkerVanGenuchten3PEffToAbsPolicy::Params< Scalar >::snr ( ) const

inline

Return the residual nonwetting saturation.

swr()

template<class Scalar >

Scalar Dumux::FluidMatrix::ParkerVanGenuchten3PEffToAbsPolicy::Params< Scalar >::swr ( ) const

inline

Return the residual wetting saturation.

---

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

• parkervangenuchten.hh