From: Giovanni Alzetta <giovannialzetta@hotmail.it>
Date: Wed, 13 Feb 2019 08:30:53 +0000 (+0100)
Subject: Adding cell_hint to GridTools::compute_point_locations documentation
X-Git-Tag: v9.1.0-rc1~339^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F7724%2Fhead;p=dealii.git

Adding cell_hint to GridTools::compute_point_locations documentation
---

diff --git a/include/deal.II/grid/grid_tools.h b/include/deal.II/grid/grid_tools.h
index 3a89f434b7..420ec05376 100644
--- a/include/deal.II/grid/grid_tools.h
+++ b/include/deal.II/grid/grid_tools.h
@@ -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