test: update tests to use ImperativeAffect

Author: AayushSabharwal

test/index_cache.jl

@@ -98,15 +98,17 @@ mutable struct ParamTest
 end
 (pt::ParamTest)(x) = pt.y - x
 @testset "Issue#3215: Callable discrete parameter" begin
-    function update_affect!(integ, u, p, ctx)
-        integ.p[p.p_1].y = integ.t
+    function update_affect!(mod, obs, ctx, integ)
+        p_1 = mod.p_1
+        p_1.y = integ.t
+        return (; p_1)
     end
 
     tp1 = typeof(ParamTest(1))
     @parameters (p_1::tp1)(..) = ParamTest(1)
     @variables x(ModelingToolkit.t_nounits) = 0
 
-    event1 = [1.0, 2, 3] => (update_affect!, [], [p_1], [p_1], nothing)
+    event1 = [1.0, 2, 3] => (f = update_affect!, modified = (; p_1))
 
     @named sys = System([
             ModelingToolkit.D_nounits(x) ~ p_1(x)

test/initializationsystem.jl

@@ -1367,13 +1367,13 @@ end
 
 @testset "Issue#3342" begin
     @variables x(t) y(t)
-    stop!(integrator, _, _, _) = terminate!(integrator)
+    stop!(mod, obs, ctx, integrator) = (terminate!(integrator); return (;))
     @named sys = System([D(x) ~ 1.0
                          D(y) ~ 1.0], t; initialization_eqs = [
             y ~ 0.0
         ],
         continuous_events = [
-            [y ~ 0.5] => (stop!, [y], [], [], nothing)
+            [y ~ 0.5] => (; f = stop!)
         ])
     sys = structural_simplify(sys)
     prob0 = ODEProblem(sys, [x => NaN], (0.0, 1.0), [])

test/jumpsystem.jl

@@ -516,12 +516,12 @@ end
     @test all(abs.(Xv .- Xact) .<= 0.05 .* Xv)
     @test all(abs.(Yv .- Yact) .<= 0.05 .* Yv)
 
-    function affect!(integ, u, p, ctx)
+    function affect!(mod, obs, ctx, integ)
         savevalues!(integ, true)
         terminate!(integ)
-        nothing
+        (;)
     end
-    cevents = [t ~ 0.2] => (affect!, [], [], [], nothing)
+    cevents = [t ~ 0.2] => (; f = affect!)
     @named jsys = JumpSystem([maj, crj, vrj, eqs[1]], t, [X, Y], [α, β];
         continuous_events = cevents)
     jsys = complete(jsys)

test/parameter_dependencies.jl

@@ -14,10 +14,10 @@ using NonlinearSolve
     @parameters p1(t)=1.0 p2
     @variables x(t)
     cb1 = SymbolicContinuousCallback([x ~ 2.0] => [p1 ~ 2.0], discrete_parameters = [p1]) # triggers at t=-2+√6
-    function affect1!(integ, u, p, ctx)
-        integ.ps[p[1]] = integ.ps[p[2]]
+    function affect1!(mod, obs, ctx, integ)
+        return (; p1 = obs.p2)
     end
-    cb2 = [x ~ 4.0] => (affect1!, [], [p1, p2], [p1]) # triggers at t=-2+√7
+    cb2 = [x ~ 4.0] => (f = affect1!, observed = (; p2), modified = (; p1)) # triggers at t=-2+√7
     cb3 = SymbolicDiscreteCallback([1.0] => [p1 ~ 5.0], discrete_parameters = [p1])
 
     @mtkbuild sys = System(

test/symbolic_events.jl

@@ -514,11 +514,10 @@ end
     testsol(ssys3, SDEProblem, RI5, u0, p, tspan; tstops = [1.0], paramtotest = k)
 
     # mixing with a func affect
-    function affect!(integrator, u, p, ctx)
-        integrator.ps[p.k] = 1.0
-        nothing
+    function affect!(mod, obs, ctx, integ)
+        return (; k = 1.0)
     end
-    cb2‵‵ = [2.0] => (affect!, [], [k], [k], nothing)
+    cb2‵‵ = [2.0] => (f = affect!, modified = (; k))
     @named osys4 = System(eqs, t, [A], [k, t1], discrete_events = [cb1, cb2‵‵])
     @named ssys4 = SDESystem(eqs, [0.0], t, [A], [k, t1],
         discrete_events = [cb1, cb2‵‵])
@@ -527,7 +526,7 @@ end
     testsol(ssys4, SDEProblem, RI5, u0, p, tspan; tstops = [1.0], paramtotest = k)
 
     # mixing with symbolic condition in the func affect
-    cb2‵‵‵ = (t == t2) => (affect!, [], [k], [k], nothing)
+    cb2‵‵‵ = (t == t2) => (f = affect!, modified = (; k))
     @named osys5 = System(eqs, t, [A], [k, t1, t2], discrete_events = [cb1, cb2‵‵‵])
     @named ssys5 = SDESystem(eqs, [0.0], t, [A], [k, t1, t2],
         discrete_events = [cb1, cb2‵‵‵])
@@ -605,17 +604,15 @@ end
     testsol(jsys3, u0, p, tspan; tstops = [1.0], rng, paramtotest = k)
 
     # mixing with a func affect
-    function affect!(integrator, u, p, ctx)
-        integrator.ps[p.k] = 1.0
-        reset_aggregated_jumps!(integrator)
-        nothing
+    function affect!(mod, obs, ctx, integrator)
+        return (; k = 1.0)
     end
-    cb2‵‵ = [2.0] => (affect!, [], [k], [k], nothing)
+    cb2‵‵ = [2.0] => (f = affect!, modified = (; k))
     @named jsys4 = JumpSystem(eqs, t, [A], [k, t1], discrete_events = [cb1, cb2‵‵])
     testsol(jsys4, u0, p, tspan; tstops = [1.0], rng, paramtotest = k)
 
     # mixing with symbolic condition in the func affect
-    cb2‵‵‵ = (t == t2) => (affect!, [], [k], [k], nothing)
+    cb2‵‵‵ = (t == t2) => (f = affect!, modified = (; k))
     @named jsys5 = JumpSystem(eqs, t, [A], [k, t1, t2], discrete_events = [cb1, cb2‵‵‵])
     testsol(jsys5, u0, p, tspan; tstops = [1.0, 2.0], rng, paramtotest = k)
     @named jsys6 = JumpSystem(eqs, t, [A], [k, t1, t2], discrete_events = [cb2‵‵‵, cb1])
@@ -649,13 +646,16 @@ end
     # baseline affect (pos + neg + left root find)
     @variables c1(t)=1.0 c2(t)=1.0 # c1 = cos(t), c2 = cos(3t)
     eqs = [D(c1) ~ -sin(t); D(c2) ~ -3 * sin(3 * t)]
-    record_crossings(i, u, _, c) = push!(c, i.t => i.u[u.v])
+    function record_crossings(mod, obs, ctx, integ)
+        push!(ctx, integ.t => obs.v)
+        return (;)
+    end
     cr1 = []
     cr2 = []
     evt1 = ModelingToolkit.SymbolicContinuousCallback(
-        [c1 ~ 0], (record_crossings, [c1 => :v], [], [], cr1))
+        [c1 ~ 0], (f = record_crossings, observed = (; v = c1), ctx = cr1))
     evt2 = ModelingToolkit.SymbolicContinuousCallback(
-        [c2 ~ 0], (record_crossings, [c2 => :v], [], [], cr2))
+        [c2 ~ 0], (f = record_crossings, observed = (; v = c2), ctx = cr2))
     @named trigsys = System(eqs, t; continuous_events = [evt1, evt2])
     trigsys_ss = structural_simplify(trigsys)
     prob = ODEProblem(trigsys_ss, [], (0.0, 2π))
@@ -673,11 +673,11 @@ end
     cr1n = []
     cr2n = []
     evt1 = ModelingToolkit.SymbolicContinuousCallback(
-        [c1 ~ 0], (record_crossings, [c1 => :v], [], [], cr1p);
-        affect_neg = (record_crossings, [c1 => :v], [], [], cr1n))
+        [c1 ~ 0], (f = record_crossings, observed = (; v = c1), ctx = cr1p);
+        affect_neg = (f = record_crossings, observed = (; v = c1), ctx = cr1n))
     evt2 = ModelingToolkit.SymbolicContinuousCallback(
-        [c2 ~ 0], (record_crossings, [c2 => :v], [], [], cr2p);
-        affect_neg = (record_crossings, [c2 => :v], [], [], cr2n))
+        [c2 ~ 0], (f = record_crossings, observed = (; v = c2), ctx = cr2p);
+        affect_neg = (f = record_crossings, observed = (; v = c2), ctx = cr2n))
     @named trigsys = System(eqs, t; continuous_events = [evt1, evt2])
     trigsys_ss = structural_simplify(trigsys)
     prob = ODEProblem(trigsys_ss, [], (0.0, 2π))
