Merge branch 'master' into qqy/merge_kwargs

ErikQQY · web-flow · commit 407814521fac · 2025-05-14T23:10:00.000+08:00
diff --git a/.github/workflows/Downstream.yml b/.github/workflows/Downstream.yml
@@ -0,0 +1,72 @@
+name: IntegrationTest
+on:
+  push:
+    branches: [master]
+    tags: [v*]
+  pull_request:
+concurrency:
+  # Skip intermediate builds: always.
+  # Cancel intermediate builds: only if it is a pull request build.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+jobs:
+  test:
+    name: ${{ matrix.package.repo }}/${{ matrix.package.group }}/${{ matrix.julia-version }}
+    runs-on: ${{ matrix.os }}
+    env:
+      GROUP: ${{ matrix.package.group }}
+    strategy:
+      fail-fast: false
+      matrix:
+        julia-version: [1]
+        os: [ubuntu-latest]
+        package:
+          - {user: SciML, repo: ModelingToolkit.jl, group: All}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: ${{ matrix.julia-version }}
+          arch: x64
+      - name: "Install Dependencies"
+        run: |
+          import Pkg
+          Pkg.Registry.update()
+          # Install packages present in subdirectories
+          dev_pks = Pkg.PackageSpec[]
+          for path in ("lib/BoundaryValueDiffEqCore", "lib/BoundaryValueDiffEqMIRK", "lib/BoundaryValueDiffEqMIRKN", "lib/BoundaryValueDiffEqFIRK", "lib/BoundaryValueDiffEqShooting", "lib/BoundaryValueDiffEqAscher")
+              push!(dev_pks, Pkg.PackageSpec(; path))
+          end
+          Pkg.develop(dev_pks)
+          Pkg.instantiate()
+        shell: julia --color=yes --code-coverage=user --depwarn=yes --project=. {0}
+      - name: Clone Downstream
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ matrix.package.user }}/${{ matrix.package.repo }}
+          path: downstream
+      - name: Load this and run the downstream tests
+        shell: julia --color=yes --project=downstream {0}
+        run: |
+          using Pkg
+          try
+            # force it to use this PR's version of the package
+            Pkg.develop(PackageSpec(path="."))  # resolver may fail with main deps
+            Pkg.update()
+            Pkg.test(coverage="user")  # resolver may fail with test time deps
+          catch err
+            err isa Pkg.Resolve.ResolverError || rethrow()
+            # If we can't resolve that means this is incompatible by SemVer and this is fine
+            # It means we marked this as a breaking change, so we don't need to worry about
+            # Mistakenly introducing a breaking change, as we have intentionally made one
+            @info "Not compatible with this release. No problem." exception=err
+            exit(0)  # Exit immediately, as a success
+          end
+      - uses: julia-actions/julia-processcoverage@v1
+        with:
+          directories: src,ext
+      - uses: codecov/codecov-action@v5
+        with:
+          file: lcov.info
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: false
diff --git a/Project.toml b/Project.toml
@@ -1,6 +1,6 @@
 name = "BoundaryValueDiffEq"
 uuid = "764a87c0-6b3e-53db-9096-fe964310641d"
-version = "5.16.1"
+version = "5.17.0"
 
 [deps]
 ADTypes = "47edcb42-4c32-4615-8424-f2b9edc5f35b"
@@ -48,7 +48,7 @@ Hwloc = "3.3"
 InteractiveUtils = "<0.0.1, 1"
 JET = "0.9.18"
 LinearAlgebra = "1.10"
-LinearSolve = "3.9"
+LinearSolve = "3.12"
 NonlinearSolveFirstOrder = "1.3"
 ODEInterface = "0.5"
 OrdinaryDiffEqLowOrderRK = "1.2"
diff --git a/lib/BoundaryValueDiffEqCore/Project.toml b/lib/BoundaryValueDiffEqCore/Project.toml
@@ -1,7 +1,7 @@
 name = "BoundaryValueDiffEqCore"
 uuid = "56b672f2-a5fe-4263-ab2d-da677488eb3a"
 authors = ["Qingyu Qu <erikqqy123@gmail.com>"]
-version = "1.8.1"
+version = "1.9.0"
 
 [deps]
 ADTypes = "47edcb42-4c32-4615-8424-f2b9edc5f35b"
diff --git a/lib/BoundaryValueDiffEqFIRK/Project.toml b/lib/BoundaryValueDiffEqFIRK/Project.toml
@@ -23,8 +23,8 @@ SciMLBase = "0bca4576-84f4-4d90-8ffe-ffa030f20462"
 Setfield = "efcf1570-3423-57d1-acb7-fd33fddbac46"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 
