From 48c3720d6ba312fdf22f9c3a1799b929770de5c3 Mon Sep 17 00:00:00 2001
From: Timo Koch <timo.koch@iws.uni-stuttgart.de>
Date: Tue, 10 Jul 2018 20:30:29 +0200
Subject: [PATCH] [multidomain][facet][doc] Correct ingroups
---
.../multidomain/facet/box/couplingmanager.hh | 8 +++----
dumux/multidomain/facet/box/couplingmapper.hh | 8 +++----
dumux/multidomain/facet/box/darcyslaw.hh | 6 ++++--
.../facet/box/elementboundarytypes.hh | 6 ++++--
.../facet/box/fvelementgeometry.hh | 8 +++----
dumux/multidomain/facet/box/fvgridgeometry.hh | 18 +++++++++-------
dumux/multidomain/facet/box/localresidual.hh | 10 ++++-----
dumux/multidomain/facet/box/properties.hh | 4 ++--
.../facet/box/subcontrolvolumeface.hh | 8 +++----
dumux/multidomain/facet/box/upwindscheme.hh | 8 +++----
.../facet/cellcentered/localresidual.hh | 8 +++----
.../cellcentered/tpfa/couplingmanager.hh | 8 +++----
.../facet/cellcentered/tpfa/couplingmapper.hh | 8 +++----
.../facet/cellcentered/tpfa/darcyslaw.hh | 21 ++++++++++++-------
.../facet/cellcentered/tpfa/properties.hh | 4 ++--
.../facet/cellcentered/upwindscheme.hh | 8 +++----
.../multidomain/facet/codimonegridadapter.hh | 8 +++----
dumux/multidomain/facet/couplingmanager.hh | 14 +++++++------
dumux/multidomain/facet/couplingmapper.hh | 12 +++++------
dumux/multidomain/facet/couplingmapperbase.hh | 8 +++----
dumux/multidomain/facet/enrichmenthelper.hh | 6 ++++--
dumux/multidomain/facet/gmshreader.hh | 8 +++----
dumux/multidomain/facet/gridcreator.hh | 8 +++----
dumux/multidomain/facet/vertexmapper.hh | 12 +++++------
.../facet/1p_1p/analytical/bulkproblem.hh | 4 ++--
.../facet/1p_1p/analytical/lowdimproblem.hh | 4 ++--
.../facet/1p_1p/threedomain/bulkproblem.hh | 4 ++--
.../facet/1p_1p/threedomain/edgeproblem.hh | 4 ++--
.../facet/1p_1p/threedomain/facetproblem.hh | 4 ++--
29 files changed, 127 insertions(+), 110 deletions(-)
diff --git a/dumux/multidomain/facet/box/couplingmanager.hh b/dumux/multidomain/facet/box/couplingmanager.hh
index 0ff37ca4aa..04333c95df 100644
--- a/dumux/multidomain/facet/box/couplingmanager.hh
+++ b/dumux/multidomain/facet/box/couplingmanager.hh
@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \copydoc Dumux::FacetCouplingManager
*/
#ifndef DUMUX_BOX_FACETCOUPLING_MANAGER_HH
@@ -36,8 +36,8 @@
namespace Dumux {
/*!
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Manages the coupling between bulk elements and lower dimensional elements
* where the coupling occurs across the facets of the bulk grid. This implementation
* is to be used in conjunction with models using the box scheme in the bulk domain.
diff --git a/dumux/multidomain/facet/box/couplingmapper.hh b/dumux/multidomain/facet/box/couplingmapper.hh
index afe489dab9..21e67be3d6 100644
--- a/dumux/multidomain/facet/box/couplingmapper.hh
+++ b/dumux/multidomain/facet/box/couplingmapper.hh
@@ -16,8 +16,8 @@
*****************************************************************************/
/*!
* \file
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \copydoc Dumux::FacetCouplingMapper
*/
#ifndef DUMUX_BOX_FACETCOUPLING_MAPPER_HH
@@ -34,8 +34,8 @@
namespace Dumux {
/*!
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Base class for the coupling mapper that sets up and stores
* the coupling maps between two domains of dimension d and (d-1).
* This specialization is for the bulk domain using the box scheme.
diff --git a/dumux/multidomain/facet/box/darcyslaw.hh b/dumux/multidomain/facet/box/darcyslaw.hh
index 85e1e28a6c..e69d899552 100644
--- a/dumux/multidomain/facet/box/darcyslaw.hh
+++ b/dumux/multidomain/facet/box/darcyslaw.hh
@@ -18,6 +18,8 @@
*****************************************************************************/
/*!
* \file
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \copydoc Dumux::BoxFacetCouplingDarcysLaw
*/
#ifndef DUMUX_DISCRETIZATION_BOX_FACET_COUPLING_DARCYS_LAW_HH
@@ -36,8 +38,8 @@
namespace Dumux {
/*!
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Darcy's law for the box scheme scheme in the context of coupled models
* where coupling occurs across the facets of the bulk domain elements
* with a lower-dimensional domain living on these facets.
diff --git a/dumux/multidomain/facet/box/elementboundarytypes.hh b/dumux/multidomain/facet/box/elementboundarytypes.hh
index e8e87f178c..ec8b85c059 100644
--- a/dumux/multidomain/facet/box/elementboundarytypes.hh
+++ b/dumux/multidomain/facet/box/elementboundarytypes.hh
@@ -18,6 +18,8 @@
*****************************************************************************/
/*!
* \file
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Boundary types gathered on an element for the box scheme
* with coupling occurring across the element facets.
*/
@@ -32,8 +34,8 @@
namespace Dumux {
/*!
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief This class stores an array of BoundaryTypes objects
* on an element for the box scheme with coupling occuring
* across the element facets.
diff --git a/dumux/multidomain/facet/box/fvelementgeometry.hh b/dumux/multidomain/facet/box/fvelementgeometry.hh
index 500616047f..860675b9ce 100644
--- a/dumux/multidomain/facet/box/fvelementgeometry.hh
+++ b/dumux/multidomain/facet/box/fvelementgeometry.hh
@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \ingroup BoxDiscretization
* \brief \copydoc Dumux::BoxFacetCouplingFVElementGeometry
*/
@@ -36,8 +36,8 @@
namespace Dumux {
/*!
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \ingroup BoxDiscretization
* \brief Base class for the element-local finite volume geometry for box models
* in the context of models considering coupling of different domains across the
diff --git a/dumux/multidomain/facet/box/fvgridgeometry.hh b/dumux/multidomain/facet/box/fvgridgeometry.hh
index 4542503da2..0b6534da18 100644
--- a/dumux/multidomain/facet/box/fvgridgeometry.hh
+++ b/dumux/multidomain/facet/box/fvgridgeometry.hh
@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \ingroup BoxDiscretization
* \brief Base class for the finite volume grid geometry for box models in the
* context of models considering coupling of different domains across the
@@ -47,8 +47,8 @@
namespace Dumux {
/*!
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \ingroup BoxDiscretization
* \brief The default traits for the finite volume grid geometry
* of the box scheme with coupling occuring across the element facets.
@@ -74,8 +74,8 @@ struct BoxFacetCouplingDefaultGridGeometryTraits
};
/*!
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \ingroup BoxDiscretization
* \brief Base class for the finite volume geometry vector for box schemes in the context
* of coupled models where the coupling occurs across the element facets. This builds
@@ -89,8 +89,8 @@ template<class Scalar,
class BoxFacetCouplingFVGridGeometry;
/*!
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \ingroup BoxDiscretization
* \brief Base class for the finite volume geometry vector for box schemes in the context
* of coupled models where the coupling occurs across the element facets. This builds
@@ -326,6 +326,8 @@ private:
};
/*!
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \ingroup BoxDiscretization
* \brief Base class for the finite volume geometry vector for box schemes
* This builds up the sub control volumes and sub control volume faces
diff --git a/dumux/multidomain/facet/box/localresidual.hh b/dumux/multidomain/facet/box/localresidual.hh
index 731315e3cc..969565b081 100644
--- a/dumux/multidomain/facet/box/localresidual.hh
+++ b/dumux/multidomain/facet/box/localresidual.hh
@@ -19,9 +19,9 @@
/*!
* \file
* \ingroup Assembly
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
-+ * \brief Calculates the element-wise residual for the box scheme with
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
+ * \brief Calculates the element-wise residual for the box scheme with
* coupling to a lower-dimensional domain occurring across the element facets.
*/
#ifndef DUMUX_FACETCOUPLING_BOX_LOCAL_RESIDUAL_HH
@@ -36,8 +36,8 @@ namespace Dumux {
/*!
* \ingroup Assembly
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief The element-wise residual for the box scheme
* \tparam TypeTag the TypeTag
*/
diff --git a/dumux/multidomain/facet/box/properties.hh b/dumux/multidomain/facet/box/properties.hh
index 8bb4f700e1..ffa796d566 100644
--- a/dumux/multidomain/facet/box/properties.hh
+++ b/dumux/multidomain/facet/box/properties.hh
@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Properties (and default properties) for all models using the box
* scheme together with coupling across the grid element facets
* \note If n is the dimension of the lowest grid to be considered in the hierarchy,
diff --git a/dumux/multidomain/facet/box/subcontrolvolumeface.hh b/dumux/multidomain/facet/box/subcontrolvolumeface.hh
index 7a671ff454..11ead4ccec 100644
--- a/dumux/multidomain/facet/box/subcontrolvolumeface.hh
+++ b/dumux/multidomain/facet/box/subcontrolvolumeface.hh
@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \ingroup BoxDiscretization
* \brief Base class for a sub control volume face of the box method
* in the context of of models considering coupling of different
@@ -41,8 +41,8 @@
namespace Dumux {
/*!
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \ingroup BoxDiscretization
* \brief Class for a sub control volume face in the box method, i.e a part of the boundary
* of a sub control volume we compute fluxes on. This is a specialization for models
diff --git a/dumux/multidomain/facet/box/upwindscheme.hh b/dumux/multidomain/facet/box/upwindscheme.hh
index 8f70bfd3f0..c4215e1a8b 100644
--- a/dumux/multidomain/facet/box/upwindscheme.hh
+++ b/dumux/multidomain/facet/box/upwindscheme.hh
@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Modified upwind scheme for models using the box scheme
* with coupling across element facets.
*/
@@ -32,8 +32,8 @@
namespace Dumux {
/*!
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief The upwind scheme used for the advective fluxes.
* This is a modified scheme for models involving coupling
* with a lower-dimensional domain across the element facets.
diff --git a/dumux/multidomain/facet/cellcentered/localresidual.hh b/dumux/multidomain/facet/cellcentered/localresidual.hh
index 6ef5b84ac7..ea18dc4de0 100644
--- a/dumux/multidomain/facet/cellcentered/localresidual.hh
+++ b/dumux/multidomain/facet/cellcentered/localresidual.hh
@@ -19,8 +19,8 @@
/*!
* \file
* \ingroup Assembly
- * \ingroup MixedDimension
- * \ingroud MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Calculates the element-wise residual for cell-centered discretization schemes
* in models where coupling occurs across the element facets. This extra implementation
* is necessary as facets that lie on the boundary but couple to a facet element have to be
@@ -36,8 +36,8 @@ namespace Dumux {
/*!
* \ingroup Assembly
- * \ingroup MixedDimension
- * \ingroud MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Calculates the element-wise residual for cell-centered discretization schemes
* in models where coupling occurs across the element facets. We only overwrite the
* function for the computation of a flux across a single sub-control volume face,
diff --git a/dumux/multidomain/facet/cellcentered/tpfa/couplingmanager.hh b/dumux/multidomain/facet/cellcentered/tpfa/couplingmanager.hh
index e0bdc70910..3a8e5e3802 100644
--- a/dumux/multidomain/facet/cellcentered/tpfa/couplingmanager.hh
+++ b/dumux/multidomain/facet/cellcentered/tpfa/couplingmanager.hh
@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \copydoc Dumux::FacetCouplingManager
*/
#ifndef DUMUX_CCTPFA_FACETCOUPLING_MANAGER_HH
@@ -37,8 +37,8 @@
namespace Dumux {
/*!
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Manages the coupling between bulk elements and lower dimensional elements
* where the coupling occurs across the facets of the bulk grid. This implementation
* is to be used in conjunction with models using the cell-centered tpfa scheme.
diff --git a/dumux/multidomain/facet/cellcentered/tpfa/couplingmapper.hh b/dumux/multidomain/facet/cellcentered/tpfa/couplingmapper.hh
index cee41f93f3..59cee8ea51 100644
--- a/dumux/multidomain/facet/cellcentered/tpfa/couplingmapper.hh
+++ b/dumux/multidomain/facet/cellcentered/tpfa/couplingmapper.hh
@@ -16,8 +16,8 @@
*****************************************************************************/
/*!
* \file
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \copydoc Dumux::FacetCouplingMapper
*/
#ifndef DUMUX_CCTPFA_FACETCOUPLING_MAPPER_HH
@@ -32,8 +32,8 @@
namespace Dumux {
/*!
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Base class for the coupling mapper that sets up and stores
* the coupling maps between two domains of dimension d and (d-1).
* This specialization is for the bulk domain using the cell-centered
diff --git a/dumux/multidomain/facet/cellcentered/tpfa/darcyslaw.hh b/dumux/multidomain/facet/cellcentered/tpfa/darcyslaw.hh
index 684cbbd462..92bdad1687 100644
--- a/dumux/multidomain/facet/cellcentered/tpfa/darcyslaw.hh
+++ b/dumux/multidomain/facet/cellcentered/tpfa/darcyslaw.hh
@@ -18,6 +18,8 @@
*****************************************************************************/
/*!
* \file
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \copydoc Dumux::CCTpfaFacetCouplingDarcysLaw
*/
#ifndef DUMUX_DISCRETIZATION_CC_TPFA_FACET_COUPLING_DARCYS_LAW_HH
@@ -44,7 +46,8 @@ template<class TypeTag, bool isNetwork>
class CCTpfaFacetCouplingDarcysLawImpl;
/*!
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief The cache corresponding to tpfa Darcy's Law with facet coupling
* \note We distinguish between network and non-network grids here. Specializations
* for the two cases can be found below.
@@ -53,8 +56,8 @@ template<class TypeTag, bool isNetwork>
class CCTpfaFacetCouplingDarcysLawCache;
/*!
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Darcy's law for cell-centered finite volume schemes with two-point flux approximation
* in the context of coupled models where the coupling occurs across the facets of the bulk
* domain elements with a lower-dimensional domain living on these facets.
@@ -65,7 +68,8 @@ using CCTpfaFacetCouplingDarcysLaw =
int(GET_PROP_TYPE(TypeTag, GridView)::dimensionworld) ) >;
/*!
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Specialization of the FacetCouplingTpfaDarcysLawCache for non-network grids.
*/
template<class TypeTag>
@@ -126,7 +130,8 @@ private:
};
/*!
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Specialization of the CCTpfaDarcysLaw grids where dim=dimWorld
*/
template<class TypeTag>
@@ -328,7 +333,8 @@ class CCTpfaFacetCouplingDarcysLawImpl<TypeTag, /*isNetwork*/false>
};
/*!
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Specialization of the FacetCouplingTpfaDarcysLawCache for network grids
*/
template<class TypeTag>
@@ -389,7 +395,8 @@ private:
};
/*!
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Specialization of the CCTpfaDarcysLaw grids where dim<dimWorld
*/
template<class TypeTag>
diff --git a/dumux/multidomain/facet/cellcentered/tpfa/properties.hh b/dumux/multidomain/facet/cellcentered/tpfa/properties.hh
index 77f09d8093..0b97c42906 100644
--- a/dumux/multidomain/facet/cellcentered/tpfa/properties.hh
+++ b/dumux/multidomain/facet/cellcentered/tpfa/properties.hh
@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Properties (and default properties) for all models using cell-centered
* finite volume scheme with TPFA together with coupling across the grid element facets
* \note If n is the dimension of the lowest grid to be considered in the hierarchy,
diff --git a/dumux/multidomain/facet/cellcentered/upwindscheme.hh b/dumux/multidomain/facet/cellcentered/upwindscheme.hh
index dcaa8e328a..3a5191ba22 100644
--- a/dumux/multidomain/facet/cellcentered/upwindscheme.hh
+++ b/dumux/multidomain/facet/cellcentered/upwindscheme.hh
@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Modified upwind scheme for models using cell-centered schemes
* with coupling across element facets.
*/
@@ -33,8 +33,8 @@
namespace Dumux {
/*!
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief The upwind scheme used for the advective fluxes.
* This is a modified scheme for models involving coupling
* with a lower-dimensional domain across the element facets.
diff --git a/dumux/multidomain/facet/codimonegridadapter.hh b/dumux/multidomain/facet/codimonegridadapter.hh
index d34eb60897..cb7dcc58ae 100644
--- a/dumux/multidomain/facet/codimonegridadapter.hh
+++ b/dumux/multidomain/facet/codimonegridadapter.hh
@@ -19,8 +19,8 @@
/*!
* \file
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief copydoc Dumux::CodimOneGridAdapter
*/
#ifndef DUMUX_FACETCOUPLING_CODIM_ONE_GRID_ADAPTER_HH
@@ -32,8 +32,8 @@
namespace Dumux {
/*!
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Adapter to be plugged on top of a grid creator that allows for obtaining
* information on a d-dimensional grid for entities of a (d-1)-dimensional
* grid. This lower-dimensional grid is assumed to be facet-conforming to the
diff --git a/dumux/multidomain/facet/couplingmanager.hh b/dumux/multidomain/facet/couplingmanager.hh
index 081354d569..368648a76b 100644
--- a/dumux/multidomain/facet/couplingmanager.hh
+++ b/dumux/multidomain/facet/couplingmanager.hh
@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \copydoc Dumux::FacetCouplingManager
*/
#ifndef DUMUX_FACETCOUPLING_MANAGER_HH
@@ -33,6 +33,8 @@
namespace Dumux {
/*!
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Free function that allows the creation of a volume variables object
* interpolated to a given position within an element. This is the standard
* implementation which simply interpolates the solution to the given position
@@ -69,8 +71,8 @@ void makeInterpolatedVolVars(VolumeVariables& volVars,
}
/*!
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Implementation for the coupling manager between two domains of dimension d
* and (d-1) for models considering coupling across the bulk domain element facets.
* The implementations are specificto the discretization method used in the bulk
@@ -92,8 +94,8 @@ template< class MDTraits,
class FacetCouplingManager;
/*!
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Class that handles the coupling between three sub-domains in models where
* the coupling between the two occurs across the facets of the d- and (d-1)-
* dimensional domains.
diff --git a/dumux/multidomain/facet/couplingmapper.hh b/dumux/multidomain/facet/couplingmapper.hh
index a5ac9bcad6..a2d90bbcc3 100644
--- a/dumux/multidomain/facet/couplingmapper.hh
+++ b/dumux/multidomain/facet/couplingmapper.hh
@@ -16,8 +16,8 @@
*****************************************************************************/
/*!
* \file
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \copydoc Dumux::FacetCouplingMapper
*/
#ifndef DUMUX_FACETCOUPLING_MAPPER_HH
@@ -29,8 +29,8 @@
namespace Dumux {
/*!
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Implementation for the coupling mapper that sets up and stores
* the coupling maps between two domains of dimension d and (d-1).
* The implementations are specific to the discretization method
@@ -52,8 +52,8 @@ template< class BulkFVG,
class FacetCouplingMapper;
/*!
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Specialization of the mapper class for the case of
* three domains with the grid dimensions d, (d-1) & (d-2).
*
diff --git a/dumux/multidomain/facet/couplingmapperbase.hh b/dumux/multidomain/facet/couplingmapperbase.hh
index a3bcdec27c..90099f1188 100644
--- a/dumux/multidomain/facet/couplingmapperbase.hh
+++ b/dumux/multidomain/facet/couplingmapperbase.hh
@@ -16,8 +16,8 @@
*****************************************************************************/
/*!
* \file
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \copydoc Dumux::FacetCouplingMapperBase
*/
#ifndef DUMUX_FACETCOUPLING_MAPPER_BASE_HH
@@ -32,8 +32,8 @@
namespace Dumux {
/*!
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Base class for the coupling mapper that sets up and stores
* the coupling maps between two domains of dimension d and (d-1).
*
diff --git a/dumux/multidomain/facet/enrichmenthelper.hh b/dumux/multidomain/facet/enrichmenthelper.hh
index adeb2ba598..ab6676e6e2 100644
--- a/dumux/multidomain/facet/enrichmenthelper.hh
+++ b/dumux/multidomain/facet/enrichmenthelper.hh
@@ -19,8 +19,8 @@
/*!
* \file
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief copydoc Dumux::VertexEnrichmentHelper
*/
#ifndef DUMUX_VERTEX_ENRICHMENT_HELPER_HH
@@ -42,6 +42,8 @@
namespace Dumux {
/*!
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Specialization of the enrichment helper class for 2d grids.
* In this case, we look for two-dimensional bulk grid elements that
* are enclosed by (lie in between) two 1-dimensional facet grid elements.
diff --git a/dumux/multidomain/facet/gmshreader.hh b/dumux/multidomain/facet/gmshreader.hh
index ac57a8ada3..1d7c4d1df6 100644
--- a/dumux/multidomain/facet/gmshreader.hh
+++ b/dumux/multidomain/facet/gmshreader.hh
@@ -16,8 +16,8 @@
*****************************************************************************/
/*!
* \file
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \copydoc Dumux::FacetCouplingGmshReader.
*/
#ifndef DUMUX_FACETCOUPLING_GMSH_READER_HH
@@ -38,8 +38,8 @@
namespace Dumux {
/*
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Reads gmsh files where (n-1)-dimensional grids are defined on the faces
* or edges of n-dimensional grids.
*
diff --git a/dumux/multidomain/facet/gridcreator.hh b/dumux/multidomain/facet/gridcreator.hh
index 019ae3a7a5..128bdfe3ab 100644
--- a/dumux/multidomain/facet/gridcreator.hh
+++ b/dumux/multidomain/facet/gridcreator.hh
@@ -16,8 +16,8 @@
*****************************************************************************/
/*!
* \file
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Contains the grid creator class that creates the grids in the context
* of hybrid-dimensional coupled models, where the (n-1)-dimensional
* domains live on the element facets of the n-dimensional domains.
@@ -44,8 +44,8 @@
namespace Dumux {
/*!
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief Creates the grids in the context of hybrid-dimensional coupled models,
* where the (n-1)-dimensional domains live on the element facets of the
* n-dimensional domains.
diff --git a/dumux/multidomain/facet/vertexmapper.hh b/dumux/multidomain/facet/vertexmapper.hh
index d9971b91d0..1ee38599a1 100644
--- a/dumux/multidomain/facet/vertexmapper.hh
+++ b/dumux/multidomain/facet/vertexmapper.hh
@@ -19,8 +19,8 @@
/*!
* \file
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief copydoc Dumux::EnrichedVertexDofMapper
*/
#ifndef DUMUX_ENRICHED_VERTEX_DOF_MAPPER_HH
@@ -39,8 +39,8 @@
namespace Dumux {
/*!
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief An indicator class used to mark vertices for enrichment. This
* implementation marks all vertices of a given grid of codimension
* one for enrichment, except those that are connected to inmersed
@@ -136,8 +136,8 @@ public:
};
/*!
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief A vertex mapper that allows for enrichment of nodes. Indication on where to
* enrich the nodes is done on the basis of a grid of codimension one living
* on the facets of the bulk grid.
diff --git a/test/multidomain/facet/1p_1p/analytical/bulkproblem.hh b/test/multidomain/facet/1p_1p/analytical/bulkproblem.hh
index 2d11ac0c1a..eac60f6c71 100644
--- a/test/multidomain/facet/1p_1p/analytical/bulkproblem.hh
+++ b/test/multidomain/facet/1p_1p/analytical/bulkproblem.hh
@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief The problem for the bulk domain in the single-phase facet coupling test
*/
#ifndef DUMUX_TEST_TPFAFACETCOUPLING_ONEP_BULKPROBLEM_HH
diff --git a/test/multidomain/facet/1p_1p/analytical/lowdimproblem.hh b/test/multidomain/facet/1p_1p/analytical/lowdimproblem.hh
index 5895c1560f..72b061cd29 100644
--- a/test/multidomain/facet/1p_1p/analytical/lowdimproblem.hh
+++ b/test/multidomain/facet/1p_1p/analytical/lowdimproblem.hh
@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief The problem for the lower-dimensional domain in the single-phase facet coupling test
*/
#ifndef DUMUX_TEST_TPFAFACETCOUPLING_ONEP_LOWDIMPROBLEM_HH
diff --git a/test/multidomain/facet/1p_1p/threedomain/bulkproblem.hh b/test/multidomain/facet/1p_1p/threedomain/bulkproblem.hh
index ac5b116b5e..6098c8ea0a 100644
--- a/test/multidomain/facet/1p_1p/threedomain/bulkproblem.hh
+++ b/test/multidomain/facet/1p_1p/threedomain/bulkproblem.hh
@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief The problem for the bulk domain in the single-phase facet coupling test
*/
#ifndef DUMUX_TEST_FACETCOUPLING_THREEDOMAIN_ONEP_BULKPROBLEM_HH
diff --git a/test/multidomain/facet/1p_1p/threedomain/edgeproblem.hh b/test/multidomain/facet/1p_1p/threedomain/edgeproblem.hh
index 14f93b5674..0495cc85e4 100644
--- a/test/multidomain/facet/1p_1p/threedomain/edgeproblem.hh
+++ b/test/multidomain/facet/1p_1p/threedomain/edgeproblem.hh
@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief The problem for the (d-2)-dimensional edge domain in the single-phase
* facet coupling test involving three domains.
*/
diff --git a/test/multidomain/facet/1p_1p/threedomain/facetproblem.hh b/test/multidomain/facet/1p_1p/threedomain/facetproblem.hh
index 7274319d8e..d6302e1045 100644
--- a/test/multidomain/facet/1p_1p/threedomain/facetproblem.hh
+++ b/test/multidomain/facet/1p_1p/threedomain/facetproblem.hh
@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
- * \ingroup MixedDimension
- * \ingroup MixedDimensionFacet
+ * \ingroup MultiDomain
+ * \ingroup FacetCoupling
* \brief The problem for the (d-1)-dimensional facet domain in the single-phase
* facet coupling test involving three domains.
*/
--
GitLab