@@ -699,9 +699,9 @@ end
     cr1p = []
     cr2p = []
     evt1 = ModelingToolkit.SymbolicContinuousCallback(
-        [c1 ~ 0], (record_crossings, [c1 => :v], [], [], cr1p); affect_neg = nothing)
+        [c1 ~ 0], (f = record_crossings, observed = (; v = c1), ctx = cr1p); affect_neg = nothing)
     evt2 = ModelingToolkit.SymbolicContinuousCallback(
-        [c2 ~ 0], (record_crossings, [c2 => :v], [], [], cr2p); affect_neg = nothing)
+        [c2 ~ 0], (f = record_crossings, observed = (; v = c2), ctx = cr2p); affect_neg = nothing)
     @named trigsys = System(eqs, t; continuous_events = [evt1, evt2])
     trigsys_ss = structural_simplify(trigsys)
     prob = ODEProblem(trigsys_ss, [], (0.0, 2π))
@@ -717,10 +717,10 @@ end
     cr1n = []
     cr2n = []
     evt1 = ModelingToolkit.SymbolicContinuousCallback(
-        [c1 ~ 0], (record_crossings, [c1 => :v], [], [], cr1p); affect_neg = nothing)
+        [c1 ~ 0], (f = record_crossings, observed = (; v = c1), ctx = cr1p); affect_neg = nothing)
     evt2 = ModelingToolkit.SymbolicContinuousCallback(
-        [c2 ~ 0], (record_crossings, [c2 => :v], [], [], cr2p);
-        affect_neg = (record_crossings, [c2 => :v], [], [], cr2n))
+        [c2 ~ 0], (f = record_crossings, observed = (; v = c2), ctx = cr2p);
+        affect_neg = (f = record_crossings, observed = (; v = c2), ctx = cr2n))
     @named trigsys = System(eqs, t; continuous_events = [evt1, evt2])
     trigsys_ss = structural_simplify(trigsys)
     prob = ODEProblem(trigsys_ss, [], (0.0, 2π))
