From c9c87ff0c73bbbaafc52c31de45bcffc13c8f824 Mon Sep 17 00:00:00 2001
From: Melanie Lipp <melanie.lipp@iws.uni-stuttgart.de>
Date: Tue, 31 Mar 2020 17:47:09 +0200
Subject: [PATCH] [doxygen] Improve ingroups.
---
doc/doxygen/modules.txt | 84 ++++++++++---------
dumux/common/boundaryflag.hh | 2 +-
dumux/common/doubleexpintegrationconstants.hh | 6 +-
dumux/common/doubleexpintegrator.hh | 6 +-
dumux/common/staggeredfvproblem.hh | 2 +
dumux/flux/box/fourierslawnonequilibrium.hh | 2 +-
dumux/flux/fluxvariablescaching.hh | 2 +-
dumux/freeflow/compositional/zeroeqncmodel.hh | 1 +
dumux/freeflow/rans/twoeq/indices.hh | 4 +-
dumux/freeflow/staggeredupwindmethods.hh | 25 ++++--
dumux/geomechanics/elastic/indices.hh | 4 +-
dumux/geomechanics/elastic/localresidual.hh | 4 +-
dumux/geomechanics/elastic/model.hh | 6 +-
dumux/geomechanics/elastic/volumevariables.hh | 4 +-
.../poroelastic/couplingmanager.hh | 4 +-
dumux/geomechanics/poroelastic/iofields.hh | 4 +-
.../geomechanics/poroelastic/localresidual.hh | 4 +-
dumux/geomechanics/poroelastic/model.hh | 4 +-
.../poroelastic/volumevariables.hh | 4 +-
dumux/io/grid/gridmanager_alu.hh | 5 ++
dumux/io/grid/gridmanager_base.hh | 1 +
dumux/io/grid/gridmanager_foam.hh | 2 +
dumux/io/grid/gridmanager_mmesh.hh | 1 +
dumux/io/grid/gridmanager_oned.hh | 1 +
dumux/io/grid/gridmanager_sp.hh | 1 +
dumux/io/grid/gridmanager_ug.hh | 1 +
dumux/io/grid/gridmanager_yasp.hh | 2 +
dumux/material/components/ammonia.hh | 4 +
dumux/material/components/base.hh | 12 +++
dumux/material/components/chlorideion.hh | 4 +
dumux/material/components/componenttraits.hh | 4 +
dumux/material/components/glucose.hh | 4 +
dumux/material/components/n2.hh | 2 +-
dumux/material/components/sodiumion.hh | 5 +-
dumux/material/components/solid.hh | 4 +
dumux/material/components/urea.hh | 3 +
dumux/nonlinear/findscalarroot.hh | 8 +-
dumux/parallel/vectorcommdatahandle.hh | 4 +-
dumux/parallel/vertexhandles.hh | 2 +-
39 files changed, 159 insertions(+), 83 deletions(-)
diff --git a/doc/doxygen/modules.txt b/doc/doxygen/modules.txt
index 5f3a6f54ef..053abe0624 100644
--- 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 ******************/
/*!
diff --git a/dumux/common/boundaryflag.hh b/dumux/common/boundaryflag.hh
index 49b7770b13..8429f47ee1 100644
--- 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.
*/
diff --git a/dumux/common/doubleexpintegrationconstants.hh b/dumux/common/doubleexpintegrationconstants.hh
index 9c5fdaee4d..be4b5f8f58 100644
--- 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
diff --git a/dumux/common/doubleexpintegrator.hh b/dumux/common/doubleexpintegrator.hh
index 0b4ba4c848..3591e82a01 100644
--- 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
diff --git a/dumux/common/staggeredfvproblem.hh b/dumux/common/staggeredfvproblem.hh
index a0ffc55ed3..c74db38cfa 100644
--- 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
diff --git a/dumux/flux/box/fourierslawnonequilibrium.hh b/dumux/flux/box/fourierslawnonequilibrium.hh
index ce61739057..8add74d130 100644
--- 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>
diff --git a/dumux/flux/fluxvariablescaching.hh b/dumux/flux/fluxvariablescaching.hh
index 680b3ce2ab..1c63433b15 100644
--- 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 {};
diff --git a/dumux/freeflow/compositional/zeroeqncmodel.hh b/dumux/freeflow/compositional/zeroeqncmodel.hh
index da41a68fd9..8d0ee38b41 100644
--- 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
*/
diff --git a/dumux/freeflow/rans/twoeq/indices.hh b/dumux/freeflow/rans/twoeq/indices.hh
index 3ce7ab167f..484830c58c 100644
--- 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
diff --git a/dumux/freeflow/staggeredupwindmethods.hh b/dumux/freeflow/staggeredupwindmethods.hh
index 28ff9e223f..bc1d606568 100644
--- 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
{
diff --git a/dumux/geomechanics/elastic/indices.hh b/dumux/geomechanics/elastic/indices.hh
index be7411a149..892b21d155 100644
--- 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
diff --git a/dumux/geomechanics/elastic/localresidual.hh b/dumux/geomechanics/elastic/localresidual.hh
index 0c1a3eb6af..cf4bc3972c 100644
--- 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.
*/
diff --git a/dumux/geomechanics/elastic/model.hh b/dumux/geomechanics/elastic/model.hh
index 05c041dbf9..82614c943f 100644
--- 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
diff --git a/dumux/geomechanics/elastic/volumevariables.hh b/dumux/geomechanics/elastic/volumevariables.hh
index fe8836e17a..add72433a1 100644
--- 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.
*
diff --git a/dumux/geomechanics/poroelastic/couplingmanager.hh b/dumux/geomechanics/poroelastic/couplingmanager.hh
index 498477afc2..a49e3e79e4 100644
--- 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
diff --git a/dumux/geomechanics/poroelastic/iofields.hh b/dumux/geomechanics/poroelastic/iofields.hh
index 3127c3a21f..3d05389956 100644
--- 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
diff --git a/dumux/geomechanics/poroelastic/localresidual.hh b/dumux/geomechanics/poroelastic/localresidual.hh
index 26f8f0c53a..9ee1188a70 100644
--- 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.
*/
diff --git a/dumux/geomechanics/poroelastic/model.hh b/dumux/geomechanics/poroelastic/model.hh
index cea6945b12..68334dd6e7 100644
--- 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 >
diff --git a/dumux/geomechanics/poroelastic/volumevariables.hh b/dumux/geomechanics/poroelastic/volumevariables.hh
index 3b94dd5ac7..682e7fbf8b 100644
--- 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.
*
diff --git a/dumux/io/grid/gridmanager_alu.hh b/dumux/io/grid/gridmanager_alu.hh
index cdf03c364e..1a6906d9ac 100644
--- 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>>
diff --git a/dumux/io/grid/gridmanager_base.hh b/dumux/io/grid/gridmanager_base.hh
index c3ee66b62f..78f56e1c99 100644
--- a/dumux/io/grid/gridmanager_base.hh
+++ b/dumux/io/grid/gridmanager_base.hh
@@ -55,6 +55,7 @@
namespace Dumux {
/*!
+ * \ingroup InputOutput
* \brief The grid manager (this is the class used by the user) for all supported grid managers that constructs a grid
* from information in the input file and handles the data.
* \note This class is specialised below for all supported grid managers. It inherits the functionality of the base class Dumux::GridManagerBase.
diff --git a/dumux/io/grid/gridmanager_foam.hh b/dumux/io/grid/gridmanager_foam.hh
index b591c5be6c..8ca5a56332 100644
--- a/dumux/io/grid/gridmanager_foam.hh
+++ b/dumux/io/grid/gridmanager_foam.hh
@@ -39,6 +39,7 @@ namespace Dumux {
#if HAVE_DUNE_FOAMGRID
/*!
+ * \ingroup InputOutput
* \brief Provides a grid manager for FoamGrids
* from information in the input file
*
@@ -95,6 +96,7 @@ public:
};
/*!
+ * \ingroup InputOutput
* \brief Provides a grid manager for FoamGrids of dim 1
* from information in the input file
*
diff --git a/dumux/io/grid/gridmanager_mmesh.hh b/dumux/io/grid/gridmanager_mmesh.hh
index 2ef9d76547..fc69fcbe59 100644
--- a/dumux/io/grid/gridmanager_mmesh.hh
+++ b/dumux/io/grid/gridmanager_mmesh.hh
@@ -37,6 +37,7 @@ namespace Dumux {
#if HAVE_DUNE_MMESH
/*!
+ * \ingroup InputOutput
* \brief Provides a grid manager for Dune MMesh
* from information in the input file
*
diff --git a/dumux/io/grid/gridmanager_oned.hh b/dumux/io/grid/gridmanager_oned.hh
index 0ae0026e9b..75cbdba920 100644
--- a/dumux/io/grid/gridmanager_oned.hh
+++ b/dumux/io/grid/gridmanager_oned.hh
@@ -34,6 +34,7 @@
namespace Dumux {
/*!
+ * \ingroup InputOutput
* \brief Provides a grid manager for OneDGrids
* from information in the input file
*
diff --git a/dumux/io/grid/gridmanager_sp.hh b/dumux/io/grid/gridmanager_sp.hh
index 95b132053c..645f306b48 100644
--- a/dumux/io/grid/gridmanager_sp.hh
+++ b/dumux/io/grid/gridmanager_sp.hh
@@ -39,6 +39,7 @@ namespace Dumux {
#if HAVE_DUNE_SPGRID
/*!
+ * \ingroup InputOutput
* \brief Provides a grid manager for SPGrid
*
* The following keys are recognized:
diff --git a/dumux/io/grid/gridmanager_ug.hh b/dumux/io/grid/gridmanager_ug.hh
index 6ede5af6bf..a112d97c53 100644
--- a/dumux/io/grid/gridmanager_ug.hh
+++ b/dumux/io/grid/gridmanager_ug.hh
@@ -38,6 +38,7 @@ namespace Dumux {
#if HAVE_UG
/*!
+ * \ingroup InputOutput
* \brief Provides a grid manager for UGGrids
* from information in the input file
*
diff --git a/dumux/io/grid/gridmanager_yasp.hh b/dumux/io/grid/gridmanager_yasp.hh
index 2f5d6aae94..5ffbbbc4b3 100644
--- a/dumux/io/grid/gridmanager_yasp.hh
+++ b/dumux/io/grid/gridmanager_yasp.hh
@@ -34,6 +34,7 @@
namespace Dumux {
/*!
+ * \ingroup InputOutput
* \brief Provides a grid manager for YaspGrids
* from information in the input file
*
@@ -173,6 +174,7 @@ private:
};
/*!
+ * \ingroup InputOutput
* \brief Provides a grid manager for YaspGrids with different zones and grading
*
* All keys are expected to be in group GridParameterGroup.
diff --git a/dumux/material/components/ammonia.hh b/dumux/material/components/ammonia.hh
index 22ab1ea141..4f30f7a165 100644
--- a/dumux/material/components/ammonia.hh
+++ b/dumux/material/components/ammonia.hh
@@ -29,6 +29,10 @@
namespace Dumux {
namespace Components {
+/*!
+ * \ingroup Components
+ * \brief A class for the Ammonia (NH3) component properties
+ */
template <class Scalar>
class Ammonia
: public Components::Base<Scalar, Ammonia<Scalar> >
diff --git a/dumux/material/components/base.hh b/dumux/material/components/base.hh
index 23e84bac9c..14aa6e29a3 100644
--- a/dumux/material/components/base.hh
+++ b/dumux/material/components/base.hh
@@ -39,9 +39,21 @@
namespace Dumux {
namespace Components {
+/*!
+ * \ingroup Components
+ * \brief IsAqueous struct
+ */
template <class Component>
struct IsAqueous : public std::false_type {};
+/*!
+ * \ingroup Components
+ * \brief Base class for all components
+ * Components provide the thermodynamic relations for the liquid,
+ * gaseous and/or solid state of a single
+ * chemical species or a _fixed_ mixture of species.
+ * Fluid systems use components to compute thermodynamic quantities of phases.
+ */
template <class ScalarType, class Component>
class Base
{
diff --git a/dumux/material/components/chlorideion.hh b/dumux/material/components/chlorideion.hh
index 57ffb73fd7..f4981b4f76 100644
--- a/dumux/material/components/chlorideion.hh
+++ b/dumux/material/components/chlorideion.hh
@@ -30,6 +30,10 @@
namespace Dumux {
namespace Components {
+/*!
+ * \ingroup Components
+ * \brief A class for the Cl- (Chloride ion) component properties
+ */
template <class Scalar>
class ChlorideIon
: public Components::Base<Scalar, ChlorideIon<Scalar> >
diff --git a/dumux/material/components/componenttraits.hh b/dumux/material/components/componenttraits.hh
index dc6563fdcb..70d515725f 100644
--- a/dumux/material/components/componenttraits.hh
+++ b/dumux/material/components/componenttraits.hh
@@ -34,6 +34,10 @@
namespace Dumux {
+/*!
+ * \ingroup Components
+ * \brief Component traits, i.e. information extracted from components
+ */
template<class Component>
struct ComponentTraits
{
diff --git a/dumux/material/components/glucose.hh b/dumux/material/components/glucose.hh
index 4db90784ab..17e304537e 100644
--- a/dumux/material/components/glucose.hh
+++ b/dumux/material/components/glucose.hh
@@ -30,6 +30,10 @@
namespace Dumux {
namespace Components {
+/*!
+ * \ingroup Components
+ * \brief A class for the Glucose component properties
+ */
template <class Scalar>
class Glucose
: public Components::Base<Scalar, Glucose<Scalar> >
diff --git a/dumux/material/components/n2.hh b/dumux/material/components/n2.hh
index e4f248b40d..accec3a4dc 100644
--- a/dumux/material/components/n2.hh
+++ b/dumux/material/components/n2.hh
@@ -35,7 +35,7 @@ namespace Dumux {
namespace Components {
/*!
- * \ingroup Componentss
+ * \ingroup Components
* \brief Properties of pure molecular nitrogen \f$N_2\f$.
*
* \tparam Scalar The type used for scalar values
diff --git a/dumux/material/components/sodiumion.hh b/dumux/material/components/sodiumion.hh
index 4304df7203..c588992493 100644
--- a/dumux/material/components/sodiumion.hh
+++ b/dumux/material/components/sodiumion.hh
@@ -30,7 +30,10 @@
namespace Dumux {
namespace Components {
-
+/*!
+ * \ingroup Components
+ * \brief A class for the Na+ (Sodium ion) component properties
+ */
template <class Scalar>
class SodiumIon
: public Components::Base<Scalar, SodiumIon<Scalar> >
diff --git a/dumux/material/components/solid.hh b/dumux/material/components/solid.hh
index 0581330f6b..4030fed68a 100644
--- a/dumux/material/components/solid.hh
+++ b/dumux/material/components/solid.hh
@@ -32,6 +32,10 @@
namespace Dumux {
namespace Components {
+/*!
+ * \ingroup Components
+ * \brief Interface for components that have a solid state
+ */
template<class Scalar, class Component>
class Solid
{
diff --git a/dumux/material/components/urea.hh b/dumux/material/components/urea.hh
index 37d0787299..5f27451a38 100644
--- a/dumux/material/components/urea.hh
+++ b/dumux/material/components/urea.hh
@@ -30,6 +30,9 @@
namespace Dumux {
namespace Components {
+/*! \ingroup Components
+ * \brief A class for the Urea component properties
+ */
template <class Scalar>
class Urea
: public Components::Base<Scalar, Urea<Scalar> >
diff --git a/dumux/nonlinear/findscalarroot.hh b/dumux/nonlinear/findscalarroot.hh
index 9eff421612..20bb5c65d1 100644
--- a/dumux/nonlinear/findscalarroot.hh
+++ b/dumux/nonlinear/findscalarroot.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \ingroup Common
+ * \ingroup Nonlinear
* \brief Root finding algorithms for scalar functions
*/
#ifndef DUMUX_COMMON_SCALAR_ROOT_FINDING_HH
@@ -35,7 +35,7 @@
namespace Dumux {
/*!
- * \ingroup Common
+ * \ingroup Nonlinear
* \brief Newton's root finding algorithm for scalar functions (secant method)
* \param xOld initial guess
* \param residual Residual function
@@ -76,7 +76,7 @@ Scalar findScalarRootNewton(Scalar xOld, const ResFunc& residual, const DerivFun
}
/*!
- * \ingroup Common
+ * \ingroup Nonlinear
* \brief Newton's root finding algorithm for scalar functions (secant method)
* \note The derivative is numerically computed. If the derivative is know use signature with derivative function.
* \param xOld initial guess
@@ -95,7 +95,7 @@ Scalar findScalarRootNewton(Scalar xOld, const ResFunc& residual,
}
/*!
- * \ingroup Common
+ * \ingroup Nonlinear
* \brief Brent's root finding algorithm for scalar functions
* \note Modified from pseudo-code on wikipedia: https://en.wikipedia.org/wiki/Brent%27s_method
* \note See also R.P. Brent "An algorithm with guaranteed convergence for finding a zero of a function", The Computer Journal (1971).
diff --git a/dumux/parallel/vectorcommdatahandle.hh b/dumux/parallel/vectorcommdatahandle.hh
index e2bc4c4f34..74122a6ec7 100644
--- a/dumux/parallel/vectorcommdatahandle.hh
+++ b/dumux/parallel/vectorcommdatahandle.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \ingroup Linear
+ * \ingroup Parallel
* \brief Contains a class to exchange entries of a vector
*/
#ifndef DUMUX_VECTOR_COMM_DATA_HANDLE_HH
@@ -69,7 +69,7 @@ namespace Detail {
} // end namespace Detail
/*!
- * \ingroup Linear
+ * \ingroup Parallel
* \brief A data handle class to exchange entries of a vector
*/
template<class Mapper, class Vector, int entityCodim, class ScatterOperator>
diff --git a/dumux/parallel/vertexhandles.hh b/dumux/parallel/vertexhandles.hh
index 0faa96649f..e6b014acca 100644
--- a/dumux/parallel/vertexhandles.hh
+++ b/dumux/parallel/vertexhandles.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \ingroup Assembly
+ * \ingroup Parallel
* \brief Provides data handles for parallel communication which operate on vertices
* \note This is useful for schemes with degrees of freedom on vertices (box scheme)
*/
--
GitLab