From: bangerth Date: Thu, 7 Feb 2013 20:09:34 +0000 (+0000) Subject: Augment documentation. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=bc2d3b9e399d1b8824252d289262f284008e81bb;p=dealii-svn.git Augment documentation. git-svn-id: https://svn.dealii.org/trunk@28265 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/include/deal.II/grid/tria_accessor.h b/deal.II/include/deal.II/grid/tria_accessor.h index 75608faceb..6a0e28e247 100644 --- a/deal.II/include/deal.II/grid/tria_accessor.h +++ b/deal.II/include/deal.II/grid/tria_accessor.h @@ -756,6 +756,13 @@ public: * associated with it. For this, see the * @p DoFAccessor::vertex_dof_index * functions. + * + * @note Despite the name, the index returned here is only + * global in the sense that it is specific to a particular + * Triangulation object or, in the case the triangulation is + * actually of type parallel::distributed::Triangulation, + * specific to that part of the distributed triangulation stored + * on the current processor. */ unsigned int vertex_index (const unsigned int i) const; @@ -1882,6 +1889,13 @@ public: * associated with it. For this, see the * @p DoFAccessor::vertex_dof_index * functions. + * + * @note Despite the name, the index returned here is only + * global in the sense that it is specific to a particular + * Triangulation object or, in the case the triangulation is + * actually of type parallel::distributed::Triangulation, + * specific to that part of the distributed triangulation stored + * on the current processor. */ unsigned int vertex_index (const unsigned int i = 0) const; @@ -2276,6 +2290,13 @@ public: /** * Return the (global) index of the * @p ith face of this cell. + * + * @note Despite the name, the index returned here is only + * global in the sense that it is specific to a particular + * Triangulation object or, in the case the triangulation is + * actually of type parallel::distributed::Triangulation, + * specific to that part of the distributed triangulation stored + * on the current processor. */ unsigned int face_index (const unsigned int i) const;