From: Wolfgang Bangerth Date: Wed, 11 Jan 2023 17:54:41 +0000 (-0700) Subject: Minor updates to bounding box documentation. X-Git-Tag: v9.5.0-rc1~661^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F14666%2Fhead;p=dealii.git Minor updates to bounding box documentation. --- diff --git a/include/deal.II/base/bounding_box.h b/include/deal.II/base/bounding_box.h index 6ea5bc3354..dcca720b17 100644 --- a/include/deal.II/base/bounding_box.h +++ b/include/deal.II/base/bounding_box.h @@ -39,15 +39,17 @@ enum class NeighborType /** * Simple neighbors: the boxes intersect with an intersection of dimension at - * most `spacedim - 2`. For example, in 2d this means that the two boxes - * touch at one corner of the each box. + * most `spacedim - 2`. For example, in 2d this means that the two rectangles + * touch at a single point, which must then be a vertex of each box. In 3d, + * this means that two boxes touch along an edge. */ simple_neighbors = 1, /** * Attached neighbors: neighbors with an intersection of * `dimension > spacedim - 2`. For example, in 2d this means that the two - * boxes touch along an edge. + * rectangles touch along (parts of) their edges. In 3d, it would mean that + * two boxes touch along (parts of) their faces. */ attached_neighbors = 2, @@ -59,7 +61,9 @@ enum class NeighborType * | | | = | | * V--W--. V-----. * @endcode - * or one is inside the other + * or one is inside the other. This is a special case of `attached_neighbors` + * where the two bounding boxes touch along the entirety of their respective + * faces, or where they overlap in suitable ways. */ mergeable_neighbors = 3 };