]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fix documentation.
authorMartin Kronbichler <kronbichler@lnm.mw.tum.de>
Tue, 17 Oct 2017 20:29:30 +0000 (22:29 +0200)
committerMartin Kronbichler <kronbichler@lnm.mw.tum.de>
Tue, 17 Oct 2017 20:29:30 +0000 (22:29 +0200)
include/deal.II/base/partitioner.h
source/base/partitioner.inst.in

index c38b32730e70ac4695f4163c74ca799306c976e3..d211ffe1c5529dfe7dea4e1d79a997ebe0621c8c 100644 (file)
@@ -116,11 +116,11 @@ namespace Utilities
        * Allows to set the ghost indices after the constructor has been
        * called.
        *
-       * The optional parameter @p larger_ghost_index_set allows for defining
-       * an indirect addressing into a larger set of ghost indices. This setup
-       * is useful if a distributed vector is based on that larger ghost index
-       * set but only a tighter subset should be communicated according to the
-       * given index set.
+       * The optional parameter @p larger_ghost_index_set allows defining an
+       * indirect addressing into a larger set of ghost indices. This setup is
+       * useful if a distributed vector is based on that larger ghost index
+       * set but only a tighter subset should be communicated according to
+       * @p larger_ghost_index_set.
        */
       void set_ghost_indices (const IndexSet &ghost_indices,
                               const IndexSet &larger_ghost_index_set = IndexSet());
@@ -200,14 +200,13 @@ namespace Utilities
 
       /**
        * In case the partitioner was built to define ghost indices as a subset
-       * of indices in a larger set of ghosts, this set returns the numbering
-       * in terms of ranges of that range. Similar structure as in an
-       * IndexSet, but tailored to be iterated over, and some indices may be
-       * duplicates.
+       * of indices in a larger set of ghosts, this function returns the
+       * numbering in terms of ranges within that set. Similar structure as in
+       * an IndexSet, but tailored to be iterated over.
        *
        * In case the partitioner did not take a second set of ghost indices
        * into account, this subset is simply defined as the half-open interval
-       * <code>local_size(),local_size().second+n_ghost_indices()</code>.
+       * <code>[0, n_ghost_indices())</code>.
        */
       const std::vector<std::pair<unsigned int, unsigned int> > &
       ghost_indices_within_larger_ghost_set() const;
@@ -336,7 +335,7 @@ namespace Utilities
                                     std::vector<MPI_Request>       &requests) const;
 
       /**
-       * Starts the exports of the data in a locally owned array to the range
+       * Finish the exports of the data in a locally owned array to the range
        * described by the ghost indices of this class.
        *
        * This functionality is used in
@@ -348,8 +347,9 @@ namespace Utilities
                                      std::vector<MPI_Request> &requests) const;
 
       /**
-       * Imports the data on an array described by the
-       * ghost indices of this class into the locally owned array. The
+       * Starts importing the data on an array indexed by the ghost indices of
+       * this class that is later accumulated into a locally owned array with
+       * import_from_ghosted_array_finish().
        *
        * This functionality is used in
        * LinearAlgebra::distributed::Vector::compress().
@@ -363,8 +363,9 @@ namespace Utilities
                                       std::vector<MPI_Request>     &requests) const;
 
       /**
-       * Imports the data on an array described by the
-       * ghost indices of this class into the locally owned array. The
+       * Finishes importing the data from an array indexed by the ghost
+       * indices of this class into a specified locally owned array, combining
+       * the results according to the given input @p vector_operation.
        *
        * This functionality is used in
        * LinearAlgebra::distributed::Vector::compress().
index 31fd308660756f1f28d623b6ad365666c379aa17..111d4ed4777567bbd655d588a5a5fbfe00561f85 100644 (file)
@@ -17,6 +17,7 @@
 
 for (SCALAR : MPI_SCALARS)
 {
+#ifdef DEAL_II_WITH_MPI
     template void Utilities::MPI::Partitioner::export_to_ghosted_array_start<SCALAR>(const unsigned int ,
             const ArrayView<const SCALAR> &,
             const ArrayView<SCALAR> &,
@@ -34,11 +35,13 @@ for (SCALAR : MPI_SCALARS)
             const ArrayView<SCALAR> &,
             const ArrayView<SCALAR> &,
             std::vector<MPI_Request> &) const;
+#endif
 }
 
 
 for (SCALAR : COMPLEX_SCALARS)
 {
+#ifdef DEAL_II_WITH_MPI
     template void Utilities::MPI::Partitioner::export_to_ghosted_array_start<SCALAR>(const unsigned int ,
             const ArrayView<const SCALAR> &,
             const ArrayView<SCALAR> &,
@@ -56,4 +59,5 @@ for (SCALAR : COMPLEX_SCALARS)
             const ArrayView<SCALAR> &,
             const ArrayView<SCALAR> &,
             std::vector<MPI_Request> &) const;
+#endif
 }

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.