]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Adding cell_hint to GridTools::compute_point_locations documentation 7724/head
authorGiovanni Alzetta <giovannialzetta@hotmail.it>
Wed, 13 Feb 2019 08:30:53 +0000 (09:30 +0100)
committerGiovanni Alzetta <giovannialzetta@hotmail.it>
Wed, 13 Feb 2019 08:33:28 +0000 (09:33 +0100)
include/deal.II/grid/grid_tools.h

index 3a89f434b7519809a36afc5ce484b87d855b192d..420ec05376d567b06891a8fbdd387005b07cd814 100644 (file)
@@ -698,6 +698,8 @@ namespace GridTools
    *
    * @param[in] cache The triangulation's GridTools::Cache .
    * @param[in] points The point's vector.
+   * @param[in] cell_hint (optional) A cell iterator for a cell which likely
+   * contains the first point of @p points.
    *
    * @return A tuple containing the following information:
    *  - Cells, is a vector of a vector cells of the all cells

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.