From: Daniel Arndt <daniel.arndt@iwr.uni-heidelberg.de>
Date: Mon, 18 Sep 2017 13:58:09 +0000 (+0200)
Subject: Improve documentation for copy_to_mg
X-Git-Tag: v9.0.0-rc1~1058^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=543282ddf84debf238049c890b9c47f3ebcda328;p=dealii.git

Improve documentation for copy_to_mg
---

diff --git a/include/deal.II/multigrid/mg_transfer.h b/include/deal.II/multigrid/mg_transfer.h
index 075c86c47d..04c4629928 100644
--- a/include/deal.II/multigrid/mg_transfer.h
+++ b/include/deal.II/multigrid/mg_transfer.h
@@ -154,7 +154,9 @@ public:
 
   /**
    * Transfer from a vector on the global grid to vectors defined on each of
-   * the levels separately, i.a. an @p MGVector.
+   * the levels separately for the active degrees of freedom. In particular,
+   * for a globally refined mesh only the finest level in @p dst is filled as a
+   * plain copy of @p src. All the other level objects are left untouched.
    */
   template <int dim, class InVector, int spacedim>
   void
@@ -302,7 +304,9 @@ public:
 
   /**
    * Transfer from a vector on the global grid to vectors defined on each of
-   * the levels separately, i.a. an @p MGVector.
+   * the levels separately for the active degrees of freedom. In particular, for
+   * a globally refined mesh only the finest level in @p dst is filled as a
+   * plain copy of @p src. All the other level objects are left untouched.
    */
   template <int dim, typename Number2, int spacedim>
   void
diff --git a/include/deal.II/multigrid/mg_transfer_block.h b/include/deal.II/multigrid/mg_transfer_block.h
index 2fc420bf34..2ea8d24fc9 100644
--- a/include/deal.II/multigrid/mg_transfer_block.h
+++ b/include/deal.II/multigrid/mg_transfer_block.h
@@ -228,7 +228,10 @@ public:
                                  const BlockVector<number> &src) const;
 
   /**
-   * Transfer from a vector on the global grid to a multilevel vector.
+   * Transfer from a vector on the global grid to a multilevel vector for the
+   * active degrees of freedom. In particular, for a globally refined mesh only
+   * the finest level in @p dst is filled  as a plain copy of @p src. All the
+   * other level objects are left untouched.
    *
    * The action for discontinuous elements is as follows: on an active mesh
    * cell, the global vector entries are simply copied to the corresponding
@@ -356,7 +359,9 @@ public:
 
   /**
    * Transfer a single block from a vector on the global grid to a multilevel
-   * vector.
+   * vector for the active degrees of freedom. In particular, for a globally
+   * refined mesh only the finest level in @p dst is filled as a plain copy of
+   * @p src. All the other level objects are left untouched.
    */
   template <int dim, typename number2, int spacedim>
   void
@@ -389,7 +394,10 @@ public:
 
   /**
    * Transfer a block from a vector on the global grid to multilevel vectors.
-   * Only the block selected is transfered.
+   * Only the values for the active degrees of freedom of the block selected are
+   * transfered. In particular, for a globally refined mesh only the finest
+   * level in @p dst is filled as a plain copy of @p src. All the other level
+   * objects are left untouched.
    */
   template <int dim, typename number2, int spacedim>
   void
diff --git a/include/deal.II/multigrid/mg_transfer_component.h b/include/deal.II/multigrid/mg_transfer_component.h
index 16506f7cca..b0fb551b03 100644
--- a/include/deal.II/multigrid/mg_transfer_component.h
+++ b/include/deal.II/multigrid/mg_transfer_component.h
@@ -242,7 +242,10 @@ public:
                                  const Vector<number> &src) const;
 
   /**
-   * Transfer from a vector on the global grid to a multilevel vector.
+   * Transfer from a vector on the global grid to a multilevel vector for the
+   * active degrees of freedom. In particular, for a globally refined mesh only
+   * the finest level in @p dst is filled as a plain copy of @p src. All the
+   * other level objects are left untouched.
    */
   template <int dim, typename number2, int spacedim>
   void
@@ -274,7 +277,10 @@ public:
                     const MGLevelObject<Vector<number> > &src) const;
 
   /**
-   * Transfer from a vector on the global grid to multilevel vectors.
+   * Transfer from a vector on the global grid to a multilevel vector for the
+   * active degrees of freedom. In particular, for a globally refined mesh only
+   * the finest level in @p dst is filled as a plain copy of @p src. All the
+   * other level objects are left untouched.
    */
   template <int dim, typename number2, int spacedim>
   void
diff --git a/include/deal.II/multigrid/mg_transfer_matrix_free.h b/include/deal.II/multigrid/mg_transfer_matrix_free.h
index 2f5eecfa4c..ddb94109c9 100644
--- a/include/deal.II/multigrid/mg_transfer_matrix_free.h
+++ b/include/deal.II/multigrid/mg_transfer_matrix_free.h
@@ -329,7 +329,10 @@ public:
 
   /**
    * Transfer from a block-vector on the global grid to block-vectors defined
-   * on each of the levels separately.
+   * on each of the levels separately for active degrees of freedom.
+   * In particular, for a globally refined mesh only the finest level in @p dst
+   * is filled as a plain copy of @p src. All the other level objects are left
+   * untouched.
    *
    * This function will initialize @p dst accordingly if needed as required by
    * the Multigrid class.