Implementation of the Brooks-Corey capillary pressure <-> saturation relation. This class bundles the "raw" curves as static members and doesn't concern itself converting absolute to effective saturations and vice versa. More...

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

Description

template<class ScalarT, class ParamsT = BrooksCoreyParams<ScalarT>>
class Dumux::BrooksCorey< ScalarT, ParamsT >

Implementation of the Brooks-Corey capillary pressure <-> saturation relation. This class bundles the "raw" curves as static members and doesn't concern itself converting absolute to effective saturations and vice versa.

For general info: EffToAbsLaw

See also: BrooksCoreyParams

Public Types
using	Params = ParamsT

using	Scalar = typename Params::Scalar

Static Public Member Functions
static Scalar	pc (const Params &params, Scalar swe)
	The capillary pressure-saturation curve according to Brooks & Corey. More...

static Scalar	sw (const Params &params, Scalar pc)
	The saturation-capillary pressure curve according to Brooks & Corey. More...

static Scalar	endPointPc (const Params &params)
	The capillary pressure at Swe = 1.0 also called end point capillary pressure. More...

static Scalar	dpc_dswe (const Params &params, Scalar swe)
	The partial derivative of the capillary pressure w.r.t. the effective saturation according to Brooks & Corey. More...

static Scalar	dswe_dpc (const Params &params, Scalar pc)
	The partial derivative of the effective saturation w.r.t. the capillary pressure according to Brooks & Corey. More...

static Scalar	krw (const Params &params, Scalar swe)
	The relative permeability for the wetting phase of the medium implied by the Brooks-Corey parameterization. More...

static Scalar	dkrw_dswe (const Params &params, Scalar swe)
	The derivative of the relative permeability for the wetting phase with regard to the wetting saturation of the medium implied by the Brooks-Corey parameterization. More...

static Scalar	krn (const Params &params, Scalar swe)
	The relative permeability for the nonwetting phase of the medium as implied by the Brooks-Corey parameterization. More...

static Scalar	dkrn_dswe (const Params &params, Scalar swe)
	The derivative of the relative permeability for the nonwetting phase in regard to the wetting saturation of the medium as implied by the Brooks-Corey parameterization. More...

Member Typedef Documentation

◆ Params

template<class ScalarT , class ParamsT = BrooksCoreyParams<ScalarT>>

using Dumux::BrooksCorey< ScalarT, ParamsT >::Params = ParamsT

◆ Scalar

template<class ScalarT , class ParamsT = BrooksCoreyParams<ScalarT>>

using Dumux::BrooksCorey< ScalarT, ParamsT >::Scalar = typename Params::Scalar

Member Function Documentation

◆ dkrn_dswe()

template<class ScalarT , class ParamsT = BrooksCoreyParams<ScalarT>>

static Scalar Dumux::BrooksCorey< ScalarT, ParamsT >::dkrn_dswe	(	const Params &	params,
		Scalar	swe
	)

inlinestatic

The derivative of the relative permeability for the nonwetting phase in regard to the wetting saturation of the medium as implied by the Brooks-Corey parameterization.

Parameters

swe	The mobile saturation of the wetting phase.
params	A 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 relative permeability of the nonwetting phase w.r.t. effective wetting phase saturation calculated as implied by Brooks & Corey.

Note: Instead of undefined behaviour if pc is not in the valid range, we return a valid number, by clamping the input.

◆ dkrw_dswe()

template<class ScalarT , class ParamsT = BrooksCoreyParams<ScalarT>>

static Scalar Dumux::BrooksCorey< ScalarT, ParamsT >::dkrw_dswe	(	const Params &	params,
		Scalar	swe
	)

inlinestatic

The derivative of the relative permeability for the wetting phase with regard to the wetting saturation of the medium implied by the Brooks-Corey parameterization.

Parameters

swe	The mobile saturation of the wetting phase.
params	A 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 relative permeability of the wetting phase w.r.t. effective wetting phase saturation calculated as implied by Brooks & Corey.

Note: Instead of undefined behaviour if pc is not in the valid range, we return a valid number, by clamping the input.

◆ dpc_dswe()

template<class ScalarT , class ParamsT = BrooksCoreyParams<ScalarT>>

static Scalar Dumux::BrooksCorey< ScalarT, ParamsT >::dpc_dswe	(	const Params &	params,
		Scalar	swe
	)

inlinestatic

The partial derivative of the capillary pressure w.r.t. the effective saturation according to Brooks & Corey.

This is equivalent to \(\mathrm{\frac{\partial p_C}{\partial \overline{S}_w} = -\frac{p_e}{\lambda} \overline{S}_w^{-1/\lambda - 1} }\)

