Commit 3f50e9f1 authored by Simon Scholz's avatar Simon Scholz
Browse files

[doxygen] fix doxygen in fluidmatrixinteractions

parent 7677fe7c
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionsparams
* \brief Parameters that are necessary for the \em regularization of
* the Parker - Van Genuchten capillary pressure model.
*/
......@@ -30,10 +30,9 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionsparams
* \brief Parameters that are necessary for the \em regularization of
* the Parker - van Genuchten capillary pressure model.
*
* \ingroup fluidmatrixinteractionsparams
*/
template <class ScalarT>
class RegularizedParkerVanGen3PParams : public ParkerVanGen3PParams<ScalarT>
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionslaws
* \brief Relation for the saturation-dependent effective thermal conductivity
*/
#ifndef THERMALCONDUCTIVITY_SOMERTON_3P_HH
......@@ -39,7 +39,6 @@ struct SimpleThreePIndices
/*!
* \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.
......
......@@ -8,5 +8,10 @@ add_subdirectory("mp")
install(FILES
diffusivityconstant.hh
diffusivityconstanttau.hh
diffusivityconstanttortuosity.hh
diffusivitymillingtonquirk.hh
permeabilitykozenycarman.hh
permeabilityrutqvisttsang.hh
porosityprecipitation.hh
porosityreactivebed.hh
DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/dumux/material/fluidmatrixinteractions)
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionslaws
* \brief Relation for the saturation-dependent effective diffusion coefficient
*/
#ifndef DIFFUSIVITY_CONSTANT_HH
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionslaws
* \brief Relation for the saturation-dependent effective diffusion coefficient
*/
#ifndef DIFFUSIVITY_CONSTANT_TAU_HH
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionslaws
* \brief Relation for the saturation-dependent effective diffusion coefficient
*/
#ifndef DIFFUSIVITY_CONSTANT_TORTUOSITY_HH
......@@ -30,7 +30,6 @@ namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
*
* \brief Relation for the saturation-dependent effective diffusion coefficient
*
* The material law is:
......@@ -52,7 +51,6 @@ public:
/*!
* \brief Returns the effective diffusion coefficient \f$\mathrm{[m^2/s]}\f$ based
* on a constant tortuosity value
*
* \param porosity The porosity
* \param saturation The saturation of the wetting phase
* \param diffCoeff The diffusion coefficient of the phase in \f$\mathrm{[m^2/s]}\f$
......@@ -60,7 +58,6 @@ public:
static Scalar effectiveDiffusivity(const Scalar porosity,
const Scalar saturation,
const Scalar diffCoeff)
{
static const Scalar tau = getParam<Scalar>("SpatialParams.Tortuosity", 0.5);
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionslaws
* \brief Relation for the saturation-dependent effective diffusion coefficient
*/
#ifndef DIFFUSIVITY_MILLINGTON_QUIRK_HH
......@@ -30,10 +30,8 @@ namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
*
* \brief Relation for the saturation-dependent effective diffusion coefficient
*
*
* The material law is:
* \f[
* D_\text{eff,pm} = \phi * S_w * \tau * D
......@@ -62,7 +60,6 @@ public:
static Scalar effectiveDiffusivity(const Scalar porosity,
const Scalar saturation,
const Scalar diffCoeff)
{
// instead of D_eff,pm = phi * Sw * 1/phi^2 * (phi * Sw)^(7/3) * D
// we calculate the more efficient
......
......@@ -17,8 +17,8 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file 2padapter.hh
*
* \file
* \ingroup fluidmatrixinteractionslaws
* \brief Makes the twophase capillary pressure-saturation relations available under the M-phase API for material laws
*
* Makes the twophase capillary pressure-saturation relations
......@@ -32,8 +32,7 @@
namespace Dumux
{
/*!
* \ingroup material
*
* \ingroup fluidmatrixinteractionslaws
* \brief Implements a brookscorey saturation-capillary pressure relation
*
* Implements a brookscorey saturation-capillary pressure relation for
......
......@@ -18,10 +18,9 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionslaws
* \brief Makes the twophase capillary pressure-saturation relations
* available under the M-phase API for material laws.
*
* Also use the temperature dependent version of the material laws.
*/
#ifndef DUMUX_MP_2P_OFT_ADAPTER_HH
......@@ -32,11 +31,9 @@
namespace Dumux
{
/*!
* \ingroup material
*
* \ingroup fluidmatrixinteractionslaws
* \brief Adapts the interface of the MpNc material law to the standard-Dumux material law.
*
* Also use the temperature dependent version of the material laws.
* Also use the temperature dependent version of the material laws.
*/
template <int wPhaseIdx, class TwoPLaw>
class TwoPOfTAdapter
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionslaws
* \brief Implements a linear saturation-capillary pressure relation
*
* Implements a linear saturation-capillary pressure relation for
......@@ -34,8 +34,7 @@
namespace Dumux
{
/*!
* \ingroup material
*
* \ingroup fluidmatrixinteractionslaws
* \brief Implements a linear saturation-capillary pressure relation
*
* Implements a linear saturation-capillary pressure relation for
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionsparams
* \brief Reference implementation of parameters for the M-phase linear
* material material.
*/
......@@ -28,6 +28,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionsparams
* \brief Reference implementation of params for the linear M-phase
* material material.
*/
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionslaws
* \brief The Kozeny-Carman relationship for the calculation of a porosity-dependent permeability.
*/
#ifndef DUMUX_PERMEABILITY_KOZENY_CARMAN_HH
......@@ -29,9 +29,6 @@ namespace Dumux
/*!
* \ingroup fluidmatrixinteractionslaws
*/
/**
* \brief The Kozeny-Carman relationship for the calculation of a porosity-dependent permeability.
* When the porosity is implemented as solution-independent, using this relationship for the
* permeability leads to unnecessary overhead.
......@@ -56,13 +53,21 @@ class PermeabilityKozenyCarman
public:
// the initial parameter distribution
/*!
* \brief The initial parameter distribution.
* \param spatialParams the spatial parameters
*/
void init(const SpatialParams& spatialParams)
{
spatialParamsPtr_ = &spatialParams;
}
// calculate permeability for a given scv
/*!
* \brief calculates the permeability for a given sub-control volume
* \param element element
* \param elemSol the element solution
* \param scv sub control volume
*/
PermType evaluatePermeability(const Element& element,
const SubControlVolume& scv,
const ElementSolution& elemSol) const
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionslaws
* \brief Relation for the effective permeability
*/
#ifndef PERMEABILITYRUTQVISTSTANG_HH
......@@ -32,7 +32,6 @@ namespace Dumux
/*!
* \ingroup fluidmatrixinteractionslaws
*
* \brief Relation for the effective permeability
*
* After Rutqvist and Tsang (2002) \cite rutqvist2002, the effective permeability can be
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionslaws
* \brief Class for the evaluation of the porosity subject to precipitation.
*/
#ifndef DUMUX_POROSITY_PRECIPITATION_HH
......@@ -31,9 +31,6 @@ namespace Dumux
/*!
* \ingroup fluidmatrixinteractionslaws
*/
/**
* \brief Calculates the porosity depending on the volume fractions of precipitated minerals.
*/
template<class TypeTag>
......@@ -59,7 +56,12 @@ public:
spatialParamsPtr_ = &spatialParams;
}
// calculates the porosity in a sub-control volume
/*!
* \brief calculates the porosity in a sub-control volume
* \param element element
* \param elemSol the element solution
* \param scv sub control volume
*/
Scalar evaluatePorosity(const Element& element,
const SubControlVolume& scv,
const ElementSolution& elemSol) const
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup fluidmatrixinteractionslaws
* \brief Class for the evaluation of the porosity subject to precipitation.
*/
#ifndef DUMUX_POROSITY_REACTIVE_BED_HH
......@@ -31,9 +31,6 @@ namespace Dumux
/*!
* \ingroup fluidmatrixinteractionslaws
*/
/**
* \brief Calculates the porosity depeding on the volume fractions of different solid species.
*/
template<class TypeTag>
......@@ -60,7 +57,13 @@ public:
spatialParamsPtr_ = &spatialParams;
}
// calculates the porosity in a sub-control volume
/*!
* \brief Calculates the porosity in a sub-control volume.
*
* \param element element
* \param elemSol the element solution
* \param scv sub control volume
*/
Scalar evaluatePorosity(const Element& element,
const SubControlVolume& scv,
const ElementSolution& elemSol) const
......
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