From dd451d0b35d559757f87320590631bdfafca8b03 Mon Sep 17 00:00:00 2001
From: Katharina Heck <katharina.heck@iws.uni-stuttgart.de>
Date: Thu, 21 Dec 2017 10:28:19 +0100
Subject: [PATCH] [fix] docu nonequilibrium
---
.../nonequilibrium/gridvariables.hh | 4 ++--
dumux/porousmediumflow/nonequilibrium/indices.hh | 4 ++--
.../nonequilibrium/localresidual.hh | 2 ++
dumux/porousmediumflow/nonequilibrium/model.hh | 15 +++++++++------
.../nonequilibrium/newtoncontroller.hh | 10 ++++------
.../nonequilibrium/thermal/localresidual.hh | 11 +++++++----
.../nonequilibrium/volumevariables.hh | 10 ++++++++--
.../nonequilibrium/vtkoutputfields.hh | 3 ++-
8 files changed, 36 insertions(+), 23 deletions(-)
diff --git a/dumux/porousmediumflow/nonequilibrium/gridvariables.hh b/dumux/porousmediumflow/nonequilibrium/gridvariables.hh
index a758850bf1..5212df7f51 100644
--- a/dumux/porousmediumflow/nonequilibrium/gridvariables.hh
+++ b/dumux/porousmediumflow/nonequilibrium/gridvariables.hh
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
+ * \ingroup PorousmediumNonEquilibriumModel
* \brief Class storing scv and scvf variables
*/
#ifndef DUMUX_NONEQUILIBRIUM_GRID_VARIABLES_HH
@@ -28,9 +29,8 @@
namespace Dumux
{
-
/*!
- * \ingroup NonEquilbriumModel
+ * \ingroup PorousmediumNonEquilibriumModel
* \brief This class stores the velocities which are used to compute reynoldsnumbers for the source terms of nonequilibrium models
*/
template<class TypeTag>
diff --git a/dumux/porousmediumflow/nonequilibrium/indices.hh b/dumux/porousmediumflow/nonequilibrium/indices.hh
index c87e5192af..4247110b56 100644
--- a/dumux/porousmediumflow/nonequilibrium/indices.hh
+++ b/dumux/porousmediumflow/nonequilibrium/indices.hh
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
+ * \ingroup PorousmediumNonEquilibriumModel
* \brief The primary variable and equation indices for the MpNc model.
*/
#ifndef DUMUX_NONEQUILIBRIUM_INDICES_HH
@@ -29,8 +30,7 @@ namespace Dumux
{
/*!
- * \ingroup NonEquilibrium
- * \ingroup ImplicitIndices
+ * \ingroup PorousmediumNonEquilibriumModel
* \brief The primary variable and equation indices for the MpNc model.
*/
template <class TypeTag, int BasePVOffset = 0>
diff --git a/dumux/porousmediumflow/nonequilibrium/localresidual.hh b/dumux/porousmediumflow/nonequilibrium/localresidual.hh
index 55bc503ceb..68f0ccf264 100644
--- a/dumux/porousmediumflow/nonequilibrium/localresidual.hh
+++ b/dumux/porousmediumflow/nonequilibrium/localresidual.hh
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
+ * \ingroup PorousmediumNonEquilibriumModel
* \brief The local residual for the kinetic mass transfer module of
* the compositional multi-phase model.
*/
@@ -38,6 +39,7 @@ template <class TypeTag>
using NonEquilibriumLocalResidual = NonEquilibriumLocalResidualImplementation<TypeTag, GET_PROP_VALUE(TypeTag, EnableThermalNonEquilibrium), GET_PROP_VALUE(TypeTag, EnableChemicalNonEquilibrium)>;
/*!
+ * \ingroup PorousmediumNonEquilibriumModel
* \brief The mass conservation part of the nonequilibrium model for a model without chemical non-equilibrium
*/
template<class TypeTag>
diff --git a/dumux/porousmediumflow/nonequilibrium/model.hh b/dumux/porousmediumflow/nonequilibrium/model.hh
index bf304d33e5..1679c2c15a 100644
--- a/dumux/porousmediumflow/nonequilibrium/model.hh
+++ b/dumux/porousmediumflow/nonequilibrium/model.hh
@@ -16,6 +16,13 @@
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
+
+/*!
+ * \file
+ * \ingroup PorousmediumNonEquilibriumModel
+ * \brief This is the specialization that is able to capture non-equilibrium mass and / or energy transfer.
+ * \todo DocMe
+ */
#ifndef DUMUX_NONEQUILIBRIUM_MODEL_HH
#define DUMUX_NONEQUILIBRIUM_MODEL_HH
@@ -30,12 +37,8 @@
#include "vtkoutputfields.hh"
/*!
- * \ingroup Properties
- * \ingroup ImplicitProperties
- * \ingroup NonEquilibriumModel
- * \file
- * \brief This is the specialization that is able to capture non-equilibrium mass and / or energy transfer.
- *
+ * \ingroup \ingroup PorousmediumNonEquilibriumModel
+ * \brief Defines the properties required for non-equilibrium models
*/
namespace Dumux
{
diff --git a/dumux/porousmediumflow/nonequilibrium/newtoncontroller.hh b/dumux/porousmediumflow/nonequilibrium/newtoncontroller.hh
index a5876081c7..704aeb28c8 100644
--- a/dumux/porousmediumflow/nonequilibrium/newtoncontroller.hh
+++ b/dumux/porousmediumflow/nonequilibrium/newtoncontroller.hh
@@ -18,9 +18,9 @@
*****************************************************************************/
/*!
* \file
+ * \ingroup PorousmediumNonEquilibriumModel
* \brief A MpNc specific controller for the newton solver.
- *
- * This controller calls the velocity averaging in the model after each iteration.
+ * This controller calls the velocity averaging in the model after each iteration.
*/
#ifndef DUMUX_NONEQUILIBRIUM_NEWTON_CONTROLLER_HH
#define DUMUX_NONEQUILIBRIUM_NEWTON_CONTROLLER_HH
@@ -31,11 +31,9 @@
namespace Dumux {
/*!
- * \brief A kinetic-nonequilibrium specific controller for the newton solver.
- *
+ * \ingroup PorousmediumNonEquilibriumModel
+ * \brief A nonequilibrium specific controller for the newton solver.
* This controller calls the velocity averaging in the problem after each iteration.
- *
- * Everything else is taken from the standard mpnc newtoncontroller.
*/
template <class TypeTag>
class NonEquilibriumNewtonController : public NewtonController<TypeTag>
diff --git a/dumux/porousmediumflow/nonequilibrium/thermal/localresidual.hh b/dumux/porousmediumflow/nonequilibrium/thermal/localresidual.hh
index dbfdf601e4..cb620ec92f 100644
--- a/dumux/porousmediumflow/nonequilibrium/thermal/localresidual.hh
+++ b/dumux/porousmediumflow/nonequilibrium/thermal/localresidual.hh
@@ -17,10 +17,9 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup PorousmediumThermalNonEquilibriumModel
* \brief This file contains the parts of the local residual to
- * calculate the heat conservation in the thermal non-equilibrium M-phase
- * N-component model.
+ * calculate the heat conservation in the thermal non-equilibrium model.
*/
#ifndef DUMUX_ENERGY_NONEQUILIBRIUM_LOCAL_RESIDUAL_HH
#define DUMUX_ENERGY_NONEQUILIBRIUM_LOCAL_RESIDUAL_HH
@@ -30,7 +29,11 @@
namespace Dumux
{
-
+/*!
+ * \ingroup PorousmediumThermalNonEquilibriumModel
+ * \brief This file contains the parts of the local residual to
+ * calculate the heat conservation in the thermal non-equilibrium model.
+ */
// forward declaration
template <class TypeTag, int numEnergyEqFluid>
class EnergyLocalResidualNonEquilibrium;
diff --git a/dumux/porousmediumflow/nonequilibrium/volumevariables.hh b/dumux/porousmediumflow/nonequilibrium/volumevariables.hh
index 3ef398eed7..9fe220b7bb 100644
--- a/dumux/porousmediumflow/nonequilibrium/volumevariables.hh
+++ b/dumux/porousmediumflow/nonequilibrium/volumevariables.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup PorousmediumNonEquilibriumModel
* \brief This class contains the volume variables required for the
* modules which require the specific interfacial area between
* fluid phases.
@@ -40,7 +40,13 @@
namespace Dumux
{
-
+/*!
+ * \file
+ * \ingroup PorousmediumNonEquilibriumModel
+ * \brief This class contains the volume variables required for the
+ * modules which require the specific interfacial area between
+ * fluid phases.
+ */
// forward declaration
template <class TypeTag, bool enableChemicalNonEquilibrium ,bool enableThermalNonEquilibrium>
class NonEquilibriumVolumeVariablesImplementation;
diff --git a/dumux/porousmediumflow/nonequilibrium/vtkoutputfields.hh b/dumux/porousmediumflow/nonequilibrium/vtkoutputfields.hh
index b22429f491..2370dec34e 100644
--- a/dumux/porousmediumflow/nonequilibrium/vtkoutputfields.hh
+++ b/dumux/porousmediumflow/nonequilibrium/vtkoutputfields.hh
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
+ * \ingroup PorousmediumNonEquilibriumModel
* \brief Adds vtk output fields specific to non-isothermal models
*/
#ifndef DUMUX_NONEQUILBRIUM_OUTPUT_FIELDS_HH
@@ -29,7 +30,7 @@ namespace Dumux
{
/*!
- * \ingroup NonEquilibrium, InputOutput
+ * \ingroup PorousmediumNonEquilibriumModel
* \brief Adds vtk output fields specific to non-isothermal models
*/
template<class TypeTag>
--
GitLab