From: ESeNonFossiIo Date: Sat, 26 Mar 2016 23:04:41 +0000 (+0100) Subject: minor changes X-Git-Tag: v8.5.0-rc1~1168^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4d70d77df9aa41525fd041e89aee4639a2ed6ced;p=dealii.git minor changes --- diff --git a/include/deal.II/grid/grid_tools.h b/include/deal.II/grid/grid_tools.h index 15e1228cb7..ae3387ba71 100644 --- a/include/deal.II/grid/grid_tools.h +++ b/include/deal.II/grid/grid_tools.h @@ -378,14 +378,14 @@ namespace GridTools * * @param[in,out] tria Triangulation to refine. * - * @param[in] isotropic if true refine cells in each directions, otherwise + * @param[in] isotropic If true refine cells in each directions, otherwise * (default value) refine the cell in the direction that removes hanging node. * - * @param[in] max_iterations at each step only closest cells to hanging nodes + * @param[in] max_iterations At each step only closest cells to hanging nodes * are refined. The code may require a lot of iterations to to remove all * hangind nodes. @p max_iterations is the maximum number of iteration - * allowed. If @p max_iterations == 0 this function continues refining until - * there are no hanging nodes. + * allowed. If @p max_iterations == numbers::invalid_unsigned_int this + * function continues refining until there are no hanging nodes. * * @note In the case of parallel codes, this function should be combined * with GridGenerator::flatten_triangulation. @@ -401,8 +401,9 @@ namespace GridTools /** * Refine a mesh anisotropically such that the resulting mesh is composed by * cells with maximum ratio between dimensions less than @p max_ratio. - * This procedure is possibly infinite therefore it possible to set a maximum - * number of refinements, @p max_iterations. + * This procedure requires an algorithm that may not terminate. Consequently, + * it is possible to set a maximum number of iterations through the + * @p max_iterations parameter. * * Starting from a cell like this: * @image html remove_anisotropy-coarse.png @@ -412,10 +413,10 @@ namespace GridTools * * @param[in,out] tria Triangulation to refine. * - * @param[in] max_ratio maximum value allowed among the ratio between + * @param[in] max_ratio Maximum value allowed among the ratio between * the dimensions of each cell. * - * @param[in] max_iterations maximum number of iterations allowed. + * @param[in] max_iterations Maximum number of iterations allowed. * * @note In the case of parallel codes, this function should be combined * with GridGenerator::flatten_triangulation and GridTools::remove_hanging_nodes. @@ -753,8 +754,9 @@ namespace GridTools const parallel::distributed::Triangulation &triangulation); /** - * Return the highest value among ratios between dimensions of a - * @p cell. Moreover, return the dimension relative to the highest elongation. + * Return the highest value among ratios between extents in each of the + * coordinate directions of a @p cell. Moreover, return the dimension + * relative to the highest elongation. * * @param[in] cell an iterator pointing to the cell. * diff --git a/source/grid/grid_tools.cc b/source/grid/grid_tools.cc index 4b6f1a5c4e..8144bb61f5 100644 --- a/source/grid/grid_tools.cc +++ b/source/grid/grid_tools.cc @@ -3887,7 +3887,7 @@ next_cell: while ( continue_refinement && (iter < max_iterations) ) { - if (!(max_iterations == 0)) iter++; + if (max_iterations != numbers::invalid_unsigned_int) iter++; continue_refinement = false; for (cell=tria.begin_active(); cell!= endc; ++cell) @@ -3934,7 +3934,7 @@ next_cell: } } tria.execute_coarsening_and_refinement (); - }; + } } } /* namespace GridTools */