From: bangerth Date: Wed, 27 Jun 2012 12:42:34 +0000 (+0000) Subject: Clarify documentation. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8fc5034f01d324f125e1d8c3292ba28ee1acf4dc;p=dealii-svn.git Clarify documentation. git-svn-id: https://svn.dealii.org/trunk@25648 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/include/deal.II/grid/grid_generator.h b/deal.II/include/deal.II/grid/grid_generator.h index 6e9ca578e1..500f5e8624 100644 --- a/deal.II/include/deal.II/grid/grid_generator.h +++ b/deal.II/include/deal.II/grid/grid_generator.h @@ -695,13 +695,21 @@ class GridGenerator /** - * Produce a quarter hyper-shell, - * i.e. the space between two circles in - * two space dimensions and the region - * between two spheres in 3d, with given - * inner and outer radius and a given - * number of elements for this initial - * triangulation. + * Produce a domain that is the + * intersection between a + * hyper-shell with given inner + * and outer radius, i.e. the + * space between two circles in + * two space dimensions and the + * region between two spheres in + * 3d, and the positive quadrant + * (in 2d) or octant (in 3d). In + * 2d, this is indeed a quarter + * of the full annulus, while the + * function is a misnomer in 3d + * because there the domain is + * not a quarter but one eighth + * of the full shell. * * If the number of initial cells is zero * (as is the default), then it is