From 9393f9cdca43c75ad7779e6d66cfb08fd7fe6fdf Mon Sep 17 00:00:00 2001 From: wolf Date: Wed, 15 Sep 2004 18:55:37 +0000 Subject: [PATCH] Mention that a few places in the library actually do use the user_pointers. git-svn-id: https://svn.dealii.org/trunk@9618 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/deal.II/include/grid/tria.h | 24 +++++++++++++++--------- deal.II/doc/news/c-5.0.html | 10 ++++++++++ 2 files changed, 25 insertions(+), 9 deletions(-) diff --git a/deal.II/deal.II/include/grid/tria.h b/deal.II/deal.II/include/grid/tria.h index a821fefcf7..06d891c6dd 100644 --- a/deal.II/deal.II/include/grid/tria.h +++ b/deal.II/deal.II/include/grid/tria.h @@ -979,15 +979,20 @@ struct TriaNumberCache<3> : public TriaNumberCache<2> * It is recommended that a functions using the flags states so in its * documentation. * - * There is another set of user data, namely a void *, for each - * line, quad, etc. You can access these user pointers through the - * functions user_pointer(), clear_user_pointer() and - * set_user_pointer(p) in the accessor classes. These pointers are - * neither used nor changed by the library and are @p NULL by - * default. Thus, their handling is the sole responsibility of the - * application program. Especially, the pointers are not inherited - * to children upon refinement. Still, after a remeshing they are - * available on all cells, where they were set on the previous mesh. + * There is another set of user data, namely a void *, for + * each line, quad, etc. You can access these user pointers through + * the functions user_pointer(), + * clear_user_pointer() and set_user_pointer(p) in + * 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. + * + * The value of these user pointers is @p NULL by default. Note that + * the pointers are not inherited to children upon + * refinement. Still, after a remeshing they are available on all + * cells, where they were set on the previous mesh (unless, of + * course, overwritten by the SolutionTransfer class). * * The usual warning about the missing type safety of @p void pointers are * obviously in place here; responsibility for correctness of types etc @@ -997,6 +1002,7 @@ struct TriaNumberCache<3> : public TriaNumberCache<2> * which does no harm since the vertices have a unique and continuous number * unlike the structured objects lines and quads. * + * * @sect3{Boundary approximation} * * You can specify a boundary function for each boundary diff --git a/deal.II/doc/news/c-5.0.html b/deal.II/doc/news/c-5.0.html index 0845766976..88ad8e6883 100644 --- a/deal.II/doc/news/c-5.0.html +++ b/deal.II/doc/news/c-5.0.html @@ -326,6 +326,16 @@ inconvenience this causes.

deal.II

    +
  1. + Fixed: The documentation of the Triangulation class mentioned that no + places in the library use or touch the user pointers. That is + wrong, the SolutionTransfer class + actually does. This is now properly documented. +
    + (WB 2004/09/15) +

    +
  2. Fixed: The DerivativeApproximation::approximate_second_derivative -- 2.39.5