[doxygen] Improve ingroups.

c9c87ff0 · Melanie Lipp · Timo Koch · de8d9f48 · c9c87ff0 · c9c87ff0
Commit c9c87ff0 authored Mar 31, 2020 by Melanie Lipp Committed by Timo Koch Apr 10, 2020
--- a/doc/doxygen/modules.txt
+++ b/doc/doxygen/modules.txt
@@ -213,24 +213,24 @@
         * \defgroup TwoEqModel 2-Eq. Models
         * \brief Two-equation turbulence models
         */
-        /*!
-         * \ingroup TwoEqModel
-         * \defgroup KEpsilonModel K-epsilon model
-         * \brief K-epsilon model
-         * For a detailed model decription see freeflow/rans/twoeq/kepsilon/model.hh
-         */
-        /*!
-         * \ingroup TwoEqModel
-         * \defgroup KOmegaModel K-omega model
-         * \brief K-omega model
-         * For a detailed model decription see freeflow/rans/twoeq/komega/model.hh
-         */
-        /*!
-         * \ingroup TwoEqModel
-         * \defgroup LowReKEpsilonModel Low-Re k-epsilon model
-         * \brief Low-Re k-epsilon model
-         * For a detailed model decription see freeflow/rans/twoeq/lowrekepsilon/model.hh
-         */
+            /*!
+             * \ingroup TwoEqModel
+             * \defgroup KEpsilonModel K-epsilon model
+             * \brief K-epsilon model
+             * For a detailed model decription see freeflow/rans/twoeq/kepsilon/model.hh
+             */
+            /*!
+             * \ingroup TwoEqModel
+             * \defgroup KOmegaModel K-omega model
+             * \brief K-omega model
+             * For a detailed model decription see freeflow/rans/twoeq/komega/model.hh
+             */
+            /*!
+             * \ingroup TwoEqModel
+             * \defgroup LowReKEpsilonModel Low-Re k-epsilon model
+             * \brief Low-Re k-epsilon model
+             * For a detailed model decription see freeflow/rans/twoeq/lowrekepsilon/model.hh
+             */
    /*!
     * \ingroup FreeflowModels
     * \defgroup FreeflowNCModel Compositional
@@ -351,6 +351,11 @@
         * \defgroup RichardsNCTests Richards multi-component benchmarks and tests
         * \brief A multi-component transport problem in the unsaturated zone using the RichardsNCModel. The files are listed below.
         */
+        /*!
+         * \ingroup SolidEnergyTests
+         * \defgroup SolidEnergyTests Solid energy tests
+         * \brief Tests for the solid energy model.
+         */
        /*!
         * \ingroup PorousmediumflowTests
         * \defgroup TracerTests Tracer benchmarks and tests
@@ -464,7 +469,7 @@
 */
    /*!
     * \ingroup Flux
-     * \defgroup BoxFlux Flux related to the Box scheme
+     * \defgroup BoxFlux Flux related to the box scheme
     * \brief Flux related to the box scheme
     */
    /*!
@@ -654,27 +659,26 @@
 * \defgroup AssemblyAndSolvers Assembly and Solvers
 * \brief Assembling matrices and vectors, solvers for linear and nonlinear equations
 */
-
-/* ***************** Assembly ******************/
-/*!
- * \ingroup AssemblyAndSolvers
- * \defgroup Assembly Assembly
- * \brief Assembly of linear systems (Jacobian and residual)
- */
-
-/* ***************** Linear ******************/
-/*!
- * \ingroup AssemblyAndSolvers
- * \defgroup Linear Linear
- * \brief Linear solvers and helpers
- */
-
-/* ***************** Nonlinear ******************/
-/*!
- * \ingroup AssemblyAndSolvers
- * \defgroup Nonlinear Nonlinear
- * \brief Nonlinear solvers: Newton method
- */
+    /*!
+     * \ingroup AssemblyAndSolvers
+     * \defgroup Assembly Assembly
+     * \brief Assembly of linear systems (Jacobian and residual)
+     */
+    /*!
+     * \ingroup AssemblyAndSolvers
+     * \defgroup Linear Linear
+     * \brief Linear solvers and helpers
+     */
+    /*!
+     * \ingroup AssemblyAndSolvers
+     * \defgroup Nonlinear Nonlinear
+     * \brief Nonlinear solvers: Newton method
+     */
+    /*!
+     * \ingroup AssemblyAndSolvers
+     * \defgroup Parallel Parallel
+     * \brief Files for communication of parallel solvers
+     */

 /* ***************** Common ******************/
 /*!

--- a/dumux/common/boundaryflag.hh
+++ b/dumux/common/boundaryflag.hh
@@ -30,7 +30,7 @@
 namespace Dumux {

 /*!
- * \ingroup InputOutput
+ * \ingroup Common
 * \brief Class for accessing boundary flags
 * \note this works for all grid managers with gmsh meshes.
 */

