From 57090f2097168142773d39ff5ac0a5430f2be55f Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Wed, 15 Oct 2014 08:17:32 -0500 Subject: [PATCH] Minor doc update. We had forgotten to update the documentation for the new manifold_id field. Also a few other touches of TLC. --- include/deal.II/grid/tria.h | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/include/deal.II/grid/tria.h b/include/deal.II/grid/tria.h index 4aea5c3933..bb218fa3f3 100644 --- a/include/deal.II/grid/tria.h +++ b/include/deal.II/grid/tria.h @@ -84,14 +84,17 @@ template class MGDoFHandler; /*------------------------------------------------------------------------*/ /** - * Structure which is passed to Triangulation::create_triangulation. It + * A structure to describe individual cells and passed as argument to + * Triangulation::create_triangulation(). It * contains all data needed to construct a cell, namely the indices of the - * vertices and the material indicator. + * vertices, the material or boundary indicator (depending on whether it + * represents a cell or a face), and a manifold id to describe the manifold + * this object belongs to. * * 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 + * Triangulation::create_triangulation() that denotes the faces. It can be used * to attach boundary indicators to faces. * * @ingroup grid @@ -132,8 +135,10 @@ struct CellData types::manifold_id manifold_id; /** - * Default constructor. Sets the vertex indices to invalid values and the boundary or material - * id the default value (zero). + * Default constructor. Sets the member variables to the following values: + * - vertex indices to invalid values + * - boundary or material id zero (the default for boundary or material ids) + * - manifold id to numbers::invalid_manifold_id */ CellData (); }; -- 2.39.5