From: Doug Shi-Dong <doug.shidong@gmail.com>
Date: Thu, 25 Jun 2020 23:18:22 +0000 (-0400)
Subject: Update solver Vector documentation.
X-Git-Tag: v9.3.0-rc1~1366^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F10605%2Fhead;p=dealii.git

Update solver Vector documentation.

Requires 2 more function definition for GMRES and PreconditionIdentity.
Vector & operator = (const double a)
Vector & operator = (const Vector &x)

See https://github.com/dealii/dealii/blob/301fce157e88add9a6a41e307d7cc5767b679cf1/include/deal.II/lac/solver_gmres.h#L1013
See https://github.com/dealii/dealii/blob/301fce157e88add9a6a41e307d7cc5767b679cf1/include/deal.II/lac/precondition.h#L1273
---

diff --git a/include/deal.II/lac/solver.h b/include/deal.II/lac/solver.h
index d58005469c..f068fc8b1f 100644
--- a/include/deal.II/lac/solver.h
+++ b/include/deal.II/lac/solver.h
@@ -83,6 +83,9 @@ class Vector;
  * class Vector
  * {
  *   public:
+ *     // Define value type of the entries
+ *     using value_type = double;
+ *
  *     // Resize the current object to have the same size and layout as
  *     // the model_vector argument provided. The second argument
  *     // indicates whether to clear the current object after resizing.
@@ -93,6 +96,13 @@ class Vector;
  *     // Inner product between the current object and the argument.
  *     double operator * (const Vector &v) const;
  *
+ *     // Set all the vector entries to a constant scalar.
+ *     Vector & operator = (const double a);
+ *
+ *     // Deep copy of the vector.
+ *     // Important if Vector contains pointers to data to duplicate data.
+ *     Vector & operator = (const Vector &x);
+ *
  *     // Addition of vectors
  *     void add (const Vector &x);
  *