From fa9ce8be36336030e0e13d6993ee3aca8b559d7b Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Tue, 10 Jan 2023 08:52:28 -0700 Subject: [PATCH] Augment documentation of DataOutBase::Patch. --- include/deal.II/base/data_out_base.h | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/include/deal.II/base/data_out_base.h b/include/deal.II/base/data_out_base.h index 64ee5c70c3..d698079803 100644 --- a/include/deal.II/base/data_out_base.h +++ b/include/deal.II/base/data_out_base.h @@ -281,6 +281,11 @@ namespace DataOutBase * * The order of points is the same as for cells in the * triangulation. + * + * @note This array is sized to accommodate the maximal number of vertices + * one might encounter in a cell, namely those for a hypercube cell. + * For other kinds of cells (triangles, tetrahedra, etc.), only the + * first few elements of this array will be used. */ Point vertices[GeometryInfo::vertices_per_cell]; @@ -288,6 +293,11 @@ namespace DataOutBase * Patch indices of neighbors of the current patch. This is made available * for the OpenDX format that requires neighbor * information for advanced output. + * + * @note This array is sized to accommodate the maximal number of faces + * one might encounter in a cell, namely those for a hypercube cell. + * For other kinds of cells (triangles, tetrahedra, etc.), only the + * first few elements of this array will be used. */ std::array::faces_per_cell> neighbors; -- 2.39.5