@@ -740,10 +740,10 @@ end
     cr1 = []
     cr2 = []
     evt1 = ModelingToolkit.SymbolicContinuousCallback(
-        [c1 ~ 0], (record_crossings, [c1 => :v], [], [], cr1);
+        [c1 ~ 0], (f = record_crossings, observed = (; v = c1), ctx = cr1);
         rootfind = SciMLBase.RightRootFind)
     evt2 = ModelingToolkit.SymbolicContinuousCallback(
-        [c2 ~ 0], (record_crossings, [c2 => :v], [], [], cr2);
+        [c2 ~ 0], (f = record_crossings, observed = (; v = c2), ctx = cr2);
         rootfind = SciMLBase.RightRootFind)
     @named trigsys = System(eqs, t; continuous_events = [evt1, evt2])
     trigsys_ss = structural_simplify(trigsys)
@@ -760,10 +760,10 @@ end
     cr1 = []
     cr2 = []
     evt1 = ModelingToolkit.SymbolicContinuousCallback(
-        [c1 ~ 0], (record_crossings, [c1 => :v], [], [], cr1);
+        [c1 ~ 0], (f = record_crossings, observed = (; v = c1), ctx = cr1);
         rootfind = SciMLBase.LeftRootFind)
     evt2 = ModelingToolkit.SymbolicContinuousCallback(
-        [c2 ~ 0], (record_crossings, [c2 => :v], [], [], cr2);
+        [c2 ~ 0], (f = record_crossings, observed = (; v = c2), ctx = cr2);
         rootfind = SciMLBase.RightRootFind)
     @named trigsys = System(eqs, t; continuous_events = [evt1, evt2])
     trigsys_ss = structural_simplify(trigsys)
