From b4eca22f36747017df16fbc707fb1ce7fe7aefe4 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Wed, 24 Feb 2021 20:59:41 -0700 Subject: [PATCH] Mark GeometryInfo as deprecated in favor of ReferenceCell. --- include/deal.II/base/geometry_info.h | 6 ++++++ include/deal.II/grid/reference_cell.h | 5 +++++ 2 files changed, 11 insertions(+) diff --git a/include/deal.II/base/geometry_info.h b/include/deal.II/base/geometry_info.h index 6f7c4fd39e..299637b5c1 100644 --- a/include/deal.II/base/geometry_info.h +++ b/include/deal.II/base/geometry_info.h @@ -1215,6 +1215,9 @@ struct GeometryInfo; /** + * This class provides a description of zero-dimensional cells. It has been + * superseded by the ReferenceCell class -- see there for more information. + * * Topological description of zero dimensional cells, i.e. points. This class * might not look too useful but often is if in a certain dimension we would * like to enquire information about objects with dimension one lower than the @@ -1434,6 +1437,9 @@ struct GeometryInfo<0> * This class provides dimension independent information to all topological * structures that make up the unit, or * @ref GlossReferenceCell "reference cell". + * This class has been + * superseded by the ReferenceCell class -- see there for more information. + * * * It is the one central point in the library where information about the * numbering of vertices, lines, or faces of the reference cell is collected. diff --git a/include/deal.II/grid/reference_cell.h b/include/deal.II/grid/reference_cell.h index 99569b072a..39b76d0d05 100644 --- a/include/deal.II/grid/reference_cell.h +++ b/include/deal.II/grid/reference_cell.h @@ -77,6 +77,11 @@ namespace internal * all of the possible values. User codes should therefore rely * exclusively on assigning ReferenceCell objects from these special * objects, and comparing against those special objects. + * + * The purposes and intents of this class are described in the + * @ref GlossReferenceCell "reference cell" glossary entry. + * + * @ingroup grid geomprimitives aniso */ class ReferenceCell { -- 2.39.5