]> https://gitweb.dealii.org/ - dealii.git/commitdiff
doc edits for KINSol 14779/head
authorSean Ingimarson <singima@clemson.edu>
Thu, 9 Feb 2023 13:31:20 +0000 (08:31 -0500)
committerSean Ingimarson <singima@clemson.edu>
Thu, 9 Feb 2023 15:07:27 +0000 (10:07 -0500)
include/deal.II/sundials/kinsol.h

index 49475b63c6252030148ae6e0d8e99f70c6cae377..2bbc4465fb5fa4854bac836428b2746d3d2bb743 100644 (file)
@@ -517,9 +517,9 @@ namespace SUNDIALS
      * that this may not converge, or may converge very slowly.
      *
      * A call to this function should store in `dst` the result of $J^{-1}$
-     * applied to `rhs`, i.e., `J*dst = rhs`. It is the user's responsibility
-     * to set up proper solvers and preconditioners inside this function
-     * (or in the `setup_jacobian` callback above).
+     * applied to `rhs`, i.e., $J \cdot dst = rhs$. It is the user's
+     * responsibility to set up proper solvers and preconditioners inside this
+     * function (or in the `setup_jacobian` callback above).
      *
      *
      * Arguments to the function are:
@@ -569,7 +569,7 @@ namespace SUNDIALS
      * the Jacobian, then KINSOL does not call setup_jacobian() again. If, on
      * the contrary, internal KINSOL convergence tests fail, then KINSOL calls
      * setup_jacobian() again with updated vectors and coefficients so that
-     * successive calls to solve_jacobian_systems() lead to better convergence
+     * successive calls to solve_jacobian_system() lead to better convergence
      * in the Newton process.
      *
      * If you do not specify a `solve_with_jacobian` function, then only a
@@ -577,13 +577,13 @@ namespace SUNDIALS
      * converge, or may converge very slowly.
      *
      * A call to this function should store in `dst` the result of $J^{-1}$
-     * applied to `rhs`, i.e., `J*dst = rhs`. It is the user's responsibility
-     * to set up proper solvers and preconditioners inside this function
-     * (or in the `setup_jacobian` callback above). The function attached
-     * to this callback is also provided with a tolerance to the linear solver,
-     * indicating that it is not necessary to solve the linear system with
-     * the Jacobian matrix exactly, but only to a tolerance that KINSOL will
-     * adapt over time.
+     * applied to `rhs`, i.e., $J \cdot dst = rhs$. It is the user's
+     * responsibility to set up proper solvers and preconditioners inside this
+     * function (or in the `setup_jacobian` callback above). The function
+     * attached to this callback is also provided with a tolerance to the linear
+     * solver, indicating that it is not necessary to solve the linear system
+     * with the Jacobian matrix exactly, but only to a tolerance that KINSOL
+     * will adapt over time.
      *
      * Arguments to the function are:
      *

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.