--- a/dumux/common/doubleexpintegrationconstants.hh
+++ b/dumux/common/doubleexpintegrationconstants.hh
@@ -48,7 +48,11 @@
 *   EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                      *
 *                                                                           *
 *****************************************************************************/
-
+/*!
+ * \file
+ * \ingroup Common
+ * \brief Exponential integration abcissas
+ */
 #ifndef DUMUX_COMMON_DOUBLEEXP_INTEGRATION_CONSTANTS_HH
 #define DUMUX_COMMON_DOUBLEEXP_INTEGRATION_CONSTANTS_HH


--- a/dumux/common/doubleexpintegrator.hh
+++ b/dumux/common/doubleexpintegrator.hh
@@ -48,7 +48,11 @@
 *   EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                      *
 *                                                                           *
 *****************************************************************************/
-
+/*!
+ * \file
+ * \ingroup Common
+ * \brief A double exponential integrator
+ */
 #ifndef DUMUX_COMMON_DOUBLEEXP_INTEGRATOR_HH
 #define DUMUX_COMMON_DOUBLEEXP_INTEGRATOR_HH


--- a/dumux/common/staggeredfvproblem.hh
+++ b/dumux/common/staggeredfvproblem.hh
@@ -19,6 +19,7 @@
 /*!
 * \file
 * \ingroup Common
+ * \ingroup StaggeredDiscretization
 * \brief Base class for all staggered fv problems
 */
 #ifndef DUMUX_STAGGERD_FV_PROBLEM_HH
