From 013509ded5b3262ded09982093ba35dabec3f9ab Mon Sep 17 00:00:00 2001 From: Daniel Arndt Date: Fri, 5 Nov 2021 11:24:39 -0400 Subject: [PATCH] Revert "Minor updates to the SUNDIALS/IDA wrappers." This reverts commit 9e8dc71be8e24e77ae3ced1a93617d938f073abf. --- include/deal.II/sundials/ida.h | 29 ++++++++--------------------- 1 file changed, 8 insertions(+), 21 deletions(-) diff --git a/include/deal.II/sundials/ida.h b/include/deal.II/sundials/ida.h index 8726e9b157..5c549b7956 100644 --- a/include/deal.II/sundials/ida.h +++ b/include/deal.II/sundials/ida.h @@ -614,10 +614,7 @@ namespace SUNDIALS set_n_iterations(const int n_iter); /** - * Return the number of iterations of the last Jacobian solve. This - * piece of information corresponds to the what the - * solve_jacobian_system_up_to_tolerance() function returns through - * its third argument. + * Return the number of iterations of the last Jacobian solve. */ int get_n_iterations() const; @@ -756,7 +753,7 @@ namespace SUNDIALS * Solve the Jacobian linear system up to a specified tolerance. This * function will be called by IDA (possibly several times) after * setup_jacobian() has been called at least once. IDA tries to do its best - * to call setup_jacobian() the minimum number of times. If convergence can + * to call setup_jacobian() the minimum amount of times. If convergence can * be achieved without updating the Jacobian, then IDA does not call * setup_jacobian() again. If, on the contrary, internal IDA convergence * tests fail, then IDA calls again setup_jacobian() with updated vectors @@ -764,7 +761,7 @@ namespace SUNDIALS * solve_jacobian_system_up_to_tolerance() lead to better convergence in the * Newton process. * - * The Jacobian $J$ should be (an approximation of) the system Jacobian + * The jacobian $J$ should be (an approximation of) the system Jacobian * \f[ * J=\dfrac{\partial G}{\partial y} = \dfrac{\partial F}{\partial y} + * \alpha \dfrac{\partial F}{\partial \dot y}. @@ -775,26 +772,18 @@ namespace SUNDIALS * @param[in] rhs The system right hand side to solve for. * @param[out] dst The solution of $J^{-1} * src$. * @param[out] n_iter the number of iterations required to solve the - * Jacobian system. This is an output argument through which the - * function can communicate how many iterations it took to solve the - * linear system, and that can then be queried from the outside using the - * get_n_iterations() function. + * jacobian system * @param[in] tolerance The tolerance with which to solve the linear system * of equations. * * A call to this function should store in `dst` the result of $J^{-1}$ - * applied to `src`, i.e., the solution of the linear system `J*dst = src`. - * It is the user's responsibility to set up proper solvers and - * preconditioners either inside this function, or already within the - * `setup_jacobian()` function. (The latter is, for example, what the - * step-77 program does: All expensive operations happen in - * `setup_jacobian()`, given that that function is called far less often - * than the current one.) + * applied to `src`, i.e., `J*dst = src`. It is the users responsibility + * to set up proper solvers and preconditioners inside this function. * * This function should return: * - 0: Success * - >0: Recoverable error (IDAReinit will be called if this happens, and - * then the last function will be attempted again). + * then last function will be attempted again * - <0: Unrecoverable error the computation will be aborted and an * assertion will be thrown. */ @@ -906,9 +895,7 @@ namespace SUNDIALS void *ida_mem; /** - * Number of iteration that were required to solve the last - * Jacobian system. This variable is set by the wrapper that calls - * `solve_jacobian_system_up_to_tolerance`. + * Number of iteration that were required to solve the last Jacobian system */ int n_iterations; -- 2.39.5