Support SciMLBase v3: rename u_modified! → derivative_discontinuity!

Project.toml

@@ -1,6 +1,6 @@
 name = "DiffEqCallbacks"
 uuid = "459566f4-90b8-5000-8ac3-15dfb0a30def"
-version = "4.13.0"
+version = "4.14.0"
 authors = ["Chris Rackauckas <accounts@chrisrackauckas.com>"]
 
 [deps]
@@ -47,7 +47,7 @@ PrecompileTools = "1.2"
 QuadGK = "2.9"
 RecipesBase = "1.3.4"
 RecursiveArrayTools = "3.27, 4"
-SciMLBase = "2.54"
+SciMLBase = "2.54, 3.1"
 StaticArrays = "1.9.7"
 StaticArraysCore = "1.4"
 Sundials = "4.19.2"

README.md

@@ -60,7 +60,7 @@ save after the projection is applied.
 ```julia
 using Test
 sol = solve(prob, Vern7(), save_everystep = false, callback = cb)
-@test sol[end][1]^2 + sol[end][2]^2 ≈ 2
+@test sol.u[end][1]^2 + sol.u[end][2]^2 ≈ 2
 ```
 
 ![manifold_projection](https://user-images.githubusercontent.com/1814174/184501895-38f081b6-3d7a-434c-adca-63b6b36a315c.png)

docs/src/projection.md

@@ -48,7 +48,7 @@ save after the projection is applied.
 
 ```@example manifold
 sol = solve(prob, Vern7(), save_everystep = false, callback = cb)
-@show sol[end][1]^2 + sol[end][2]^2 ≈ 2
+@show sol.u[end][1]^2 + sol.u[end][2]^2 ≈ 2
 ```
 
 ```@example manifold

src/DiffEqCallbacks.jl

@@ -13,9 +13,18 @@ using SciMLBase: SciMLBase, CallbackSet, DiscreteCallback, NonlinearFunction,
     NonlinearLeastSquaresProblem, NonlinearProblem, RODEProblem,
     ReturnCode, SDEProblem, add_tstop!, check_error, get_du,
     get_proposed_dt, get_tmp_cache, init, reinit!,
-    set_proposed_dt!, solve!, terminate!, u_modified!
+    set_proposed_dt!, solve!, terminate!
 using StaticArraysCore: StaticArraysCore
 
+# SciMLBase v3 renamed `u_modified!` → `derivative_discontinuity!` (with
+# an `@deprecate` on the old name). Support both SciMLBase v2 and v3 by
+# aliasing to whichever name the loaded SciMLBase provides.
+@static if isdefined(SciMLBase, :derivative_discontinuity!)
+    using SciMLBase: derivative_discontinuity!
+else
+    const derivative_discontinuity! = SciMLBase.u_modified!
+end
+
 const DI = DifferentiationInterface
 true_condition(u, t, integrator) = true
 

src/autoabstol.jl

@@ -15,14 +15,14 @@ function (p::AutoAbstolAffect)(integrator)
         integrator.opts.abstol = p.curmax .* integrator.opts.reltol
     end
 
-    return u_modified!(integrator, false)
+    return derivative_discontinuity!(integrator, false)
 end
 
 function AutoAbstol_initialize(cb, u, t, integrator)
     if cb.affect!.curmax == zero(integrator.opts.abstol)
         cb.affect!.curmax = integrator.opts.abstol
     end
-    return u_modified!(integrator, false)
+    return derivative_discontinuity!(integrator, false)
 end
 
 """

src/domain.jl

@@ -112,7 +112,7 @@ function affect!(integrator, f::AbstractDomainAffect{T, S, uType}) where {T, S,
     end
 
     # modify u
-    u_modified!(integrator, modify_u!(integrator, f))
+    derivative_discontinuity!(integrator, modify_u!(integrator, f))
 
     return
 end

src/function_caller.jl

@@ -35,7 +35,7 @@ function (affect!::FunctionCallingAffect)(integrator, force_func = false)
     if affect!.func_everystep || force_func
         affect!.func(integrator.u, integrator.t, integrator)
     end
-    return u_modified!(integrator, false)
+    return derivative_discontinuity!(integrator, false)
 end
 
 function functioncalling_initialize(cb, u, t, integrator)
@@ -56,7 +56,7 @@ function functioncalling_initialize(cb, u, t, integrator)
         cb.affect!.funciter = 1
     end
     cb.affect!.func_start && cb.affect!(integrator)
-    return u_modified!(integrator, false)
+    return derivative_discontinuity!(integrator, false)
 end
 
 """

src/integrating.jl

@@ -209,7 +209,7 @@ function (affect!::SavingIntegrandAffect)(integrator)
     )
     push!(affect!.integrand_values.ts, integrator.t)
     push!(affect!.integrand_values.integrand, recursive_copy(accumulation_cache))
-    return u_modified!(integrator, false)
+    return derivative_discontinuity!(integrator, false)
 end
 
 """

src/integrating_GK_affect.jl

@@ -243,7 +243,7 @@ function (affect!::SavingIntegrandGKAffect)(integrator)
     )
     push!(affect!.integrand_values.ts, integrator.t)
     push!(affect!.integrand_values.integrand, recursive_copy(affect!.accumulation_cache))
-    return u_modified!(integrator, false)
+    return derivative_discontinuity!(integrator, false)
 end
 
 """

src/integrating_GK_sum.jl

@@ -84,7 +84,7 @@ function (affect!::SavingIntegrandGKSumAffect)(integrator)
         affect!, integrator, integrator.tprev, integrator.t, order = n, tol = affect!.tol
     )
     recursive_add!(affect!.integrand_values.integrand, accumulation_cache)
-    return u_modified!(integrator, false)
+    return derivative_discontinuity!(integrator, false)
 end
 
 """

src/integrating_sum.jl

@@ -104,7 +104,7 @@ function (affect!::SavingIntegrandSumAffect)(integrator)
     end
     recursive_scalar_mul!(accumulation_cache, (integrator.t - integrator.tprev) / 2)
     recursive_add!(affect!.integrand_values.integrand, accumulation_cache)
-    return u_modified!(integrator, false)
+    return derivative_discontinuity!(integrator, false)
 end
 
 """

src/iterative_and_periodic.jl

@@ -20,7 +20,7 @@ effect at `t₁`, you can define `t₂` to apply the next effect.
 function IterativeCallback(
         time_choice, user_affect!, tType = Float64;
         initial_affect = false,
-        initialize = (cb, u, t, integrator) -> u_modified!(
+        initialize = (cb, u, t, integrator) -> derivative_discontinuity!(
             integrator,
             initial_affect
         ),
@@ -146,7 +146,7 @@ function PeriodicCallback(
         phase = 0,
         initial_affect = false,
         final_affect = false,
-        initialize = (cb, u, t, integrator) -> u_modified!(
+        initialize = (cb, u, t, integrator) -> derivative_discontinuity!(
             integrator,
             initial_affect
         ),

src/manifold.jl

@@ -144,7 +144,7 @@ function initialize_manifold_projection(affect!::ManifoldProjection, u, t, integ
         )
     end
     affect!.nlcache = cache
-    return u_modified!(integrator, false)
+    return derivative_discontinuity!(integrator, false)
 end
 
 export ManifoldProjection

src/saving.jl

@@ -86,7 +86,7 @@ function (affect!::SavingAffect)(integrator, force_save = false)
             Val{false}
         )
     end
-    return u_modified!(integrator, false)
+    return derivative_discontinuity!(integrator, false)
 end
 
 function saving_initialize(cb, u, t, integrator)
@@ -119,7 +119,7 @@ function saving_initialize(cb, u, t, integrator)
         cb.affect!.saveiter = 0
     end
     cb.affect!.save_start && cb.affect!(integrator)
-    return u_modified!(integrator, false)
+    return derivative_discontinuity!(integrator, false)
 end
 
 """
@@ -432,7 +432,7 @@ function LinearizingSavingCallback(
                     )
                 end
             end
-            u_modified!(integ, false)
+            derivative_discontinuity!(integ, false)
         end,
         # In our `initialize`, we create some caches so we allocate less
         initialize = (
@@ -462,7 +462,7 @@ function LinearizingSavingCallback(
                 u_block = Matrix{S}(undef, (num_derivatives(ilsc) + 1, num_us)),
                 u_masks = CachePool(BitVector, () -> BitVector(undef, num_us)),
             )
-            u_modified!(integ, false)
+            derivative_discontinuity!(integ, false)
         end,
         # We need to finalize the ils and free our caches
         finalize = (c, u, t, integ) -> begin

src/stepsizelimiters.jl

@@ -18,7 +18,7 @@ function (p::StepsizeLimiterAffect)(integrator)
         set_proposed_dt!(integrator, integrator.opts.dtmax)
         integrator.dtcache = integrator.opts.dtmax
     end
-    return u_modified!(integrator, false)
+    return derivative_discontinuity!(integrator, false)
 end
 
 function StepsizeLimiter_initialize(cb, u, t, integrator)

test/preset_time.jl

@@ -94,7 +94,7 @@ sol2 = solve(prob2, Tsit5(), callback = cb1)
 @test sol2(24.0 + eps(24.0)) ≈ [10.0]
 @test sol2(48.0 + eps(48.0)) ≈ [10.0]
 
-_some_test_func(integrator) = u_modified!(integrator, false)
+_some_test_func(integrator) = derivative_discontinuity!(integrator, false)
 @inferred PresetTimeCallback(
     collect(range(0, 10, 100)), _some_test_func, save_positions = (false, false)
 )