From 75b69765f7e3b841c33476fa2d8fd62f85983b6d Mon Sep 17 00:00:00 2001 From: Timo Heister Date: Thu, 28 Jul 2016 14:54:54 +0200 Subject: [PATCH] extend documentation for ::project --- include/deal.II/numerics/vector_tools.h | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/include/deal.II/numerics/vector_tools.h b/include/deal.II/numerics/vector_tools.h index a01c32c2c8..fd0fea2a37 100644 --- a/include/deal.II/numerics/vector_tools.h +++ b/include/deal.II/numerics/vector_tools.h @@ -771,6 +771,26 @@ namespace VectorTools * * In 1d, the default value of the boundary quadrature formula is an invalid * object since integration on the boundary doesn't happen in 1d. + * + * @note This function is not implemented for MPI parallel computations, + * see step-32 for a way to do a projection in parallel. + * + * @param mapping The mapping object to use. + * @param dof The DoFHandler the describes the finite element space to + * project into and that corresponds to @p vec. + * @param constraints Constraints to be used when assembling the mass + * matrix, typically needed when you have hanging nodes. + * @param quadrature The quadrature formula to be used for assembling the + * mass matrix. + * @param function The function to project into the finite element space. + * @param[out] vec The output vector where the projected function will be + * stored in. This vector is required to be already initialized. + * @param enforce_zero_boundary If true, @p vec will have zero boundary + * conditions. + * @param q_boundary Quadrature rule to be used if @p project_to_boundary_first + * is true. + * @param project_to_boundary_first If true, perform a projection on the + * boundary before projecting the interior of the function. */ template void project (const Mapping &mapping, -- 2.39.5