From 5d149311d1e3b382dc49f3d5b0473a5acd1bf9f7 Mon Sep 17 00:00:00 2001 From: wolf Date: Thu, 4 Nov 2004 14:13:17 +0000 Subject: [PATCH] Fix documentation. git-svn-id: https://svn.dealii.org/trunk@9747 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/deal.II/include/grid/grid_generator.h | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/deal.II/deal.II/include/grid/grid_generator.h b/deal.II/deal.II/include/grid/grid_generator.h index bd07bcf03e..c45842f9af 100644 --- a/deal.II/deal.II/include/grid/grid_generator.h +++ b/deal.II/deal.II/include/grid/grid_generator.h @@ -436,9 +436,17 @@ class GridGenerator /** * Initialize the given * Triangulation with a hypercube - * with a slit. The slit goes - * from (x=0,y=-1) to - * (0,0) in 2d. + * with a slit. In each + * coordinate direction, the + * hypercube extends from @p left + * to @p right. + * + * In 2d, the split goes in + * vertical direction from + * x=(left+right)/2, + * y=left to the center of + * the square at + * x=y=(left+right)/2. * * The triangulation needs to be * void upon calling this @@ -448,7 +456,7 @@ class GridGenerator * exist for triangulations of * all space dimensions, but * throws an error if called in - * 1d. It is also not presently + * 1d. It is also presently not * implemented in 3d. */ static void hyper_cube_slit (Triangulation<1> &tria, -- 2.39.5