]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Augment documentation.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Sun, 20 Mar 2005 21:26:03 +0000 (21:26 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Sun, 20 Mar 2005 21:26:03 +0000 (21:26 +0000)
git-svn-id: https://svn.dealii.org/trunk@10191 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/grid/tria_accessor.h

index a2908ea61512a52f57e350a30cdcb1a868fa65c9..f222ec3beb03fafcfcf709d63934a95d40130872 100644 (file)
@@ -2,7 +2,7 @@
 //    $Id$
 //    Version: $Name$
 //
-//    Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004 by the deal.II authors
+//    Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 by the deal.II authors
 //
 //    This file is subject to QPL and may not be  distributed
 //    without copyright and license information. Please refer
@@ -599,6 +599,16 @@ class TriaObjectAccessor :  public TriaAccessor<dim>
                                      * maximum number of refinement
                                      * in any branch of children of
                                      * this object.
+                                     *
+                                     * For example, if this object is
+                                     * refined, and one of its children is
+                                     * refined exactly one more time, then
+                                     * <tt>max_refinement_depth</tt> should
+                                     * return 2.
+                                     *
+                                     * If this object is not refined (i.e. it
+                                     * is active), then the return value is
+                                     * zero.
                                      */
     unsigned int max_refinement_depth () const;    
     
@@ -1064,6 +1074,16 @@ class TriaObjectAccessor<1, dim> :  public TriaAccessor<dim>
                                      * is rather the maximum number
                                      * of refinement in any branch of
                                      * children of this object.
+                                     *
+                                     * For example, if this object is
+                                     * refined, and one of its children is
+                                     * refined exactly one more time, then
+                                     * <tt>max_refinement_depth</tt> should
+                                     * return 2.
+                                     *
+                                     * If this object is not refined (i.e. it
+                                     * is active), then the return value is
+                                     * zero.
                                      */
     unsigned int max_refinement_depth () const;
     
@@ -1533,6 +1553,16 @@ class TriaObjectAccessor<2, dim> :  public TriaAccessor<dim>
                                      * is rather the maximum number
                                      * of refinement in any branch of
                                      * children of this object.
+                                     *
+                                     * For example, if this object is
+                                     * refined, and one of its children is
+                                     * refined exactly one more time, then
+                                     * <tt>max_refinement_depth</tt> should
+                                     * return 2.
+                                     *
+                                     * If this object is not refined (i.e. it
+                                     * is active), then the return value is
+                                     * zero.
                                      */
     unsigned int max_refinement_depth () const;
     
@@ -2044,6 +2074,16 @@ class TriaObjectAccessor<3, dim> :  public TriaAccessor<dim>
                                      * is rather the maximum number
                                      * of refinement in any branch of
                                      * children of this object.
+                                     *
+                                     * For example, if this object is
+                                     * refined, and one of its children is
+                                     * refined exactly one more time, then
+                                     * <tt>max_refinement_depth</tt> should
+                                     * return 2.
+                                     *
+                                     * If this object is not refined (i.e. it
+                                     * is active), then the return value is
+                                     * zero.
                                      */
     unsigned int max_refinement_depth () const;    
     

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.