From 8505c07af7a9adfa098945d96d4cc3e0f0221b1c Mon Sep 17 00:00:00 2001
From: Katharina Heck <katharina.heck@iws.uni-stuttgart.de>
Date: Wed, 20 Dec 2017 13:14:56 +0100
Subject: [PATCH] [fix] doxygen groups
---
dumux/porousmediumflow/3pwateroil/indices.hh | 2 +-
.../3pwateroil/localresidual.hh | 9 ++-
dumux/porousmediumflow/3pwateroil/model.hh | 57 ++++++++++---------
.../3pwateroil/primaryvariableswitch.hh | 2 +-
.../3pwateroil/volumevariables.hh | 4 +-
.../3pwateroil/vtkoutputfields.hh | 3 +-
.../3pwateroil/implicit/test_box3pwateroil.cc | 5 +-
7 files changed, 41 insertions(+), 41 deletions(-)
diff --git a/dumux/porousmediumflow/3pwateroil/indices.hh b/dumux/porousmediumflow/3pwateroil/indices.hh
index bab64a79ea..52541a3205 100644
--- a/dumux/porousmediumflow/3pwateroil/indices.hh
+++ b/dumux/porousmediumflow/3pwateroil/indices.hh
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
+ * \ingroup ThreePWaterOilModel
* \brief Defines the indices required for the 3p2cni model.
*/
#ifndef DUMUX_3P2CNI_INDICES_HH
@@ -29,7 +30,6 @@ namespace Dumux
/*!
* \ingroup ThreePWaterOilModel
- * \ingroup ImplicitIndices
* \brief The indices for the isothermal 3p2cni model.
*
* \tparam formulation The formulation, only pgSwSn
diff --git a/dumux/porousmediumflow/3pwateroil/localresidual.hh b/dumux/porousmediumflow/3pwateroil/localresidual.hh
index f1990f5a47..4bb312fd78 100644
--- a/dumux/porousmediumflow/3pwateroil/localresidual.hh
+++ b/dumux/porousmediumflow/3pwateroil/localresidual.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup ThreePWaterOilModel
* \brief Element-wise calculation of the Jacobian matrix for problems
* using the three-phase three-component fully implicit model.
*/
@@ -32,11 +32,10 @@ namespace Dumux
{
/*!
* \ingroup ThreePWaterOilModel
- * \ingroup ImplicitLocalResidual
- * \brief Element-wise calculation of the Jacobian matrix for problems
- * using the three-phase three-component fully implicit model.
+ * \brief Element-wise calculation of the local residual for problems
+ * using the ThreePWaterOil fully implicit model.
*
- * This class is used to fill the gaps in BoxLocalResidual for the 3P2C flow.
+ * This class is used to fill the gaps in the CompositionalLocalResidual for the 3PWaterOil flow.
*/
template<class TypeTag>
class ThreePWaterOilLocalResidual: public ThreePThreeCLocalResidual<TypeTag>
diff --git a/dumux/porousmediumflow/3pwateroil/model.hh b/dumux/porousmediumflow/3pwateroil/model.hh
index 2fd41afc98..0506938e88 100644
--- a/dumux/porousmediumflow/3pwateroil/model.hh
+++ b/dumux/porousmediumflow/3pwateroil/model.hh
@@ -18,38 +18,11 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup ThreePWaterOilModel
* \brief Adaption of the fully implicit scheme to the three-phase three-component flow model.
*
* The model is designed for simulating three fluid phases with water, gas, and
* a liquid contaminant (NAPL - non-aqueous phase liquid)
- */
-#ifndef DUMUX_3PWATEROIL_MODEL_HH
-#define DUMUX_3PWATEROIL_MODEL_HH
-
-#include <dumux/common/properties.hh>
-
-#include <dumux/material/spatialparams/fv.hh>
-#include <dumux/material/fluidmatrixinteractions/3p/thermalconductivitysomerton3p.hh>
-#include <dumux/material/fluidmatrixinteractions/diffusivitymillingtonquirk.hh>
-
-#include <dumux/porousmediumflow/properties.hh>
-#include <dumux/porousmediumflow/nonisothermal/model.hh>
-#include <dumux/porousmediumflow/compositional/switchableprimaryvariables.hh>
-
-#include "indices.hh"
-#include "model.hh"
-#include "volumevariables.hh"
-#include "localresidual.hh"
-#include "primaryvariableswitch.hh"
-#include "vtkoutputfields.hh"
-
-namespace Dumux
-{
-/*!
- * \ingroup ThreePWaterOilModel
- * \brief Adaption of the fully implicit scheme to the three-phase two-component flow model.
- *
* This model implements three-phase two-component flow of three fluid phases
* \f$\alpha \in \{ water, gas, NAPL \}\f$ each composed of up to two components
* \f$\kappa \in \{ water, contaminant \}\f$. The standard multiphase Darcy
@@ -94,6 +67,34 @@ namespace Dumux
* <li> ... to be completed ... </li>
* </ul>
*/
+
+#ifndef DUMUX_3PWATEROIL_MODEL_HH
+#define DUMUX_3PWATEROIL_MODEL_HH
+
+#include <dumux/common/properties.hh>
+
+#include <dumux/material/spatialparams/fv.hh>
+#include <dumux/material/fluidmatrixinteractions/3p/thermalconductivitysomerton3p.hh>
+#include <dumux/material/fluidmatrixinteractions/diffusivitymillingtonquirk.hh>
+
+#include <dumux/porousmediumflow/properties.hh>
+#include <dumux/porousmediumflow/nonisothermal/model.hh>
+#include <dumux/porousmediumflow/compositional/switchableprimaryvariables.hh>
+
+#include "indices.hh"
+#include "model.hh"
+#include "volumevariables.hh"
+#include "localresidual.hh"
+#include "primaryvariableswitch.hh"
+#include "vtkoutputfields.hh"
+
+namespace Dumux
+{
+/*!
+ * \ingroup ThreePWaterOilModel
+ * \brief Adaption of the fully implicit scheme to the three-phase two-component flow model.
+ *
+ */
namespace Properties {
NEW_TYPE_TAG(ThreePWaterOilNI, INHERITS_FROM(PorousMediumFlow, NonIsothermal));
diff --git a/dumux/porousmediumflow/3pwateroil/primaryvariableswitch.hh b/dumux/porousmediumflow/3pwateroil/primaryvariableswitch.hh
index 3585f350b5..35c945abef 100644
--- a/dumux/porousmediumflow/3pwateroil/primaryvariableswitch.hh
+++ b/dumux/porousmediumflow/3pwateroil/primaryvariableswitch.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup ThreePWaterOilModel
* \brief The primary variable switch for the 3p3c model
*/
#ifndef DUMUX_3P3C_PRIMARY_VARIABLE_SWITCH_HH
diff --git a/dumux/porousmediumflow/3pwateroil/volumevariables.hh b/dumux/porousmediumflow/3pwateroil/volumevariables.hh
index fe6f805f56..b48f932ada 100644
--- a/dumux/porousmediumflow/3pwateroil/volumevariables.hh
+++ b/dumux/porousmediumflow/3pwateroil/volumevariables.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup ThreePWaterOilModel
* \brief Contains the quantities which are constant within a
* finite volume in the three-phase, two-component model.
*/
@@ -45,7 +45,7 @@ namespace Dumux
/*!
* \ingroup ThreePWaterOilModel
* \brief Contains the quantities which are are constant within a
- * finite volume in the two-phase, two-component model.
+ * finite volume in the three-phase, two-component model.
*/
template <class TypeTag>
class ThreePWaterOilVolumeVariables : public PorousMediumFlowVolumeVariables<TypeTag>
diff --git a/dumux/porousmediumflow/3pwateroil/vtkoutputfields.hh b/dumux/porousmediumflow/3pwateroil/vtkoutputfields.hh
index fe13bf378c..079e1dce92 100644
--- a/dumux/porousmediumflow/3pwateroil/vtkoutputfields.hh
+++ b/dumux/porousmediumflow/3pwateroil/vtkoutputfields.hh
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
+ * \ingroup ThreePWaterOilModel
* \brief Adds vtk output fields specific to the twop model
*/
#ifndef DUMUX_THREEPWATEROIL_VTK_OUTPUT_FIELDS_HH
@@ -29,7 +30,7 @@ namespace Dumux
{
/*!
- * \ingroup ThreePThreeC, InputOutput
+ * \ingroup ThreePWaterOilModel
* \brief Adds vtk output fields specific to the three-phase three-component model
*/
template<class TypeTag>
diff --git a/test/porousmediumflow/3pwateroil/implicit/test_box3pwateroil.cc b/test/porousmediumflow/3pwateroil/implicit/test_box3pwateroil.cc
index 6f5c1d3b18..ef46ef7d47 100644
--- a/test/porousmediumflow/3pwateroil/implicit/test_box3pwateroil.cc
+++ b/test/porousmediumflow/3pwateroil/implicit/test_box3pwateroil.cc
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup OnePTests
* \brief Test for the three-phase three-component box model
*/
#include <config.h>
@@ -52,8 +52,7 @@
/*!
* \brief Provides an interface for customizing error messages associated with
* reading in parameters.
- *
- * \param progName The name of the program, that was tried to be started.
+ * \ingroup OnePTests
* \param errorMsg The error message that was issued by the start function.
* Comprises the thing that went wrong and a general help message.
*/
--
GitLab