3.6-git
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Classes | Static Public Member Functions | List of all members
Dumux::FluidMatrix::TwoPEffToAbsDefaultPolicy Class Reference

This is a policy for 2p material laws how to convert absolute to relative saturations and vice versa. More...

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

Description

This is a policy for 2p material laws how to convert absolute to relative saturations and vice versa.

Material laws (like VanGenuchten or BrooksCorey) are defined for effective saturations. The numeric calculations however are performed with absolute saturations. The policy class converts the saturations. This allows for changing the calculation of the effective saturations easily, as this is subject of discussion / may be problem specific.

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...
 

Member Function Documentation

◆ dsw_dswe()

template<class Scalar >
static Scalar Dumux::FluidMatrix::TwoPEffToAbsDefaultPolicy::dsw_dswe ( const Params< Scalar > &  params)
inlinestatic

Derivative of the absolute saturation w.r.t. the effective saturation.

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::TwoPEffToAbsDefaultPolicy::dswe_dsw ( const Params< Scalar > &  params)
inlinestatic

Derivative of the effective saturation w.r.t. the absolute saturation.

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::TwoPEffToAbsDefaultPolicy::makeParams ( const std::string &  paramGroup)
inlinestatic

Construct from a subgroup from the global parameter tree.

Note
This will give you nice error messages if a mandatory parameter is missing

◆ sweToSw()

template<class Scalar >
static Scalar Dumux::FluidMatrix::TwoPEffToAbsDefaultPolicy::sweToSw ( const Scalar  swe,
const Params< Scalar > &  params 
)
inlinestatic

Convert an effective wetting saturation to an absolute one.

Parameters
sweEffective saturation of the non-wetting 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 non-wetting phase.

◆ swToSwe()

template<class Scalar >
static Scalar Dumux::FluidMatrix::TwoPEffToAbsDefaultPolicy::swToSwe ( const Scalar  sw,
const Params< Scalar > &  params 
)
inlinestatic

Convert an absolute wetting saturation to an effective one.

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 class was generated from the following file: