]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update documentation. 4693/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Fri, 4 Aug 2017 12:08:00 +0000 (06:08 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Fri, 4 Aug 2017 21:32:13 +0000 (15:32 -0600)
include/deal.II/grid/tria.h

index 70a29275743bdec0f41613404d72c59ddcd291a8..85af22bdff1a79e7d70696f47f7fc7a06355d237 100644 (file)
@@ -1503,7 +1503,28 @@ public:
   typedef TriaIterator      <TriaAccessor<dim-1, dim, spacedim> > face_iterator;
   typedef TriaActiveIterator<TriaAccessor<dim-1, dim, spacedim> > active_face_iterator;
 
+  /**
+   * A typedef that defines an iterator type to iterate over
+   * vertices of a mesh.  The concept of iterators is discussed at
+   * length in the
+   * @ref Iterators "iterators documentation module".
+   *
+   * @ingroup Iterators
+   */
   typedef TriaIterator      <dealii::TriaAccessor<0, dim, spacedim> > vertex_iterator;
+
+  /**
+   * A typedef that defines an iterator type to iterate over
+   * vertices of a mesh.  The concept of iterators is discussed at
+   * length in the
+   * @ref Iterators "iterators documentation module".
+   *
+   * This typedef is in fact identical to the @p vertex_iterator typedef
+   * above since all vertices in a mesh are active (i.e., are a vertex of
+   * an active cell).
+   *
+   * @ingroup Iterators
+   */
   typedef TriaActiveIterator<dealii::TriaAccessor<0, dim, spacedim> > active_vertex_iterator;
 
   typedef typename IteratorSelector::line_iterator        line_iterator;

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.