From: David Wells <drwells@email.unc.edu>
Date: Sat, 11 May 2019 02:48:52 +0000 (-0400)
Subject: Update documentation relative to other changes.
X-Git-Tag: v9.1.0-rc1~75^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F8087%2Fhead;p=dealii.git

Update documentation relative to other changes.

In f21656e3fd2 we switched to using LinearOperator in step-20, which
made some other references to that program no longer make sense. This
commit updates said references.
---

diff --git a/examples/step-22/step-22.cc b/examples/step-22/step-22.cc
index 5e1927c0e6..a05af51dc4 100644
--- a/examples/step-22/step-22.cc
+++ b/examples/step-22/step-22.cc
@@ -104,8 +104,11 @@ namespace Step22
   // This is an adaptation of step-20, so the main class and the data types
   // are nearly the same as used there. The only difference is that we have an
   // additional member <code>preconditioner_matrix</code>, that is used for
-  // preconditioning the Schur complement, and a corresponding sparsity pattern
-  // <code>preconditioner_sparsity_pattern</code>.
+  // preconditioning the Schur complement, and a corresponding sparsity
+  // pattern <code>preconditioner_sparsity_pattern</code>. In addition,
+  // instead of relying on LinearOperator, we implement our own InverseMatrix
+  // class.
+  //
   // In this example we also use adaptive grid refinement, which is handled
   // in analogy to step-6. According to the discussion in the introduction,
   // we are also going to use the AffineConstraints object for implementing
@@ -256,18 +259,16 @@ namespace Step22
   // introduction. Here, we create the respective objects that will be used.
 
   // @sect4{The <code>InverseMatrix</code> class template}
-
   // The <code>InverseMatrix</code> class represents the data structure for an
-  // inverse matrix. It is derived from the one in step-20. The only
-  // difference is that we now do include a preconditioner to the matrix since
-  // we will apply this class to different kinds of matrices that will require
-  // different preconditioners (in step-20 we did not use a preconditioner in
-  // this class at all). The types of matrix and preconditioner are passed to
-  // this class via template parameters, and matrix and preconditioner objects
-  // of these types will then be passed to the constructor when an
+  // inverse matrix. Unlike step-20, we implement this with a class instead of
+  // the helper function inverse_linear_operator() we will apply this class to
+  // different kinds of matrices that will require different preconditioners
+  // (in step-20 we only used a non-identity preconditioner for the mass
+  // matrix). The types of matrix and preconditioner are passed to this class
+  // via template parameters, and matrix and preconditioner objects of these
+  // types will then be passed to the constructor when an
   // <code>InverseMatrix</code> object is created. The member function
-  // <code>vmult</code> is, as in step-20, a multiplication with a vector,
-  // obtained by solving a linear system:
+  // <code>vmult</code> is obtained by solving a linear system:
   template <class MatrixType, class PreconditionerType>
   class InverseMatrix : public Subscriptor
   {
diff --git a/examples/step-31/step-31.cc b/examples/step-31/step-31.cc
index f68496993a..6f559434a6 100644
--- a/examples/step-31/step-31.cc
+++ b/examples/step-31/step-31.cc
@@ -214,7 +214,7 @@ namespace Step31
     // of (templated) class <code>PreconditionerType</code>.
     //
     // In a minor deviation from the implementation of the same class in
-    // step-22 (and step-20), we make the <code>vmult</code> function take any
+    // step-22, we make the <code>vmult</code> function take any
     // kind of vector type (it will yield compiler errors, however, if the
     // matrix does not allow a matrix-vector product with this kind of
     // vector).
diff --git a/examples/step-55/step-55.cc b/examples/step-55/step-55.cc
index d2d3e03890..928183d1b2 100644
--- a/examples/step-55/step-55.cc
+++ b/examples/step-55/step-55.cc
@@ -95,10 +95,9 @@ namespace Step55
     // This class exposes the action of applying the inverse of a giving
     // matrix via the function InverseMatrix::vmult(). Internally, the
     // inverse is not formed explicitly. Instead, a linear solver with CG
-    // is performed. This class extends the InverseMatrix class in step-20
+    // is performed. This class extends the InverseMatrix class in step-22
     // with an option to specify a preconditioner, and to allow for different
-    // vector types
-    // in the vmult function.
+    // vector types in the vmult function.
     template <class Matrix, class Preconditioner>
     class InverseMatrix : public Subscriptor
     {