From 34525d365c0de756cb14f728da8a007684167ab2 Mon Sep 17 00:00:00 2001 From: Ralf Hartmann Date: Tue, 13 Dec 2005 15:31:34 +0000 Subject: [PATCH] Doc update: point out that line (quad) user_flags are used by the execute_coarsening_and_refinement function. git-svn-id: https://svn.dealii.org/trunk@11860 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/deal.II/include/grid/tria.h | 31 +++++++++++++++++++++-------- 1 file changed, 23 insertions(+), 8 deletions(-) diff --git a/deal.II/deal.II/include/grid/tria.h b/deal.II/deal.II/include/grid/tria.h index 9e5b3f69bd..2b5ac9cc27 100644 --- a/deal.II/deal.II/include/grid/tria.h +++ b/deal.II/deal.II/include/grid/tria.h @@ -943,8 +943,10 @@ struct TriaNumberCache<3> : public TriaNumberCache<2> * often necessary to use the flags in more than one function consecutively and * is then error prone to dedicate one of these to clear the flags. * - * It is recommended that a functions using the flags states so in its - * documentation. + * It is recommended that a functions using the flags states so in + * its documentation. For example, the + * execute_coarsening_and_refinement() function uses the face user + * flags. * * There is another set of user data, namely a void *, for * each line, quad, etc. You can access these user pointers through @@ -953,7 +955,8 @@ struct TriaNumberCache<3> : public TriaNumberCache<2> * the accessor classes. These pointers are not used nor changed in * many places of the library, and those classes and functions that * do use them should document this clearly; the most prominent user - * of these pointers is the Solutiontransfer class. + * of these pointers is the SolutionTransfer class which uses the + * cell->user_pointers. * * The value of these user pointers is @p NULL by default. Note that * the pointers are not inherited to children upon @@ -1905,16 +1908,22 @@ class Triangulation : public Subscriptor * The function resets all * refinement and coarsening * flags to false. It uses the - * user flags. + * line->user_flags for + * dim=2,3 and the + * quad->user_flags for + * dim=3. * * See the general docs for more * information. * * Note that this function is - * @p virtual to allow derived - * classes to insert hooks, such - * as saving refinement flags and - * the like. + * virtual to allow + * derived classes to insert + * hooks, such as saving + * refinement flags and the like + * (see e.g. the + * PersistentTriangulation + * class). */ virtual void execute_coarsening_and_refinement (); @@ -3248,6 +3257,12 @@ class Triangulation : public Subscriptor /** * Refine all cells on all levels which * were previously flagged for refinement. + * + * Note, that this function uses + * the line->user_flags + * for dim=2,3 and the + * quad->user_flags for + * dim=3. */ void execute_refinement (); -- 2.39.5