Commit 64dcb316 authored by Philipp Nuske's avatar Philipp Nuske
Browse files

doxygen documentation for the fluidmatrixinteraction


git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@4674 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent 874565be
......@@ -26,10 +26,9 @@
/*!
* \file
*
* \ingroup fluidmatrixinteractionslaws
*
* \brief Implementation of the capillary pressure and
* relative permeability <-> saturation relations according to Brooks and Corey.
*
*/
#ifndef DUMUX_BROOKS_COREY_HH
#define DUMUX_BROOKS_COREY_HH
......@@ -48,6 +47,9 @@ namespace Dumux
* as static members and doesn't concern itself converting
* absolute to effective saturations and vice versa.
*
* For general info: EffToAbsLaw
*
*\see BrooksCoreyParams
*/
template <class ScalarT, class ParamsT = BrooksCoreyParams<ScalarT> >
class BrooksCorey
......@@ -57,7 +59,7 @@ public:
typedef typename Params::Scalar Scalar;
/*!
* \brief The capillary pressure-saturation curve.
* \brief The capillary pressure-saturation curve according to Brooks & Corey.
*
* The Brooks-Corey empirical capillary pressure <-> saturation
* function is given by
......@@ -70,6 +72,7 @@ public:
* \param 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.
* \return Capillary pressure calculated by Brooks & Corey constitutive relation.
*/
static Scalar pC(const Params &params, Scalar Swe)
{
......@@ -79,7 +82,7 @@ public:
}
/*!
* \brief The saturation-capillary pressure curve.
* \brief The saturation-capillary pressure curve according to Brooks & Corey.
*
* This is the inverse of the capillary pressure-saturation curve:
* \f[
......@@ -90,8 +93,7 @@ public:
* \param 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.
*
* \return The effective saturation of the wetting phase \f$\overline{S}_w\f$
* \return Effective wetting phase saturation calculated as inverse of BrooksCorey constitutive relation.
*/
static Scalar Sw(const Params &params, Scalar pC)
{
......@@ -102,18 +104,20 @@ public:
}
/*!
* \brief Returns the partial derivative of the capillary
* pressure to the effective saturation.
* \brief The partial derivative of the capillary
* pressure w.r.t. the effective saturation according to Brooks & Corey.
*
* This is equivalent to
* \f[
\frac{\partial p_C}{\partial \overline{S}_w} =
-\frac{p_e}{\alpha} \overline{S}_w^{-1/\alpha - 1}
\f]
*
* \param Swe Effective saturation of the wetting phase \f$\overline{S}_w\f$
* \param 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.
* \return Partial derivative of \f$p_c\f$ w.r.t. effective saturation according to Brooks & Corey.
*/
static Scalar dpC_dSw(const Params &params, Scalar Swe)
{
......@@ -123,12 +127,14 @@ public:
}
/*!
* \brief Returns the partial derivative of the effective
* saturation to the capillary pressure.
* \param pC Capillary pressure \f$p_C\f$
* \brief The partial derivative of the effective
* saturation w.r.t. the capillary pressure according to Brooks & Corey.
*
* \param pC Capillary pressure \f$p_C\f$
* \param 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.
* \return Partial derivative of effective saturation w.r.t. \f$p_c\f$ according to Brooks & Corey.
*/
static Scalar dSw_dpC(const Params &params, Scalar pC)
{
......@@ -142,10 +148,11 @@ public:
* the medium implied by the Brooks-Corey
* parameterization.
*
* \param Swe effective saturation of the wetting phase.
* \param Swe The mobile saturation of the wetting phase.
* \param 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.
* \return Relative permeability of the wetting phase calculated as implied by Brooks & Corey.
*/
static Scalar krw(const Params &params, Scalar Swe)
{
......@@ -159,10 +166,11 @@ public:
* wetting phase with regard to the wetting saturation of the
* medium implied by the Brooks-Corey parameterization.
*
* \param Swe effective saturation of the wetting phase.
* \param Swe The mobile saturation of the wetting phase.
* \param 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.
* \return Derivative of the relative permeability of the wetting phase w.r.t. effective wetting phase saturation calculated as implied by Brooks & Corey.
*/
static Scalar dkrw_dSw(const Params &params, Scalar Swe)
{
......@@ -176,10 +184,11 @@ public:
* the medium as implied by the Brooks-Corey
* parameterization.
*
* \param Swe effective saturation of the wetting phase.
* \param Swe The mobile saturation of the wetting phase.
* \param 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.
* \return Relative permeability of the non-wetting phase calculated as implied by Brooks & Corey.
*/
static Scalar krn(const Params &params, Scalar Swe)
{
......@@ -196,10 +205,11 @@ public:
* the medium as implied by the Brooks-Corey
* parameterization.
*
* \param Swe effective saturation of the wetting phase.
* \param Swe The mobile saturation of the wetting phase.
* \param 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.
* \return Derivative of the relative permeability of the non-wetting phase w.r.t. effective wetting phase saturation calculated as implied by Brooks & Corey.
*/
static Scalar dkrn_dSw(const Params &params, Scalar Swe)
{
......
......@@ -13,11 +13,16 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \ingroup fluidmatrixinteractions
* \defgroup fluidmatrixinteractionsparams FluidMatrixInteractions Parameters
*/
/*!
* \file
*
* \brief Specification of the params API for the Brooks-Corey
* capillary pressure model.
* \brief Specification of the material parameters
* for the Brooks Corey constitutive relations.
*/
#ifndef DUMUX_BROOKS_COREY_PARAMS_HH
#define DUMUX_BROOKS_COREY_PARAMS_HH
......@@ -28,8 +33,12 @@ namespace Dumux
{
/*!
* \brief A reference implementation of the params API class for the
* Brooks-Corey Sw-pC relation.
* \brief Specification of the material parameters
* for the Brooks Corey constitutive relations.
*
* \ingroup fluidmatrixinteractionsparams
*
*\see BrooksCorey
*/
template <class ScalarT>
class BrooksCoreyParams
......
......@@ -19,6 +19,7 @@
* \brief This material law takes a material law defined for effective
* saturations and converts it to a material law defined on
* absolute saturations.
*
*/
#ifndef DUMUX_EFF_TO_ABS_LAW_HH
#define DUMUX_EFF_TO_ABS_LAW_HH
......@@ -28,11 +29,30 @@
namespace Dumux
{
/*!
* \ingroup material
* \ingroup fluidmatrixinteractionslaws
*
* \brief This material law takes a material law defined for effective
* saturations and converts it to a material law defined on absolute
* saturations.
*
* The idea: "material laws" (like VanGenuchten or BrooksCorey) are defined for effective saturations.
* The numeric calculations however are performed with absolute saturations. The EffToAbsLaw class gets
* the "material laws" actually used as well as the corresponding parameter container as template arguments.
*
* Subsequently, the desired function (pc, Sw... ) of the actually used "material laws" are called but with the
* saturations already converted from absolute to effective.
*
* This approach makes sure that in the "material laws" only effective saturations are considered, which makes sense,
* as these laws only deal with effective saturations. This also allows for changing the calculation of the effective
* saturations easily, as this is subject of discussion / may be problem specific.
*
* Additionally, handing over effective saturations to the "material laws" in stead of them calculating effective
* saturations prevents accidently "converting twice".
*
* This boils down to:
* - the actual material laws (linear, VanGenuchten...) do not need to deal with any kind of conversion
* - the definition of the material law in the spatial parameters is not really intuitive, but using it is:
* Hand in values, get back values, do not deal with conversion.
*/
template <class EffLawT, class AbsParamsT = EffToAbsLawParams<typename EffLawT::Params> >
class EffToAbsLaw
......@@ -46,9 +66,14 @@ public:
/*!
* \brief The capillary pressure-saturation curve.
*
* \param params material law parameters
* \param Sw wetting phase saturation
* \return the capillary pressure
*
* \param Sw Absolute saturation of the wetting phase \f$\overline{S}_w\f$. It is converted to effective saturation
* and then handed over to the material law actually used for calculation.
* \param 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.
* \return Capillary pressure calculated by specific constitutive relation (EffLaw e.g. Brooks & Corey, van Genuchten, linear...)
*
*/
static Scalar pC(const Params &params, Scalar Sw)
{
......@@ -58,9 +83,13 @@ public:
/*!
* \brief The saturation-capillary pressure curve.
*
* \param params material law parameters
* \param pC capillary pressure
* \return the absolute saturation of the wetting phase \f$S_w\f$
* \param pC Capillary pressure \f$p_C\f$:
* \param 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.
*\return Absolute wetting phase saturation calculated as inverse of (EffLaw e.g. Brooks & Corey, van Genuchten, linear...) constitutive relation.
*
* \return The absolute saturation of the wetting phase \f$S_w\f$
*/
static Scalar Sw(const Params &params, Scalar pC)
{
......@@ -69,24 +98,40 @@ public:
/*!
* \brief Returns the partial derivative of the capillary
* pressure to the absolute saturation.
* pressure w.r.t the absolute saturation.
*
* \param params material law parameters
* \param Sw wetting phase saturation
* \return the derivative of the capillary pressure w.r.t. saturation
* In this case the chain rule needs to be applied:
\f[
p_c = p_c( \overline S_w (S_w))
\rightarrow p_c ^\prime = \frac{\partial p_c}{\partial \overline S_w} \frac{\partial \overline S_w}{\partial S_w}
\f]
* \param Sw Absolute saturation of the wetting phase \f$\overline{S}_w\f$.
* \param 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.
* \return Partial derivative of \f$p_c\f$ w.r.t. effective saturation according to EffLaw e.g. Brooks & Corey, van Genuchten, linear... .
*/
static Scalar dpC_dSw(const Params &params, Scalar Sw)
{
return EffLaw::dpC_dSw(params, Sw)*dSwe_dSw_(params);
return EffLaw::dpC_dSw(params, SwToSwe(params, Sw) )*dSwe_dSw_(params);
}
/*!
* \brief Returns the partial derivative of the absolute
* saturation to the capillary pressure.
* saturation w.r.t. the capillary pressure.
*
* In this case the chain rule needs to be applied:
\f[
S_w = S_w(\overline{S}_w (p_c) )
\rightarrow S_w^\prime = \frac{\partial S_w}{\partial \overline S_w} \frac{\partial \overline S_w}{\partial p_c}
\f]
*
*
* \param params material law parameters
* \param pC capillary pressure
* \return the derivative of the saturation w.r.t. capillary pressure
* \param pC Capillary pressure \f$p_C\f$:
* \param 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.
* \return Partial derivative of effective saturation w.r.t. \f$p_c\f$ according to EffLaw e.g. Brooks & Corey, van Genuchten, linear... .
*/
static Scalar dSw_dpC(const Params &params, Scalar pC)
{
......@@ -96,9 +141,13 @@ public:
/*!
* \brief The relative permeability for the wetting phase.
*
* \param params material law parameters
* \param Sw wetting phase saturation
* \return the relative permeability of the wetting phase
* \param Sw Absolute saturation of the wetting phase \f$\overline{S}_w\f$. It is converted to effective saturation
* and then handed over to the material law actually used for calculation.
* \param 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.
* \return Relative permeability of the wetting phase calculated as implied by EffLaw e.g. Brooks & Corey, van Genuchten, linear... .
*
*/
static Scalar krw(const Params &params, Scalar Sw)
{
......@@ -108,9 +157,12 @@ public:
/*!
* \brief The relative permeability for the non-wetting phase.
*
* \param params material law parameters
* \param Sw wetting phase saturation
* \return the relative permeability of the nonwetting phase
* \param Sw Absolute saturation of the wetting phase \f${S}_w\f$. It is converted to effective saturation
* and then handed over to the material law actually used for calculation.
* \param 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.
* \return Relative permeability of the non-wetting phase calculated as implied by EffLaw e.g. Brooks & Corey, van Genuchten, linear... .
*/
static Scalar krn(const Params &params, Scalar Sw)
{
......@@ -120,9 +172,11 @@ public:
/*!
* \brief Convert an absolute wetting saturation to an effective one.
*
* \param params material law parameters
* \param Sw absolute wetting phase saturation
* \return effective wetting phase saturation
* \param Sw Absolute saturation of the wetting phase \f${S}_w\f$.
* \param 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.
* \return Effective saturation of the wetting phase.
*/
static Scalar SwToSwe(const Params &params, Scalar Sw)
{
......@@ -130,11 +184,13 @@ public:
}
/*!
* \brief convert an absolute wetting saturation to an effective one
* \brief Convert an absolute non-wetting saturation to an effective one.
*
* \param params material law parameters
* \param Sn absolute nonwetting phase saturation
* \return effective nonwetting phase saturation
* \param Sn Absolute saturation of the non-wetting phase \f${S}_n\f$.
* \param 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.
* \return Effective saturation of the non-wetting phase.
*/
static Scalar SnToSne(const Params &params, Scalar Sn)
{
......@@ -142,19 +198,39 @@ public:
}
private:
// convert an effective wetting saturation to an absolute one
/*!
* \brief Convert an effective wetting saturation to an absolute one.
*
* \param Swe Effective saturation of the non-wetting phase \f$\overline{S}_n\f$.
* \param 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.
* \return Absolute saturation of the non-wetting phase.
*/
static Scalar SweToSw_(const Params &params, Scalar Swe)
{
return Swe*(1 - params.Swr() - params.Snr()) + params.Swr();
}
// derivative of the effective saturation to the absolute
// saturation.
/*!
* \brief Derivative of the effective saturation w.r.t. the absolute saturation.
*
* \param 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.
* \return Derivative of the effective saturation w.r.t. the absolute saturation.
*/
static Scalar dSwe_dSw_(const Params &params)
{ return 1.0/(1 - params.Swr() - params.Snr()); }
// derivative of the absolute saturation to the effective
// saturation.
/*!
* \brief Derivative of the absolute saturation w.r.t. the effective saturation.
*
* \param 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.
* \return Derivative of the absolute saturation w.r.t. the effective saturation.
*/
static Scalar dSw_dSwe_(const Params &params)
{ return 1 - params.Swr() - params.Snr(); }
};
......
......@@ -26,7 +26,7 @@
namespace Dumux
{
/*!
* \ingroup material
* \ingroup fluidmatrixinteractionsparams
*
* \brief A default implementation of the parameters for the adapter
* class to convert material laws from effective to absolute
......
......@@ -16,8 +16,8 @@
/*!
* \file
*
* \brief Linear capillary pressure and
* relative permeability <-> saturation relations
* \brief Linear capillary pressure and
* relative permeability <-> saturation relations
*/
#ifndef LINEAR_MATERIAL_HH
#define LINEAR_MATERIAL_HH
......@@ -29,15 +29,17 @@
namespace Dumux
{
/*!
* \ingroup material
* \ingroup fluidmatrixinteractionslaws
*
* \brief Implements a linear saturation-capillary pressure relation
* \brief Linear capillary pressure and
* relative permeability <-> saturation relations
*
* The entry pressure is reached at \f$ \overline S_w = 1\f$, the maximum
* capillary pressure is observed at \f$ \overline S_w = 0\f$.
*
* The entry pressure is reached at \f$S_w = 1\f$, the maximum
* capillary pressure is observed at \f$S_w = 0\f$.
* For general info: EffToAbsLaw
*
* \sa LinearMaterialParams
* \see LinearMaterialParams
*/
template <class ScalarT, class ParamsT = LinearMaterialParams<ScalarT> >
class LinearMaterial
......@@ -54,9 +56,11 @@ public:
p_C = (1 - \overline{S}_w) (p_{C,max} - p_{C,entry}) + p_{C,entry}
\f]
*
* \param params material law parameters
* \param Swe effective saturation of the wetting phase
* \return the capillary pressure
* \param Swe Effective saturation of the wetting phase \f$\overline{S}_w\f$ conversion from absolute saturation happened in EffToAbsLaw.
* \param 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.
* \return Capillary pressure calculated by linear constitutive relation.
*/
static Scalar pC(const Params &params, Scalar Swe)
{
......@@ -68,12 +72,14 @@ public:
*
* This is the inverse of the capillary pressure-saturation curve:
* \f[
S_w = 1 - \frac{p_C - p_{C,entry}}{p_{C,max} - p_{C,entry}}
S_w = 1 - \frac{p_C - p_{C,entry}}{p_{C,max} - p_{C,entry}}
\f]
*
* \param params material law parameters
* \param pC capillary pressure
* \return the effective saturation of the wetting phase
* \param pC Capillary pressure \f$p_C\f$
* \param 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.
* \return Effective wetting phase saturation calculated as inverse of the linear constitutive relation.
*/
static Scalar Sw(const Params &params, Scalar pC)
{
......@@ -82,17 +88,18 @@ public:
/*!
* \brief Returns the partial derivative of the capillary
* pressure to the effective saturation.
* pressure w.r.t. the effective saturation.
*
* This is equivalent to
* \f[
\frac{\partial p_C}{\partial \overline{S}_w} =
- (p_{C,max} - p_{C,min})
\f]
*
* \param params material law parameters
* \param Swe effective saturation of the wetting phase
* \return the derivative of capillary pressure w.r.t. saturation
* \param Swe Effective saturation of the wetting phase \f$\overline{S}_w\f$ conversion from absolute saturation happened in EffToAbsLaw.
* \param 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.
* \return Partial derivative of \f$p_c\f$ w.r.t. effective saturation according to linear material relation.
*/
static Scalar dpC_dSw(const Params &params, Scalar Swe)
{
......@@ -103,9 +110,11 @@ public:
* \brief Returns the partial derivative of the effective
* saturation to the capillary pressure.
*
* \param params material law parameters
* \param pC capillary pressure
* \return the derivative of saturation w.r.t. capillary pressure
* \param pC Capillary pressure \f$p_C\f$
* \param 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.
* \return Partial derivative of effective saturation w.r.t. \f$p_c\f$ according to linear relation.
*/
static Scalar dSw_dpC(const Params &params, Scalar pC)
{
......@@ -115,9 +124,11 @@ public:
/*!
* \brief The relative permeability for the wetting phase.
*
* \param params material law parameters
* \param Swe effective saturation of the wetting phase
* \return the relative permability of the wetting phase
* \param 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.
* \param Swe Effective saturation of the wetting phase \f$\overline{S}_w\f$ conversion from absolute saturation happened in EffToAbsLaw.
* \return Relative permeability of the wetting phase calculated as linear relation.
*/
static Scalar krw(const Params &params, Scalar Swe)
{
......@@ -127,9 +138,11 @@ public:
/*!
* \brief The relative permeability for the non-wetting phase.
*
* \param params material law parameters
* \param Swe effective saturation of the wetting phase
* \return the relative permability of the nonwetting phase
* \param 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.
* \param Swe Effective saturation of the wetting phase \f$\overline{S}_w\f$ conversion from absolute saturation happened in EffToAbsLaw.
* \return Relative permeability of the non-wetting phase calculated as linear relation.
*/
static Scalar krn(const Params &params, Scalar Swe)
{
......
......@@ -16,8 +16,8 @@
/*!
* \file
*
* \brief Parameters for the linear capillary pressure and
* relative permeability <-> saturation relations
* \brief Parameters for the linear capillary pressure and
* relative permeability <-> saturation relations
*/
#ifndef LINEAR_MATERIAL_PARAMS_HH
#define LINEAR_MATERIAL_PARAMS_HH
......@@ -27,6 +27,8 @@ namespace Dumux
/*!
* \brief Reference implementation of params for the linear material
* law.
*
* \ingroup fluidmatrixinteractionsparams
*/
template<class ScalarT>
class LinearMaterialParams
......@@ -43,19 +45,11 @@ public:
setMaxPC(maxPC);
};
/*!
* \brief Return the threshold saturation at which the relative
* permeability starts to get regularized.
*
* This is simply 10%
*/
Scalar Sreg() const
{ return 0.10; }
/*!
* \brief Return the entry pressure for the linear material law.
*
* The entry pressure is reached at \f$S_w = 1\f$
* The entry pressure is reached at \f$\overline S_w = 1\f$
*/
Scalar entryPC() const
{ return entryPC_; }
......@@ -63,7 +57,7 @@ public:
/*!
* \brief Set the entry pressure for the linear material law.
*
* The entry pressure is reached at \f$S_w = 1\f$
* The entry pressure is reached at \f$ \overline S_w = 1\f$
*/
void setEntryPC(Scalar v)
{ entryPC_ = v; }
......@@ -71,7 +65,7 @@ public:
/*!
* \brief Return the maximum capillary pressure for the linear material law.
*
* The maximum capillary pressure is reached at \f$S_w = 0\f$
* The maximum capillary pressure is reached at \f$ \overline S_w = 0\f$
*/
Scalar maxPC() const
{ return maxPC_; }
......@@ -79,30 +73,11 @@ public:
/*!