]> https://gitweb.dealii.org/ - dealii.git/commitdiff
extend documentation for ::project 2883/head
authorTimo Heister <timo.heister@gmail.com>
Thu, 28 Jul 2016 12:54:54 +0000 (14:54 +0200)
committerTimo Heister <timo.heister@gmail.com>
Thu, 28 Jul 2016 12:54:54 +0000 (14:54 +0200)
include/deal.II/numerics/vector_tools.h

index a01c32c2c8cffd9be3a90023e85e4f22f37557ff..fd0fea2a37f53ef35af1b2877d2e334d85186698 100644 (file)
@@ -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 <int dim, typename VectorType, int spacedim>
   void project (const Mapping<dim, spacedim>    &mapping,

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.