]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Better link to what one can do with iterators. 10925/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Wed, 16 Sep 2020 18:58:24 +0000 (12:58 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Wed, 16 Sep 2020 18:58:24 +0000 (12:58 -0600)
examples/step-1/doc/results.dox

index 65d5f8b6593d660a5662ac83ed968243ad72784e..83776a2c26c73eacf4b6adfe1c42cb9d5a01c45d 100644 (file)
@@ -54,6 +54,19 @@ the $x$-coordinate, subscripting <code>[1]</code> the
 $y$-coordinate). By looking at the functions that TriaAccessor
 provides, you can also use more complicated criteria for refinement.
 
+In general, what you can do with operations of the form
+`cell->something()` is a bit difficult to find in the documentation
+because `cell` is not a pointer but an iterator. The functions you can
+call on a cell can be found in the documentation of the classes
+`TriaAccessor` (which has functions that can also be called on faces
+of cells or, more generally, all sorts of geometric objects that
+appear in a triangulation), and `CellAccessor` (which adds a few
+functions that are specific to *cells*).
+
+A more thorough description of the whole iterator concept can be found
+in the @ref Iterators documentation module.
+
+
 <h4> Different geometries </h4>
 
 Another possibility would be to generate meshes of entirely different

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.