]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Document (active_)?face_iterator typedefs.
authorWolfgang Bangerth <bangerth@colostate.edu>
Mon, 16 Oct 2017 15:02:49 +0000 (09:02 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Mon, 16 Oct 2017 15:56:36 +0000 (09:56 -0600)
include/deal.II/dofs/dof_handler.h
include/deal.II/grid/tria.h
include/deal.II/hp/dof_handler.h

index c5614b470188ad457dca44f3892c351f8af75273..1eba933fd2018d3ebc67d3f93383d5c2fccb4139 100644 (file)
@@ -256,7 +256,35 @@ public:
    */
   typedef typename ActiveSelector::cell_iterator        cell_iterator;
 
+  /**
+   * A typedef that is used to identify iterators that point to faces.
+   * The concept of iterators is discussed at length in the
+   * @ref Iterators "iterators documentation module".
+   *
+   * While the actual data type of the typedef is hidden behind a few layers
+   * of (unfortunately necessary) indirections, it is in essence
+   * TriaIterator<DoFAccessor>. The
+   * TriaIterator class works like a pointer to objects that when
+   * you dereference it yields an object of type DoFAccessor. DoFAccessor,
+   * in turn, is a class that can be used to query DoF indices on faces,
+   * but it is also derived from TriaAccessor and consequently can be used
+   * to query geometric properties such as vertices of faces, their area, etc.
+   *
+   * @ingroup Iterators
+   */
   typedef typename ActiveSelector::face_iterator        face_iterator;
+
+  /**
+   * A typedef that is used to identify iterators that point to active faces,
+   * i.e., to faces that have no children. Active faces must be faces of at
+   * least one active cell.
+   *
+   * Other than the "active" qualification, this typedef is identical to the
+   * @p face_iterator typedef. In particular, dereferencing either yields
+   * the same kind of object.
+   *
+   * @ingroup Iterators
+   */
   typedef typename ActiveSelector::active_face_iterator active_face_iterator;
 
   typedef typename LevelSelector::CellAccessor          level_cell_accessor;
index a600d993a6c910bdc282f91d49bc494b069bc104..ff36a5f826d826fa5190ff6081d031a7d939b5dd 100644 (file)
@@ -1503,7 +1503,32 @@ public:
    */
   typedef TriaActiveIterator<CellAccessor<dim,spacedim>         > active_cell_iterator;
 
+  /**
+   * A typedef that is used to identify iterators that point to faces.
+   * The concept of iterators is discussed at length in the
+   * @ref Iterators "iterators documentation module".
+   *
+   * The current typedef identifies faces in a triangulation. The
+   * TriaIterator class works like a pointer to objects that when
+   * you dereference it yields an object of type TriaAccessor, i.e.,
+   * class that can be used to query geometric properties of faces
+   * such as their vertices, their area, etc.
+   *
+   * @ingroup Iterators
+   */
   typedef TriaIterator      <TriaAccessor<dim-1, dim, spacedim> > face_iterator;
+
+  /**
+   * A typedef that is used to identify iterators that point to active faces,
+   * i.e., to faces that have no children. Active faces must be faces of at
+   * least one active cell.
+   *
+   * Other than the "active" qualification, this typedef is identical to the
+   * @p face_iterator typedef. In particular, dereferencing either yields
+   * the same kind of object.
+   *
+   * @ingroup Iterators
+   */
   typedef TriaActiveIterator<TriaAccessor<dim-1, dim, spacedim> > active_face_iterator;
 
   /**
index 47b1103b58739f43923ff9786ea6e757e3d07b11..9b868d3e20efe11740f39154c471ad7443d1c8f0 100644 (file)
@@ -237,8 +237,35 @@ namespace hp
     typedef TriaIterator < dealii::DoFCellAccessor < DoFHandler < dim, spacedim >, false > >        cell_iterator;
 #endif
 
-
+    /**
+     * A typedef that is used to identify iterators that point to faces.
+     * The concept of iterators is discussed at length in the
+     * @ref Iterators "iterators documentation module".
+     *
+     * While the actual data type of the typedef is hidden behind a few layers
+     * of (unfortunately necessary) indirections, it is in essence
+     * TriaIterator<DoFAccessor>. The
+     * TriaIterator class works like a pointer to objects that when
+     * you dereference it yields an object of type DoFAccessor. DoFAccessor,
+     * in turn, is a class that can be used to query DoF indices on faces,
+     * but it is also derived from TriaAccessor and consequently can be used
+     * to query geometric properties such as vertices of faces, their area, etc.
+     *
+     * @ingroup Iterators
+     */
     typedef typename ActiveSelector::face_iterator        face_iterator;
+
+    /**
+     * A typedef that is used to identify iterators that point to active faces,
+     * i.e., to faces that have no children. Active faces must be faces of at
+     * least one active cell.
+     *
+     * Other than the "active" qualification, this typedef is identical to the
+     * @p face_iterator typedef. In particular, dereferencing either yields
+     * the same kind of object.
+     *
+     * @ingroup Iterators
+     */
     typedef typename ActiveSelector::active_face_iterator active_face_iterator;
 
     typedef typename LevelSelector::CellAccessor          level_cell_accessor;

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.