From dc45335de73d389768bd01c028c93f6c6a294c52 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Mon, 3 Aug 2009 11:57:08 +0000 Subject: [PATCH] Clarify documentation in one place. git-svn-id: https://svn.dealii.org/trunk@19168 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/deal.II/include/grid/tria.h | 30 +++++++++++++++++++++-------- 1 file changed, 22 insertions(+), 8 deletions(-) diff --git a/deal.II/deal.II/include/grid/tria.h b/deal.II/deal.II/include/grid/tria.h index 3a949013f6..cf13eb33fd 100644 --- a/deal.II/deal.II/include/grid/tria.h +++ b/deal.II/deal.II/include/grid/tria.h @@ -65,26 +65,40 @@ template class MGDoFHandler; /*------------------------------------------------------------------------*/ /** - * Structure which is passed to the - * Triangulation::create_triangulation function. It - * contains all data needed to construct a cell, namely the indices - * of the vertices and the material indicator. + * Structure which is passed to Triangulation::create_triangulation. It + * contains all data needed to construct a cell, namely the indices of the + * vertices and the material indicator. + * + * This structure is also used to represent data for faces and edge as part of + * the SubCellData class. In that case the #vertices array needs to represent + * the vertices of a face or edge of a cell listed in the argument to + * Triangulation::create_triangulation that denotes the cells. It can be used + * to attach boundary indicators to faces. * * @ingroup grid */ -template +template struct CellData { /** * Indices of the vertices of * this cell. */ - unsigned int vertices[GeometryInfo::vertices_per_cell]; + unsigned int vertices[GeometryInfo::vertices_per_cell]; /** * Material indicator of this * cell. May be used to denote * different coefficients, etc. + * + * Note that if this object is part of a + * SubCellData object, then it represents + * a face or edge of a cell. Since + * deal.II only allows material_id tags + * on cells, this field is re-interpreted + * to indicate the boundary_indicator of + * a face or edge. In other words, for + * faces, this field is a misnomer. */ unsigned char material_id; }; @@ -92,8 +106,8 @@ struct CellData /** - * Structure to be passed to the Triangulation::create_triangulation - * function to describe boundary information. + * Structure to be passed to Triangulation::create_triangulation function to + * describe boundary information. * * This structure is the same for all dimensions, since we use an input * function which is the same for all dimensions. The content of objects -- 2.39.5