]> https://gitweb.dealii.org/ - dealii.git/commitdiff
improve FunctionMap deprecation message 9480/head
authorTimo Heister <timo.heister@gmail.com>
Wed, 5 Feb 2020 19:01:48 +0000 (14:01 -0500)
committerTimo Heister <timo.heister@gmail.com>
Thu, 6 Feb 2020 01:33:24 +0000 (20:33 -0500)
I was confused by this help message and decided to clarify. Also fix one
occurrence of FunctionMap in a code example.

include/deal.II/dofs/deprecated_function_map.h
include/deal.II/hp/refinement.h

index 522f7460012a2b9d76235ac14f948cda5fe0b908..ec641657a5806c72f3bc2643b561000503ef865c 100644 (file)
@@ -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> *>;
index cb269b75e785500a20b7f90fe84670025b0f970d..b45eb71c3d2580aabf56fcb426a782b3f16b24f3 100644 (file)
@@ -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,

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.