Skip to content

Commit

Permalink
docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
DanielDoehring committed Feb 25, 2024
1 parent 7357360 commit 110bac7
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/callbacks_step/nan.jl
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
NaNCallback(analysis_interval=0, nan_interval=analysis_interval÷10)
Callback checking for NaNs in the solution vector `u` every `nan_interval`.
This should be used when using `Trixi.solve` to solve the ODEs.
If `analysis_interval ≂̸ 0`, the output is omitted every
`analysis_interval` time steps.
This should be used when using `Trixi.solve` to solve the ODEs as the custom
integrators do not come with the `unstable_check` of the DifferentialEquations.jl integrators.
If `analysis_interval ≂̸ 0`, the output is omitted every `analysis_interval` time steps.
"""
mutable struct NaNCallback
nan_interval::Int
Expand Down

0 comments on commit 110bac7

Please sign in to comment.