From: Sean Ingimarson Date: Fri, 27 Jan 2023 17:45:20 +0000 (-0500) Subject: Some edits of the KINSol documentation. X-Git-Tag: v9.5.0-rc1~588^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F14744%2Fhead;p=dealii.git Some edits of the KINSol documentation. --- diff --git a/include/deal.II/sundials/kinsol.h b/include/deal.II/sundials/kinsol.h index 943ffc0c35..49475b63c6 100644 --- a/include/deal.II/sundials/kinsol.h +++ b/include/deal.II/sundials/kinsol.h @@ -161,7 +161,9 @@ namespace SUNDIALS * * Specifying residual() allows the user to use Newton and Picard strategies * (i.e., $F(u)=0$ will be solved), while specifying iteration_function(), a - * fixed point iteration will be used (i.e., $G(u)=u$ will be solved). + * fixed point iteration will be used (i.e., $G(u)=u$ will be solved). An + * error will be thrown if iteration_function() is set for Picard or + * Newton. * * If the use of a Newton or Picard method is desired, then the user should * also supply @@ -292,10 +294,10 @@ namespace SUNDIALS add_parameters(ParameterHandler &prm); /** - * The solution strategy to use. If you choose SolutionStrategy::newton - * or SolutionStrategy::linesearch, you have to provide also the function - * residual(). If you choose SolutionStrategy::picard or - * SolutionStrategy::fixed_point, you have to provide also the function + * The solution strategy to use. If you choose SolutionStrategy::newton, + * SolutionStrategy::linesearch, or SolutionStrategy::picard you have to + * provide the function residual(). If you choose + * SolutionStrategy::fixed_point, you have to provide the function * iteration_function(). */ SolutionStrategy strategy; @@ -418,8 +420,8 @@ namespace SUNDIALS /** * A function object that users should supply and that is intended to * compute the residual `dst = F(src)`. This function is only used if the - * SolutionStrategy::newton or SolutionStrategy::linesearch strategies - * were selected. + * SolutionStrategy::newton, SolutionStrategy::linesearch, or + * SolutionStrategy::picard strategies were selected. * * This function should return: * - 0: Success @@ -432,10 +434,9 @@ namespace SUNDIALS /** * A function object that users should supply and that is intended to - * compute the iteration function $G(u)$ for the fixed point and Picard + * compute the iteration function $G(u)$ for the fixed point * iteration. This function is only used if the - * SolutionStrategy::fixed_point or SolutionStrategy::picard strategies - * were selected. + * SolutionStrategy::fixed_point strategy is selected. * * This function should return: * - 0: Success