]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Augment documentation.
authorbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Thu, 7 Feb 2013 20:09:34 +0000 (20:09 +0000)
committerbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Thu, 7 Feb 2013 20:09:34 +0000 (20:09 +0000)
git-svn-id: https://svn.dealii.org/trunk@28265 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/include/deal.II/grid/tria_accessor.h

index 75608faceb54e3c11ec86303c0474ec5def4c10f..6a0e28e2477c259669b8aae6b72bb8a511c923df 100644 (file)
@@ -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;

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.