From: Wolfgang Bangerth Date: Thu, 1 Nov 2018 16:54:30 +0000 (-0600) Subject: Clarify the documentation of GridGenerator::cylinder(). X-Git-Tag: v9.1.0-rc1~586^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F7405%2Fhead;p=dealii.git Clarify the documentation of GridGenerator::cylinder(). --- diff --git a/include/deal.II/grid/grid_generator.h b/include/deal.II/grid/grid_generator.h index 5c61e0faaa..81e4ef5085 100644 --- a/include/deal.II/grid/grid_generator.h +++ b/include/deal.II/grid/grid_generator.h @@ -713,13 +713,16 @@ namespace GridGenerator const double radius = 1.); /** - * Create a cylinder around the $x$-axis. The cylinder extends from - * x=-half_length to x=+half_length and its projection - * into the @p yz-plane is a circle of radius @p radius. - * - * In two dimensions, the cylinder is a rectangle from - * x=-half_length to x=+half_length and from - * y=-radius to y=radius. + * Create a @p dim dimensional cylinder where the $x$-axis serves as + * the axis of the cylinder. For the purposes of this function, a + * cylinder is defined as a (@p dim - 1) dimensional disk of given + * @p radius, extruded along the axis of the cylinder (which is the + * first coordinate direction). Consequently, in three dimensions, + * the cylinder extends from `x=-half_length` to `x=+half_length` + * and its projection into the @p yz-plane is a circle of radius @p + * radius. In two dimensions, the cylinder is a rectangle from + * `x=-half_length` to `x=+half_length` and from `y=-radius` to + * `y=radius`. * * The boundaries are colored according to the following scheme: 0 for the * hull of the cylinder, 1 for the left hand face and 2 for the right hand