]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Doc update for GridTools::compute_bounding_box().
authorWolfgang Bangerth <bangerth@colostate.edu>
Tue, 3 Oct 2017 19:27:46 +0000 (13:27 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Tue, 3 Oct 2017 19:27:46 +0000 (13:27 -0600)
include/deal.II/grid/grid_tools.h

index 89eafb28b4f4d96cbfdc7dc1bff2f8acc8cad825..de1df60edeefefa2b0dcac08fb1972cc13e06cbd 100644 (file)
@@ -1111,8 +1111,14 @@ namespace GridTools
    * Here, the "subdomain" consists of exactly all of those
    * active cells for which the @p predicate returns @p true.
    *
-   * For a description of how predicate works,
-   * see compute_active_cell_halo_layer()
+   * For a description of how @p predicate works,
+   * see compute_active_cell_halo_layer().
+   *
+   * @note This function was written before the BoundingBox class was invented.
+   *   Consequently, it returns a pair of points, rather than a BoundingBox object
+   *   as one may expect. However, BoundingBox has a conversion constructor from
+   *   pairs of points, so the result of this function can still be assigned to
+   *   a BoundingBox object.
    */
   template <class MeshType>
   std::pair< Point<MeshType::space_dimension>, Point<MeshType::space_dimension> >

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.