]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Fix docu of patch_level_1.
authorhartmann <hartmann@0785d39b-7218-0410-832d-ea1e28bc413d>
Tue, 12 Dec 2006 09:24:13 +0000 (09:24 +0000)
committerhartmann <hartmann@0785d39b-7218-0410-832d-ea1e28bc413d>
Tue, 12 Dec 2006 09:24:13 +0000 (09:24 +0000)
git-svn-id: https://svn.dealii.org/trunk@14223 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/grid/tria.h
deal.II/deal.II/source/grid/tria.cc

index 25ad6e805b9cfd3aa300faa38023f08554e6780d..c8f721a1dd1a4e0897ea6caaa5210a781b849197 100644 (file)
@@ -793,13 +793,19 @@ namespace internal
  *     be refined after the step.
  *
  *   <li> @p patch_level_1:
- *     Ensures patch level 1. As result the triangulation consists of
- *     patches, i.e. of cells that are refined once. It follows that
- *     if at least one of the children of a cell is or will be refined
- *     than all children need to be refined. If the @p patch_level_1 flag
- *     is set, than the flags @p eliminate_unrefined_islands,
- *     @p eliminate_refined_inner_islands and
- *     @p eliminate_refined_boundary_islands will be ignored as they will
+ *     A triangulation of patch level 1 consists of patches, i.e. of
+ *     cells that are refined once. This flag ensures that a mesh of
+ *     patch level 1 is still of patch level 1 after coarsening and
+ *     refinement. It is, however, the user's responsibility to ensure
+ *     that the mesh is of patch level 1 before calling
+ *     execute_coarsening_and_refinement the first time. The easiest
+ *     way to achieve this is by calling global_refine(1) straight
+ *     after creation of the triangulation.  It follows that if at
+ *     least one of the children of a cell is or will be refined than
+ *     all children need to be refined. If the @p patch_level_1 flag
+ *     is set, than the flags @p eliminate_unrefined_islands, @p
+ *     eliminate_refined_inner_islands and @p
+ *     eliminate_refined_boundary_islands will be ignored as they will
  *     be fulfilled automatically.
  *
  *   <li> @p smoothing_on_refinement:
index 851ed5a2c77efb5740793725e792dbd62e40e4e2..d726f7037fb6064d62a10a0c7933066d1f5bf0b0 100644 (file)
@@ -7590,7 +7590,7 @@ bool Triangulation<dim>::prepare_coarsening_and_refinement ()
                                   //    need to be refined. This step
                                   //    only sets refinement flags and does
                                   //    not set coarsening flags.
-                                  //    If the path_level_1 flag is set, than
+                                  //    If the path_level_1 flag is set, then
                                   //    eliminate_unrefined_islands,
                                   //    eliminate_refined_inner_islands and
                                   //    eliminate_refined_boundary_islands will
@@ -8007,7 +8007,7 @@ bool Triangulation<dim>::prepare_coarsening_and_refinement ()
                                       //    - patch level n says that
                                       //      the triangulation consists
                                       //      of patches of level n.
-                                      //      This does make sence only
+                                      //      This makes sense only
                                       //      if the grid is already at
                                       //      least n times globally
                                       //      refined.
@@ -8030,7 +8030,7 @@ bool Triangulation<dim>::prepare_coarsening_and_refinement ()
                                           // (A) is that before
                                           // calling this function
                                           // the grid was already of
-                                          // patch level 2.
+                                          // patch level 1.
 
                                           // loop over all cells
                                           // whose children are all

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.