Skip to content
GitLab
Commit 3f50e9f1 authored by Simon Scholz's avatar Simon Scholz
Browse files

[doxygen] fix doxygen in fluidmatrixinteractions

parent 7677fe7c
Hide whitespace changes
Inline Side-by-side
dumux/material/fluidmatrixinteractions/1p/thermalconductivityaverage.hh
View file @ 3f50e9f1
......@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
*
* \brief simple effective thermal conductivity
* \ingroup fluidmatrixinteractionslaws
* \brief Reation for a simple effective thermal conductivity
*/
#ifndef THERMALCONDUCTIVITY_AVERAGE_HH
#define THERMALCONDUCTIVITY_AVERAGE_HH
......@@ -31,7 +31,6 @@ namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
*
* \brief Relation for a simple effective thermal conductivity
*/
template<class Scalar>
......@@ -39,7 +38,7 @@ class ThermalConductivityAverage
{
public:
/*!
* \brief simple effective thermal conductivity \f$\mathrm{[W/(m K)]}\f$
* \brief Relation for a simple effective thermal conductivity \f$\mathrm{[W/(m K)]}\f$
*
* \param volVars volume variables
* \param spatialParams spatial parameters
......
dumux/material/fluidmatrixinteractions/2p/brookscorey.hh
View file @ 3f50e9f1
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionslaws
* \brief Implementation of the capillary pressure and
* relative permeability <-> saturation relations according to Brooks and Corey.
*
......@@ -58,10 +58,9 @@ public:
* The Brooks-Corey empirical capillary pressure <-> saturation
* function is given by
*
* \f$\mathrm{
p_C = p_e\overline{S}_w^{-1/\lambda}
* }\f$
*
* \f$\mathrm{ p_C = p_e\overline{S}_w^{-1/\lambda}
* }\f$
*
* \param swe Effective saturation of the wetting phase \f$\mathrm{[\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,
......@@ -86,8 +85,7 @@ public:
* \brief The saturation-capillary pressure curve according to Brooks & Corey.
*
* This is the inverse of the capillary pressure-saturation curve:
* \f$\mathrm{
\overline{S}_w = (\frac{p_C}{p_e})^{-\lambda}}\f$
* \f$\mathrm{ \overline{S}_w = (\frac{p_C}{p_e})^{-\lambda}}\f$
*
* \param pc Capillary pressure \f$\mathrm{[p_C]}\f$ in \f$\mathrm{[Pa]}\f$.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
......@@ -123,10 +121,9 @@ public:
* pressure w.r.t. the effective saturation according to Brooks & Corey.
*
* This is equivalent to
* \f$\mathrm{
\frac{\partial p_C}{\partial \overline{S}_w} =
-\frac{p_e}{\lambda} \overline{S}_w^{-1/\lambda - 1}
}\f$
* \f$\mathrm{\frac{\partial p_C}{\partial \overline{S}_w} =
* -\frac{p_e}{\lambda} \overline{S}_w^{-1/\lambda - 1}
* }\f$
*
* \param swe Effective saturation of the wetting phase \f$\mathrm{[\overline{S}_w]}\f$
* \param params A container object that is populated with the appropriate coefficients for the respective law.
......@@ -136,7 +133,7 @@ public:
*
* \note Instead of undefined behaviour if pc is not in the valid range, we return a valid number,
* by clamping the input.
*/
*/
static Scalar dpc_dswe(const Params &params, Scalar swe)
{
using std::pow;
......
dumux/material/fluidmatrixinteractions/2p/brookscoreyparams.hh
View file @ 3f50e9f1
......@@ -19,7 +19,7 @@
/*!
* \file
*
* \ingroup fluidmatrixinteractionsparams
* \brief Specification of the material parameters
* for the Brooks Corey constitutive relations.
*/
......@@ -35,7 +35,7 @@ namespace Dumux
* \brief Specification of the material parameters
* for the Brooks Corey constitutive relations.
*
* \ingroup fluidmatrixinteractionsparams
* \ingroup fluidmatrixinteractionsparams
*
*\see BrooksCorey
*/
......
dumux/material/fluidmatrixinteractions/2p/efftoabslaw.hh
View file @ 3f50e9f1
......@@ -18,11 +18,10 @@
*****************************************************************************/
/*!
* \file
*
* \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.
*
*/
#ifndef DUMUX_EFF_TO_ABS_LAW_HH
#define DUMUX_EFF_TO_ABS_LAW_HH
......@@ -68,8 +67,6 @@ public:
/*!
* \brief The capillary pressure-saturation curve.
*
*
* \param sw Absolute saturation of the wetting phase \f$\mathrm{[\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.
......@@ -77,7 +74,6 @@ public:
* 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)
{
......@@ -91,17 +87,15 @@ 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 Absolute wetting phase saturation calculated as inverse of
* \return Absolute wetting phase saturation \f$\mathrm{[S_w]}\f$ calculated as inverse of
* (EffLaw e.g. Brooks & Corey, van Genuchten, linear...) constitutive relation.
*
* \return The absolute saturation of the wetting phase \f$\mathrm{[S_w]}\f$
*/
static Scalar sw(const Params &params, Scalar pc)
{
return sweToSw_(params, EffLaw::sw(params, pc));
}
/*!
/*!
* \brief The capillary pressure at Swe = 1.0 also called end point capillary pressure
*
* \param params A container object that is populated with the appropriate coefficients for the respective law.
......@@ -126,7 +120,7 @@ public:
and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Partial derivative of \f$\mathrm{[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_dswe(params, swToSwe(params, sw) )*dswe_dsw_(params);
......@@ -165,7 +159,6 @@ public:
* 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)
{
......
dumux/material/fluidmatrixinteractions/2p/efftoabslawparams.hh
View file @ 3f50e9f1
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionsparams
* \brief A default implementation of the parameters for the adapter
* class to convert material laws from effective to absolute
* saturations.
......@@ -30,7 +30,6 @@ namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionsparams
*
* \brief A default implementation of the parameters for the adapter
* class to convert material laws from effective to absolute
* saturations.
......
dumux/material/fluidmatrixinteractions/2p/heatpipelaw.hh
View file @ 3f50e9f1
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionslaws
* \brief Implementation of the capillary pressure <-> saturation relation
* for the heatpipe problem.
*/
......@@ -37,8 +37,7 @@
namespace Dumux
{
/*!
* \ingroup material
*
* \ingroup fluidmatrixinteractionslaws
* \brief Implementation of the capillary pressure <-> saturation
* relation for the heatpipe problem.
*
......
dumux/material/fluidmatrixinteractions/2p/heatpipelawparams.hh
View file @ 3f50e9f1
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionslparams
* \brief Specification of the material params for the heat pipe's capillary
* pressure model.
*/
......@@ -28,6 +28,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionsparams
* \brief Reference implementation of a params for the heat pipe's
* material law
*/
......
dumux/material/fluidmatrixinteractions/2p/linearmaterial.hh
View file @ 3f50e9f1
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionslaws
* \brief Linear capillary pressure and
* relative permeability <-> saturation relations
*/
......@@ -33,7 +33,6 @@ namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
*
* \brief Linear capillary pressure and
* relative permeability <-> saturation relations
*
......@@ -113,7 +112,7 @@ public:
* 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$\mathrm{[p_c]}\f$ w.r.t. effective saturation according to linear material relation.
*/
*/
static Scalar dpc_dswe(const Params &params, Scalar swe)
{
return - (params.maxPc() - params.entryPc());
......
dumux/material/fluidmatrixinteractions/2p/linearmaterialparams.hh
View file @ 3f50e9f1
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionsparams
* \brief Parameters for the linear capillary pressure and
* relative permeability <-> saturation relations
*/
......@@ -30,8 +30,7 @@ namespace Dumux
/*!
* \brief Reference implementation of params for the linear material
* law.
*
* \ingroup fluidmatrixinteractionsparams
* \ingroup fluidmatrixinteractionsparams
*/
template<class ScalarT>
class LinearMaterialParams
......
dumux/material/fluidmatrixinteractions/2p/philtophoblaw.hh
View file @ 3f50e9f1
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \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. It is valid for hydrophobic materials and is
......@@ -37,7 +37,6 @@ namespace Dumux
{
/*!
* \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.
......
dumux/material/fluidmatrixinteractions/2p/regularizedbrookscorey.hh
View file @ 3f50e9f1
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionslaws
* \brief Implementation of a regularized version of the Brooks-Corey
* capillary pressure / relative permeability <-> saturation relation.
*/
......@@ -34,8 +34,8 @@
namespace Dumux
{
/*!\ingroup fluidmatrixinteractionslaws
*
/*!
* \ingroup fluidmatrixinteractionslaws
* \brief Implementation of the regularized Brooks-Corey
* capillary pressure / relative permeability <-> saturation relation.
* This class bundles the "raw" curves as
......@@ -276,7 +276,7 @@ public:
* - above \f$\mathrm{\overline{S}_w =1}\f$: set relative permeability to one
* - for \f$\mathrm{0 \leq \overline{S}_w \leq 0.05}\f$: use a spline as interpolation
*
\copydetails BrooksCorey::krn()
* \copydetails BrooksCorey::krn()
*
*/
static Scalar krn(const Params &params, Scalar swe)
......
dumux/material/fluidmatrixinteractions/2p/regularizedbrookscoreyparams.hh
View file @ 3f50e9f1
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionsparams
* \brief Parameters that are necessary for the \em regularization of
* the Brooks-Corey capillary pressure model.
*/
......@@ -32,8 +32,7 @@ namespace Dumux
/*!
* \brief Parameters that are necessary for the \em regularization of
* the Brooks-Corey capillary pressure model.
*
* \ingroup fluidmatrixinteractionsparams
* \ingroup fluidmatrixinteractionsparams
*/
template <class ScalarT>
class RegularizedBrooksCoreyParams : public BrooksCoreyParams<ScalarT>
......
dumux/material/fluidmatrixinteractions/2p/regularizedlinearmaterial.hh
View file @ 3f50e9f1
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionslaws
* \brief Regularized linear capillary pressure and
* relative permeability <-> saturation relations.
*/
......@@ -36,7 +36,6 @@ namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
*
* \brief Implements a linear saturation-capillary pressure relation
*
* The entry pressure is reached at \f$\mathrm{\overline{S}_w = 1}\f$, the maximum
......@@ -102,7 +101,7 @@ public:
return LinearMaterial::sw(params, pc);
}
/*!
/*!
* \brief The capillary pressure at Swe = 1.0 also called end point capillary pressure
*
* \param params A container object that is populated with the appropriate coefficients for the respective law.
......@@ -125,7 +124,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.
*/
*/
static Scalar dpc_dswe(const Params &params, Scalar swe)
{
return LinearMaterial::dpc_dswe(params, swe);
......
dumux/material/fluidmatrixinteractions/2p/regularizedlinearmaterialparams.hh
View file @ 3f50e9f1
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionsparams
* \brief Parameters that are necessary for the \em regularization of
* the linear constitutive relations.
*/
......@@ -30,11 +30,9 @@
namespace Dumux
{
/*!
*
* \ingroup fluidmatrixinteractionsparams
* \brief Parameters that are necessary for the \em regularization of
* the linear constitutive relations.
*
* \ingroup fluidmatrixinteractionsparams
*/
template<class ScalarT>
class RegularizedLinearMaterialParams : public LinearMaterialParams<ScalarT>
......
dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchten.hh
View file @ 3f50e9f1
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionslaws
* \brief Implementation of the regularized version of the van Genuchten's
* capillary pressure / relative permeability <-> saturation relation.
*/
......@@ -35,9 +35,8 @@
namespace Dumux
{
/*!\ingroup fluidmatrixinteractionslaws
/*!
* \ingroup fluidmatrixinteractionslaws
* \brief Implementation of the regularized van Genuchten's
* capillary pressure / relative permeability <-> saturation relation.
*
......@@ -88,7 +87,7 @@ public:
*
* For not-regularized part:
*
\copydetails VanGenuchten::pc()
* \copydetails VanGenuchten::pc()
*/
static Scalar pc(const Params &params, Scalar swe)
{
......@@ -141,7 +140,7 @@ public:
*
* For not-regularized part:
*
\copydetails VanGenuchten::sw()
* \copydetails VanGenuchten::sw()
*
*/
static Scalar sw(const Params &params, Scalar pc)
......@@ -215,8 +214,7 @@ public:
*
* For not-regularized part:
*
\copydetails VanGenuchten::dpc_dswe()
*
* \copydetails VanGenuchten::dpc_dswe()
*/
static Scalar dpc_dswe(const Params &params, Scalar swe)
{
......@@ -263,7 +261,7 @@ public:
* by a straight line and use that slope (yes, there is a kink :-( ).
*
* For not-regularized part:
\copydetails VanGenuchten::dswe_dpc()
* \copydetails VanGenuchten::dswe_dpc()
*/
static Scalar dswe_dpc(const Params &params, Scalar pc)
{
......@@ -302,7 +300,7 @@ public:
* - between \f$\mathrm{0.95 \leq \overline{S}_w \leq 1}\f$: use a spline as interpolation
*
* For not-regularized part:
\copydetails VanGenuchten::krw()
* \copydetails VanGenuchten::krw()
*/
static Scalar krw(const Params &params, Scalar swe)
{
......@@ -331,7 +329,7 @@ public:
* permeability for the wetting phase in regard to the wetting
* saturation of the medium implied by the van Genuchten parameterization.
*
\copydetails VanGenuchten::dkrw_dswe()
* \copydetails VanGenuchten::dkrw_dswe()
*/
static Scalar dkrw_dswe(const Params &params, Scalar swe)
{
......@@ -371,7 +369,7 @@ public:
* - above \f$\mathrm{\overline{S}_w =1}\f$: set relative permeability to one
* - for \f$\mathrm{0 \leq \overline{S}_w \leq 0.05}\f$: use a spline as interpolation
*
\copydetails VanGenuchten::krn()
* \copydetails VanGenuchten::krn()
*
*/
static Scalar krn(const Params &params, Scalar swe)
......@@ -401,7 +399,7 @@ public:
* for the non-wetting phase in regard to the wetting saturation of
* the medium as implied by the van Genuchten parameterization.
*
\copydetails VanGenuchten::dkrw_dswe()
* \copydetails VanGenuchten::dkrw_dswe()
*/
static Scalar dkrn_dswe(const Params &params, Scalar swe)
{
......
dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchtenparams.hh
View file @ 3f50e9f1
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionsparams
* \brief Parameters that are necessary for the \em regularization of
* VanGenuchten "material law".
*/
......@@ -31,12 +31,9 @@
namespace Dumux
{
/*!
*
*
* \ingroup fluidmatrixinteractionsparams
* \brief Parameters that are necessary for the \em regularization of
* VanGenuchten "material law".
*
* \ingroup fluidmatrixinteractionsparams
*/
template<class ScalarT>
class RegularizedVanGenuchtenParams : public VanGenuchtenParams<ScalarT>
......
dumux/material/fluidmatrixinteractions/2p/thermalconductivityjohansen.hh
View file @ 3f50e9f1
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionslaws
* \brief Relation for the saturation-dependent effective thermal conductivity
*/
#ifndef THERMALCONDUCTIVITY_JOHANSEN_HH
......@@ -37,7 +37,6 @@ struct JohansenIndices
/*!
* \ingroup fluidmatrixinteractionslaws
*
* \brief Relation for the saturation-dependent effective thermal conductivity
*
* The Johansen method (Johansen 1975 \cite johansen1977 ) computes the thermal conductivity of dry and the
......
dumux/material/fluidmatrixinteractions/2p/thermalconductivitysimplefluidlumping.hh
View file @ 3f50e9f1
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionslaws
* \brief Relation for the saturation-dependent effective thermal conductivity
*/
#ifndef THERMALCONDUCTIVITY_SIMPLE_FLUID_LUMPING_HH
......
dumux/material/fluidmatrixinteractions/2p/thermalconductivitysomerton.hh
View file @ 3f50e9f1
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionslaws
* \brief Relation for the saturation-dependent effective thermal conductivity
*/
#ifndef THERMALCONDUCTIVITY_SOMERTON_HH
......@@ -38,7 +38,6 @@ struct SomertonIndices
/*!
* \ingroup fluidmatrixinteractionslaws
*
* \brief Relation for the saturation-dependent effective thermal conductivity
*
* The Somerton method computes the thermal conductivity of dry and the wet soil material
......
dumux/material/fluidmatrixinteractions/2p/vangenuchten.hh
View file @ 3f50e9f1
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionslaws
* \brief Implementation of the capillary pressure and
* relative permeability <-> saturation relations according to van Genuchten.
*/
......@@ -35,7 +35,6 @@ namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
*
* \brief Implementation of the van Genuchten capillary pressure <->
* saturation relation. This class bundles the "raw" curves
* as static members and doesn't concern itself converting
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment