3.5-git
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Classes | Public Member Functions | List of all members
Dumux::FluidMatrix::ParkerVanGenuchten3PRegularization< Scalar > Class Template Reference

A regularization for the ParkerVanGenuchten3PRegularization material law. More...

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

Description

template<class Scalar>
class Dumux::FluidMatrix::ParkerVanGenuchten3PRegularization< Scalar >

A regularization for the ParkerVanGenuchten3PRegularization material law.

Note
Regularization can be turned of by setting the threshold parameters out of range (runtime) or by replacing this class by NoRegularization (compile time).

Classes

struct  Params
 Regularization parameters. More...
 

Public Member Functions

template<class MaterialLaw >
void init (const MaterialLaw *m, const std::string &paramGroup)
 Initialize the spline. More...
 
template<class MaterialLaw , class BaseParams , class EffToAbsParams >
void init (const MaterialLaw *m, const BaseParams &bp, const EffToAbsParams &etap, const Params< Scalar > &p)
 
bool operator== (const ParkerVanGenuchten3PRegularization &o) const
 Equality comparison with another instance. More...
 
OptionalScalar< Scalar > pcgw (Scalar swe) const
 The regularized capillary pressure-saturation curve for the gas and wetting phase regularized part: More...
 
OptionalScalar< Scalar > pcnw (Scalar swe) const
 The regularized capillary pressure-saturation curve for the nonwetting and wetting phase regularized part: More...
 
OptionalScalar< Scalar > pcgn (Scalar ste) const
 The regularized capillary pressure-saturation curve for the gas and nonwetting phase regularized part: More...
 
OptionalScalar< Scalar > pcAlpha (Scalar sne) const
 This function ensures a continuous transition from 2 to 3 phases and vice versa. More...
 
OptionalScalar< Scalar > krw (const Scalar swe) const
 The regularized relative permeability for the wetting phase. More...
 
OptionalScalar< Scalar > krn (Scalar swe, const Scalar sn, Scalar ste) const
 The regularized relative permeability for the nonwetting phase. More...
 
OptionalScalar< Scalar > krg (const Scalar ste) const
 The regularized relative permeability for the gas phase. More...
 
OptionalScalar< Scalar > kr (const int phaseIdx, const Scalar swe, const Scalar sne) const
 The relative permeability for a phase. More...
 

Member Function Documentation

◆ init() [1/2]

template<class Scalar >
template<class MaterialLaw , class BaseParams , class EffToAbsParams >
void Dumux::FluidMatrix::ParkerVanGenuchten3PRegularization< Scalar >::init ( const MaterialLaw *  m,
const BaseParams &  bp,
const EffToAbsParams &  etap,
const Params< Scalar > &  p 
)
inline

◆ init() [2/2]

template<class Scalar >
template<class MaterialLaw >
void Dumux::FluidMatrix::ParkerVanGenuchten3PRegularization< Scalar >::init ( const MaterialLaw *  m,
const std::string &  paramGroup 
)
inline

Initialize the spline.

◆ kr()

template<class Scalar >
OptionalScalar< Scalar > Dumux::FluidMatrix::ParkerVanGenuchten3PRegularization< Scalar >::kr ( const int  phaseIdx,
const Scalar  swe,
const Scalar  sne 
) const
inline

The relative permeability for a phase.

Parameters
phaseIdxIndicator, The saturation of all phases.
sweEffective wetting phase saturation
sneEffective nonwetting saturation

◆ krg()

template<class Scalar >
OptionalScalar< Scalar > Dumux::FluidMatrix::ParkerVanGenuchten3PRegularization< Scalar >::krg ( const Scalar  ste) const
inline

The regularized relative permeability for the gas phase.

Parameters
steEffective total (wetting + nonwetting) saturation

◆ krn()

template<class Scalar >
OptionalScalar< Scalar > Dumux::FluidMatrix::ParkerVanGenuchten3PRegularization< Scalar >::krn ( Scalar  swe,
const Scalar  sn,
Scalar  ste 
) const
inline

The regularized relative permeability for the nonwetting phase.

Parameters
sweEffective wetting phase saturation
snNonwetting saturation
steEffective total (wetting + nonwetting) saturation

◆ krw()

template<class Scalar >
OptionalScalar< Scalar > Dumux::FluidMatrix::ParkerVanGenuchten3PRegularization< Scalar >::krw ( const Scalar  swe) const
inline

The regularized relative permeability for the wetting phase.

Parameters
sweEffective wetting phase saturation

◆ operator==()

template<class Scalar >
bool Dumux::FluidMatrix::ParkerVanGenuchten3PRegularization< Scalar >::operator== ( const ParkerVanGenuchten3PRegularization< Scalar > &  o) const
inline

Equality comparison with another instance.

◆ pcAlpha()

template<class Scalar >
OptionalScalar< Scalar > Dumux::FluidMatrix::ParkerVanGenuchten3PRegularization< Scalar >::pcAlpha ( Scalar  sne) const
inline

This function ensures a continuous transition from 2 to 3 phases and vice versa.

Parameters
sneEffective nonwetting liquid saturation

◆ pcgn()

template<class Scalar >
OptionalScalar< Scalar > Dumux::FluidMatrix::ParkerVanGenuchten3PRegularization< Scalar >::pcgn ( Scalar  ste) const
inline

The regularized capillary pressure-saturation curve for the gas and nonwetting phase regularized part:

  • low saturation: extend the \(\mathrm{p_{cgn}(S_{te})}\) curve with the slope at the regularization point (i.e. no kink).
  • high saturation: connect the high regularization point with with a spline and continue linearly for \(\mathrm{S_{te} > 1}\)
    Parameters
    steEffective total liquid (sw + sn) saturation

◆ pcgw()

template<class Scalar >
OptionalScalar< Scalar > Dumux::FluidMatrix::ParkerVanGenuchten3PRegularization< Scalar >::pcgw ( Scalar  swe) const
inline

The regularized capillary pressure-saturation curve for the gas and wetting phase regularized part:

  • low saturation: extend the \(\mathrm{p_{cgw}(S_{we})}\) curve with the slope at the regularization point (i.e. no kink).
  • high saturation: connect the high regularization point with with a spline and continue linearly for \(\mathrm{S_{we} > 1}\)
    Parameters
    sweEffective wetting phase saturation

◆ pcnw()

template<class Scalar >
OptionalScalar< Scalar > Dumux::FluidMatrix::ParkerVanGenuchten3PRegularization< Scalar >::pcnw ( Scalar  swe) const
inline

The regularized capillary pressure-saturation curve for the nonwetting and wetting phase regularized part:

  • low saturation: extend the \(\mathrm{p_{cnw}(S_{we})}\) curve with the slope at the regularization point (i.e. no kink).
  • high saturation: connect the high regularization point with with a spline and continue linearly for \(\mathrm{S_{we} > 1}\)
    Parameters
    sweEffective wetting phase saturation

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