Parameters

swe	Effective saturation of the wetting phase \(\mathrm{[\overline{S}_w]}\)
params	A 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: Partial derivative of \(\mathrm{[p_c]}\) w.r.t. effective saturation according to Brooks & Corey.

Note: Instead of undefined behaviour if pc is not in the valid range, we return a valid number, by clamping the input.

◆ dswe_dpc()

template<class ScalarT , class ParamsT = BrooksCoreyParams<ScalarT>>

static Scalar Dumux::BrooksCorey< ScalarT, ParamsT >::dswe_dpc	(	const Params &	params,
		Scalar	pc
	)

inlinestatic

The partial derivative of the effective saturation w.r.t. the capillary pressure according to Brooks & Corey.

Parameters

pc	Capillary pressure \(\mathrm{[p_c]}\) in \(\mathrm{[Pa]}\).
params	A 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: Partial derivative of effective saturation w.r.t. \(\mathrm{[p_c]}\) according to Brooks & Corey.

Note: Instead of undefined behaviour if pc is not in the valid range, we return a valid number, by clamping the input.

◆ endPointPc()

template<class ScalarT , class ParamsT = BrooksCoreyParams<ScalarT>>

static Scalar Dumux::BrooksCorey< ScalarT, ParamsT >::endPointPc ( const Params & params )

inlinestatic

The capillary pressure at Swe = 1.0 also called end point capillary pressure.

Parameters

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

◆ krn()

template<class ScalarT , class ParamsT = BrooksCoreyParams<ScalarT>>

static Scalar Dumux::BrooksCorey< ScalarT, ParamsT >::krn	(	const Params &	params,
		Scalar	swe
	)

inlinestatic

The relative permeability for the nonwetting phase of the medium as implied by the Brooks-Corey parameterization.

Parameters

swe	The mobile saturation of the wetting phase.
params	A 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: Relative permeability of the nonwetting phase calculated as implied by Brooks & Corey.

Note: Instead of undefined behaviour if pc is not in the valid range, we return a valid number, by clamping the input.

◆ krw()

template<class ScalarT , class ParamsT = BrooksCoreyParams<ScalarT>>

static Scalar Dumux::BrooksCorey< ScalarT, ParamsT >::krw	(	const Params &	params,
		Scalar	swe
	)

inlinestatic

The relative permeability for the wetting phase of the medium implied by the Brooks-Corey parameterization.

Parameters

swe	The mobile saturation of the wetting phase.
params	A 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: Relative permeability of the wetting phase calculated as implied by Brooks & Corey.

Note: Instead of undefined behaviour if pc is not in the valid range, we return a valid number, by clamping the input.

◆ pc()

template<class ScalarT , class ParamsT = BrooksCoreyParams<ScalarT>>

static Scalar Dumux::BrooksCorey< ScalarT, ParamsT >::pc	(	const Params &	params,
		Scalar	swe
	)

inlinestatic

The capillary pressure-saturation curve according to Brooks & Corey.

The Brooks-Corey empirical capillary pressure <-> saturation function is given by

\(\mathrm{ p_C = p_e\overline{S}_w^{-1/\lambda} }\)

Parameters

swe	Effective saturation of the wetting phase \(\mathrm{[\overline{S}_w]}\)
params	A 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: Capillary pressure calculated by Brooks & Corey constitutive relation.

Note: Instead of undefined behaviour if pc is not in the valid range, we return a valid number, by clamping the input.

◆ sw()

template<class ScalarT , class ParamsT = BrooksCoreyParams<ScalarT>>

static Scalar Dumux::BrooksCorey< ScalarT, ParamsT >::sw	(	const Params &	params,
		Scalar	pc
	)

inlinestatic

The saturation-capillary pressure curve according to Brooks & Corey.

This is the inverse of the capillary pressure-saturation curve: \(\mathrm{ \overline{S}_w = (\frac{p_C}{p_e})^{-\lambda}}\)

Parameters

pc	Capillary pressure \(\mathrm{[p_C]}\) in \(\mathrm{[Pa]}\).
params	A 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 wetting phase saturation calculated as inverse of BrooksCorey constitutive relation.

Note: Instead of undefined behaviour if pc is not in the valid range, we return a valid number, by clamping the input.

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

brookscorey.hh

Description

Public Types

Static Public Member Functions

Member Typedef Documentation

◆ Params

◆ Scalar

Member Function Documentation

◆ dkrn_dswe()

◆ dkrw_dswe()

◆ dpc_dswe()

◆ dswe_dpc()

◆ endPointPc()

◆ krn()

◆ krw()

◆ pc()

◆ sw()