From: Ralf Hartmann Date: Mon, 26 Mar 2001 16:01:30 +0000 (+0000) Subject: Doc update. X-Git-Tag: v8.0.0~19488 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=abde5633c218afb872b387de193efb18901f1b8c;p=dealii.git Doc update. git-svn-id: https://svn.dealii.org/trunk@4292 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/deal.II/include/grid/persistent_tria.h b/deal.II/deal.II/include/grid/persistent_tria.h index ba4fc4f2f2..744e8f26db 100644 --- a/deal.II/deal.II/include/grid/persistent_tria.h +++ b/deal.II/deal.II/include/grid/persistent_tria.h @@ -153,17 +153,29 @@ class PersistentTriangulation : public Triangulation * succeed if this object is * newly created or @p{clear()} * was called on it before. + * + * Multiply calles the + * @p{restore(unsigned int)} + * function in a loop over all + * refinement steps. */ void restore (); /** * Differential restore. Performs - * the @p{step}th local + * the @p{step_no}th local * refinement and coarsening step. * Step 0 stands for the copying * of the coarse grid. + * + * This function will only + * succeed if the triangulation + * is in just the state it were + * if restore would have been + * called from + * @p{step=0...step_no-1} before. */ - void restore (const unsigned int step); + void restore (const unsigned int step_no); /** * Returns the number of