version 3.8.0
Loading...
Searching...
No Matches
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 >
Template Parameters
ScalarThe 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.
 
void setSwr (Scalar v)
 Set the residual wetting saturation.
 
Scalar snr () const
 Return the residual nonwetting saturation.
 
void setSnr (Scalar v)
 Set the residual nonwetting saturation.
 
Scalar sgr () const
 Return the residual gas phase saturation.
 
void setSgr (Scalar v)
 Set the residual gas phase saturation.
 
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

◆ setSnr()

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

◆ setSwr()

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

◆ sgr()

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

◆ snr()

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

◆ swr()

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

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