Commit 48c3720d authored by Timo Koch's avatar Timo Koch
Browse files

[multidomain][facet][doc] Correct ingroups

parent b5b93642
......@@ -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.
......
......@@ -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.
......
......@@ -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.
......
......@@ -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.
......
......@@ -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
......
......@@ -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
......
......@@ -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
*/
......
......@@ -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,
......
......@@ -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
......
......@@ -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.
......
......@@ -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,
......
......@@ -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.
......
......@@ -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
......
......@@ -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>
......
......@@ -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,
......
......@@ -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.
......
......@@ -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
......
......@@ -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.
......
......@@ -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).
*
......
......@@ -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).
*
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment