version 3.9-dev
Dumux::FluidMatrix::ParkerVanGenuchten3PEffToAbsPolicy Struct Reference

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

Classes

struct  Params
 The parameter type. More...
 

Static Public Member Functions

template<class Scalar >
static Params< Scalar > makeParams (const std::string &paramGroup)
 Construct from a subgroup from the global parameter tree. More...
 
template<class Scalar >
static Scalar swToSwe (const Scalar sw, const Params< Scalar > &params)
 Convert an absolute wetting saturation to an effective one. More...
 
template<class Scalar >
static Scalar sweToSw (const Scalar swe, const Params< Scalar > &params)
 Convert an effective wetting saturation to an absolute one. More...
 
template<class Scalar >
static Scalar dswe_dsw (const Params< Scalar > &params)
 Derivative of the effective saturation w.r.t. the absolute saturation. More...
 
template<class Scalar >
static Scalar dsw_dswe (const Params< Scalar > &params)
 Derivative of the absolute saturation w.r.t. the effective saturation. More...
 
template<class Scalar >
static Scalar snToSne (const Scalar sn, const Params< Scalar > &params)
 Convert an absolute nonwetting saturation to an effective one. More...
 
template<class Scalar >
static Scalar stToSte (const Scalar st, const Params< Scalar > &params)
 Convert an absolute total liquid saturation to an effective one. More...
 
template<class Scalar >
static Scalar steToSt (const Scalar ste, const Params< Scalar > &params)
 Convert an effective wetting saturation to an absolute one. More...
 
template<class Scalar >
static Scalar dste_dst (const Params< Scalar > &params)
 Derivative of the effective saturation w.r.t. the absolute saturation. More...
 
template<class Scalar >
static Scalar dst_dste (const Params< Scalar > &params)
 Derivative of the absolute saturation w.r.t. the effective saturation. More...
 

Member Function Documentation

◆ dst_dste()

template<class Scalar >
static Scalar Dumux::FluidMatrix::ParkerVanGenuchten3PEffToAbsPolicy::dst_dste ( const Params< Scalar > &  params)
inlinestatic
Parameters
paramsA container object that is populated with the appropriate coefficients for the respective law. Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container is constructed accordingly. Afterwards the values are set there, too.
Returns
Derivative of the absolute saturation w.r.t. the effective saturation.

◆ dste_dst()

template<class Scalar >
static Scalar Dumux::FluidMatrix::ParkerVanGenuchten3PEffToAbsPolicy::dste_dst ( const Params< Scalar > &  params)
inlinestatic
Parameters
paramsA container object that is populated with the appropriate coefficients for the respective law. Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container is constructed accordingly. Afterwards the values are set there, too.
Returns
Derivative of the effective saturation w.r.t. the absolute saturation.

◆ dsw_dswe()

template<class Scalar >
static Scalar Dumux::FluidMatrix::ParkerVanGenuchten3PEffToAbsPolicy::dsw_dswe ( const Params< Scalar > &  params)
inlinestatic
Parameters
paramsA container object that is populated with the appropriate coefficients for the respective law. Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container is constructed accordingly. Afterwards the values are set there, too.
Returns
Derivative of the absolute saturation w.r.t. the effective saturation.

◆ dswe_dsw()

template<class Scalar >
static Scalar Dumux::FluidMatrix::ParkerVanGenuchten3PEffToAbsPolicy::dswe_dsw ( const Params< Scalar > &  params)
inlinestatic
Parameters
paramsA container object that is populated with the appropriate coefficients for the respective law. Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container is constructed accordingly. Afterwards the values are set there, too.
Returns
Derivative of the effective saturation w.r.t. the absolute saturation.

◆ makeParams()

template<class Scalar >
static Params< Scalar > Dumux::FluidMatrix::ParkerVanGenuchten3PEffToAbsPolicy::makeParams ( const std::string &  paramGroup)
inlinestatic
Note
This will give you nice error messages if a mandatory parameter is missing

◆ snToSne()

template<class Scalar >
static Scalar Dumux::FluidMatrix::ParkerVanGenuchten3PEffToAbsPolicy::snToSne ( const Scalar  sn,
const Params< Scalar > &  params 
)
inlinestatic
Parameters
snAbsolute saturation of the nonwetting phase \(\mathrm{[{S}_n]}\).
paramsA container object that is populated with the appropriate coefficients for the respective law. Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container is constructed accordingly. Afterwards the values are set there, too.
Returns
Effective saturation of the nonwetting phase.

◆ steToSt()

template<class Scalar >
static Scalar Dumux::FluidMatrix::ParkerVanGenuchten3PEffToAbsPolicy::steToSt ( const Scalar  ste,
const Params< Scalar > &  params 
)
inlinestatic
Parameters
steEffective total liquid (wetting + nonwetting) saturation
paramsA container object that is populated with the appropriate coefficients for the respective law. Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container is constructed accordingly. Afterwards the values are set there, too.
Returns
Absolute saturation of the nonwetting phase.

◆ stToSte()

template<class Scalar >
static Scalar Dumux::FluidMatrix::ParkerVanGenuchten3PEffToAbsPolicy::stToSte ( const Scalar  st,
const Params< Scalar > &  params 
)
inlinestatic
Parameters
stAbsolute saturation of the total liquid phase (sw+sn) \(\mathrm{[{S}_n]}\).
paramsA container object that is populated with the appropriate coefficients for the respective law. Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container is constructed accordingly. Afterwards the values are set there, too.
Returns
Effective saturation of the nonwetting phase.

◆ sweToSw()

template<class Scalar >
static Scalar Dumux::FluidMatrix::ParkerVanGenuchten3PEffToAbsPolicy::sweToSw ( const Scalar  swe,
const Params< Scalar > &  params 
)
inlinestatic
Parameters
sweEffective saturation of the nonwetting phase \(\mathrm{[\overline{S}_n]}\).
paramsA container object that is populated with the appropriate coefficients for the respective law. Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container is constructed accordingly. Afterwards the values are set there, too.
Returns
Absolute saturation of the nonwetting phase.

◆ swToSwe()

template<class Scalar >
static Scalar Dumux::FluidMatrix::ParkerVanGenuchten3PEffToAbsPolicy::swToSwe ( const Scalar  sw,
const Params< Scalar > &  params 
)
inlinestatic
Parameters
swAbsolute saturation of the wetting phase \(\mathrm{[{S}_w]}\).
paramsA container object that is populated with the appropriate coefficients for the respective law. Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container is constructed accordingly. Afterwards the values are set there, too.
Returns
Effective saturation of the wetting phase.

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