From: Wolfgang Bangerth Date: Mon, 13 Jul 2009 03:26:14 +0000 (+0000) Subject: Add to the documentation. X-Git-Tag: v8.0.0~7497 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1cfff0a441b2e19e0f4685d78b0a78b29f726428;p=dealii.git Add to the documentation. git-svn-id: https://svn.dealii.org/trunk@19062 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/deal.II/include/grid/tria.h b/deal.II/deal.II/include/grid/tria.h index c2ce29771a..cc3ce77b17 100644 --- a/deal.II/deal.II/include/grid/tria.h +++ b/deal.II/deal.II/include/grid/tria.h @@ -1767,21 +1767,19 @@ class Triangulation : public Subscriptor void set_all_refine_flags (); /** - * Refine all cells @p times - * times, by alternatingly - * calling - * set_all_refine_flags() - * and - * execute_coarsening_and_refinement(). - * This function actually starts - * the refinement process, so - * you have no way to store the - * refinement flags unless you - * overload the - * @p execute_coarsening_and_refinement - * function. + * Refine all cells @p times times, by + * alternatingly calling + * set_all_refine_flags and + * execute_coarsening_and_refinement. * - * + * The latter function may throw an + * exception if it creates cells that are + * distorted (see its documentation for + * an explanation). This exception will + * be propagated through this function if + * that happens, and you may not get the + * actual number of refinement steps in + * that case. */ void refine_global (const unsigned int times);