From: Denis Davydov <davydden@gmail.com>
Date: Wed, 13 Dec 2017 13:03:15 +0000 (+0100)
Subject: improve documentation of p::d::SolutionTransfer when used with LA::d::Vector
X-Git-Tag: v9.0.0-rc1~661^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0e3dbd70d5245dbb027766291c8dada2de6c7a8b;p=dealii.git

improve documentation of p::d::SolutionTransfer when used with LA::d::Vector
---

diff --git a/include/deal.II/distributed/solution_transfer.h b/include/deal.II/distributed/solution_transfer.h
index 17f18729dc..c6e47e1912 100644
--- a/include/deal.II/distributed/solution_transfer.h
+++ b/include/deal.II/distributed/solution_transfer.h
@@ -46,7 +46,8 @@ namespace parallel
      * so that all locally_active elements can be read. On the other hand,
      * ghosted vectors are generally not writable, so for calls to
      * interpolate() or deserialize() you need to supply distributed vectors
-     * without ghost elements.
+     * without ghost elements. More precisely, during interpolation the
+     * current algorithm writes into all locally active degrees of freedom.
      *
      * <h3>Transferring a solution</h3> Here VectorType is your favorite
      * vector type, e.g. PETScWrappers::MPI::Vector,
@@ -74,6 +75,15 @@ namespace parallel
      * soltrans.interpolate(interpolated_solution);
      * @endcode
      *
+     * Different from PETSc and Trilinos vectors, LinearAlgebra::distributed::Vector
+     * allows writing into ghost elements. For a ghosted vector the
+     * interpolation step can be accomplished via
+     * @code
+     * interpolated_solution.zero_out_ghosts();
+     * soltrans.interpolate(interpolated_solution);
+     * interpolated_solution.update_ghost_values();
+     * @endcode
+     *
      * <h3>Use for Serialization</h3>
      *
      * This class can be used to serialize and later deserialize a distributed