From fe4b32c5091e0b21402d3c7302c3a2be7db688ac Mon Sep 17 00:00:00 2001
From: Timo Koch <timo.koch@iws.uni-stuttgart.de>
Date: Tue, 19 Dec 2017 21:09:47 +0100
Subject: [PATCH] [doc] Improve documentation for cell-centered scheme

---
 dumux/discretization/cellcentered/connectivitymap.hh      | 3 ++-
 dumux/discretization/cellcentered/elementboundarytypes.hh | 6 ++++--
 dumux/discretization/cellcentered/elementsolution.hh      | 4 ++--
 dumux/discretization/cellcentered/gridvolumevariables.hh  | 6 +++++-
 dumux/discretization/cellcentered/subcontrolvolume.hh     | 8 ++++++--
 5 files changed, 19 insertions(+), 8 deletions(-)

diff --git a/dumux/discretization/cellcentered/connectivitymap.hh b/dumux/discretization/cellcentered/connectivitymap.hh
index 5c69551e77..efca535243 100644
--- a/dumux/discretization/cellcentered/connectivitymap.hh
+++ b/dumux/discretization/cellcentered/connectivitymap.hh
@@ -18,6 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
+ * \ingroup CCDiscretization
  * \brief Stores the face indices corresponding to the neighbors of an element
  *        that contribute to the derivative calculation. This is used for
  *        finite-volume schemes with symmetric sparsity pattern in the global matrix.
@@ -34,7 +35,7 @@ namespace Dumux
 {
 
 /*!
- * \ingroup CellCentered
+ * \ingroup CCDiscretization
  * \brief A simple version of the connectivity map for cellcentered schemes.
  *        This implementation works for schemes in which for a given cell I only
  *        those cells J have to be prepared in whose stencil the cell I appears.
diff --git a/dumux/discretization/cellcentered/elementboundarytypes.hh b/dumux/discretization/cellcentered/elementboundarytypes.hh
index 82baa1e88e..188439bb48 100644
--- a/dumux/discretization/cellcentered/elementboundarytypes.hh
+++ b/dumux/discretization/cellcentered/elementboundarytypes.hh
@@ -18,6 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
+ * \ingroup CCDiscretization
  * \brief Boundary types gathered on an element
  */
 #ifndef DUMUX_CC_ELEMENT_BOUNDARY_TYPES_HH
@@ -29,8 +30,9 @@ namespace Dumux
 {
 
 /*!
- * \ingroup CCModel
- * \brief This class exists only for compatibility purposes with the
+ * \ingroup CCDiscretization
+ * \brief Boundary types gathered on an element
+ * \note This class exists only for compatibility purposes with the
  *        box scheme. The cell-centered schemes and the box scheme use
  *        a common base local residual, which passes an ElementBoundaryTypes
  *        object to the implemented interfaces.
diff --git a/dumux/discretization/cellcentered/elementsolution.hh b/dumux/discretization/cellcentered/elementsolution.hh
index 6cc65557f0..1ab481db9b 100644
--- a/dumux/discretization/cellcentered/elementsolution.hh
+++ b/dumux/discretization/cellcentered/elementsolution.hh
@@ -18,6 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
+ * \ingroup CCDiscretization
  * \brief The local element solution class for cell-centered methods
  */
 #ifndef DUMUX_CC_ELEMENT_SOLUTION_HH
@@ -30,7 +31,7 @@ namespace Dumux
 {
 
 /*!
- * \ingroup CCModel
+ * \ingroup CCDiscretization
  * \brief The element solution vector
  */
 template<class TypeTag>
@@ -46,7 +47,6 @@ class CCElementSolution
 public:
     using PrimaryVariables = typename GET_PROP_TYPE(TypeTag, PrimaryVariables);
 
-    //! Default constructors
     CCElementSolution() = default;
 
     //! Constructor with element and solution
diff --git a/dumux/discretization/cellcentered/gridvolumevariables.hh b/dumux/discretization/cellcentered/gridvolumevariables.hh
index e1322345f3..9f970c2c4b 100644
--- a/dumux/discretization/cellcentered/gridvolumevariables.hh
+++ b/dumux/discretization/cellcentered/gridvolumevariables.hh
@@ -18,6 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
+ * \ingroup CCDiscretization
  * \brief The grid volume variables class for cell centered models
  */
 #ifndef DUMUX_DISCRETIZATION_CC_GRID_VOLUMEVARIABLES_HH
@@ -29,8 +30,11 @@ namespace Dumux
 {
 
 /*!
- * \ingroup CCModel
+ * \ingroup CCDiscretization
  * \brief Base class for the grid volume variables
+ * \note This class has a cached version and a non-cached version
+ * \tparam TypeTag the TypeTag
+ * \tparam enableGridVolVarsCache if the cache is enabled
  */
 template<class TypeTag, bool enableGridVolVarsCache>
 class CCGridVolumeVariables
diff --git a/dumux/discretization/cellcentered/subcontrolvolume.hh b/dumux/discretization/cellcentered/subcontrolvolume.hh
index f8875526ff..c9521b8bbe 100644
--- a/dumux/discretization/cellcentered/subcontrolvolume.hh
+++ b/dumux/discretization/cellcentered/subcontrolvolume.hh
@@ -18,7 +18,8 @@
  *****************************************************************************/
 /*!
  * \file
- * \brief Base class for a sub control volume
+ * \ingroup CCDiscretization
+ * \brief Sub control volumes for cell-centered discretization schemes
  */
 #ifndef DUMUX_DISCRETIZATION_CC_SUBCONTROLVOLUME_HH
 #define DUMUX_DISCRETIZATION_CC_SUBCONTROLVOLUME_HH
@@ -28,6 +29,10 @@
 
 namespace Dumux
 {
+/*!
+ * \ingroup CCDiscretization
+ * \brief Sub control volumes for cell-centered discretization schemes
+ */
 template<class ScvGeometryTraits>
 class CCSubControlVolume : public SubControlVolumeBase<CCSubControlVolume<ScvGeometryTraits>, ScvGeometryTraits>
 {
@@ -42,7 +47,6 @@ public:
     //! state the traits public and thus export all types
     using Traits = ScvGeometryTraits;
 
-    // the default constructor
     CCSubControlVolume() = default;
 
     // the contructor in the cc case
-- 
GitLab