Replace u_modified! by derivative_discontinuity!

examples/tree_2d_dgsem/elixir_advection_callbacks.jl

@@ -5,7 +5,14 @@ using Trixi
 module TrixiExtensionExample
 
 using Trixi
-using OrdinaryDiffEqSSPRK: DiscreteCallback, u_modified!
+using OrdinaryDiffEqSSPRK: OrdinaryDiffEqSSPRK, DiscreteCallback
+# To keep backwards compatibility with SciMLBase v2, see
+# https://github.com/trixi-framework/Trixi.jl/pull/2918#issuecomment-4233720339
+@static if isdefined(OrdinaryDiffEqSSPRK, :derivative_discontinuity!)
+    import OrdinaryDiffEqSSPRK: derivative_discontinuity!
+else
+    const derivative_discontinuity! = OrdinaryDiffEqSSPRK.u_modified!
+end
 
 # This is an example implementation for a simple stage callback (i.e., a callable
 # that is executed after each Runge-Kutta *stage*), which records some values
@@ -67,7 +74,7 @@ function (example_callback::ExampleStepCallback)(integrator)
     push!(example_callback.max_values, max_val)
 
     # avoid re-evaluating possible FSAL stages
-    u_modified!(integrator, false)
+    derivative_discontinuity!(integrator, false)
     return nothing
 end
 

src/Trixi.jl

@@ -41,13 +41,20 @@ using Reexport: @reexport
 using MPI: MPI
 
 @reexport using SciMLBase: CallbackSet
-using SciMLBase: DiscreteCallback,
+using SciMLBase: SciMLBase, DiscreteCallback,
                  ODEProblem, ODESolution,
                  SplitODEProblem
-import SciMLBase: get_du, get_tmp_cache, u_modified!,
+import SciMLBase: get_du, get_tmp_cache,
                   init, step!, check_error,
                   get_proposed_dt, set_proposed_dt!,
                   terminate!, remake, add_tstop!, has_tstop, first_tstop
+# To keep backwards compatibility with SciMLBase v2, see
+# https://github.com/trixi-framework/Trixi.jl/pull/2918#issuecomment-4233720339
+@static if isdefined(SciMLBase, :derivative_discontinuity!)
+    import SciMLBase: derivative_discontinuity!
+else
+    const derivative_discontinuity! = SciMLBase.u_modified!
+end
 
 using DelimitedFiles: readdlm
 using Downloads: Downloads

src/callbacks_step/alive.jl

@@ -98,7 +98,7 @@ function (alive_callback::AliveCallback)(integrator)
     end
 
     # avoid re-evaluating possible FSAL stages
-    u_modified!(integrator, false)
+    derivative_discontinuity!(integrator, false)
     return nothing
 end
 end # @muladd

src/callbacks_step/amr.jl

@@ -141,7 +141,7 @@ function initialize!(cb::DiscreteCallback{Condition, Affect!}, u, t,
         iterations = 1
         while has_changed
             compute_coefficients!(integrator.u, t, semi)
-            u_modified!(integrator, true)
+            derivative_discontinuity!(integrator, true)
             has_changed = amr_callback(integrator,
                                        only_refine = amr_callback.adapt_initial_condition_only_refine)
             iterations = iterations + 1
@@ -195,7 +195,7 @@ function (amr_callback::AMRCallback)(integrator; kwargs...)
                                    integrator.t, integrator.iter; kwargs...)
         if has_changed
             resize!(integrator, length(u_ode))
-            u_modified!(integrator, true)
+            derivative_discontinuity!(integrator, true)
         end
     end
 

src/callbacks_step/analysis.jl

@@ -358,7 +358,7 @@ function (analysis_callback::AnalysisCallback)(u_ode, du_ode, integrator, semi)
     end
 
     # avoid re-evaluating possible FSAL stages
-    u_modified!(integrator, false)
+    derivative_discontinuity!(integrator, false)
 
     # Reset performance measurements
     analysis_callback.start_time_last_analysis = time_ns()

