From: Timo Heister Date: Mon, 29 Aug 2016 16:57:27 +0000 (-0400) Subject: clarify documentation of subdivided_hyper_rectangle X-Git-Tag: v8.5.0-rc1~725^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=57cf3055a1c9b880ea8ac17758712bf49af49bca;p=dealii.git clarify documentation of subdivided_hyper_rectangle --- diff --git a/include/deal.II/grid/grid_generator.h b/include/deal.II/grid/grid_generator.h index f50bdf941c..72bf924b1b 100644 --- a/include/deal.II/grid/grid_generator.h +++ b/include/deal.II/grid/grid_generator.h @@ -128,25 +128,26 @@ namespace GridGenerator * Create a coordinate-parallel brick from the two diagonally opposite * corner points @p p1 and @p p2. * - * If the @p colorize flag is @p true, the @p boundary_ids of the boundary faces are - * assigned, such that the lower one in @p x-direction is 0, the upper one - * is 1. The indicators for the surfaces in @p y-direction are 2 and 3, the - * ones for @p z are 4 and 5. This corresponds to the numbers of faces - * of the unit square of cube as laid out in the documentation of the - * GeometryInfo class. Importantly, however, in 3d colorization does not - * set @p boundary_ids of edges, but only of faces, because - * each boundary edge is shared between two faces and it is not clear how - * the boundary id of an edge should be set in that case. This may later on - * lead to problems if one wants to assign boundary or manifold objects to - * parts of the boundary with certain boundary indicators since then the - * boundary object may not apply to the edges bounding the face it is meant - * to describe. + * If the @p colorize flag is @p true, the @p boundary_ids of the boundary + * faces are assigned, such that the lower one in @p x-direction is 0, the + * upper one is 1. The indicators for the surfaces in @p y-direction are 2 + * and 3, the ones for @p z are 4 and 5. This corresponds to the numbers of + * faces of the unit square of cube as laid out in the documentation of the + * GeometryInfo class. Importantly, however, in 3d colorization does not set + * @p boundary_ids of edges, but only of faces, because each + * boundary edge is shared between two faces and it is not clear how the + * boundary id of an edge should be set in that case. This may later on lead + * to problems if one wants to assign boundary or manifold objects to parts + * of the boundary with certain boundary indicators since then the boundary + * object may not apply to the edges bounding the face it is meant to + * describe. * * Additionally, if @p colorize is @p true, material ids are assigned to the * cells according to the octant their center is in: being in the right half * space for any coordinate direction xi adds - * 2i. For instance, a cell with center point (1,-1,1) yields a material - * id 5, assuming that the center of the hyper rectangle lies at the origin. + * 2i. For instance, a cell with center point (1,-1,1) yields a + * material id 5, assuming that the center of the hyper rectangle lies at + * the origin. * * If @p dim < @p spacedim, this will create a @p dim dimensional object in * the first @p dim coordinate directions embedded into the @p spacedim @@ -163,15 +164,14 @@ namespace GridGenerator const bool colorize = false); /** - * Create a coordinate-parallel parallelepiped from the two diagonally - * opposite corner points @p p1 and @p p2. In direction @p i, - * repetitions[i] cells are generated. + * Create a coordinate-parallel brick from the two diagonally opposite + * corner points @p p1 and @p p2. The number of cells in coordinate + * direction @p i is given by the integer repetitions[i]. * * To get cells with an aspect ratio different from that of the domain, use - * different numbers of subdivisions in different coordinate directions. The - * minimum number of subdivisions in each direction is 1. @p repetitions is - * a list of integers denoting the number of subdivisions in each coordinate - * direction. + * different numbers of subdivisions, given by @p repetitions, in different + * coordinate directions. The minimum number of subdivisions in each + * direction is 1. * * If the @p colorize flag is set, the @p boundary_ids of the surfaces are * assigned, such that the lower one in @p x-direction is 0, the upper one @@ -200,15 +200,15 @@ namespace GridGenerator * @param tria The Triangulation to create. It needs to be empty upon * calling this function. * - * @param repetitions A vector of dim positive values denoting the number of - * cells to generate in that direction. + * @param repetitions A vector of @p dim positive values denoting the number + * of cells to generate in that direction. * * @param p1 First corner point. * * @param p2 Second corner opposite to @p p1. * - * @param colorize Assign different boundary ids if set to true. The - * same comments apply as for the hyper_rectangle() function. + * @param colorize Assign different boundary ids if set to true. The same + * comments apply as for the hyper_rectangle() function. * */ template @@ -224,7 +224,7 @@ namespace GridGenerator * denote the number of subdivisions in each coordinate direction, but a * sequence of step sizes for each coordinate direction. The domain will * therefore be subdivided into step_sizes[i].size() cells in - * coordinate direction i, with widths + * coordinate direction i, with width * step_sizes[i][j] for the jth cell. * * This function is therefore the right one to generate graded meshes where