Skip to content

Commit d6c8312

Browse files
jClugstorChrisRackauckas
authored andcommitted
add some docs
1 parent 6d917ff commit d6c8312

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

docs/src/basics/solve.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,32 @@ These are exclusively available for native `NonlinearSolve.jl` solvers.
3636
level of detail of the trace. (Defaults to `TraceMinimal()`)
3737
- `store_trace`: Must be `Val(true)` or `Val(false)`. This controls whether the trace is
3838
stored in the solution object. (Defaults to `Val(false)`)
39+
40+
## Verbosity Controls
41+
42+
NonlinearSolve.jl provides fine-grained control over diagnostic messages, warnings, and errors
43+
through the `verbose` keyword argument. The verbosity system allows you to control what
44+
information is displayed during the solve process. See [SciMLLogging.jl](https://docs.sciml.ai/SciMLLogging/dev/) for more details.
45+
46+
```@docs
47+
NonlinearVerbosity
48+
```
49+
50+
### Quick Start
51+
52+
```julia
53+
# Use a preset
54+
solve(prob, alg; verbose = NonlinearVerbosity(SciMLLogging.Standard()))
55+
56+
# Silence all messages
57+
solve(prob, alg; verbose = NonlinearVerbosity(SciMLLogging.None()))
58+
59+
# Maximum verbosity
60+
solve(prob, alg; verbose = NonlinearVerbosity(SciMLLogging.All()))
61+
62+
# Custom configuration
63+
solve(prob, alg; verbose = NonlinearVerbosity(
64+
alias_u0_immutable = SciMLLogging.WarnLevel(),
65+
threshold_state = SciMLLogging.InfoLevel()
66+
))
67+
```

0 commit comments

Comments
 (0)