]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update solver Vector documentation. 10605/head
authorDoug Shi-Dong <doug.shidong@gmail.com>
Thu, 25 Jun 2020 23:18:22 +0000 (19:18 -0400)
committerDoug Shi-Dong <doug.shidong@gmail.com>
Thu, 25 Jun 2020 23:49:48 +0000 (19:49 -0400)
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

include/deal.II/lac/solver.h

index d58005469c57c2c11c7c4c874b6ae16763364038..f068fc8b1f3cf26a01db52c24859f8ea71af20b1 100644 (file)
@@ -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);
  *

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.