3.4
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Public Member Functions | List of all members
Dumux::FluidMatrix::TwoPEffToAbsDefaultPolicy::Params< Scalar > Struct Template Reference

The parameter type. More...

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

Description

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

The parameter type.

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)
 
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 non-wetting saturation. More...
 
void setSnr (Scalar v)
 Set the residual non-wetting saturation. More...
 
bool operator== (const Params &p) const
 

Constructor & Destructor Documentation

◆ Params()

template<class Scalar >
Dumux::FluidMatrix::TwoPEffToAbsDefaultPolicy::Params< Scalar >::Params ( const Scalar  swr = 0.0,
const Scalar  snr = 0.0 
)
inline

Member Function Documentation

◆ operator==()

template<class Scalar >
bool Dumux::FluidMatrix::TwoPEffToAbsDefaultPolicy::Params< Scalar >::operator== ( const Params< Scalar > &  p) const
inline

◆ setSnr()

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

Set the residual non-wetting saturation.

◆ setSwr()

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

Set the residual wetting saturation.

◆ snr()

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

Return the residual non-wetting saturation.

◆ swr()

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

Return the residual wetting saturation.


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