-[sources]
-BoundaryValueDiffEqCore = {path = "../BoundaryValueDiffEqCore"}
+[sources.BoundaryValueDiffEqCore]
+path = "../BoundaryValueDiffEqCore"
 
 [compat]
 ADTypes = "1.14"
@@ -35,7 +35,7 @@ BoundaryValueDiffEqCore = "1"
 ConcreteStructs = "0.2.3"
 DiffEqBase = "6.167"
 DiffEqDevTools = "2.44"
-DifferentiationInterface = "0.6.42"
+DifferentiationInterface = "0.6.42, 0.7"
 Enzyme = "0.13.33"
 FastAlmostBandedMatrices = "0.1.4"
 FastClosures = "0.3.2"
diff --git a/lib/BoundaryValueDiffEqMIRK/Project.toml b/lib/BoundaryValueDiffEqMIRK/Project.toml
@@ -23,8 +23,8 @@ SciMLBase = "0bca4576-84f4-4d90-8ffe-ffa030f20462"
 Setfield = "efcf1570-3423-57d1-acb7-fd33fddbac46"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 
-[sources]
-BoundaryValueDiffEqCore = {path = "../BoundaryValueDiffEqCore"}
+[sources.BoundaryValueDiffEqCore]
+path = "../BoundaryValueDiffEqCore"
 
 [compat]
 ADTypes = "1.14"
@@ -35,7 +35,7 @@ BoundaryValueDiffEqCore = "1"
 ConcreteStructs = "0.2.3"
 DiffEqBase = "6.167"
 DiffEqDevTools = "2.44"
-DifferentiationInterface = "0.6.42"
+DifferentiationInterface = "0.6.42, 0.7"
 Enzyme = "0.13.33"
 FastAlmostBandedMatrices = "0.1.4"
 FastClosures = "0.3.2"
diff --git a/lib/BoundaryValueDiffEqMIRK/src/BoundaryValueDiffEqMIRK.jl b/lib/BoundaryValueDiffEqMIRK/src/BoundaryValueDiffEqMIRK.jl
@@ -15,13 +15,13 @@ using BoundaryValueDiffEqCore: AbstractBoundaryValueDiffEqAlgorithm,
                                safe_similar, __vec, __vec_f, __vec_f!, __vec_bc, __vec_bc!,
                                recursive_flatten_twopoint!, __internal_nlsolve_problem,
                                __extract_mesh, __extract_u0, __has_initial_guess,
-                               __initial_guess_length, __cache_trait,
-                               __initial_guess_on_mesh, __flatten_initial_guess,
-                               __build_solution, __Fix3, get_dense_ad, _sparse_like,
-                               AbstractErrorControl, DefectControl, GlobalErrorControl,
-                               SequentialErrorControl, HybridErrorControl, HOErrorControl,
-                               __use_both_error_control, __default_coloring_algorithm,
-                               DiffCacheNeeded, NoDiffCacheNeeded, __split_kwargs
+                               __initial_guess_length, __initial_guess_on_mesh,
+                               __flatten_initial_guess, __build_solution, __Fix3,
+                               get_dense_ad, _sparse_like, AbstractErrorControl,
+                               DefectControl, GlobalErrorControl, SequentialErrorControl,
+                               HybridErrorControl, HOErrorControl, __use_both_error_control,
+                               __default_coloring_algorithm, DiffCacheNeeded,
+                               NoDiffCacheNeeded, __split_kwargs
 
 using ConcreteStructs: @concrete
 using DiffEqBase: DiffEqBase
diff --git a/lib/BoundaryValueDiffEqMIRK/src/adaptivity.jl b/lib/BoundaryValueDiffEqMIRK/src/adaptivity.jl
@@ -7,7 +7,7 @@ After we construct an interpolant, we use interp_eval to evaluate it.
     i = interval(mesh, t)
     dt = mesh_dt[i]
     τ = (t - mesh[i]) / dt
-    w, w′ = interp_weights(τ, cache.alg)
+    w, _ = interp_weights(τ, cache.alg)
     sum_stages!(y, cache, w, i, dt)
     return y
 end
