From: Timo Heister <timo.heister@gmail.com>
Date: Wed, 5 Feb 2020 19:01:48 +0000 (-0500)
Subject: improve FunctionMap deprecation message
X-Git-Tag: v9.2.0-rc1~568^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=fd83d9464d0dc0558c4e9382758f14cc9d1f5af3;p=dealii.git

improve FunctionMap deprecation message

I was confused by this help message and decided to clarify. Also fix one
occurrence of FunctionMap in a code example.
---

diff --git a/include/deal.II/dofs/deprecated_function_map.h b/include/deal.II/dofs/deprecated_function_map.h
index 522f746001..ec641657a5 100644
--- a/include/deal.II/dofs/deprecated_function_map.h
+++ b/include/deal.II/dofs/deprecated_function_map.h
@@ -79,7 +79,9 @@ struct DEAL_II_DEPRECATED FunctionMap
    * (as that would ambiguate a possible constructor of this class), name it
    * in the fashion of the standard container local alias.
    *
-   * @deprecated Use the alias type directly.
+   * @deprecated Directly use the type
+   * <tt>std::map<types::boundary_id, const Function<dim, Number> *></tt>
+   * in your code instead of this alias.
    */
   using type DEAL_II_DEPRECATED =
     std::map<types::boundary_id, const Function<dim, Number> *>;
diff --git a/include/deal.II/hp/refinement.h b/include/deal.II/hp/refinement.h
index cb269b75e7..b45eb71c3d 100644
--- a/include/deal.II/hp/refinement.h
+++ b/include/deal.II/hp/refinement.h
@@ -101,11 +101,12 @@ namespace hp
    * @code
    * // step 1: flag cells for refinement or coarsening
    * Vector<float> estimated_error_per_cell (triangulation.n_active_cells());
-   * KellyErrorEstimator<dim>::estimate(hp_dof_handler,
-   *                                    QGauss<dim-1> (quadrature_points),
-   *                                    typename FunctionMap<dim>::type(),
-   *                                    solution,
-   *                                    estimated_error_per_cell);
+   * KellyErrorEstimator<dim>::estimate(
+   *     hp_dof_handler,
+   *     QGauss<dim-1> (quadrature_points),
+   *     std::map<types::boundary_id, const Function<dim, Number> *>(),
+   *     solution,
+   *     estimated_error_per_cell);
    * GridRefinement::refine_and_coarsen_fixed_fraction(triangulation,
    *                                                   estimated_error_per_cell,
    *                                                   top_fraction,