From: Timo Heister Date: Mon, 3 Jun 2024 23:40:18 +0000 (-0400) Subject: documentation: improve Vector reinit X-Git-Tag: v9.6.0-rc1~213^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=970cde033b32cb3a99350ac4430b34a765c7ee74;p=dealii.git documentation: improve Vector reinit --- diff --git a/include/deal.II/lac/cuda_vector.h b/include/deal.II/lac/cuda_vector.h index b40b479c6d..c8f352f211 100644 --- a/include/deal.II/lac/cuda_vector.h +++ b/include/deal.II/lac/cuda_vector.h @@ -115,8 +115,8 @@ namespace LinearAlgebra /** * Reinit functionality. The flag omit_zeroing_entries - * 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); diff --git a/include/deal.II/lac/trilinos_epetra_vector.h b/include/deal.II/lac/trilinos_epetra_vector.h index 51136b3355..651fefe01f 100644 --- a/include/deal.II/lac/trilinos_epetra_vector.h +++ b/include/deal.II/lac/trilinos_epetra_vector.h @@ -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 * omit_zeroing_entries 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 ¶llel_partitioner, diff --git a/include/deal.II/lac/trilinos_tpetra_vector.h b/include/deal.II/lac/trilinos_tpetra_vector.h index 6ea8c60346..8e44eb0b49 100644 --- a/include/deal.II/lac/trilinos_tpetra_vector.h +++ b/include/deal.II/lac/trilinos_tpetra_vector.h @@ -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 * omit_zeroing_entries 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 ¶llel_partitioner, diff --git a/include/deal.II/lac/trilinos_vector.h b/include/deal.II/lac/trilinos_vector.h index 48a5f9a339..439ba748d5 100644 --- a/include/deal.II/lac/trilinos_vector.h +++ b/include/deal.II/lac/trilinos_vector.h @@ -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 v. If omit_zeroing_entries - * is not true, the elements in the vector are initialized with + * is false, the elements in the vector are initialized with * zero. If it is set to true, 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