diff --git a/doc/doxygen/modules.txt b/doc/doxygen/modules.txt index 4ad12ff178bed54f39dcb97a722b087ce8ad695c..8dfee529d1b80cb1278fee475355b18728967de7 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 5656c03afddd0bb0a7d74ba0614579f8ab39ab84..7f38323df366c916726f6cc830f1b839b1a10a03 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 143dbd45a7bcbdcfdb7f786958ec252c23afdd4c..00c13884192c3eb0a341b8e075379b47c13edd81 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 1d6899c3086233dbcfcae8abf5d403b187211c7f..631f4295cdd53bf9a615cee3500e9561c2c63b3a 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 c12c6c66d6be66b70b1aee7e5b301d3efe1e2eaf..e83341ba161317b3b2d266f668e64ba95cd853e3 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 b5002b566929f87649d09370c2cb38c344cd9aaf..70f5d82cb921c5f90cc9bd3a1dce2b5d15e556a3 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 59048496ef1cfda25b5001f8b57586c79d0bbaac..0718f21839f4a584de20d80e0a0cd568fa0c20b5 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 bdebcf5ae0e1cb136a6acbfbbc4c53c213094df1..43c6a5c153147da047974572c86d375952948908 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 8ef587d804948330fde80becc80ee4f1b463738f..fc5dfe2b987bd88556a2fecc02c18d461aab5af9 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 f0d7638c1b485db133094b3271440470c58e40e8..3f785c769add55dfdde3f744491ffb5c9e860e43 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 1a506398c00b1ef3f6d18d41cf026e36202ddfd7..d520d3123be55cd96cda15c96e29a9a55612792a 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 d74ea4aa6add65be2c35fddd7f8b87bde843c673..0e1fb9a47bb0bc5ce6ed8bb35c23ce7f1d2bddd4 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 583fe4a5074f4ab1c34432fe4bdedf8b527316d7..7ff97306dbb0acf66da383c7b1833da95256b589 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 f0fdf766ab68d90a302647c2586a60ae00da5bff..d253b4c9229e2030d2c92b14e9a4d014c985e974 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;