]> https://gitweb.dealii.org/ - dealii.git/commitdiff
document PETScWrappers::Vector constructors better
authorTimo Heister <timo.heister@gmail.com>
Thu, 14 Dec 2017 03:24:02 +0000 (22:24 -0500)
committerTimo Heister <timo.heister@gmail.com>
Thu, 14 Dec 2017 03:24:02 +0000 (22:24 -0500)
include/deal.II/lac/petsc_parallel_vector.h

index f60b268149543d215edba36b9e16fd6b1dacba6a..abab4c5f870a0c46ee86bd691b98bc89428f4d21 100644 (file)
@@ -223,11 +223,16 @@ namespace PETScWrappers
                        const size_type     local_size);
 
       /**
-       * Construct a new parallel ghosted PETSc vector from an IndexSet.
-       * Note that @p local must be ascending and 1:1.
-       * The global size of the vector is determined by local.size().
-       * The global indices in @p ghost are supplied as ghost indices
-       * that can also be read locally.
+       * Construct a new parallel ghosted PETSc vector from IndexSets.
+       *
+       * Note that @p local must be ascending and 1:1, see
+       * IndexSet::is_ascending_and_one_to_one().  In particular, the DoFs in
+       * @p local need to be contiguous, meaning you can only create vectors
+       * from a DoFHandler with several finite element components if they are
+       * not reordered by component (use a PETScWrappers::BlockVector
+       * otherwise).  The global size of the vector is determined by
+       * local.size().  The global indices in @p ghost are supplied as ghost
+       * indices that can also be read locally.
        *
        * Note that the @p ghost IndexSet may be empty and that any indices
        * already contained in @p local are ignored during construction. That
@@ -244,8 +249,15 @@ namespace PETScWrappers
               const MPI_Comm &communicator);
 
       /**
-       * Construct a new parallel PETSc vector from an IndexSet. This creates
-       * a non ghosted vector.
+       * Construct a new parallel PETSc vector without ghost elements from an
+       * IndexSet.
+       *
+       * Note that @p local must be ascending and 1:1, see
+       * IndexSet::is_ascending_and_one_to_one().  In particular, the DoFs in
+       * @p local need to be contiguous, meaning you can only create vectors
+       * from a DoFHandler with several finite element components if they are
+       * not reordered by component (use a PETScWrappers::BlockVector
+       * otherwise).
        */
       explicit Vector (const IndexSet &local,
                        const MPI_Comm &communicator);

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.