Skip to content

Commit 36361f2

Browse files
committed
add verbosity stuff
1 parent 029bd33 commit 36361f2

File tree

3 files changed

+473
-2
lines changed

3 files changed

+473
-2
lines changed

docs/src/interfaces/Verbosity.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# SciML Verbosity
2+
The SciML verbosity system is designed to make it easy for users to specify what messages are logged, and at what level they are logged at, during the solution process.
3+
4+
At the highest level are the `AbstractVerbositySpecifier` subtypes, e.g. `ODEVerbosity`, `LinearVerbosity`, and so on. These hold `group` objects that group the error messages into three broad categories. The first is error control, which contains options related to solver error control and adaptivity algorithms, such as convergence issues and correctness guarantees (e.g. `dt < dtmin)
5+
6+
At the lowest level are the `option` settings. These correspond to either individual messages or groups of messages in
7+
8+
## Verbosity Types
9+

src/SciMLBase.jl

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -637,9 +637,9 @@ abstract type AbstractAliasSpecifier end
637637
"""
638638
$(TYPEDEF)
639639
640-
Base for types which specify what will be printed during a solve.
640+
Base for types which specify which log messages are emitted at what level.
641641
"""
642-
abstract type AbstractVerbositySpecifier end
642+
abstract type AbstractVerbositySpecifier{T} end
643643

644644
"""
645645
$(TYPEDEF)
@@ -759,6 +759,8 @@ include("integrator_interface.jl")
759759
include("remake.jl")
760760
include("callbacks.jl")
761761

762+
include("verbosity.jl")
763+
762764
include("deprecated.jl")
763765

764766
import PrecompileTools

0 commit comments

Comments
 (0)