From: Wolfgang Bangerth Date: Tue, 3 Oct 2017 19:27:46 +0000 (-0600) Subject: Doc update for GridTools::compute_bounding_box(). X-Git-Tag: v9.0.0-rc1~996^2~1 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1805fbe2f0a13c74f4578dbe8ae03b78cce56088;p=dealii.git Doc update for GridTools::compute_bounding_box(). --- diff --git a/include/deal.II/grid/grid_tools.h b/include/deal.II/grid/grid_tools.h index 89eafb28b4..de1df60ede 100644 --- a/include/deal.II/grid/grid_tools.h +++ b/include/deal.II/grid/grid_tools.h @@ -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 std::pair< Point, Point >