Commit fa53f144 authored by Simon Scholz's avatar Simon Scholz

[doxygen] adapt ingroup Fluidmatrixinteractions,delete old style with params and laws

parent bae853df
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Reation for a simple effective thermal conductivity
*/
#ifndef THERMALCONDUCTIVITY_AVERAGE_HH
......@@ -30,7 +30,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Relation for a simple effective thermal conductivity
*/
template<class Scalar>
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Implementation of the capillary pressure and
* relative permeability <-> saturation relations according to Brooks and Corey.
*
......@@ -34,7 +34,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
*
* \brief Implementation of the Brooks-Corey capillary pressure <->
* saturation relation. This class bundles the "raw" curves
......
......@@ -19,7 +19,7 @@
/*!
* \file
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \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 Fluidmatrixinteractions
*
*\see BrooksCorey
*/
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief This material law takes a material law defined for effective
* saturations and converts it to a material law defined on
* absolute saturations.
......@@ -31,7 +31,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
*
* \brief This material law takes a material law defined for effective
* saturations and converts it to a material law defined on absolute
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief A default implementation of the parameters for the adapter
* class to convert material laws from effective to absolute
* saturations.
......@@ -29,7 +29,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief A default implementation of the parameters for the adapter
* class to convert material laws from effective to absolute
* saturations.
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Implementation of the capillary pressure <-> saturation relation
* for the heatpipe problem.
*/
......@@ -37,7 +37,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Implementation of the capillary pressure <-> saturation
* relation for the heatpipe problem.
*
......
......@@ -28,7 +28,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief Reference implementation of a params for the heat pipe's
* material law
*/
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Linear capillary pressure and
* relative permeability <-> saturation relations
*/
......@@ -32,7 +32,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Linear capillary pressure and
* relative permeability <-> saturation relations
*
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief Parameters for the linear capillary pressure and
* relative permeability <-> saturation relations
*/
......@@ -30,7 +30,7 @@ namespace Dumux
/*!
* \brief Reference implementation of params for the linear material
* law.
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
*/
template<class ScalarT>
class LinearMaterialParams
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \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
......@@ -36,7 +36,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief This material law takes a material law defined for effective
* saturations and converts it to a material law defined on absolute
* saturations.
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Implementation of a regularized version of the Brooks-Corey
* capillary pressure / relative permeability <-> saturation relation.
*/
......@@ -35,7 +35,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Implementation of the regularized Brooks-Corey
* capillary pressure / relative permeability <-> saturation relation.
* This class bundles the "raw" curves as
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief Parameters that are necessary for the \em regularization of
* the Brooks-Corey capillary pressure model.
*/
......@@ -32,7 +32,7 @@ namespace Dumux
/*!
* \brief Parameters that are necessary for the \em regularization of
* the Brooks-Corey capillary pressure model.
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
*/
template <class ScalarT>
class RegularizedBrooksCoreyParams : public BrooksCoreyParams<ScalarT>
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Regularized linear capillary pressure and
* relative permeability <-> saturation relations.
*/
......@@ -35,7 +35,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Implements a linear saturation-capillary pressure relation
*
* The entry pressure is reached at \f$\mathrm{\overline{S}_w = 1}\f$, the maximum
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief Parameters that are necessary for the \em regularization of
* the linear constitutive relations.
*/
......@@ -30,7 +30,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief Parameters that are necessary for the \em regularization of
* the linear constitutive relations.
*/
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Implementation of the regularized version of the van Genuchten's
* capillary pressure / relative permeability <-> saturation relation.
*/
......@@ -36,7 +36,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Implementation of the regularized van Genuchten's
* capillary pressure / relative permeability <-> saturation relation.
*
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief Parameters that are necessary for the \em regularization of
* VanGenuchten "material law".
*/
......@@ -31,7 +31,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief Parameters that are necessary for the \em regularization of
* VanGenuchten "material law".
*/
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Relation for the saturation-dependent effective thermal conductivity
*/
#ifndef THERMALCONDUCTIVITY_JOHANSEN_HH
......@@ -36,7 +36,7 @@ struct JohansenIndices
};
/*!
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Relation for the saturation-dependent effective thermal conductivity
*
* The Johansen method (Johansen 1975 \cite johansen1977 ) computes the thermal conductivity of dry and the
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Relation for the saturation-dependent effective thermal conductivity
*/
#ifndef THERMALCONDUCTIVITY_SIMPLE_FLUID_LUMPING_HH
......@@ -36,7 +36,7 @@ struct SimpleLumpingIndices
};
/*!
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Relation for the saturation-dependent effective thermal conductivity
* \todo This shouldn't depend on TypeTag!!
*/
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Relation for the saturation-dependent effective thermal conductivity
*/
#ifndef THERMALCONDUCTIVITY_SOMERTON_HH
......@@ -37,7 +37,7 @@ struct SomertonIndices
};
/*!
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Relation for the saturation-dependent effective thermal conductivity
*
* The Somerton method computes the thermal conductivity of dry and the wet soil material
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Implementation of the capillary pressure and
* relative permeability <-> saturation relations according to van Genuchten.
*/
......@@ -34,7 +34,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \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
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Implementation of the regularized version of the van Genuchten's
* capillary pressure / relative permeability <-> saturation relation
* *as function of temperature*.
......@@ -32,7 +32,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Implementation of the regularized van Genuchten's
* capillary pressure / relative permeability <-> saturation relation
* *as a function of temperature*.
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief Specification of the material parameters
* for the van Genuchten constitutive relations.
*/
......@@ -28,7 +28,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief Specification of the material parameters
* for the van Genuchten constitutive relations.
*
......
......@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Specification of a function relating volume specific interfacial area to capillary pressure and saturation.
* This function is exponential.
*/
......@@ -34,7 +34,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Implementation of the exponential function relating
* specific interfacial area to wetting phase saturation and capillary pressure as suggested by Nuske(2009) (Diploma thesis) \cite nuske2009 .
*/
......
......@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief Specification of the parameters for a function relating volume specific interfacial area to capillary pressure and saturation.
* This function is exponential.
*/
......@@ -26,7 +26,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief implementation of interfacial area surface params
*/
template<class ScalarT>
......
......@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Specification of a function relating volume specific interfacial area to capillary pressure and saturation.
* This function is of third order in pc.
*/
......@@ -35,7 +35,7 @@ namespace Dumux
{
/*!
* \ingroup material
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Implementation of a exponential function relating
* specific interfacial area to wetting phase saturation and capillary pressure.
*/
......
......@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief Specification of the parameters for a function relating volume specific interfacial area to capillary pressure and saturation.
* This is of third order in pc.
*/
......@@ -26,7 +26,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief implementation of interfacial area surface params
*/
template<class ScalarT>
......
......@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Specification of a function relating volume specific interfacial area to capillary pressure and saturation.
* This parametrization uses a maximum value of capillary pressure.
*/
......@@ -29,7 +29,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Implementation of an interfacial area surface.
*
* The idea here is to make sure that interfacial area be zero for Sw=1 and pc=pcmax.
......
......@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief Specification of the parameters for a function relating volume specific interfacial area to capillary pressure and saturation.
* This parametrization uses a maximum value of capillary pressure.
*/
......@@ -26,7 +26,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief implementation of interfacial area surface params
*/
template<class ScalarT>
......
......@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Specification of a function relating volume specific interfacial area to capillary pressure and saturation.
* This parametrization is a second order polynomial.
*/
......@@ -35,7 +35,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Implementation of the polynomial of second order relating
* specific interfacial area to wetting phase saturation and capillary pressure as suggested by Joekar-Niasar(2008) \cite joekar2008 .
*/
......
......@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief Specification of the parameters for a function relating volume specific interfacial area to capillary pressure and saturation.
* This parametrization is a second order polynomial.
*/
......@@ -26,7 +26,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief implementation of interfacial area surface params
*/
template<class ScalarT>
......
......@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Specification of a function relating volume specific interfacial area to capillary pressure and saturation.
* This parametrization is a second order polynomial which is zero for saturations of zero and one.
*/
......@@ -34,7 +34,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Implementation of the polynomial of second order relating
* specific interfacial area to wetting phase saturation and capillary pressure.
*/
......
......@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief Specification of the parameters for a function relating volume specific interfacial area to capillary pressure and saturation.
* This parametrization is a second order polynomial which is zero for saturations of zero and one.
*/
......@@ -26,7 +26,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief Implementation of interfacial area surface params
*/
template<class ScalarT>
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief This material law takes a material law (interfacial area surface)
* defined for effective saturations and converts it to a material law defined on
* absolute saturations.
......@@ -33,7 +33,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief This material law takes a material law (interfacial area surface) defined for effective
* saturations and converts it to a material (interfacial area surface) law defined on absolute
* saturations.
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief A default implementation of the parameters for the adapter
* class to convert material laws -- in this case the interfacial area surfaces --
* from effective to absolute saturations.
......@@ -29,7 +29,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief A default implementation of the parameters for the adapter
* class to convert material laws -- in this case the interfacial area surfaces --
* from effective to absolute saturations.
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief This material law takes a material law defined for effective
* saturations and converts it to a material law defined on
* absolute saturations.
......@@ -32,7 +32,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief This material law takes a material law defined for effective
* saturations and converts it to a material law defined on absolute
* saturations.
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief A default implementation of the parameters for the adapter
* class to convert material laws from effective to absolute
* saturations.
......@@ -29,7 +29,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief A default implementation of the parameters for the adapter
* class to convert material laws from effective to absolute
* saturations.
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Implementation of van Genuchten's capillary pressure-saturation relation for three phases.
*/
#ifndef PARKERVANGEN_3P_HH
......@@ -31,7 +31,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Implementation of van Genuchten's capillary pressure <->
* saturation relation. This class bundles the "raw" curves
* as static members and doesn't concern itself converting
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief Specification of the material params for the van Genuchten
* capillary pressure model.
*
......@@ -34,7 +34,7 @@
namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief Reference implementation of a van Genuchten params
*/
template<class ScalarT>
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionslaws
* \ingroup Fluidmatrixinteractions
* \brief Implementation of a regularized version of van Genuchten's capillary
* pressure-saturation relation for three phases.
*/
......@@ -32,7 +32,7 @@
namespace Dumux
{
/*!\ingroup fluidmatrixinteractionslaws
/*!\ingroup Fluidmatrixinteractions
*
* \brief Implementation of the regularized van Genuchten's
* capillary pressure <-> saturation relation.
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup fluidmatrixinteractionsparams
* \ingroup Fluidmatrixinteractions
* \brief Parameters that are necessary for the \em regularization of
* the Parker - Van Genuchten capillary pressure model.
*/
......@@ -30,7 +30,7 @@