]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Document the user pointer feature.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Thu, 23 Jul 1998 14:04:51 +0000 (14:04 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Thu, 23 Jul 1998 14:04:51 +0000 (14:04 +0000)
git-svn-id: https://svn.dealii.org/trunk@455 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/Todo
deal.II/deal.II/include/grid/tria.h

index 4a93bbc95961225a9efaf9af9d3954a682768871..076f233782bedbce2a7c4700a20e88ab6bcab760 100644 (file)
@@ -123,8 +123,6 @@ Review the restruction matrices. I'm not really sure about their
   elements and they are not implemented at all for quadratic ones.
 
 
-Document the user pointer interface of the triangulation.
-
 
 
 DEAL:
index 139c931ecc4b506802008b70da66525038eb43ba..d5a8a3fe0c0d83db49372d379ab68aa615b9175b 100644 (file)
@@ -844,6 +844,19 @@ class TriaDimensionInfo<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. Just like the user flags, this field is not available for vertices,
+ *   which does no harm since the vertices have a unique and continuous number
+ *   unlike the structured objects lines and quads. You can access these user
+ *   pointers through the functions #user_pointer()#, #clear_user_pointer()#
+ *   and #set_user_pointer(p)# in the accessor classes.
+ *
+ *   You should not rely on any specific value for the user pointer if you
+ *   haven't set it yourself before. In special, the pointers are not inherited
+ *   upon refinement. In principle, all user pointers should be #NULL# pointers
+ *   at the time a line, quad, etc comes into life. #NULL# pointers are always
+ *   a good choice, since they raise an exception when being dereferenced.
+ *
  *
  *   \subsection{Boundary approximation}
  *

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.