We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent c86413c commit 513eef6Copy full SHA for 513eef6
docs/src/basics/NonlinearSolution.md
@@ -3,3 +3,14 @@
3
```@docs
4
SciMLBase.NonlinearSolution
5
```
6
+
7
+## Return Code
8
9
+ - `ReturnCode.Success` - The nonlinear solve succeeded.
10
+ - `ReturnCode.ConvergenceFailure` - The nonlinear solve failed to converge due to stalling
11
+ or some limit of the solver was exceeded. For example, too many shrinks for trust
12
+ region methods, number of resets for Broyden, etc.
13
+ - `ReturnCode.Unstable` - This corresponds to
14
+ `NonlinearSafeTerminationReturnCode.ProtectiveTermination` and is caused if the step-size
15
+ of the solver was too large or the objective value became non-finite.
16
+ - `ReturnCode.MaxIters` - The maximum number of iterations was reached.
0 commit comments