From a8229e1deb9e9017e7dabd31bf9880c1696633c3 Mon Sep 17 00:00:00 2001
From: Melanie Lipp <melanie.lipp@iws.uni-stuttgart.de>
Date: Tue, 4 May 2021 11:53:53 +0200
Subject: [PATCH] [doxygen] Add some new ingroups in modules.txt and use them
in the files.
---
doc/doxygen/modules.txt | 16 ++++++++++++++++
.../porenetwork/fvelementgeometry.hh | 4 ++--
dumux/discretization/porenetwork/gridgeometry.hh | 6 +++---
.../porenetwork/subcontrolvolume.hh | 6 +++---
.../porenetwork/subcontrolvolumeface.hh | 4 ++--
dumux/flux/porenetwork/advection.hh | 4 ++--
dumux/flux/porenetwork/fickslaw.hh | 4 ++--
dumux/flux/porenetwork/fourierslaw.hh | 4 ++--
dumux/timestepping/multistagemethods.hh | 1 +
dumux/timestepping/multistagetimestepper.hh | 1 +
dumux/timestepping/timelevel.hh | 1 +
11 files changed, 35 insertions(+), 16 deletions(-)
diff --git a/doc/doxygen/modules.txt b/doc/doxygen/modules.txt
index c63fa63ad0..d587f0732c 100644
--- a/doc/doxygen/modules.txt
+++ b/doc/doxygen/modules.txt
@@ -305,6 +305,11 @@
* \defgroup FEMDiscretization Finite element method
* \brief The finite element method
*/
+ /*!
+ * \ingroup Discretization
+ * \defgroup PoreNetworkDiscretization Pore network model discretization
+ * \brief The pore-network model discretization.
+ */
/* ***************** Flux ******************/
/*!
* \defgroup Flux Flux
@@ -330,6 +335,11 @@
* \defgroup CCMpfaFlux Flux related to the cell-centered multi-point flux approximation schemes
* \brief Flux related to the cell-centered multi-point flux approximation schemes
*/
+ /*!
+ * \ingroup Flux
+ * \defgroup PoreNetworkFlux Flux related to the pore network models
+ * \brief Flux related to the pore newtwork models
+ */
/*!
* \ingroup Flux
* \defgroup StaggeredFlux Flux related to the staggered scheme
@@ -602,3 +612,9 @@
* \brief Two-phase (immiscible) flow
* For a detailed model description see porenetwork/2p/model.hh
*/
+
+ /* ***************** TimeStepping ******************/
+ /*!
+ * \defgroup TimeStepping Time stepping
+ * \brief The time stepping
+ */
diff --git a/dumux/discretization/porenetwork/fvelementgeometry.hh b/dumux/discretization/porenetwork/fvelementgeometry.hh
index 70243b7569..269ee1c665 100644
--- a/dumux/discretization/porenetwork/fvelementgeometry.hh
+++ b/dumux/discretization/porenetwork/fvelementgeometry.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \ingroup PoreNetworkModels
+ * \ingroup PoreNetworkDiscretization
* \brief Base class for the local geometry for porenetworks
*/
#ifndef DUMUX_DISCRETIZATION_PNM_FV_ELEMENT_GEOMETRY_HH
@@ -31,7 +31,7 @@
namespace Dumux::PoreNetwork {
/*!
- * \ingroup PoreNetworkModels
+ * \ingroup PoreNetworkDiscretization
* \brief Base class for the local geometry for porenetworks
* \tparam GG the finite volume grid geometry type
* \tparam enableFVGridGeometryCache if the grid geometry is cached or not
diff --git a/dumux/discretization/porenetwork/gridgeometry.hh b/dumux/discretization/porenetwork/gridgeometry.hh
index 31cc117aed..c790bbb5a6 100644
--- a/dumux/discretization/porenetwork/gridgeometry.hh
+++ b/dumux/discretization/porenetwork/gridgeometry.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \ingroup PoreNetworkModels
+ * \ingroup PoreNetworkDiscretization
* \brief Base class for the finite volume geometry for porenetwork models
*/
#ifndef DUMUX_DISCRETIZATION_PNM_GRID_GEOMETRY_HH
@@ -459,7 +459,7 @@ private:
};
/*!
- * \ingroup PoreNetworkModels
+ * \ingroup PoreNetworkDiscretization
* \brief The default traits
* \tparam the grid view type
*/
@@ -669,7 +669,7 @@ private:
};
/*!
- * \ingroup PoreNetworkModels
+ * \ingroup PoreNetworkDiscretization
* \brief Base class for the finite volume geometry for porenetwork models
* \note For caching disabled we store only some essential index maps to build up local systems on-demand in
* the corresponding FVElementGeometry
diff --git a/dumux/discretization/porenetwork/subcontrolvolume.hh b/dumux/discretization/porenetwork/subcontrolvolume.hh
index 3434e0920c..e5d1f5eb84 100644
--- a/dumux/discretization/porenetwork/subcontrolvolume.hh
+++ b/dumux/discretization/porenetwork/subcontrolvolume.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \ingroup PoreNetworkModels
+ * \ingroup PoreNetworkDiscretization
* \brief the sub control volume for pore networks
*/
#ifndef DUMUX_DISCRETIZATION_PNM_SUBCONTROLVOLUME_HH
@@ -32,7 +32,7 @@
namespace Dumux::PoreNetwork {
/*!
- * \ingroup PoreNetworkModels
+ * \ingroup PoreNetworkDiscretization
* \brief Default traits class
* \tparam GV the type of the grid view
*/
@@ -53,7 +53,7 @@ struct PNMDefaultScvGeometryTraits
};
/*!
- * \ingroup PoreNetworkModels
+ * \ingroup PoreNetworkDiscretization
* \brief the sub control volume for porenetworks
* \tparam GV the type of the grid view
* \tparam T the scv geometry traits
diff --git a/dumux/discretization/porenetwork/subcontrolvolumeface.hh b/dumux/discretization/porenetwork/subcontrolvolumeface.hh
index 220c9b24f5..83c5a882a5 100644
--- a/dumux/discretization/porenetwork/subcontrolvolumeface.hh
+++ b/dumux/discretization/porenetwork/subcontrolvolumeface.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \ingroup PoreNetworkModels
+ * \ingroup PoreNetworkDiscretization
* \brief Base class for a sub control volume face
*/
#ifndef DUMUX_DISCRETIZATION_PNM_SUBCONTROLVOLUMEFACE_HH
@@ -30,7 +30,7 @@
namespace Dumux::PoreNetwork {
/*!
- * \ingroup PoreNetworkModels
+ * \ingroup PoreNetworkDiscretization
* \brief Default traits class
* \tparam GV the type of the grid view
*/
diff --git a/dumux/flux/porenetwork/advection.hh b/dumux/flux/porenetwork/advection.hh
index 14dc8b0da3..3ffd4180f3 100644
--- a/dumux/flux/porenetwork/advection.hh
+++ b/dumux/flux/porenetwork/advection.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \ingroup PoreNetworkModels
+ * \ingroup PoreNetworkFlux
* \brief This file contains the data which is required to calculate
* the fluxes of the pore network model over a face of a finite volume.
*/
@@ -39,7 +39,7 @@ namespace Dumux::PoreNetwork {
/*!
* \file
- * \ingroup PoreNetworkModels
+ * \ingroup PoreNetworkFlux
* \brief Hagen–Poiseuille-type flux law to describe the advective flux for pore-network models.
*/
template<class ScalarT, class... TransmissibilityLawTypes>
diff --git a/dumux/flux/porenetwork/fickslaw.hh b/dumux/flux/porenetwork/fickslaw.hh
index a6a4f4f4f3..b22f707433 100644
--- a/dumux/flux/porenetwork/fickslaw.hh
+++ b/dumux/flux/porenetwork/fickslaw.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \ingroup PoreNetworkModels
+ * \ingroup PoreNetworkFlux
* \brief This file contains the data which is required to calculate
* diffusive mass fluxes due to molecular diffusion with Fick's law.
*/
@@ -33,7 +33,7 @@
namespace Dumux::PoreNetwork {
/*!
- * \ingroup PoreNetworkModels
+ * \ingroup PoreNetworkFlux
* \brief Specialization of Fick's Law for the pore-network model.
*/
template<class Scalar, int numPhases, int numComponents,
diff --git a/dumux/flux/porenetwork/fourierslaw.hh b/dumux/flux/porenetwork/fourierslaw.hh
index 2f091f6a20..a40a96dcdf 100644
--- a/dumux/flux/porenetwork/fourierslaw.hh
+++ b/dumux/flux/porenetwork/fourierslaw.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \ingroup PoreNetworkModels
+ * \ingroup PoreNetworkFlux
* \brief This file contains the data which is required to calculate
* diffusive heat fluxes with Fourier's law.
*/
@@ -38,7 +38,7 @@ struct NoDiffusionType {};
} // end namespace Detail
/*!
- * \ingroup PoreNetworkModels
+ * \ingroup PoreNetworkFlux
* \brief Specialization of Fourier's Law for the pore-network model.
*/
template<class MolecularDiffusionType = Detail::NoDiffusionType>
diff --git a/dumux/timestepping/multistagemethods.hh b/dumux/timestepping/multistagemethods.hh
index ab4b284ad7..1a2a7275e9 100644
--- a/dumux/timestepping/multistagemethods.hh
+++ b/dumux/timestepping/multistagemethods.hh
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
+ * \ingroup TimeStepping
* \brief Parameters for different multistage time stepping methods
* \note See e.g. https://en.wikipedia.org/wiki/List_of_Runge%E2%80%93Kutta_methods
*/
diff --git a/dumux/timestepping/multistagetimestepper.hh b/dumux/timestepping/multistagetimestepper.hh
index 7759ee0113..53c1ce1524 100644
--- a/dumux/timestepping/multistagetimestepper.hh
+++ b/dumux/timestepping/multistagetimestepper.hh
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
+ * \ingroup TimeStepping
* \brief A time stepper performing a single time step of a transient simulation
*/
#ifndef DUMUX_TIMESTEPPING_MULTISTAGE_TIMESTEPPER_HH
diff --git a/dumux/timestepping/timelevel.hh b/dumux/timestepping/timelevel.hh
index 1e6f777022..d82324c7bc 100644
--- a/dumux/timestepping/timelevel.hh
+++ b/dumux/timestepping/timelevel.hh
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
+ * \ingroup TimeStepping
* \brief Class that represents a time level during time integration.
*/
#ifndef DUMUX_TIMESTEPPING_TIME_LEVEL_HH
--
GitLab