From: Daniel Arndt <daniel.arndt@iwr.uni-heidelberg.de>
Date: Fri, 3 Nov 2017 17:01:54 +0000 (+0100)
Subject: Document replacements for the Boundary objects
X-Git-Tag: v9.0.0-rc1~829^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=710a3b17822658f74d5dc8e3863729bbfe54d21d;p=dealii.git

Document replacements for the Boundary objects
---

diff --git a/include/deal.II/grid/tria_boundary_lib.h b/include/deal.II/grid/tria_boundary_lib.h
index 931d17835e..0f1c6a945b 100644
--- a/include/deal.II/grid/tria_boundary_lib.h
+++ b/include/deal.II/grid/tria_boundary_lib.h
@@ -42,7 +42,8 @@ DEAL_II_NAMESPACE_OPEN
  * StraightBoundary::in_between() function.
  *
  * @deprecated The boundary classes have been deprecated in favor of the more
- * general Manifold classes.
+ * general Manifold classes. For this class CylindricalManifold is an appropriate
+ * replacement which is expected to produce better results under mesh refinement.
  *
  * @ingroup boundary
  *
@@ -193,7 +194,8 @@ private:
  * @image html cone_3d.png
  *
  * @deprecated The boundary classes have been deprecated in favor of the more
- * general Manifold classes.
+ * general Manifold classes. For this class CylindricalManifold is an appropriate
+ * replacement for spacedim==3, else StraightManifold can be used.
  *
  * @author Markus B&uuml;rg, 2009
  */
@@ -333,7 +335,8 @@ private:
  * @ingroup boundary
  *
  * @deprecated The boundary classes have been deprecated in favor of the more
- * general Manifold classes.
+ * general Manifold classes. For this class SphericalManifold is an appropriate
+ * replacement which is expected to produce better results under mesh refinement.
  *
  * @author Wolfgang Bangerth, 1998, Ralf Hartmann, 2001
  */
@@ -474,7 +477,8 @@ private:
  * @ingroup boundary
  *
  * @deprecated The boundary classes have been deprecated in favor of the more
- * general Manifold classes.
+ * general Manifold classes. For this class CylindricalManifold is an appropriate
+ * replacement which is expected to produce better results under mesh refinement.
  *
  * @author Wolfgang Bangerth, 1999, 2001
  */
@@ -541,7 +545,8 @@ public:
  * @ingroup boundary
  *
  * @deprecated The boundary classes have been deprecated in favor of the more
- * general Manifold classes.
+ * general Manifold classes. For this class CylindricalManifold is an appropriate
+ * replacement which is expected to produce better results under mesh refinement.
  *
  * @author Wolfgang Bangerth, 1999
  */
@@ -571,7 +576,8 @@ public:
  * @ingroup boundary
  *
  * @deprecated The boundary classes have been deprecated in favor of the more
- * general Manifold classes.
+ * general Manifold classes. For this class CylindricalManifold is an appropriate
+ * replacement which is expected to produce better results under mesh refinement.
  *
  * @author Wolfgang Bangerth, 2000, 2009
  */
@@ -650,7 +656,7 @@ private:
  * is, just the surface.
  *
  * @deprecated This class has been deprecated in favor of the more general
- * Manifold class.
+ * TorusManifold class.
  */
 template <int dim, int spacedim>
 class TorusBoundary : public Boundary<dim,spacedim>