@@ -624,32 +624,35 @@ function sum_stages!(cache::MIRKCache{iip, T, use_both, NoDiffCacheNeeded}, w,
     sum_stages!(cache.fᵢ_cache, cache.fᵢ₂_cache, cache, w, w′, i, dt)
 end
 
+# Here we should not directly in-place change z in several steps
+# because in final step we actually need to use the original z(which is cache.y₀.u[i])
+# we use fᵢ₂_cache to avoid additional allocations.
 function sum_stages!(z::AbstractArray, cache::MIRKCache{iip, T, use_both, DiffCacheNeeded},
         w, i::Int, dt = cache.mesh_dt[i]) where {iip, T, use_both}
-    (; stage, k_discrete, k_interp) = cache
+    (; stage, k_discrete, k_interp, fᵢ₂_cache) = cache
     (; s_star) = cache.ITU
 
-    z .= zero(z)
-    __maybe_matmul!(z, k_discrete[i].du[:, 1:stage], w[1:stage])
+    fᵢ₂_cache .= zero(z)
+    __maybe_matmul!(fᵢ₂_cache, k_discrete[i].du[:, 1:stage], w[1:stage])
     __maybe_matmul!(
-        z, k_interp.u[i][:, 1:(s_star - stage)], w[(stage + 1):s_star], true, true)
-    z .= z .* dt .+ cache.y₀.u[i]
+        fᵢ₂_cache, k_interp.u[i][:, 1:(s_star - stage)], w[(stage + 1):s_star], true, true)
+    z .= fᵢ₂_cache .* dt .+ cache.y₀.u[i]
 
-    return z
+    return nothing
 end
 function sum_stages!(
         z::AbstractArray, cache::MIRKCache{iip, T, use_both, NoDiffCacheNeeded},
         w, i::Int, dt = cache.mesh_dt[i]) where {iip, T, use_both}
-    (; stage, k_discrete, k_interp) = cache
+    (; stage, k_discrete, k_interp, fᵢ₂_cache) = cache
     (; s_star) = cache.ITU
 
-    z .= zero(z)
-    __maybe_matmul!(z, k_discrete[i][:, 1:stage], w[1:stage])
+    fᵢ₂_cache .= zero(z)
+    __maybe_matmul!(fᵢ₂_cache, k_discrete[i][:, 1:stage], w[1:stage])
     __maybe_matmul!(
-        z, k_interp.u[i][:, 1:(s_star - stage)], w[(stage + 1):s_star], true, true)
-    z .= z .* dt .+ cache.y₀.u[i]
+        fᵢ₂_cache, k_interp.u[i][:, 1:(s_star - stage)], w[(stage + 1):s_star], true, true)
+    z .= fᵢ₂_cache .* dt .+ cache.y₀.u[i]
 
-    return z
+    return nothing
 end
 
 @views function sum_stages!(z, z′, cache::MIRKCache{iip, T, use_both, DiffCacheNeeded}, w,
diff --git a/lib/BoundaryValueDiffEqMIRK/test/mirk_basic_tests.jl b/lib/BoundaryValueDiffEqMIRK/test/mirk_basic_tests.jl
@@ -381,3 +381,23 @@ end
             prob, MIRK4(), dt = 0.05, abstol = 1e-5, controller = error_control)
     end
 end
+
+# https://github.com/SciML/BoundaryValueDiffEq.jl/issues/319
+@testitem "Test interpolant evaluation with big defect" setup=[MIRKConvergenceTests] begin
+    function lotka!(du, u, p, t)
+        x = u[1]
+        y = u[2]
+        du[1] = p[1] * x - p[2] * x * y
+        du[2] = -p[3] * y + p[4] * x * y
+    end
+
+    function bc!(resid, u, p, t)
+        resid[1] = u(0.0)[1] - 1.0
+        resid[2] = u(0.0)[2] - 2.0
+    end
+    bvp = BVProblem(lotka!, bc!, [1.0, 2.0], (0, 10), [7.5, 4.0, 8, 5])
+    for order in (4, 5, 6)
+        sol = solve(bvp, mirk_solver(Val(order)), dt = 0.01)
+        @test SciMLBase.successful_retcode(sol)
+    end
+end
diff --git a/lib/BoundaryValueDiffEqShooting/Project.toml b/lib/BoundaryValueDiffEqShooting/Project.toml
@@ -23,8 +23,8 @@ SciMLBase = "0bca4576-84f4-4d90-8ffe-ffa030f20462"
 Setfield = "efcf1570-3423-57d1-acb7-fd33fddbac46"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 
-[sources]
-BoundaryValueDiffEqCore = {path = "../BoundaryValueDiffEqCore"}
+[sources.BoundaryValueDiffEqCore]
+path = "../BoundaryValueDiffEqCore"
 
 [compat]
 ADTypes = "1.14"
