You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/basics/common_solver_opts.md
+89-1Lines changed: 89 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,6 @@ The following are the options these algorithms take, along with their defaults.
12
12
`A` and `b` can be written to and changed by the solver algorithm. When fields are `nothing`
13
13
the default behavior is used, which is to default to `true` when the algorithm is known
14
14
not to modify the matrices, and false otherwise.
15
-
-`verbose`: Whether to print extra information. Defaults to `false`.
16
15
-`assumptions`: Sets the assumptions of the operator in order to effect the default
17
16
choice algorithm. See the [Operator Assumptions page for more details](@ref assumptions).
18
17
@@ -26,3 +25,92 @@ solve completely. Error controls only apply to iterative solvers.
26
25
-`maxiters`: The number of iterations allowed. Defaults to `length(prob.b)`
27
26
-`Pl,Pr`: The left and right preconditioners, respectively. For more information,
28
27
see [the Preconditioners page](@ref prec).
28
+
29
+
## Verbosity Controls
30
+
31
+
The verbosity system in LinearSolve.jl provides fine-grained control over the diagnostic messages, warnings, and errors that are displayed during the solution of linear systems.
32
+
33
+
The verbosity system is organized hierarchically into three main categories:
34
+
35
+
1. Error Control - Messages related to fallbacks and error handling
36
+
2. Performance - Messages related to performance considerations
37
+
3. Numerical - Messages related to numerical solvers and iterations
38
+
39
+
Each category can be configured independently, and individual settings can be adjusted to suit your needs.
40
+
41
+
### Verbosity Levels
42
+
The following verbosity levels are available:
43
+
44
+
#### Individual Settings
45
+
These settings are meant for individual settings within a category. These can also be used to set all of the individual settings in a group to the same value.
46
+
- Verbosity.None() - Suppress all messages
47
+
- Verbosity.Info() - Show message as log message at info level
48
+
- Verbosity.Warn() - Show warnings (default for most settings)
49
+
- Verbosity.Error() - Throw errors instead of warnings
50
+
- Verbosity.Level(n) - Show messages with a log level setting of n
51
+
52
+
#### Group Settings
53
+
These settings are meant for
54
+
- Verbosity.Default() - Use the default settings
55
+
- Verbosity.All() - Show all possible messages
56
+
57
+
### Basic Usage
58
+
59
+
#### Global Verbosity Control
60
+
61
+
```julia
62
+
using LinearSolve
63
+
64
+
# Suppress all messages
65
+
verbose =LinearVerbosity(Verbosity.None())
66
+
prob =LinearProblem(A, b)
67
+
sol =solve(prob; verbose=verbose)
68
+
69
+
# Show all messages
70
+
verbose =LinearVerbosity(Verbosity.All())
71
+
sol =solve(prob; verbose=verbose)
72
+
73
+
# Use default settings
74
+
verbose =LinearVerbosity(Verbosity.Default())
75
+
sol =solve(prob; verbose=verbose)
76
+
```
77
+
78
+
#### Group Level Control
79
+
80
+
```julia
81
+
# Customize by category
82
+
verbose =LinearVerbosity(
83
+
error_control = Verbosity.Warn(), # Show warnings for error control related issues
0 commit comments