From d5415d37d39bd2265147444d00a36dcb35ca1063 Mon Sep 17 00:00:00 2001 From: Martin Kronbichler Date: Tue, 5 Jan 2016 18:44:41 +0100 Subject: [PATCH] Augment documentation --- include/deal.II/multigrid/mg_transfer.h | 26 +++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/include/deal.II/multigrid/mg_transfer.h b/include/deal.II/multigrid/mg_transfer.h index 89e3f57360..2dc701135f 100644 --- a/include/deal.II/multigrid/mg_transfer.h +++ b/include/deal.II/multigrid/mg_transfer.h @@ -460,10 +460,36 @@ public: template void build_matrices (const DoFHandler &mg_dof); + /** + * Prolongate a vector from level to_level-1 to level + * to_level using the embedding matrices of the underlying finite + * element. The previous content of dst is overwritten. + * + * @arg src is a vector with as many elements as there are degrees of + * freedom on the coarser level involved. + * + * @arg dst has as many elements as there are degrees of freedom on the + * finer level. + */ virtual void prolongate (const unsigned int to_level, VectorType &dst, const VectorType &src) const; + /** + * Restrict a vector from level from_level to level + * from_level-1 using the transpose operation of the @p prolongate + * method. If the region covered by cells on level from_level is + * smaller than that of level from_level-1 (local refinement), then + * some degrees of freedom in dst are active and will not be + * altered. For the other degrees of freedom, the result of the restriction + * is added. + * + * @arg src is a vector with as many elements as there are degrees of + * freedom on the finer level involved. + * + * @arg dst has as many elements as there are degrees of freedom on the + * coarser level. + */ virtual void restrict_and_add (const unsigned int from_level, VectorType &dst, const VectorType &src) const; -- 2.39.5