From 710a3b17822658f74d5dc8e3863729bbfe54d21d Mon Sep 17 00:00:00 2001 From: Daniel Arndt Date: Fri, 3 Nov 2017 18:01:54 +0100 Subject: [PATCH] Document replacements for the Boundary objects --- include/deal.II/grid/tria_boundary_lib.h | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) 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ü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 class TorusBoundary : public Boundary -- 2.39.5