From: Wolfgang Bangerth Date: Sun, 20 Mar 2005 21:26:03 +0000 (+0000) Subject: Augment documentation. X-Git-Tag: v8.0.0~14346 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b8b9a8a8e62c6c7d7cb54ff2afdcfa19610682dd;p=dealii.git Augment documentation. git-svn-id: https://svn.dealii.org/trunk@10191 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/deal.II/include/grid/tria_accessor.h b/deal.II/deal.II/include/grid/tria_accessor.h index a2908ea615..f222ec3beb 100644 --- a/deal.II/deal.II/include/grid/tria_accessor.h +++ b/deal.II/deal.II/include/grid/tria_accessor.h @@ -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 * 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 + * max_refinement_depth 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 * 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 + * max_refinement_depth 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 * 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 + * max_refinement_depth 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 * 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 + * max_refinement_depth 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;