@@ -35,7 +35,7 @@ BoundaryValueDiffEqCore = "1"
 ConcreteStructs = "0.2.3"
 DiffEqBase = "6.167"
 DiffEqDevTools = "2.44"
-DifferentiationInterface = "0.6.42"
+DifferentiationInterface = "0.6.42, 0.7"
 FastAlmostBandedMatrices = "0.1.4"
 FastClosures = "0.3.2"
 ForwardDiff = "0.10.38, 1"
@@ -69,9 +69,9 @@ Hwloc = "0e44f5e4-bd66-52a0-8798-143a42290a1d"
 InteractiveUtils = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
 JET = "c3a54625-cd67-489e-a8e7-0a5a0ff4e31b"
 OrdinaryDiffEqLowOrderRK = "1344f307-1e59-4825-a18e-ace9aa3fa4c6"
+OrdinaryDiffEqRosenbrock = "43230ef6-c299-4910-a778-202eb28ce4ce"
 OrdinaryDiffEqTsit5 = "b1df2697-797e-41e3-8120-5422d3b24e4a"
 OrdinaryDiffEqVerner = "79d7bb75-1356-48c1-b8c0-6832512096c2"
-OrdinaryDiffEqRosenbrock = "43230ef6-c299-4910-a778-202eb28ce4ce"
 Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 ReTestItems = "817f1d60-ba6b-4fd5-9520-3cf149f6a823"
diff --git a/lib/BoundaryValueDiffEqShooting/src/multiple_shooting.jl b/lib/BoundaryValueDiffEqShooting/src/multiple_shooting.jl
@@ -111,7 +111,8 @@ function __solve_nlproblem!(
     end
 
     resid_prototype_cached = similar(resid_prototype)
-    jac_cache = DI.prepare_jacobian(nothing, resid_prototype_cached, diffmode, u_at_nodes)
+    jac_cache = DI.prepare_jacobian(
+        nothing, resid_prototype_cached, diffmode, u_at_nodes; strict = Val(false))
 
     ode_cache_jac_fn = __multiple_shooting_init_jacobian_odecache(
         ensemblealg, prob, jac_cache, diffmode, alg.ode_alg,
@@ -161,8 +162,8 @@ function __solve_nlproblem!(::StandardBVProblem, alg::MultipleShooting, bcresid_
     else
         alg.jac_alg.nonbc_diffmode
     end
-    ode_jac_cache = DI.prepare_jacobian(
-        nothing, similar(u_at_nodes, cur_nshoot * N), nonbc_diffmode, u_at_nodes)
+    ode_jac_cache = DI.prepare_jacobian(nothing, similar(u_at_nodes, cur_nshoot * N),
+        nonbc_diffmode, u_at_nodes; strict = Val(false))
     ode_cache_ode_jac_fn = __multiple_shooting_init_jacobian_odecache(
         ensemblealg, prob, ode_jac_cache, nonbc_diffmode,
         alg.ode_alg, cur_nshoot, u0; internal_ode_kwargs...)
@@ -175,7 +176,7 @@ function __solve_nlproblem!(::StandardBVProblem, alg::MultipleShooting, bcresid_
         bc_diffmode
     end
     bc_jac_cache = DI.prepare_jacobian(
-        nothing, similar(bcresid_prototype), bc_diffmode, u_at_nodes)
+        nothing, similar(bcresid_prototype), bc_diffmode, u_at_nodes; strict = Val(false))
     ode_cache_bc_jac_fn = __multiple_shooting_init_jacobian_odecache(
         ensemblealg, prob, bc_jac_cache, bc_diffmode,
         alg.ode_alg, cur_nshoot, u0; internal_ode_kwargs...)
diff --git a/lib/BoundaryValueDiffEqShooting/src/single_shooting.jl b/lib/BoundaryValueDiffEqShooting/src/single_shooting.jl
@@ -37,9 +37,9 @@ function SciMLBase.__solve(prob::BVProblem, alg_::Shooting; odesolve_kwargs = (;
     y_ = similar(resid_prototype)
 
     jac_cache = if iip
-        DI.prepare_jacobian(nothing, y_, diffmode, vec(u0))
+        DI.prepare_jacobian(nothing, y_, diffmode, vec(u0); strict = Val(false))
     else
-        DI.prepare_jacobian(nothing, diffmode, vec(u0))
+        DI.prepare_jacobian(nothing, diffmode, vec(u0); strict = Val(false))
     end
 
     ode_cache_jac_fn = __single_shooting_jacobian_ode_cache(