@@ -33,6 +34,7 @@ namespace Dumux {

 /*!
 * \ingroup Common
+ * \ingroup StaggeredDiscretization
 * \brief Base class for all staggered finite-volume problems
 *
 * \note All quantities (regarding the units) are specified assuming a

--- a/dumux/flux/box/fourierslawnonequilibrium.hh
+++ b/dumux/flux/box/fourierslawnonequilibrium.hh
@@ -41,7 +41,7 @@ template <class TypeTag, DiscretizationMethod discMethod>
 class FouriersLawNonEquilibriumImplementation;

 /*!
- * \ingroup BoxFouriersLaw
+ * \ingroup BoxFlux
 * \brief Specialization of Fourier's Law for the box method for thermal nonequilibrium models.
 */
 template <class TypeTag>

--- a/dumux/flux/fluxvariablescaching.hh
+++ b/dumux/flux/fluxvariablescaching.hh
@@ -57,7 +57,7 @@ struct _EmptyCache
 #endif // DOXYGEN

 /*!
- * \ingroup Discretization
+ * \ingroup Flux
 * \brief Empty caches to use in a constitutive flux law/process, e.g. Darcy's law
 */
 struct EmptyAdvectionCache : public _EmptyCache {};

--- a/dumux/freeflow/compositional/zeroeqncmodel.hh
+++ b/dumux/freeflow/compositional/zeroeqncmodel.hh
@@ -57,6 +57,7 @@ struct ZeroEqNC { using InheritsFrom = std::tuple<NavierStokesNC>; };
 ///////////////////////////////////////////////////////////////////////////

 /*!
+ * \ingroup FreeflowNCModel
 * \ingroup ZeroEqModel
 * \brief Traits for the Reynolds-averaged Navier-Stokes 0-Eq. model
 */

--- a/dumux/freeflow/rans/twoeq/indices.hh
+++ b/dumux/freeflow/rans/twoeq/indices.hh
@@ -18,7 +18,7 @@
 *****************************************************************************/
 /*!
 * \file
- * \ingroup RANSModel
+ * \ingroup TwoEqModel
 * \copydoc Dumux::RANSTwoEqIndices
 */
 #ifndef DUMUX_RANS_TWO_EQ_INDICES_HH
@@ -30,7 +30,7 @@ namespace Dumux {

 // \{
 /*!
- * \ingroup RANSModel
+ * \ingroup TwoEqModel
 * \brief The common indices for isothermal two-equation RANS models.
 *
 * \tparam dimension The dimension of the problem

--- a/dumux/freeflow/staggeredupwindmethods.hh
+++ b/dumux/freeflow/staggeredupwindmethods.hh
@@ -16,9 +16,11 @@
 *   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
-  * \brief This file contains different higher order methods for approximating the velocity.
-  */
+/*!
+ * \file
+ * \ingroup FreeflowModels
+ * \brief This file contains different higher order methods for approximating the velocity.
+ */

 #ifndef DUMUX_UPWINDING_METHODS_HH
 #define DUMUX_UPWINDING_METHODS_HH
@@ -33,21 +35,28 @@

 namespace Dumux {

-//! \brief Available Tvd approaches
+/*!
+ * \ingroup FreeflowModels
+ * \brief Available Tvd approaches
+ */
 enum class TvdApproach
 {
    none, uniform, li, hou
 };

-//! \brief Available differencing schemes
+/*!
+ * \ingroup FreeflowModels
+ * \brief Available differencing schemes
+ */
 enum class DifferencingScheme
 {
    none, vanleer, vanalbada, minmod, superbee, umist, mclimiter, wahyd
 };

-/**
-  * \brief This file contains different higher order methods for approximating the velocity.
-  */
+/*!
+ * \ingroup FreeflowModels
+ * \brief This file contains different higher order methods for approximating the velocity.
+ */
 template<class Scalar, int upwindSchemeOrder>
 class StaggeredUpwindMethods
 {

--- a/dumux/geomechanics/elastic/indices.hh
+++ b/dumux/geomechanics/elastic/indices.hh
@@ -18,7 +18,7 @@
 *****************************************************************************/
 /*!
 * \file
- * \ingroup Geomechanics
+ * \ingroup Elastic
 * \brief Defines the indices for the elastic model
 */
 #ifndef DUMUX_ELASTIC_INDICES_HH
@@ -27,7 +27,7 @@
 namespace Dumux {

 /*!
- * \ingroup Geomechanics
+ * \ingroup Elastic
 * \brief The indices for the linear elasticity model.
 */
 struct ElasticIndices

--- a/dumux/geomechanics/elastic/localresidual.hh
+++ b/dumux/geomechanics/elastic/localresidual.hh
@@ -18,7 +18,7 @@
 *****************************************************************************/
 /*!
 * \file
- * \ingroup Geomechanics
+ * \ingroup Elastic
 * \brief Element-wise calculation of the local residual for problems
 *        using the elastic model considering linear elasticity.
 */
@@ -32,7 +32,7 @@
 namespace Dumux {

 /*!
- * \ingroup Geomechanics
+ * \ingroup Elastic
 * \brief Element-wise calculation of the local residual for problems
 *        using the elastic model considering linear elasticity.
 */

--- a/dumux/geomechanics/elastic/model.hh
+++ b/dumux/geomechanics/elastic/model.hh
@@ -18,7 +18,7 @@
 *****************************************************************************/
 /*!
 * \file
- * \ingroup Geomechanics
+ * \ingroup Elastic
 * \brief Defines a type tag and some properties for the elastic geomechanical model
 */
 #ifndef DUMUX_GEOMECHANICS_ELASTIC_MODEL_HH
@@ -39,7 +39,7 @@
 namespace Dumux {

 /*!
- * \ingroup Geomechanics
+ * \ingroup Elastic
 * \brief Specifies a number properties of the elastic model
 */
 template< int dim, int numSolidComp >
@@ -61,7 +61,7 @@ struct ElasticModelTraits
 };

 /*!
- * \ingroup Geomechanics
+ * \ingroup Elastic
 * \brief Traits class for the volume variables of the elastic model.
 *
 * \tparam PV The type used for primary variables

--- a/dumux/geomechanics/elastic/volumevariables.hh
+++ b/dumux/geomechanics/elastic/volumevariables.hh
@@ -18,7 +18,7 @@
 *****************************************************************************/
 /*!
 * \file
- * \ingroup Geomechanics
+ * \ingroup Elastic
 * \brief Quantities required by the elastic model defined on a sub-control volume.
 */
 #ifndef DUMUX_ELASTIC_VOLUME_VARIABLES_HH
@@ -33,7 +33,7 @@
 namespace Dumux {

 /*!
- * \ingroup Geomechanics
+ * \ingroup Elastic
 * \brief Contains the quantities which are constant within a
 *        finite volume in the elastic model.
 *

--- a/dumux/geomechanics/poroelastic/couplingmanager.hh
+++ b/dumux/geomechanics/poroelastic/couplingmanager.hh
@@ -18,7 +18,7 @@
 *****************************************************************************/
 /*!
 * \file
- * \ingroup Geomechanics
+ * \ingroup PoroElastic
 * \brief Coupling manager for porous medium flow problems coupled to a poro-mechanical problem
 */

@@ -37,7 +37,7 @@ namespace Dumux {

 /*!
 * \file
- * \ingroup Geomechanics
+ * \ingroup PoroElastic
 * \brief Coupling manager for porous medium flow problems coupled to a poro-mechanical problem
 *
 *        Coupling manager for porous medium flow problems coupled to a poro-mechanical

--- a/dumux/geomechanics/poroelastic/iofields.hh
+++ b/dumux/geomechanics/poroelastic/iofields.hh
@@ -18,7 +18,7 @@
 *****************************************************************************/
 /*!
 * \file
- * \ingroup Geomechanics
+ * \ingroup PoroElastic
 * \brief Adds I/O fields specific to the poro-elastic model
 */
 #ifndef DUMUX_POROELASTIC_IO_FIELDS_HH
@@ -29,7 +29,7 @@
 namespace Dumux {

 /*!
- * \ingroup Geomechanics
+ * \ingroup PoroElastic
 * \brief Adds I/O fields specific to the poro-elastic model
 */
 class PoroElasticIOFields

--- a/dumux/geomechanics/poroelastic/localresidual.hh
+++ b/dumux/geomechanics/poroelastic/localresidual.hh
@@ -18,7 +18,7 @@
 *****************************************************************************/
 /*!
 * \file
- * \ingroup Geomechanics
+ * \ingroup PoroElastic
 * \brief Element-wise calculation of the local residual
 *        for problems using the poroelastic model.
 */
@@ -31,7 +31,7 @@
 namespace Dumux {

 /*!
- * \ingroup Geomechanics
+ * \ingroup PoroElastic
 * \brief Element-wise calculation of the local residual
 *        for problems using the poroelastic model.
 */

--- a/dumux/geomechanics/poroelastic/model.hh
+++ b/dumux/geomechanics/poroelastic/model.hh
@@ -18,7 +18,7 @@
 *****************************************************************************/
 /*!
 * \file
- * \ingroup Geomechanics
+ * \ingroup PoroElastic
 * \brief Defines a type tag and some properties for the poroelastic geomechanical model
 */
 #ifndef DUMUX_GEOMECHANICS_POROELASTIC_MODEL_HH
@@ -40,7 +40,7 @@
 namespace Dumux {

 /*!
- * \ingroup Geomechanics
+ * \ingroup PoroElastic
 * \brief Specifies a number properties of the poroelastic model
 */
 template< int dim, int numSC, int numFP, int numFC >

--- a/dumux/geomechanics/poroelastic/volumevariables.hh
+++ b/dumux/geomechanics/poroelastic/volumevariables.hh
@@ -18,7 +18,7 @@
 *****************************************************************************/
 /*!
 * \file
- * \ingroup Geomechanics
+ * \ingroup PoroElastic
 * \brief Quantities required by the poroelastic model defined on a sub-control volume.
 */
 #ifndef DUMUX_POROELASTIC_VOLUME_VARIABLES_HH
@@ -29,7 +29,7 @@
 namespace Dumux {

 /*!
- * \ingroup Geomechanics
+ * \ingroup PoroElastic
 * \brief Contains the quantities which are constant within a
 *        finite volume in the poroelastic model.
 *

--- a/dumux/io/grid/gridmanager_alu.hh
+++ b/dumux/io/grid/gridmanager_alu.hh
@@ -43,6 +43,7 @@ namespace Dumux {
 #if HAVE_DUNE_ALUGRID

 /*!
+ * \ingroup InputOutput
 * \brief Provides a grid manager for Dune ALUGrids
 *        from information in the input file
 *
@@ -231,6 +232,10 @@ public:
    }
 };

+/*!
+ * \ingroup InputOutput
+ * \brief Boundary flag
+ */
 //! alu uses boundary id
 template<int dim, int dimworld, Dune::ALUGridElementType elType, Dune::ALUGridRefinementType refinementType>
 class BoundaryFlag<Dune::ALUGrid<dim, dimworld, elType, refinementType>>