Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Trust Region docstrings improvement #197

Merged
merged 6 commits into from
Jul 30, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/trustRegion.jl
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,11 @@ for large-scale and numerically-difficult nonlinear systems.
preconditioners. For more information on specifying preconditioners for LinearSolve
algorithms, consult the
[LinearSolve.jl documentation](https://docs.sciml.ai/LinearSolve/stable/).
- `radius_update_scheme`: the choice of radius update scheme to be used. Defaults to `RadiusUpdateSchemes.Simple`
which follows the conventional approach. Other available schemes are `RadiusUpdateSchemes.Hei`,
`RadiusUpdateSchemes.Yuan`, `RadiusUpdateSchemes.Bastin`, `RadiusUpdateSchemes.Fan`. These schemes
have the trust region radius converging to zero that is seen to improve convergence. For more details, see the
[Yuan, Yx](https://link.springer.com/article/10.1007/s10107-015-0893-2#Sec4).
- `max_trust_radius`: the maximal trust region radius.
Defaults to `max(norm(fu), maximum(u) - minimum(u))`.
- `initial_trust_radius`: the initial trust region radius. Defaults to
Expand Down