From: Timo Heister Date: Mon, 28 Nov 2016 16:38:42 +0000 (-0500) Subject: clarify doc for compute_nonzero_normal_flux_constraints X-Git-Tag: v8.5.0-rc1~357^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8c7519a657270d59f68b8fae9423947a46ba2f45;p=dealii.git clarify doc for compute_nonzero_normal_flux_constraints --- diff --git a/include/deal.II/numerics/vector_tools.h b/include/deal.II/numerics/vector_tools.h index 24c1fe87ea..7e22e5e1c5 100644 --- a/include/deal.II/numerics/vector_tools.h +++ b/include/deal.II/numerics/vector_tools.h @@ -1686,8 +1686,11 @@ namespace VectorTools * function multiple times with only one boundary indicator, or whether we * call the function once with the whole set of boundary indicators at once. * - * The fourth parameter describes the boundary function that is used for - * computing these constraints. + * Argument four (@p function_map) describes the boundary function $\vec u_\Gamma$ + * for each boundary id. The function function_map[id] + * is used on boundary with id @p id taken from the set @p boundary_ids. + * Each function in @p function_map is expected to have @p dim + * components, which are used independent of @p first_vector_component. * * The mapping argument is used to compute the boundary points at which the * function needs to request the normal vector $\vec n$ from the boundary