From 513eef6ce154095750b9371ea77da8e041875f85 Mon Sep 17 00:00:00 2001 From: Avik Pal Date: Thu, 7 Dec 2023 16:01:40 -0500 Subject: [PATCH] Add a note on the return codes --- docs/src/basics/NonlinearSolution.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/src/basics/NonlinearSolution.md b/docs/src/basics/NonlinearSolution.md index da9886a3c..33cab954f 100644 --- a/docs/src/basics/NonlinearSolution.md +++ b/docs/src/basics/NonlinearSolution.md @@ -3,3 +3,14 @@ ```@docs SciMLBase.NonlinearSolution ``` + +## Return Code + + - `ReturnCode.Success` - The nonlinear solve succeeded. + - `ReturnCode.ConvergenceFailure` - The nonlinear solve failed to converge due to stalling + or some limit of the solver was exceeded. For example, too many shrinks for trust + region methods, number of resets for Broyden, etc. + - `ReturnCode.Unstable` - This corresponds to + `NonlinearSafeTerminationReturnCode.ProtectiveTermination` and is caused if the step-size + of the solver was too large or the objective value became non-finite. + - `ReturnCode.MaxIters` - The maximum number of iterations was reached.