diff --git a/dumux/porousmediumflow/mpnc/indices.hh b/dumux/porousmediumflow/mpnc/indices.hh
index 84eb9a4c5f0c53078d3e43aa1577af6eabaac1d9..387dc0e58001fcfadcaef7a2ce4dfdd479f1b8ba 100644
--- a/dumux/porousmediumflow/mpnc/indices.hh
+++ b/dumux/porousmediumflow/mpnc/indices.hh
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
+ * \ingroup MPNCModel
* \brief The primary variable and equation indices for the MpNc model.
*/
#ifndef DUMUX_MPNC_INDICES_HH
@@ -30,7 +31,6 @@ namespace Dumux
/*!
* \ingroup MPNCModel
- * \ingroup ImplicitIndices
* \brief Enumerates the formulations which the MpNc model accepts.
*/
struct MpNcPressureFormulation
@@ -43,7 +43,6 @@ struct MpNcPressureFormulation
/*!
* \ingroup MPNCModel
- * \ingroup ImplicitIndices
* \brief The primary variable and equation indices for the MpNc model.
*/
template <class TypeTag, int BasePVOffset = 0>
diff --git a/dumux/porousmediumflow/mpnc/localresidual.hh b/dumux/porousmediumflow/mpnc/localresidual.hh
index 068cbbc931ed8ac9d4bc643729de54120cb4a3a2..82cd7814acaafe7d40081863f4fdbdd6a123c235 100644
--- a/dumux/porousmediumflow/mpnc/localresidual.hh
+++ b/dumux/porousmediumflow/mpnc/localresidual.hh
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
+ * \ingroup MPNCModel
* \brief MpNc specific details needed to approximately calculate the local
* defect in the fully implicit scheme.
*
@@ -32,7 +33,6 @@ namespace Dumux
{
/*!
* \ingroup MPNCModel
- * \ingroup ImplicitLocalResidual
* \brief MpNc specific details needed to approximately calculate the local
* defect in the fully implicit scheme.
*
diff --git a/dumux/porousmediumflow/mpnc/model.hh b/dumux/porousmediumflow/mpnc/model.hh
index 33854175530bdab47815a0628cf6059a9c14dae7..9dcb351516987da5260263d22c664d19e614541d 100644
--- a/dumux/porousmediumflow/mpnc/model.hh
+++ b/dumux/porousmediumflow/mpnc/model.hh
@@ -115,10 +115,7 @@
#include "localresidual.hh"
/*!
- * \ingroup Properties
- * \ingroup ImplicitProperties
- * \ingroup BoxMpNcModel
- * \file
+ * \ingroup \ingroup MPNCModel
* \brief Defines the properties required for the MpNc fully implicit model.
*/
namespace Dumux
diff --git a/dumux/porousmediumflow/mpnc/volumevariables.hh b/dumux/porousmediumflow/mpnc/volumevariables.hh
index 217e63e5f4efba4995446fdd4f688ae705174aee..c13d3d0a07e12e5d524262631a6c3f6ea69e79df 100644
--- a/dumux/porousmediumflow/mpnc/volumevariables.hh
+++ b/dumux/porousmediumflow/mpnc/volumevariables.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup MPNCModel
* \brief Contains the secondary variables (Quantities which are
* constant within a finite volume) of the MpNc model.
*/
@@ -38,7 +38,6 @@ namespace Dumux
{
/*!
* \ingroup MPNCModel
- * \ingroup ImplicitVolumeVariables
* \brief Contains the quantities which are constant within a
* finite volume in the MpNc model.
*/
diff --git a/dumux/porousmediumflow/mpnc/vtkoutputfields.hh b/dumux/porousmediumflow/mpnc/vtkoutputfields.hh
index fa3e9ae90ec722c3643533f2c0d7b9168a0ab934..f3c8c5b73b851bf652b203cd53101016fac49f8b 100644
--- a/dumux/porousmediumflow/mpnc/vtkoutputfields.hh
+++ b/dumux/porousmediumflow/mpnc/vtkoutputfields.hh
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
+ * \ingroup MPNCModel
* \brief Adds vtk output fields specific to the twop model
*/
#ifndef DUMUX_MPNC_VTK_OUTPUT_FIELDS_HH
@@ -27,7 +28,7 @@ namespace Dumux
{
/*!
- * \ingroup TwoP, InputOutput
+ * \ingroup MPNCModel
* \brief Adds vtk output fields specific to the twop model
*/
template<class TypeTag>
diff --git a/dumux/porousmediumflow/nonequilibrium/gridvariables.hh b/dumux/porousmediumflow/nonequilibrium/gridvariables.hh
index a758850bf1405b5840f42b26b07306c4a4c951f0..5212df7f51fd39897e6936fb65f9096175b07dd9 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 c87e5192af8d1856d6ce53fabc232c0a314e4e39..4247110b56e5b74d42815bf603512792889b6177 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 55bc503ceb2d592fd0b1d6a1fb19e7f88765655c..68f0ccf26405cdf410f0e794f52d1eab890e6bc7 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 bf304d33e57d011f8cb6299a9427dcc099ab12f5..1679c2c15ab19325f9f521179fa2e46f71763d51 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 a5876081c75d2d9654d060cd78f5a834e0ed78dd..704aeb28c82455c71ed7658a36ec591c9a17bfbe 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 dbfdf601e4a426e0306464df46582056300dd345..cb620ec92f44e2c94d43d8cf0e9a60bfd5ae9a17 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 3ef398eed7df6711966740b313ccbb35a354d0c5..9fe220b7bbc6ab68e607854525629453adc41756 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 b22429f49115ca234f9555c4182882759871ebfe..2370dec34eb28049ef62534cbdcbf766e1c7319e 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>
diff --git a/test/porousmediumflow/mpnc/implicit/combustionproblem1c.hh b/test/porousmediumflow/mpnc/implicit/combustionproblem1c.hh
index 53cbc1db08dfea452538911778c6d3b01dbb5320..40a1cc1d4ea30bb064f77974a9d64056bfaef880 100644
--- a/test/porousmediumflow/mpnc/implicit/combustionproblem1c.hh
+++ b/test/porousmediumflow/mpnc/implicit/combustionproblem1c.hh
@@ -15,15 +15,13 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
- * \file combustionproblem1c.hh
- *
+ * \file
+ * \ingroup MPNCTests
* \brief Problem where hot, pure liquid water is injected from the left hand side into a initially
* isotherm domain. The water is fully evaporated by a strong heat source.
* A local thermal non-equilibrium model is used: i.e. two different (fluid, solid)
* temperatures are primary variables.
*
- * \ingroup MpNcBoxproblems
- *
* \author Philipp Nuske
*/
#ifndef DUMUX_COMBUSTION_PROBLEM_ONE_COMPONENT_HH
@@ -106,8 +104,7 @@ SET_INT_PROP(CombustionProblemOneComponent, NumEqBalance, GET_PROP_VALUE(TypeTag
}
/*!
- * \ingroup MpNcBoxproblems
- *
+ * \ingroup MPNCTests
* \brief Problem where water is injected from the left hand side into a porous media filled domain,
* which is supplied with energy from the right hand side to evaporate the water.
*/
diff --git a/test/porousmediumflow/mpnc/implicit/combustionspatialparams.hh b/test/porousmediumflow/mpnc/implicit/combustionspatialparams.hh
index 5ce605f8bd889c7a8f3d7703c6b645fecf723c12..dd0bb1e7430a8b4a4496150ce8142087a1937db7 100644
--- a/test/porousmediumflow/mpnc/implicit/combustionspatialparams.hh
+++ b/test/porousmediumflow/mpnc/implicit/combustionspatialparams.hh
@@ -17,8 +17,8 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
- * \file combustionspatialparams.hh
- *
+ * \file
+ * \ingroup MPNCTests
* \brief Spatialparameters for the combustionproblem1c. Parameters for the actual simulation domain and an outflow region are provided.
*/
#ifndef DUMUX_COMBUSTION_SPATIALPARAMS_HH
@@ -34,7 +34,10 @@
namespace Dumux
{
-
+/*!
+ * \ingroup MPNCTests
+ * \brief Spatialparameters for the combustionproblem1c. Parameters for the actual simulation domain and an outflow region are provided.
+ */
//forward declaration
template<class TypeTag>
class CombustionSpatialParams;
diff --git a/test/porousmediumflow/mpnc/implicit/evaporationatmosphereproblem.hh b/test/porousmediumflow/mpnc/implicit/evaporationatmosphereproblem.hh
index de1fc1aced7ec6fb5f87bb2da490bbc5b9f5e830..6ad18d94b7381a6b3ab8ffd414f7fe6a659ee4d6 100644
--- a/test/porousmediumflow/mpnc/implicit/evaporationatmosphereproblem.hh
+++ b/test/porousmediumflow/mpnc/implicit/evaporationatmosphereproblem.hh
@@ -17,8 +17,8 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
- * \file evaporationatmosphereproblem.hh
- * \ingroup MpNcBoxproblems
+ * \file
+ * \ingroup MPNCTests
*
* \brief Problem showcasing the capabilities of the kinetic model.
*
@@ -28,10 +28,6 @@
*
* The porous domain is bypassed with dry air. This way the equilibration process on top of the porous domain can be studied.
*
- * The Problem is written, such that the kinetic consideration for mass and energy can
- * be switched of by merely setting kinetic, kineticenergy respectivly to false.
- * Boundary and initial conditions are specified for all cases.
- *
* \author Philipp Nuske
*/
#ifndef DUMUX_EVAPORATION_ATMOSPHERE_PROBLEM_HH
@@ -58,7 +54,11 @@
namespace Dumux
{
-
+/*!
+ * \ingroup MPNCTests
+ *
+ * \brief Problem showcasing the capabilities of the kinetic model.
+ */
template <class TypeTag>
class EvaporationAtmosphereProblem;
diff --git a/test/porousmediumflow/mpnc/implicit/evaporationatmospherespatialparams.hh b/test/porousmediumflow/mpnc/implicit/evaporationatmospherespatialparams.hh
index a74ca409f9b98166fffc5a60bacb6b77f2afdf09..5c4f688a42c981bf45646854493e463afe189fdb 100644
--- a/test/porousmediumflow/mpnc/implicit/evaporationatmospherespatialparams.hh
+++ b/test/porousmediumflow/mpnc/implicit/evaporationatmospherespatialparams.hh
@@ -17,7 +17,8 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
- * \file evaporationatmospherespatialparams.hh
+ * \file
+ * \ingroup MPNCTests
* \brief spatialparameters for the kinetic test-case of the mpnc model. "Poor-mans" coupling of free-flow and porous medium.
*
*/
@@ -45,7 +46,11 @@
namespace Dumux
{
-
+/*!
+ * \ingroup MPNCTests
+ * \brief spatialparameters for the kinetic test-case of the mpnc model. "Poor-mans" coupling of free-flow and porous medium.
+ *
+ */
//forward declaration
template<class TypeTag>
class EvaporationAtmosphereSpatialParams;
diff --git a/test/porousmediumflow/mpnc/implicit/obstacleproblem.hh b/test/porousmediumflow/mpnc/implicit/obstacleproblem.hh
index 561f42979c2b7d9ba8b912e5a847e83860ccd084..88c5a5fdabbdc0256e7e909665c0e2cba5e3609c 100644
--- a/test/porousmediumflow/mpnc/implicit/obstacleproblem.hh
+++ b/test/porousmediumflow/mpnc/implicit/obstacleproblem.hh
@@ -16,8 +16,9 @@
* 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 MPNCTests
* \brief Problem where liquid water is injected -- by means of a
* Dirichlet condition on the lower right of the domain -- which has to go
* around an obstacle with \f$10^3\f$ lower permeability.
@@ -41,7 +42,12 @@
namespace Dumux
{
-
+/*!
+ * \ingroup MPNCTests
+ * \brief Problem where liquid water is injected -- by means of a
+ * Dirichlet condition on the lower right of the domain -- which has to go
+ * around an obstacle with \f$10^3\f$ lower permeability.
+ */
template <class TypeTag>
class ObstacleProblem;
diff --git a/test/porousmediumflow/mpnc/implicit/obstaclespatialparams.hh b/test/porousmediumflow/mpnc/implicit/obstaclespatialparams.hh
index 16bb62b5b52c47e1157336a773bbba4d87256f73..4b6037caeaa439b00ee161d63d6ac461ae8f0b17 100644
--- a/test/porousmediumflow/mpnc/implicit/obstaclespatialparams.hh
+++ b/test/porousmediumflow/mpnc/implicit/obstaclespatialparams.hh
@@ -16,9 +16,9 @@
* 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 MPNCTests
* \brief The spatial parameters for the ObstacleProblem
*/
@@ -34,7 +34,10 @@
namespace Dumux
{
-
+/*!
+ * \ingroup MPNCTests
+ * \brief The spatial parameters for the ObstacleProblem
+ */
//forward declaration
template<class TypeTag>
class ObstacleSpatialParams;