From: Wolfgang Bangerth Date: Tue, 18 Aug 2009 12:49:00 +0000 (+0000) Subject: Add pictures to the documentation. X-Git-Tag: v8.0.0~7265 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3667a60cac422013b5e8319a100058145049e363;p=dealii.git Add pictures to the documentation. git-svn-id: https://svn.dealii.org/trunk@19303 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/deal.II/include/grid/grid_generator.h b/deal.II/deal.II/include/grid/grid_generator.h index 39ef246420..311ab03e5d 100644 --- a/deal.II/deal.II/include/grid/grid_generator.h +++ b/deal.II/deal.II/include/grid/grid_generator.h @@ -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. diff --git a/deal.II/deal.II/include/grid/tria_boundary_lib.h b/deal.II/deal.II/include/grid/tria_boundary_lib.h index 0c094060ad..3348509c97 100644 --- a/deal.II/deal.II/include/grid/tria_boundary_lib.h +++ b/deal.II/deal.II/include/grid/tria_boundary_lib.h @@ -201,6 +201,23 @@ class CylinderBoundary : public StraightBoundary * 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 triangulation; + * GridGenerator::truncated_cone (triangulation); + * Point p1, p2; + * p1[0] = -1; + * p2[0] = 1; + * const ConeBoundary 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ürg, 2009 */ template diff --git a/deal.II/doc/doxygen/images/cone_2d.png b/deal.II/doc/doxygen/images/cone_2d.png new file mode 100644 index 0000000000..802db1dfe2 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 index 0000000000..cf187fbcd4 Binary files /dev/null and b/deal.II/doc/doxygen/images/cone_3d.png differ