From 6e1212fe73adf46b6780fb72a6ea6cc9297184d7 Mon Sep 17 00:00:00 2001 From: Sean Ingimarson Date: Thu, 9 Feb 2023 08:31:20 -0500 Subject: [PATCH] doc edits for KINSol --- include/deal.II/sundials/kinsol.h | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/include/deal.II/sundials/kinsol.h b/include/deal.II/sundials/kinsol.h index 49475b63c6..2bbc4465fb 100644 --- a/include/deal.II/sundials/kinsol.h +++ b/include/deal.II/sundials/kinsol.h @@ -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: * -- 2.39.5