Skip to content

Commit 46a4cb9

Browse files
committed
add verbosity stuff
1 parent 0ebf23e commit 46a4cb9

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
@@ -638,9 +638,9 @@ abstract type AbstractAliasSpecifier end
638638
"""
639639
$(TYPEDEF)
640640
641-
Base for types which specify what will be printed during a solve.
641+
Base for types which specify which log messages are emitted at what level.
642642
"""
643-
abstract type AbstractVerbositySpecifier end
643+
abstract type AbstractVerbositySpecifier{T} end
644644

645645
"""
646646
$(TYPEDEF)
@@ -760,6 +760,8 @@ include("integrator_interface.jl")
760760
include("remake.jl")
761761
include("callbacks.jl")
762762

763+
include("verbosity.jl")
764+
763765
include("adapt.jl")
764766

765767
include("deprecated.jl")

0 commit comments

Comments
 (0)