]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Doc update.
authorRalf Hartmann <Ralf.Hartmann@dlr.de>
Mon, 26 Mar 2001 16:01:30 +0000 (16:01 +0000)
committerRalf Hartmann <Ralf.Hartmann@dlr.de>
Mon, 26 Mar 2001 16:01:30 +0000 (16:01 +0000)
git-svn-id: https://svn.dealii.org/trunk@4292 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/grid/persistent_tria.h

index ba4fc4f2f29615f30b0c168b4d7b0b0f8515f219..744e8f26dbc4df19f9bdd3dd4fd215603ba12b6f 100644 (file)
@@ -153,17 +153,29 @@ class PersistentTriangulation : public Triangulation<dim>
                                      * 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

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.