From: Luca Heltai <luca.heltai@sissa.it>
Date: Thu, 22 Dec 2022 08:24:45 +0000 (+0100)
Subject: Make the documentation clear about what the assign function does.
X-Git-Tag: v9.5.0-rc1~621^2~6
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a157e95f1e0bab3f3d8aec7fb220b955ea585aa5;p=dealii.git

Make the documentation clear about what the assign function does.
---

diff --git a/include/deal.II/lac/petsc_block_vector.h b/include/deal.II/lac/petsc_block_vector.h
index ab8e92d32e..71d9589053 100644
--- a/include/deal.II/lac/petsc_block_vector.h
+++ b/include/deal.II/lac/petsc_block_vector.h
@@ -155,8 +155,12 @@ namespace PETScWrappers
       operator=(const BlockVector &V);
 
       /**
-       * This method assigns the PETSc Vec to the instance of the class.
+       * This method assigns the given PETSc Vec to the instance of the class.
        *
+       * Note that the vector is not copied: instead, the instance of this class
+       * is initialized to use the given vector. This is useful if you want to
+       * interpret a PETSc vector as a deal.II vector, and you already have a
+       * BlockVector that you want to use for this purpose.
        */
       void
       assign_petsc_vector(Vec v);