Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc edits for KINSol #14779

Merged
merged 1 commit into from
Feb 9, 2023
Merged

doc edits for KINSol #14779

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 11 additions & 11 deletions include/deal.II/sundials/kinsol.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -569,21 +569,21 @@ 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
* fixed point iteration strategy can be used. Notice 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). 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:
*
Expand Down