]> https://gitweb.dealii.org/ - dealii.git/commitdiff
documentation: improve Vector reinit 17101/head
authorTimo Heister <timo.heister@gmail.com>
Mon, 3 Jun 2024 23:40:18 +0000 (19:40 -0400)
committerTimo Heister <timo.heister@gmail.com>
Mon, 3 Jun 2024 23:40:18 +0000 (19:40 -0400)
include/deal.II/lac/cuda_vector.h
include/deal.II/lac/trilinos_epetra_vector.h
include/deal.II/lac/trilinos_tpetra_vector.h
include/deal.II/lac/trilinos_vector.h

index b40b479c6d32d4a6f84131033e4f9c389cf26f5e..c8f352f211b34912e8fe8359dbf88671af8e0d2a 100644 (file)
@@ -115,8 +115,8 @@ namespace LinearAlgebra
 
       /**
        * Reinit functionality. The flag <tt>omit_zeroing_entries</tt>
-       * determines whether the vector should be filled with zero (false) or
-       * left untouched (true).
+       * determines whether the vector should be filled with zeros (`false`) or
+       * left in an undetermined state (`true`).
        */
       void
       reinit(const size_type n, const bool omit_zeroing_entries = false);
index 51136b3355a236a009375fab5299deadb9c833a4..651fefe01fc4aa8b8e928345d85f32a24cc4cbcb 100644 (file)
@@ -261,7 +261,7 @@ namespace LinearAlgebra
        * Reinit functionality. This function destroys the old vector content
        * and generates a new one based on the input partitioning. The flag
        * <tt>omit_zeroing_entries</tt> determines whether the vector should be
-       * filled with zero (false) or left untouched (true).
+       * filled with zeros (`false`) or left in an undetermined state (`true`).
        */
       void
       reinit(const IndexSet &parallel_partitioner,
index 6ea8c60346ae5828ab58108e718e1e43b4837dd0..8e44eb0b49d97ee09cd43805783b89acb3e2a211 100644 (file)
@@ -372,7 +372,7 @@ namespace LinearAlgebra
        * Reinit functionality. This function destroys the old vector content
        * and generates a new one based on the input partitioning. The flag
        * <tt>omit_zeroing_entries</tt> determines whether the vector should be
-       * filled with zero (false) or left untouched (true).
+       * filled with zeros (`false`) or left in an undetermined state (`true`).
        */
       void
       reinit(const IndexSet &parallel_partitioner,
index 48a5f9a3393238f39edca1cffcfad4363a7b019a..439ba748d5fd75a9008dc2eec83bd4d52a1f3df1 100644 (file)
@@ -530,7 +530,7 @@ namespace TrilinosWrappers
        * Reinit functionality. This function sets the calling vector to the
        * dimension and the parallel distribution of the input vector, but does
        * not copy the elements in <tt>v</tt>. If <tt>omit_zeroing_entries</tt>
-       * is not <tt>true</tt>, the elements in the vector are initialized with
+       * is <tt>false</tt>, the elements in the vector are initialized with
        * zero. If it is set to <tt>true</tt>, the vector entries are in an
        * unspecified state and the user has to set all elements. In the
        * current implementation, this method does not touch the vector entries

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.