From 80b35ea7988562aa4a5d0a23db7d7ad34a3edea3 Mon Sep 17 00:00:00 2001
From: Johannes Hommel <johannes.hommel@iws.uni-stuttgart.de>
Date: Tue, 19 Dec 2017 11:43:25 +0100
Subject: [PATCH] [doxygen] added 3p tests
---
doc/doxygen/modules.txt | 3 +++
.../3p/implicit/3pniconductionproblem.hh | 7 ++++++-
.../3p/implicit/3pniconvectionproblem.hh | 7 ++++++-
test/porousmediumflow/3p/implicit/3pnispatialparams.hh | 6 ++----
.../3p/implicit/infiltration3pproblem.hh | 7 ++++++-
.../3p/implicit/infiltration3pspatialparams.hh | 8 ++++++--
.../porousmediumflow/3p3c/implicit/columnxylolproblem.hh | 7 ++++++-
.../3p3c/implicit/columnxylolspatialparams.hh | 7 +++++--
.../3p3c/implicit/infiltration3p3cproblem.hh | 7 ++++++-
.../3p3c/implicit/infiltration3p3cspatialparams.hh | 9 +++++++--
test/porousmediumflow/3p3c/implicit/kuevetteproblem.hh | 8 +++++++-
.../3p3c/implicit/kuevettespatialparams.hh | 7 +++++--
.../3pwateroil/implicit/3pwateroilsagdproblem.hh | 8 ++++++--
.../3pwateroil/implicit/3pwateroilsagdspatialparams.hh | 7 +++++--
14 files changed, 76 insertions(+), 22 deletions(-)
diff --git a/doc/doxygen/modules.txt b/doc/doxygen/modules.txt
index 4ad12ff178..8dfee529d1 100644
--- a/doc/doxygen/modules.txt
+++ b/doc/doxygen/modules.txt
@@ -202,12 +202,15 @@
*/
/*! \ingroup BenchmarksAndTests
* \defgroup ThreePTests 3p (three phase) benchmarks and tests
+ * ThreePTests contain various tests using a ThreePModel. The files are listed below, with hopefully self-explanatory names.
*/
/*! \ingroup BenchmarksAndTests
* \defgroup ThreePThreeCTests 3p3c (three phase, three component) benchmarks and tests
+ * ThreePThreeCTests contain various tests using a ThreePThreeCModel. The files are listed below, with hopefully self-explanatory names.
*/
/*! \ingroup BenchmarksAndTests
* \defgroup ThreePWaterOilTests 3pwateroil (three phase, water oil) benchmarks and tests
+ * ThreePWaterOilTests contain a SAGD test problem using the ThreePWaterOilModel. The files are listed below.
*/
/*! \ingroup BenchmarksAndTests
* \defgroup CO2Tests CO2 (two phase, two component) benchmarks and tests
diff --git a/test/porousmediumflow/3p/implicit/3pniconductionproblem.hh b/test/porousmediumflow/3p/implicit/3pniconductionproblem.hh
index 5656c03afd..7f38323df3 100644
--- a/test/porousmediumflow/3p/implicit/3pniconductionproblem.hh
+++ b/test/porousmediumflow/3p/implicit/3pniconductionproblem.hh
@@ -18,6 +18,7 @@
*****************************************************************************/
/**
* \file
+ * \ingroup ThreePTests
* \brief Definition of a 3pni problem:
* Component transport of nitrogen dissolved in the water phase.
*/
@@ -40,7 +41,11 @@
namespace Dumux
{
-
+/**
+ * \ingroup ThreePTests
+ * \brief Definition of a 3pni problem:
+ * Component transport of nitrogen dissolved in the water phase.
+ */
template <class TypeTag>
class ThreePNIConductionProblem;
diff --git a/test/porousmediumflow/3p/implicit/3pniconvectionproblem.hh b/test/porousmediumflow/3p/implicit/3pniconvectionproblem.hh
index 143dbd45a7..00c1388419 100644
--- a/test/porousmediumflow/3p/implicit/3pniconvectionproblem.hh
+++ b/test/porousmediumflow/3p/implicit/3pniconvectionproblem.hh
@@ -18,6 +18,7 @@
*****************************************************************************/
/**
* \file
+ * \ingroup ThreePTests
* \brief Definition of a 1p2cni problem:
* Component transport of nitrogen dissolved in the water phase.
*/
@@ -39,7 +40,11 @@
namespace Dumux
{
-
+/**
+ * \ingroup ThreePTests
+ * \brief Definition of a 1p2cni problem:
+ * Component transport of nitrogen dissolved in the water phase.
+ */
template <class TypeTag>
class ThreePNIConvectionProblem;
diff --git a/test/porousmediumflow/3p/implicit/3pnispatialparams.hh b/test/porousmediumflow/3p/implicit/3pnispatialparams.hh
index 1d6899c308..631f4295cd 100644
--- a/test/porousmediumflow/3p/implicit/3pnispatialparams.hh
+++ b/test/porousmediumflow/3p/implicit/3pnispatialparams.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup ThreePTests
* \brief Definition of the spatial parameters for the 3pni problems.
*/
#ifndef DUMUX_THREEPNI_SPATIAL_PARAMS_HH
@@ -33,9 +33,7 @@ namespace Dumux
{
/*!
- * \ingroup ThreePNIModel
- * \ingroup ImplicitTestProblems
- *
+ * \ingroup ThreePTests
* \brief Definition of the spatial parameters for the 3pni problems.
*/
diff --git a/test/porousmediumflow/3p/implicit/infiltration3pproblem.hh b/test/porousmediumflow/3p/implicit/infiltration3pproblem.hh
index c12c6c66d6..e83341ba16 100644
--- a/test/porousmediumflow/3p/implicit/infiltration3pproblem.hh
+++ b/test/porousmediumflow/3p/implicit/infiltration3pproblem.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup ThreePTests
* \brief Isothermal NAPL infiltration problem: LNAPL contaminates
* the unsaturated and the saturated groundwater zone.
*/
@@ -37,6 +37,11 @@
namespace Dumux
{
+/*!
+ * \ingroup ThreePTests
+ * \brief Isothermal NAPL infiltration problem: LNAPL contaminates
+ * the unsaturated and the saturated groundwater zone.
+ */
template <class TypeTag>
class InfiltrationThreePProblem;
diff --git a/test/porousmediumflow/3p/implicit/infiltration3pspatialparams.hh b/test/porousmediumflow/3p/implicit/infiltration3pspatialparams.hh
index b5002b5669..70f5d82cb9 100644
--- a/test/porousmediumflow/3p/implicit/infiltration3pspatialparams.hh
+++ b/test/porousmediumflow/3p/implicit/infiltration3pspatialparams.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup ThreePTests
* \brief Definition of the spatial parameters for the kuevette problem, which
* uses the three-phase fully implicit model.
*/
@@ -34,7 +34,11 @@
namespace Dumux
{
-
+/*!
+ * \ingroup ThreePTests
+ * \brief Definition of the spatial parameters for the kuevette problem, which
+ * uses the three-phase fully implicit model.
+ */
//forward declaration
template<class TypeTag>
class InfiltrationThreePSpatialParams;
diff --git a/test/porousmediumflow/3p3c/implicit/columnxylolproblem.hh b/test/porousmediumflow/3p3c/implicit/columnxylolproblem.hh
index 59048496ef..0718f21839 100644
--- a/test/porousmediumflow/3p3c/implicit/columnxylolproblem.hh
+++ b/test/porousmediumflow/3p3c/implicit/columnxylolproblem.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup ThreePThreeCTests
* \brief Non-isothermal injection problem where water is injected into a
* sand column with a NAPL contamination.
*/
@@ -37,6 +37,11 @@
namespace Dumux
{
+/*!
+ * \ingroup ThreePThreeCTests
+ * \brief Non-isothermal injection problem where water is injected into a
+ * sand column with a NAPL contamination.
+ */
template <class TypeTag>
class ColumnProblem;
diff --git a/test/porousmediumflow/3p3c/implicit/columnxylolspatialparams.hh b/test/porousmediumflow/3p3c/implicit/columnxylolspatialparams.hh
index bdebcf5ae0..43c6a5c153 100644
--- a/test/porousmediumflow/3p3c/implicit/columnxylolspatialparams.hh
+++ b/test/porousmediumflow/3p3c/implicit/columnxylolspatialparams.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup ThreePThreeCTests
* \brief Definition of the spatial parameters for the column problem.
*/
#ifndef DUMUX_COLUMNXYLOL_SPATIAL_PARAMS_HH
@@ -31,7 +31,10 @@
namespace Dumux
{
-
+/*!
+ * \ingroup ThreePThreeCTests
+ * \brief Definition of the spatial parameters for the column problem.
+ */
//forward declaration
template<class TypeTag>
class ColumnSpatialParams;
diff --git a/test/porousmediumflow/3p3c/implicit/infiltration3p3cproblem.hh b/test/porousmediumflow/3p3c/implicit/infiltration3p3cproblem.hh
index 8ef587d804..fc5dfe2b98 100644
--- a/test/porousmediumflow/3p3c/implicit/infiltration3p3cproblem.hh
+++ b/test/porousmediumflow/3p3c/implicit/infiltration3p3cproblem.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup ThreePThreeCTests
* \brief Isothermal NAPL infiltration problem: LNAPL contaminates
* the unsaturated and the saturated groundwater zone.
*/
@@ -35,6 +35,11 @@
namespace Dumux
{
+/*!
+ * \ingroup ThreePThreeCTests
+ * \brief Isothermal NAPL infiltration problem: LNAPL contaminates
+ * the unsaturated and the saturated groundwater zone.
+ */
template <class TypeTag>
class InfiltrationThreePThreeCProblem;
diff --git a/test/porousmediumflow/3p3c/implicit/infiltration3p3cspatialparams.hh b/test/porousmediumflow/3p3c/implicit/infiltration3p3cspatialparams.hh
index f0d7638c1b..3f785c769a 100644
--- a/test/porousmediumflow/3p3c/implicit/infiltration3p3cspatialparams.hh
+++ b/test/porousmediumflow/3p3c/implicit/infiltration3p3cspatialparams.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup ThreePThreeCTests
* \brief Definition of the spatial parameters for the kuevette problem
* which uses the isothermal two-phase two component
* fully implicit model.
@@ -34,7 +34,12 @@
namespace Dumux
{
-
+/*!
+ * \ingroup ThreePThreeCTests
+ * \brief Definition of the spatial parameters for the kuevette problem
+ * which uses the isothermal two-phase two component
+ * fully implicit model.
+ */
//forward declaration
template<class TypeTag>
class InfiltrationThreePThreeCSpatialParams;
diff --git a/test/porousmediumflow/3p3c/implicit/kuevetteproblem.hh b/test/porousmediumflow/3p3c/implicit/kuevetteproblem.hh
index 1a506398c0..d520d3123b 100644
--- a/test/porousmediumflow/3p3c/implicit/kuevetteproblem.hh
+++ b/test/porousmediumflow/3p3c/implicit/kuevetteproblem.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup ThreePThreeCTests
* \brief Non-isothermal gas injection problem where a gas (e.g. steam/air)
* is injected into a unsaturated porous medium with a residually
* trapped NAPL contamination.
@@ -40,6 +40,12 @@
namespace Dumux
{
+/*!
+ * \ingroup ThreePThreeCTests
+ * \brief Non-isothermal gas injection problem where a gas (e.g. steam/air)
+ * is injected into a unsaturated porous medium with a residually
+ * trapped NAPL contamination.
+ */
template <class TypeTag>
class KuevetteProblem;
diff --git a/test/porousmediumflow/3p3c/implicit/kuevettespatialparams.hh b/test/porousmediumflow/3p3c/implicit/kuevettespatialparams.hh
index d74ea4aa6a..0e1fb9a47b 100644
--- a/test/porousmediumflow/3p3c/implicit/kuevettespatialparams.hh
+++ b/test/porousmediumflow/3p3c/implicit/kuevettespatialparams.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup ThreePThreeCTests
* \brief Definition of the spatial parameters for the kuevette problem.
*/
#ifndef DUMUX_KUEVETTE3P3CNI_SPATIAL_PARAMS_HH
@@ -33,7 +33,10 @@
namespace Dumux
{
-
+/*!
+ * \ingroup ThreePThreeCTests
+ * \brief Definition of the spatial parameters for the kuevette problem.
+ */
//forward declaration
template<class TypeTag>
class KuevetteSpatialParams;
diff --git a/test/porousmediumflow/3pwateroil/implicit/3pwateroilsagdproblem.hh b/test/porousmediumflow/3pwateroil/implicit/3pwateroilsagdproblem.hh
index 583fe4a507..7ff97306db 100644
--- a/test/porousmediumflow/3pwateroil/implicit/3pwateroilsagdproblem.hh
+++ b/test/porousmediumflow/3pwateroil/implicit/3pwateroilsagdproblem.hh
@@ -18,9 +18,8 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup ThreePWaterOilTests
* \brief Non-isothermal SAGD problem
- *
*/
#ifndef DUMUX_SAGDPROBLEM_HH
#define DUMUX_SAGDPROBLEM_HH
@@ -33,6 +32,11 @@
namespace Dumux
{
+/*!
+ * \file
+ * \ingroup ThreePWaterOilTests
+ * \brief Non-isothermal SAGD problem
+ */
template <class TypeTag>
class SagdProblem;
diff --git a/test/porousmediumflow/3pwateroil/implicit/3pwateroilsagdspatialparams.hh b/test/porousmediumflow/3pwateroil/implicit/3pwateroilsagdspatialparams.hh
index f0fdf766ab..d253b4c922 100644
--- a/test/porousmediumflow/3pwateroil/implicit/3pwateroilsagdspatialparams.hh
+++ b/test/porousmediumflow/3pwateroil/implicit/3pwateroilsagdspatialparams.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup ThreePWaterOilTests
* \brief Definition of the spatial parameters for the SAGD problem.
*/
@@ -35,7 +35,10 @@
namespace Dumux
{
-
+/*!
+ * \ingroup ThreePWaterOilTests
+ * \brief Definition of the spatial parameters for the SAGD problem.
+ */
//forward declaration
template<class TypeTag>
class SagdSpatialParams;
--
GitLab