From: Daniel Arndt <arndtd@ornl.gov>
Date: Fri, 18 Oct 2019 15:08:17 +0000 (-0400)
Subject: Document usage of empty copiers in WorkStream
X-Git-Tag: v9.2.0-rc1~970^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9450a72369aa54d06cc9a03cd943a643efdaba3b;p=dealii.git

Document usage of empty copiers in WorkStream
---

diff --git a/include/deal.II/base/work_stream.h b/include/deal.II/base/work_stream.h
index 1c7470f6c8..c2664c39e2 100644
--- a/include/deal.II/base/work_stream.h
+++ b/include/deal.II/base/work_stream.h
@@ -927,6 +927,10 @@ namespace WorkStream
    * copies of the <tt>ScratchData</tt> object and
    * <tt>queue_length*chunk_size</tt> copies of the <tt>CopyData</tt> object
    * are generated.
+   *
+   * @note In case the copier does not do anything, pass
+   * <code>std::function<void(const CopyData&)>()</code> as @p copier to make sure
+   * a more efficient algorithm is used internally.
    */
   template <typename Worker,
             typename Copier,
@@ -976,6 +980,10 @@ namespace WorkStream
    * copies of the <tt>ScratchData</tt> object and
    * <tt>queue_length*chunk_size</tt> copies of the <tt>CopyData</tt> object
    * are generated.
+   *
+   * @note In case the copier does not do anything, pass
+   * <code>std::function<void(const CopyData&)>()</code> as @p copier to make sure
+   * a more efficient algorithm is used internally.
    */
   template <typename Worker,
             typename Copier,
@@ -1266,6 +1274,10 @@ namespace WorkStream
    * copies of the <tt>ScratchData</tt> object and
    * <tt>queue_length*chunk_size</tt> copies of the <tt>CopyData</tt> object
    * are generated.
+   *
+   * @note In case the copier does not do anything, pass
+   * <code>std::function<void(const CopyData&)>()</code> as @p copier to make sure
+   * a more efficient algorithm is used internally.
    */
   template <typename MainClass,
             typename Iterator,