@@ -778,10 +778,10 @@ end
     cr1 = []
     cr2 = []
     evt1 = ModelingToolkit.SymbolicContinuousCallback(
-        [c1 ~ 0], (record_crossings, [c1 => :v], [], [], cr1);
+        [c1 ~ 0], (f = record_crossings, observed = (; v = c1), ctx = cr1);
         rootfind = SciMLBase.LeftRootFind)
     evt2 = ModelingToolkit.SymbolicContinuousCallback(
-        [c2 ~ 0], (record_crossings, [c2 => :v], [], [], cr2);
+        [c2 ~ 0], (f = record_crossings, observed = (; v = c2), ctx = cr2);
         rootfind = SciMLBase.RightRootFind)
     @named trigsys = System(eqs, t; continuous_events = [evt2, evt1])
     trigsys_ss = structural_simplify(trigsys)
@@ -879,10 +879,10 @@ end
     @variables x(t)
     @parameters a(t) b(t) c(t)
     cb1 = SymbolicContinuousCallback([x ~ 1.0] => [a ~ -Pre(a)], discrete_parameters = [a])
-    function save_affect!(integ, u, p, ctx)
-        integ.ps[p.b] = 5.0
+    function save_affect!(mod, obs, ctx, integ)
+        return (; b = 5.0)
     end
-    cb2 = [x ~ 0.5] => (save_affect!, [], [b], [b], nothing)
+    cb2 = [x ~ 0.5] => (f = save_affect!, modified = (; b))
     cb3 = SymbolicDiscreteCallback(1.0 => [c ~ t], discrete_parameters = [c])
 
     @mtkbuild sys = System(D(x) ~ cos(t), t, [x], [a, b, c];
@@ -1067,8 +1067,7 @@ end
 @testset "Initialization" begin
     @variables x(t)
     seen = false
-    f = ModelingToolkit.FunctionalAffect(
-        f = (i, u, p, c) -> seen = true, sts = [], pars = [], discretes = [])
+    f = ModelingToolkit.ImperativeAffect(f = (m, o, ctx, int) -> (seen = true; return (;)))
     cb1 = ModelingToolkit.SymbolicContinuousCallback(
         [x ~ 0], nothing, initialize = [x ~ 1.5], finalize = f)
     @mtkbuild sys = System(D(x) ~ -1, t, [x], []; continuous_events = [cb1])
@@ -1080,16 +1079,13 @@ end
 
     @variables x(t)
     seen = false
-    f = ModelingToolkit.FunctionalAffect(
-        f = (i, u, p, c) -> seen = true, sts = [], pars = [], discretes = [])
+    f = ModelingToolkit.ImperativeAffect(f = (m, o, ctx, int) -> (seen = true; return (;)))
     cb1 = ModelingToolkit.SymbolicContinuousCallback(
         [x ~ 0], nothing, initialize = [x ~ 1.5], finalize = f)
     inited = false
     finaled = false
-    a = ModelingToolkit.FunctionalAffect(
-        f = (i, u, p, c) -> inited = true, sts = [], pars = [], discretes = [])
-    b = ModelingToolkit.FunctionalAffect(
-        f = (i, u, p, c) -> finaled = true, sts = [], pars = [], discretes = [])
+    a = ModelingToolkit.ImperativeAffect(f = (m, o, ctx, int) -> (inited = true; return (;)))
+    b = ModelingToolkit.ImperativeAffect(f = (m, o, ctx, int) -> (finaled = true; return (;)))
     cb2 = ModelingToolkit.SymbolicContinuousCallback(
         [x ~ 0.1], nothing, initialize = a, finalize = b)
     @mtkbuild sys = System(D(x) ~ -1, t, [x], []; continuous_events = [cb1, cb2])