]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Add pictures to the documentation.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Tue, 18 Aug 2009 12:49:00 +0000 (12:49 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Tue, 18 Aug 2009 12:49:00 +0000 (12:49 +0000)
git-svn-id: https://svn.dealii.org/trunk@19303 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/grid/grid_generator.h
deal.II/deal.II/include/grid/tria_boundary_lib.h
deal.II/doc/doxygen/images/cone_2d.png [new file with mode: 0644]
deal.II/doc/doxygen/images/cone_3d.png [new file with mode: 0644]

index 39ef2464203baa06f7c485dfdc6b52956e515b9e..311ab03e5db6a13a3ce260b49b296d4c8057c1ea 100644 (file)
@@ -465,6 +465,12 @@ class GridGenerator
                                       * face and 2 for the right hand
                                       * face.
                                       *
+                                     * An example of use can be found in the
+                                     * documentation of the ConeBoundary
+                                     * class, with which you probably want to
+                                     * associate boundary indicator 0 (the
+                                     * hull of the cone).
+                                     * 
                                       * @note The triangulation needs to be
                                       * void upon calling this
                                       * function.
index 0c094060ad49f1a2c7eba444f5463cf9c1f3b9d3..3348509c97e9e0bf825c2c3d3a66ff39b2807cc9 100644 (file)
@@ -201,6 +201,23 @@ class CylinderBoundary : public StraightBoundary<dim>
  * Boundary, which would seem natural, since this way we can use the
  * StraightBoundary::in_between() function.
  *
+ * As an example of use, consider the following code snippet:
+ * @code
+ *  Triangulation<dim> triangulation;
+ *  GridGenerator::truncated_cone (triangulation);
+ *  Point<dim> p1, p2;
+ *  p1[0] = -1;
+ *  p2[0] = 1;
+ *  const ConeBoundary<dim> boundary (1, 0.5, p1, p2);
+ *  triangulation.set_boundary (0, boundary);
+ *  triangulation.refine_global (2);
+ * @endcode
+ * This will produce the following meshes after the two
+ * refinements we perform, in 2d and 3d, respectively:
+ *
+ * @image html cone_2d.png
+ * @image html cone_3d.png
+ *
  * @author Markus B&uuml;rg, 2009
  */
 template <int dim>
diff --git a/deal.II/doc/doxygen/images/cone_2d.png b/deal.II/doc/doxygen/images/cone_2d.png
new file mode 100644 (file)
index 0000000..802db1d
Binary files /dev/null and b/deal.II/doc/doxygen/images/cone_2d.png differ
diff --git a/deal.II/doc/doxygen/images/cone_3d.png b/deal.II/doc/doxygen/images/cone_3d.png
new file mode 100644 (file)
index 0000000..cf187fb
Binary files /dev/null and b/deal.II/doc/doxygen/images/cone_3d.png differ

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.