]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Add a note to the documentation. 5309/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Tue, 24 Oct 2017 04:24:14 +0000 (22:24 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Tue, 24 Oct 2017 04:36:23 +0000 (22:36 -0600)
include/deal.II/numerics/vector_tools.h

index 2fa2ba5250f0b6bcf93f0a5a5f12acda88847a97..f11f72611707a571e7b9b137bd9f1ddad82dc6eb 100644 (file)
@@ -949,7 +949,9 @@ namespace VectorTools
    * be handled by this function and corresponding boundary value functions.
    * The keys of this map correspond to the number @p boundary_id of the face.
    * numbers::internal_face_boundary_id is an illegal value for this key since
-   * it is reserved for interior faces.
+   * it is reserved for interior faces. For an example of how to use this
+   * argument with a non-empty map, see the step-16 tutorial program. (Note
+   * that the argument type is equal to the FunctionMap type.)
    *
    * The flags in the last parameter, @p component_mask denote which
    * components of the finite element space shall be interpolated. If it is

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.