src/callbacks_step/averaging.jl

@@ -79,7 +79,7 @@ function initialize!(cb::DiscreteCallback{Condition, Affect!}, u_ode, t,
                                                         mesh, equations, solver, cache)
 
     # avoid re-evaluating possible FSAL stages
-    u_modified!(integrator, false)
+    derivative_discontinuity!(integrator, false)
     return nothing
 end
 
@@ -111,7 +111,7 @@ function (averaging_callback::AveragingCallback)(integrator)
     end
 
     # avoid re-evaluating possible FSAL stages
-    u_modified!(integrator, false)
+    derivative_discontinuity!(integrator, false)
 
     return nothing
 end

src/callbacks_step/euler_acoustics_coupling.jl

@@ -211,8 +211,8 @@ function (euler_acoustics_coupling::EulerAcousticsCouplingCallback)(integrator_a
     end
 
     # avoid re-evaluation possible FSAL stages
-    u_modified!(integrator_acoustics, false)
-    u_modified!(integrator_euler, false)
+    derivative_discontinuity!(integrator_acoustics, false)
+    derivative_discontinuity!(integrator_euler, false)
 
     return nothing
 end

src/callbacks_step/glm_speed.jl

@@ -109,7 +109,7 @@ end
     update_cleaning_speed!(semi, glm_speed_callback, dt, integrator.t)
 
     # avoid re-evaluating possible FSAL stages
-    u_modified!(integrator, false)
+    derivative_discontinuity!(integrator, false)
 
     return nothing
 end

src/callbacks_step/save_restart.jl

@@ -102,7 +102,7 @@ function (restart_callback::SaveRestartCallback)(integrator)
     end
 
     # avoid re-evaluating possible FSAL stages
-    u_modified!(integrator, false)
+    derivative_discontinuity!(integrator, false)
     return nothing
 end
 

src/callbacks_step/save_solution.jl

@@ -42,7 +42,7 @@ function get_node_variable(::Val{symbol}, u, mesh, equations, dg, cache,
 end
 ```
 
-For hyperbolic-parabolic equations, `equations_parabolic` and `cache_parabolic` must be 
+For hyperbolic-parabolic equations, `equations_parabolic` and `cache_parabolic` must be
 added:
 ```julia
 function get_node_variable(::Val{symbol}, u, mesh, equations, dg, cache,
@@ -253,7 +253,7 @@ function (solution_callback::SaveSolutionCallback)(integrator)
     end
 
     # avoid re-evaluating possible FSAL stages
-    u_modified!(integrator, false)
+    derivative_discontinuity!(integrator, false)
     return nothing
 end
 

src/callbacks_step/stepsize.jl

@@ -121,7 +121,7 @@ end
     integrator.dtcache = dt
 
     # avoid re-evaluating possible FSAL stages
-    u_modified!(integrator, false)
+    derivative_discontinuity!(integrator, false)
     return nothing
 end
 

src/callbacks_step/summary.jl

@@ -6,7 +6,7 @@
 #! format: noindent
 
 summary_callback(u, t, integrator) = false # when used as condition; never call the summary callback during the simulation
-summary_callback(integrator) = u_modified!(integrator, false) # the summary callback does nothing when called accidentally
+summary_callback(integrator) = derivative_discontinuity!(integrator, false) # the summary callback does nothing when called accidentally
 
 """
     SummaryCallback()

src/callbacks_step/time_series.jl

@@ -212,7 +212,7 @@ function (time_series_callback::TimeSeriesCallback)(integrator)
     end
 
     # avoid re-evaluating possible FSAL stages
-    u_modified!(integrator, false)
+    derivative_discontinuity!(integrator, false)
 
     return nothing
 end

src/callbacks_step/trivial.jl

@@ -17,7 +17,7 @@ function TrivialCallback()
 end
 
 trivial_callback(u, t, integrator) = false
-trivial_callback(integrator) = u_modified!(integrator, false)
+trivial_callback(integrator) = derivative_discontinuity!(integrator, false)
 
 function Base.show(io::IO, cb::DiscreteCallback{<:Any, <:typeof(trivial_callback)})
     @nospecialize cb # reduce precompilation time

src/callbacks_step/visualization.jl

@@ -157,7 +157,7 @@ function (visualization_callback::VisualizationCallback)(integrator)
                  time = integrator.t, timestep = integrator.stats.naccept)
 
     # avoid re-evaluating possible FSAL stages
-    u_modified!(integrator, false)
+    derivative_discontinuity!(integrator, false)
     return nothing
 end
 

src/time_integration/methods_2N.jl

@@ -170,7 +170,7 @@ end
 get_tmp_cache(integrator::SimpleIntegrator2N) = (integrator.u_tmp,)
 
 # some algorithms from DiffEq like FSAL-ones need to be informed when a callback has modified u
-u_modified!(integrator::SimpleIntegrator2N, ::Bool) = false
+derivative_discontinuity!(integrator::SimpleIntegrator2N, ::Bool) = false
 
 # stop the time integration
 function terminate!(integrator::SimpleIntegrator2N)

src/time_integration/methods_3Sstar.jl

@@ -220,7 +220,7 @@ function get_tmp_cache(integrator::SimpleIntegrator3Sstar)
 end
 
 # some algorithms from DiffEq like FSAL-ones need to be informed when a callback has modified u
-u_modified!(integrator::SimpleIntegrator3Sstar, ::Bool) = false
+derivative_discontinuity!(integrator::SimpleIntegrator3Sstar, ::Bool) = false
 
 # stop the time integration
 function terminate!(integrator::SimpleIntegrator3Sstar)

src/time_integration/methods_SSP.jl

@@ -213,7 +213,7 @@ end
 get_tmp_cache(integrator::SimpleIntegratorSSP) = (integrator.u_tmp,)
 
 # some algorithms from DiffEq like FSAL-ones need to be informed when a callback has modified u
-u_modified!(integrator::SimpleIntegratorSSP, ::Bool) = false
+derivative_discontinuity!(integrator::SimpleIntegratorSSP, ::Bool) = false
 
 # stop the time integration
 function terminate!(integrator::SimpleIntegratorSSP)

src/time_integration/paired_explicit_runge_kutta/paired_explicit_runge_kutta.jl

@@ -136,7 +136,7 @@ end
 get_tmp_cache(integrator::AbstractPairedExplicitRKIntegrator) = (integrator.u_tmp,)
 
 # some algorithms from DiffEq like FSAL-ones need to be informed when a callback has modified u
-u_modified!(integrator::AbstractPairedExplicitRKIntegrator, ::Bool) = false
+derivative_discontinuity!(integrator::AbstractPairedExplicitRKIntegrator, ::Bool) = false
 
 # stop the time integration
 function terminate!(integrator::AbstractPairedExplicitRKIntegrator)

src/time_integration/relaxation_methods/relaxation_methods.jl

@@ -5,7 +5,7 @@ abstract type RelaxationIntegrator <: AbstractTimeIntegrator end
 get_tmp_cache(integrator::RelaxationIntegrator) = (integrator.u_tmp,)
 
 # some algorithms from DiffEq like FSAL-ones need to be informed when a callback has modified u
-u_modified!(integrator::RelaxationIntegrator, ::Bool) = false
+derivative_discontinuity!(integrator::RelaxationIntegrator, ::Bool) = false
 
 # stop the time integration
 function terminate!(integrator::RelaxationIntegrator)

test/test_aqua.jl

@@ -24,6 +24,7 @@ include("test_trixi.jl")
                                                     ignore = (:derivative_operator,
                                                               :periodic_derivative_operator,
                                                               :upwind_operators,
+                                                              :derivative_discontinuity!,
                                                               Symbol("@batch"))))
 end