From: Wolfgang Bangerth <bangerth@colostate.edu>
Date: Mon, 27 Aug 2018 20:51:32 +0000 (-0600)
Subject: Improve documentation of RefinementPossibilities.
X-Git-Tag: v9.1.0-rc1~768^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F7126%2Fhead;p=dealii.git

Improve documentation of RefinementPossibilities.
---

diff --git a/include/deal.II/base/geometry_info.h b/include/deal.II/base/geometry_info.h
index b586b2284d..31e75d1f0e 100644
--- a/include/deal.II/base/geometry_info.h
+++ b/include/deal.II/base/geometry_info.h
@@ -355,9 +355,17 @@ struct RefinementPossibilities
     no_refinement = 0,
 
     /**
-     * Perform isotropic refinement.
+     * Perform isotropic refinement. This implies
+     * refining in all coordinate directions. For the
+     * current general template class -- which is never used
+     * because there are specializations for the 1d, 2d, and 3d
+     * cases --, we simply set this number to a value that has
+     * all bits set. The specializations in
+     * RefinementPossibilities<1>, RefinementPossibilities<2>,
+     * and RefinementPossibilities<3> set the corresponding `enum` element
+     * to more reasonable values.
      */
-    isotropic_refinement = static_cast<std::uint8_t>(-1)
+    isotropic_refinement = 0xFF
   };
 };