]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Add a reference to step-70.
authorWolfgang Bangerth <bangerth@colostate.edu>
Mon, 18 May 2020 23:06:31 +0000 (17:06 -0600)
committerMatthias Maier <tamiko@43-1.org>
Tue, 19 May 2020 01:21:30 +0000 (20:21 -0500)
include/deal.II/numerics/rtree.h

index 59f1f822e29e2492f1de6d5bcdc6883f5a343634..26c424ab97668bda1ae68a1e172c8c681a7d0e05 100644 (file)
@@ -149,9 +149,11 @@ RTree<typename LeafTypeIterator::value_type, IndexType>
 pack_rtree(const LeafTypeIterator &begin, const LeafTypeIterator &end);
 
 /**
- * Construct the correct RTree object by passing an STL container type.
+ * Construct an RTree object by passing an STL container type.
+ * This function is used in step-70.
  *
- * Notice that the order of the parameters is the opposite with respect to the
+ * Notice that the order of the template parameters is the opposite with respect
+ * to the
  * RTree class, since we can automatically infer the @p LeafType from the
  * arguments, and we only need to specify the @p IndexType if the default is not
  * adequate.
@@ -259,7 +261,7 @@ struct ExtractLevelVisitor
  * Given a RTree object @p rtree, and a target level @p level, return a vector
  * of BoundingBox objects containing all the bounding boxes that make the given
  * @p level of the @p rtree. This function is a convenient wrapper around the
- * ExtractLevelVisitor class.
+ * ExtractLevelVisitor class. It is used in step-70.
  *
  * Since an RTree object is a balanced tree, you can expect each entry of the
  * resulting vector to contain roughly the same number of children, and

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.