From: Daniel Arndt Date: Sun, 7 Jan 2018 12:10:18 +0000 (+0100) Subject: Improve documentation X-Git-Tag: v9.0.0-rc1~586^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7abaad8d90a58d101d8616456e24e2b7666f8827;p=dealii.git Improve documentation --- diff --git a/include/deal.II/grid/tria.h b/include/deal.II/grid/tria.h index 85ced31dba..865e1016e5 100644 --- a/include/deal.II/grid/tria.h +++ b/include/deal.II/grid/tria.h @@ -838,10 +838,7 @@ namespace internal * by child cells from their parent upon mesh refinement. * * Boundary indicators on lower dimensional objects (these have no material - * id) indicate the number of a boundary component. These are used for two - * purposes: First, they specify a boundary curve. When a cell is refined, a - * function can be used to place new vertices on this curve. See the section - * on boundary approximation below. Furthermore, the weak formulation of the + * id) indicate the number of a boundary component. The weak formulation of the * partial differential equation may have different boundary conditions on * different parts of the boundary. The boundary indicator can be used in * creating the matrix or the right hand side vector to indicate these @@ -953,12 +950,12 @@ namespace internal * *

%Boundary approximation

* - * You can specify a boundary function for each boundary component. If a new - * vertex is created on a side or face at the boundary, this function is used - * to compute where it will be placed. The boundary indicator of the face will - * be used to determine the proper component. See Boundary for the details. + * You can specify a class describing the boundary for each boundary component. + * If a new vertex is created on a side or face at the boundary, this class is + * used to compute where it will be placed. The manifold indicator of the face + * will be used to determine the proper component. See Manifold for the details. * Usage with the Triangulation object is then like this (let @p Ball be a - * class derived from Boundary<2>): + * class derived from Manifold<2>): * * @code * int main () @@ -968,7 +965,7 @@ namespace internal * // for all boundaries with * // boundary indicator 0 * Ball ball; - * tria.set_boundary (0, ball); + * tria.set_manifold (0, ball); * * // read some coarse grid * @@ -1137,7 +1134,7 @@ namespace internal * indicators, subdomain ids, material ids, etc. On the other hand, the * following information is not stored: * - signals - * - pointers to boundary objects previously set using Triangulation::set_boundary + * - pointers to Manifold objects previously set using Triangulation::set_manifold * On the other hand, since these are objects that are usually set in user code, * they can typically easily be set again in that part of your code in which you * re-load triangulations. @@ -1878,10 +1875,9 @@ public: * of triangulations if you can assign them values later on. * * Keep in mind that this function also copies the pointer to the boundary - * descriptor previously set by the @p set_boundary function and to the - * Manifold object previously set by the set_manifold() function. You must - * therefore also guarantee that the boundary and manifold objects have a - * lifetime at least as long as the copied triangulation. + * descriptor previously set by the @p set_manifold function. You must + * therefore also guarantee that the Manifold objects describing the boundary + * have a lifetime at least as long as the copied triangulation. * * This triangulation must be empty beforehand. * @@ -3604,7 +3600,7 @@ private: * fields of this class that can be modified by the TriaAccessor hierarchy * are pointers, and so these accessor classes store a const pointer to the * triangulation. We could no longer do so for TriaAccessor<0,1,spacedim> if - * this field (that can be modified by TriaAccessor::set_boundary_id) were + * this field (that can be modified by TriaAccessor::set_manifold_id) were * not a pointer. */ std::unique_ptr > vertex_to_manifold_id_map_1d;