]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
document memory requirements
authorkanschat <kanschat@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 18 Oct 2010 16:01:03 +0000 (16:01 +0000)
committerkanschat <kanschat@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 18 Oct 2010 16:01:03 +0000 (16:01 +0000)
git-svn-id: https://svn.dealii.org/trunk@22368 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/base/include/base/work_stream.h

index 7771563b3a43f69b9a42efe0f322535f115da9c2..3258c800eccce192026085b0552c8dd507bc8517 100644 (file)
@@ -487,6 +487,16 @@ namespace WorkStream
                                    * stream that will be worked on by the
                                    * worker and copier functions one after
                                    * the other on the same thread.
+                                   *
+                                   * @note If your data objects are large,
+                                   * or their constructors are expensive,
+                                   * it is helpful to keep in mind
+                                   * that <tt>queue_length</tt>
+                                   * copies of the <tt>ScratchData</tt>
+                                   * object and
+                                   * <tt>queue_length*chunk_size</tt>
+                                   * copies of the <tt>CopyData</tt>
+                                   * object are generated.
                                    */
   template <typename Worker,
            typename Copier,
@@ -587,6 +597,16 @@ namespace WorkStream
                                    * stream that will be worked on by the
                                    * worker and copier functions one after
                                    * the other on the same thread.
+                                   *
+                                   * @note If your data objects are large,
+                                   * or their constructors are expensive,
+                                   * it is helpful to keep in mind
+                                   * that <tt>queue_length</tt>
+                                   * copies of the <tt>ScratchData</tt>
+                                   * object and
+                                   * <tt>queue_length*chunk_size</tt>
+                                   * copies of the <tt>CopyData</tt>
+                                   * object are generated.
                                    */
   template <typename MainClass,
            typename Iterator,

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.