]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Add note on template parameter to GridTools::get_active_neighbors. 9108/head
authorSimon Sticko <simon@sticko.se>
Thu, 28 Nov 2019 10:06:19 +0000 (11:06 +0100)
committerSimon Sticko <simon@sticko.se>
Thu, 28 Nov 2019 10:10:27 +0000 (11:10 +0100)
include/deal.II/grid/grid_tools.h

index 6d5b276837d6eb635f26d20fbf40d48cd118db8d..175c0b55b1909ad5dadb412d50887159c0cabc54 100644 (file)
@@ -1392,6 +1392,13 @@ namespace GridTools
    * @param[in] cell An iterator pointing to a cell of the mesh.
    * @param[out] active_neighbors A list of active descendants of the given
    * cell
+   *
+   * @note Since in C++ the MeshType template argument can not be deduced from
+   * a function call, you will have to specify it after the function name, as
+   * for example in
+   * @code
+   *   GridTools::get_active_neighbors<DoFHandler<dim>>(cell, active_neighbors)
+   * @endcode
    */
   template <class MeshType>
   void

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.