Skip to content

Commit 513eef6

Browse files
committed
Add a note on the return codes
1 parent c86413c commit 513eef6

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/src/basics/NonlinearSolution.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,14 @@
33
```@docs
44
SciMLBase.NonlinearSolution
55
```
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

Comments
 (0)