]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Augment documentation of DataOutBase::Patch. 14658/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Tue, 10 Jan 2023 15:52:28 +0000 (08:52 -0700)
committerWolfgang Bangerth <bangerth@colostate.edu>
Tue, 10 Jan 2023 15:54:27 +0000 (08:54 -0700)
include/deal.II/base/data_out_base.h

index 64ee5c70c38c9a963bf894d53a72811dfc7a9be2..d69807980319ccd9e0d77b404038817a32a4d53b 100644 (file)
@@ -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<spacedim> vertices[GeometryInfo<dim>::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<unsigned int, GeometryInfo<dim>::faces_per_cell> neighbors;
 

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.