Skip to content

Commit 7981d35

Browse files
Merge pull request #197 from yash2798/ys/tr_doctsrings
Trust Region docstrings improvement
2 parents 25fbd71 + f76ba68 commit 7981d35

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

src/trustRegion.jl

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,11 @@ for large-scale and numerically-difficult nonlinear systems.
5858
preconditioners. For more information on specifying preconditioners for LinearSolve
5959
algorithms, consult the
6060
[LinearSolve.jl documentation](https://docs.sciml.ai/LinearSolve/stable/).
61+
- `radius_update_scheme`: the choice of radius update scheme to be used. Defaults to `RadiusUpdateSchemes.Simple`
62+
which follows the conventional approach. Other available schemes are `RadiusUpdateSchemes.Hei`,
63+
`RadiusUpdateSchemes.Yuan`, `RadiusUpdateSchemes.Bastin`, `RadiusUpdateSchemes.Fan`. These schemes
64+
have the trust region radius converging to zero that is seen to improve convergence. For more details, see the
65+
[Yuan, Yx](https://link.springer.com/article/10.1007/s10107-015-0893-2#Sec4).
6166
- `max_trust_radius`: the maximal trust region radius.
6267
Defaults to `max(norm(fu), maximum(u) - minimum(u))`.
6368
- `initial_trust_radius`: the initial trust region radius. Defaults to

0 commit comments

Comments
 (0)