Skip to content

Array parameters and "substitute" don't work together #3628

Open
@ctessum

Description

@ctessum

Describe the bug 🐞

I would like to use an array parameter in a system, and then use "substitute" to change one variable in that system to something else. This does not work.

Expected behavior

I would expect the example below to work.

Minimal Reproducible Example 👇

using ModelingToolkit
using ModelingToolkit: t_nounits, D_nounits
t = t_nounits
D = D_nounits

@parameters p1[1:3]=[1,2,3]
@parameters p2::Int=3
@variables(x(t)=0, y(t)=0)

eq = [
    D(x) ~ p1[p2]
]

@named sys = ODESystem(eq, t, [x], [p1, p2]; name=:test)

sys2 = substitute(sys, x=>y) # ERROR: MethodError: no method matching hasmetadata(::Vector{Int64}, ::Type{Symbolics.VariableSource})

However, if I implement the missing method, then it works fine:

ModelingToolkit.hasmetadata(::Vector{Int64}, ::Type{Symbolics.VariableSource}) = false

sys2 = substitute(sys, x=>y) # Works fine

Error & Stacktrace ⚠️

ERROR: MethodError: no method matching hasmetadata(::Vector{Int64}, ::Type{Symbolics.VariableSource})
The function `hasmetadata` exists, but no method is defined for this combination of argument types.

Closest candidates are:
  hasmetadata(::Num, ::Any)
   @ Symbolics ~/.julia/packages/Symbolics/285ea/src/Symbolics.jl:194
  hasmetadata(::Complex{Num}, ::Any)
   @ Symbolics ~/.julia/packages/Symbolics/285ea/src/Symbolics.jl:194
  hasmetadata(::AbstractArray{AbstractFloat}, ::Type{Symbolics.VariableSource})
   @ Main .../test.jl:19
  ...

Stacktrace:
  [1] isvariable(x::SymbolicUtils.BasicSymbolic{Int64})
    @ ModelingToolkit ~/.julia/packages/ModelingToolkit/Iruox/src/utils.jl:383
  [2] vars!(vars::Set{Any}, O::SymbolicUtils.BasicSymbolic{Int64}; op::Type)
    @ ModelingToolkit ~/.julia/packages/ModelingToolkit/Iruox/src/utils.jl:420
  [3] vars!
    @ ~/.julia/packages/ModelingToolkit/Iruox/src/utils.jl:419 [inlined]
  [4] #58
    @ ~/.julia/packages/ModelingToolkit/Iruox/src/utils.jl:410 [inlined]
  [5] BottomRF
    @ ./reduce.jl:86 [inlined]
  [6] _foldl_impl
    @ ./reduce.jl:58 [inlined]
  [7] foldl_impl
    @ ./reduce.jl:48 [inlined]
  [8] mapfoldl_impl(f::typeof(identity), op::ModelingToolkit.var"#58#59"{}, nt::Set{…}, itr::Vector{…})
    @ Base ./reduce.jl:44
  [9] mapfoldl(f::Function, op::Function, itr::Vector{SymbolicUtils.BasicSymbolic{Int64}}; init::Set{Any})
    @ Base ./reduce.jl:175
 [10] mapfoldl
    @ ./reduce.jl:175 [inlined]
 [11] foldl
    @ ./reduce.jl:198 [inlined]
 [12] #vars#57
    @ ~/.julia/packages/ModelingToolkit/Iruox/src/utils.jl:410 [inlined]
 [13] vars
    @ ~/.julia/packages/ModelingToolkit/Iruox/src/utils.jl:408 [inlined]
 [14] vars(exprs::SymbolicUtils.BasicSymbolic{Int64}; op::Type)
    @ ModelingToolkit ~/.julia/packages/ModelingToolkit/Iruox/src/utils.jl:404
 [15] vars
    @ ~/.julia/packages/ModelingToolkit/Iruox/src/utils.jl:403 [inlined]
 [16] collect_vars!(unknowns::OrderedCollections.OrderedSet{…}, parameters::OrderedCollections.OrderedSet{…}, expr::SymbolicUtils.BasicSymbolic{…}, iv::SymbolicUtils.BasicSymbolic{…}; depth::Int64, op::Type)
    @ ModelingToolkit ~/.julia/packages/ModelingToolkit/Iruox/src/utils.jl:570
 [17] collect_vars!(unknowns::OrderedCollections.OrderedSet{…}, parameters::OrderedCollections.OrderedSet{…}, expr::SymbolicUtils.BasicSymbolic{…}, iv::SymbolicUtils.BasicSymbolic{…})
    @ ModelingToolkit ~/.julia/packages/ModelingToolkit/Iruox/src/utils.jl:566
 [18] collect_var!(unknowns::OrderedCollections.OrderedSet{…}, parameters::OrderedCollections.OrderedSet{…}, var::SymbolicUtils.BasicSymbolic{…}, iv::SymbolicUtils.BasicSymbolic{…}; depth::Int64)
    @ ModelingToolkit ~/.julia/packages/ModelingToolkit/Iruox/src/utils.jl:619
 [19] collect_vars!(unknowns::OrderedCollections.OrderedSet{…}, parameters::OrderedCollections.OrderedSet{…}, expr::SymbolicUtils.BasicSymbolic{…}, iv::SymbolicUtils.BasicSymbolic{…}; depth::Int64, op::Type)
    @ ModelingToolkit ~/.julia/packages/ModelingToolkit/Iruox/src/utils.jl:574
 [20] collect_vars!(unknowns::OrderedCollections.OrderedSet{…}, parameters::OrderedCollections.OrderedSet{…}, eq::Equation, iv::SymbolicUtils.BasicSymbolic{…}; depth::Int64, op::Type)
    @ ModelingToolkit ~/.julia/packages/ModelingToolkit/Iruox/src/utils.jl:594
 [21] collect_vars!
    @ ~/.julia/packages/ModelingToolkit/Iruox/src/utils.jl:591 [inlined]
 [22] process_equations(eqs::Vector{Equation}, iv::SymbolicUtils.BasicSymbolic{Real})
    @ ModelingToolkit ~/.julia/packages/ModelingToolkit/Iruox/src/utils.jl:1238
 [23] ODESystem(eqs::Vector{…}, iv::SymbolicUtils.BasicSymbolic{…}; kwargs::@Kwargs{})
    @ ModelingToolkit ~/.julia/packages/ModelingToolkit/Iruox/src/systems/diffeqs/odesystem.jl:374
 [24] substitute(sys::ODESystem, rules::Dict{SymbolicUtils.BasicSymbolic{Real}, SymbolicUtils.BasicSymbolic{Real}})
    @ ModelingToolkit ~/.julia/packages/ModelingToolkit/Iruox/src/systems/abstractsystem.jl:2845
 [25] (::Symbolics.var"#21#23"{Symbolics.var"#21#22#24"{Dict{}}})(expr::ODESystem)
    @ Symbolics ~/.julia/packages/Symbolics/285ea/src/num.jl:93
 [26] substitute(expr::ODESystem, s::Pair{Num, Num}; kw::@Kwargs{})
    @ Symbolics ~/.julia/packages/Symbolics/285ea/src/num.jl:78
 [27] top-level scope
    @ .../test.jl:22
Some type information was truncated. Use `show(err)` to see complete types.

Environment (please complete the following information):

  • Output of using Pkg; Pkg.status()
Status `..../test13/Project.toml`
  [961ee093] ModelingToolkit v9.78.0
  • Output of using Pkg; Pkg.status(; mode = PKGMODE_MANIFEST)
Status `~/Google Drive/uiuc/manuscripts/o3rcm/test13/Manifest.toml`
  [47edcb42] ADTypes v1.14.0
  [1520ce14] AbstractTrees v0.4.5
  [7d9f7c33] Accessors v0.1.42
  [79e6a3ab] Adapt v4.3.0
  [66dad0bd] AliasTables v1.1.3
  [ec485272] ArnoldiMethod v0.4.0
  [4fba245c] ArrayInterface v7.18.1
  [4c555306] ArrayLayouts v1.11.1
  [e2ed5e7c] Bijections v0.1.10
  [62783981] BitTwiddlingConvenienceFunctions v0.1.6
  [8e7c35d0] BlockArrays v1.6.3
  [70df07ce] BracketingNonlinearSolve v1.2.0
  [2a0fbf3d] CPUSummary v0.2.6
  [d360d2e6] ChainRulesCore v1.25.1
  [fb6a15b2] CloseOpenIntervals v0.1.13
  [861a8166] Combinatorics v1.0.3
  [a80b9123] CommonMark v0.9.1
  [38540f10] CommonSolve v0.2.4
  [bbf7d656] CommonSubexpressions v0.3.1
  [f70d9fcc] CommonWorldInvalidations v1.0.0
  [34da2185] Compat v4.16.0
  [b152e2b5] CompositeTypes v0.1.4
  [a33af91c] CompositionsBase v0.1.2
  [2569d6c7] ConcreteStructs v0.2.3
  [187b0558] ConstructionBase v1.5.8
  [adafc99b] CpuId v0.3.1
  [a8cc5b0e] Crayons v4.1.1
  [9a962f9c] DataAPI v1.16.0
  [864edb3b] DataStructures v0.18.22
  [e2d170a0] DataValueInterfaces v1.0.0
  [2b5f629d] DiffEqBase v6.173.0
  [459566f4] DiffEqCallbacks v4.4.1
  [77a26b50] DiffEqNoiseProcess v5.24.1
  [163ba53b] DiffResults v1.1.0
  [b552c78f] DiffRules v1.15.1
  [a0c0ee7d] DifferentiationInterface v0.6.54
  [8d63f2c5] DispatchDoctor v0.4.19
  [31c24e10] Distributions v0.25.120
  [ffbed154] DocStringExtensions v0.9.4
  [5b8099bc] DomainSets v0.7.15
  [7c1d4256] DynamicPolynomials v0.6.1
  [06fc5a27] DynamicQuantities v1.8.0
  [4e289a0a] EnumX v1.0.5
  [f151be2c] EnzymeCore v0.8.8
  [e2ba6199] ExprTools v0.1.10
  [55351af7] ExproniconLite v0.10.14
  [7034ab61] FastBroadcast v0.3.5
  [9aa1b823] FastClosures v0.3.2
  [a4df4552] FastPower v1.1.2
  [1a297f60] FillArrays v1.13.0
  [64ca27bc] FindFirstFunctions v1.4.1
  [6a86dc24] FiniteDiff v2.27.0
  [1fa38f19] Format v1.3.7
⌅ [f6369f11] ForwardDiff v0.10.38
  [069b7b12] FunctionWrappers v1.1.3
  [77dc65aa] FunctionWrappersWrappers v0.1.3
  [d9f16b24] Functors v0.5.2
  [46192b85] GPUArraysCore v0.2.0
  [c27321d9] Glob v1.3.1
  [86223c79] Graphs v1.12.1
  [34004b35] HypergeometricFunctions v0.3.28
  [615f187c] IfElse v0.1.1
  [d25df0c9] Inflate v0.1.5
  [18e54dd8] IntegerMathUtils v0.1.2
  [8197267c] IntervalSets v0.7.11
  [3587e190] InverseFunctions v0.1.17
  [92d709cd] IrrationalConstants v0.2.4
  [82899510] IteratorInterfaceExtensions v1.0.0
  [692b3bcd] JLLWrappers v1.7.0
  [ae98c720] Jieko v0.2.1
  [98e50ef6] JuliaFormatter v2.1.2
⌅ [70703baa] JuliaSyntax v0.4.10
  [ccbc3e58] JumpProcesses v9.14.3
  [ba0b0d4f] Krylov v0.10.1
  [b964fa9f] LaTeXStrings v1.4.0
  [23fbe1c1] Latexify v0.16.7
  [10f19ff3] LayoutPointers v0.1.17
  [5078a376] LazyArrays v2.6.1
  [87fe0de2] LineSearch v0.1.4
  [d3d80556] LineSearches v7.3.0
  [7ed4a6bd] LinearSolve v3.11.0
  [2ab3a3ac] LogExpFunctions v0.3.29
  [d8e11817] MLStyle v0.4.17
  [1914dd2f] MacroTools v0.5.16
  [d125e4d3] ManualMemory v0.1.8
  [bb5d69b7] MaybeInplace v0.1.4
  [e1d29d7a] Missings v1.2.0
  [961ee093] ModelingToolkit v9.78.0
  [2e0e35c7] Moshi v0.3.5
  [46d2c3a1] MuladdMacro v0.2.4
  [102ac46a] MultivariatePolynomials v0.5.9
  [d8a4904e] MutableArithmetics v1.6.4
  [d41bc354] NLSolversBase v7.9.1
  [77ba4419] NaNMath v1.1.3
  [8913a72c] NonlinearSolve v4.8.0
  [be0214bd] NonlinearSolveBase v1.7.0
  [5959db7a] NonlinearSolveFirstOrder v1.5.0
  [9a2c21bd] NonlinearSolveQuasiNewton v1.4.0
  [26075421] NonlinearSolveSpectralMethods v1.2.0
  [6fe1bfb0] OffsetArrays v1.17.0
  [429524aa] Optim v1.12.0
  [bac558e1] OrderedCollections v1.8.0
  [90014a1f] PDMats v0.11.35
  [d96e819e] Parameters v0.12.3
  [e409e4f3] PoissonRandom v0.4.4
  [f517fe37] Polyester v0.7.16
  [1d0040c9] PolyesterWeave v0.2.2
  [85a6dd25] PositiveFactorizations v0.2.4
⌅ [aea7be01] PrecompileTools v1.2.1
  [21216c6a] Preferences v1.4.3
  [08abe8d2] PrettyTables v2.4.0
  [27ebfcd6] Primes v0.5.7
  [43287f4e] PtrArrays v1.3.0
  [1fd47b50] QuadGK v2.11.2
  [74087812] Random123 v1.7.0
  [e6cf234a] RandomNumbers v1.6.0
  [3cdcf5f2] RecipesBase v1.3.4
  [731186ca] RecursiveArrayTools v3.33.0
  [189a3867] Reexport v1.2.2
  [ae029012] Requires v1.3.1
  [ae5879a3] ResettableStacks v1.1.1
  [79098fc4] Rmath v0.8.0
  [7e49a35a] RuntimeGeneratedFunctions v0.5.14
  [9dfe8606] SCCNonlinearSolve v1.2.0
  [94e857df] SIMDTypes v0.1.0
  [0bca4576] SciMLBase v2.89.1
  [19f34311] SciMLJacobianOperators v0.1.4
  [c0aeaf25] SciMLOperators v0.4.0
  [53ae85a6] SciMLStructures v1.7.0
  [efcf1570] Setfield v1.1.2
  [727e6d20] SimpleNonlinearSolve v2.4.0
  [699a6c99] SimpleTraits v0.9.4
  [a2af1166] SortingAlgorithms v1.2.1
  [0a514795] SparseMatrixColorings v0.4.19
  [276daf66] SpecialFunctions v2.5.1
  [aedffcd0] Static v1.2.0
  [0d7ed370] StaticArrayInterface v1.8.0
  [90137ffa] StaticArrays v1.9.13
  [1e83bf80] StaticArraysCore v1.4.3
  [10745b16] Statistics v1.11.1
  [82ae8749] StatsAPI v1.7.0
  [2913bbd2] StatsBase v0.34.5
  [4c63d2b9] StatsFuns v1.5.0
  [7792a7ef] StrideArraysCore v0.5.7
  [892a3eda] StringManipulation v0.4.1
  [2efcf032] SymbolicIndexingInterface v0.3.40
  [19f23fe9] SymbolicLimits v0.2.2
  [d1185830] SymbolicUtils v3.27.0
  [0c5d862f] Symbolics v6.39.0
  [3783bdb8] TableTraits v1.0.1
  [bd369af6] Tables v1.12.0
  [ed4db957] TaskLocalValues v0.1.2
  [8ea1fca8] TermInterface v2.0.0
  [1c621080] TestItems v1.0.0
  [8290d209] ThreadingUtilities v0.5.3
  [a759f4b9] TimerOutputs v0.5.28
  [410a4b4d] Tricks v0.1.10
  [781d530d] TruncatedStacktraces v1.4.0
  [5c2747f8] URIs v1.5.2
  [3a884ed6] UnPack v1.0.2
  [1986cc42] Unitful v1.22.0
  [a7c27f48] Unityper v0.1.6
  [897b6980] WeakValueDicts v0.1.0
  [1d5cc7b8] IntelOpenMP_jll v2025.0.4+0
  [856f044c] MKL_jll v2025.0.1+1
  [efe28fd5] OpenSpecFun_jll v0.5.6+0
  [f50d1b31] Rmath_jll v0.5.1+0
  [1317d2d5] oneTBB_jll v2022.0.0+0
  [0dad84c5] ArgTools v1.1.2
  [56f22d72] Artifacts v1.11.0
  [2a0f44e3] Base64 v1.11.0
  [ade2ca70] Dates v1.11.0
  [8ba89e20] Distributed v1.11.0
  [f43a241f] Downloads v1.6.0
  [7b1f6079] FileWatching v1.11.0
  [9fa8497b] Future v1.11.0
  [b77e0a4c] InteractiveUtils v1.11.0
  [4af54fe1] LazyArtifacts v1.11.0
  [b27032c2] LibCURL v0.6.4
  [76f85450] LibGit2 v1.11.0
  [8f399da3] Libdl v1.11.0
  [37e2e46d] LinearAlgebra v1.11.0
  [56ddb016] Logging v1.11.0
  [d6f4376e] Markdown v1.11.0
  [a63ad114] Mmap v1.11.0
  [ca575930] NetworkOptions v1.2.0
  [44cfe95a] Pkg v1.11.0
  [de0858da] Printf v1.11.0
  [9a3f8284] Random v1.11.0
  [ea8e919c] SHA v0.7.0
  [9e88b42a] Serialization v1.11.0
  [1a1011a3] SharedArrays v1.11.0
  [6462fe0b] Sockets v1.11.0
  [2f01184e] SparseArrays v1.11.0
  [4607b0f0] SuiteSparse
  [fa267f1f] TOML v1.0.3
  [a4e569a6] Tar v1.10.0
  [8dfed614] Test v1.11.0
  [cf7118a7] UUIDs v1.11.0
  [4ec0a83e] Unicode v1.11.0
  [e66e0078] CompilerSupportLibraries_jll v1.1.1+0
  [deac9b47] LibCURL_jll v8.6.0+0
  [e37daf67] LibGit2_jll v1.7.2+0
  [29816b5a] LibSSH2_jll v1.11.0+1
  [c8ffd9c3] MbedTLS_jll v2.28.6+0
  [14a3606d] MozillaCACerts_jll v2023.12.12
  [4536629a] OpenBLAS_jll v0.3.27+1
  [05823500] OpenLibm_jll v0.8.1+4
  [bea87d4a] SuiteSparse_jll v7.7.0+0
  [83775a58] Zlib_jll v1.2.13+1
  [8e850b90] libblastrampoline_jll v5.11.0+0
  [8e850ede] nghttp2_jll v1.59.0+0
  [3f19e933] p7zip_jll v17.4.0+2
Info Packages marked with ⌅ have new versions available but compatibility constraints restrict them from upgrading. To see why use `status --outdated -m`
  • Output of versioninfo()
Julia Version 1.11.4
Commit 8561cc3d68d (2025-03-10 11:36 UTC)
Build Info:
  Official https://julialang.org/ release
Platform Info:
  OS: macOS (arm64-apple-darwin24.0.0)
  CPU: 8 × Apple M1
  WORD_SIZE: 64
  LLVM: libLLVM-16.0.6 (ORCJIT, apple-m1)
Threads: 4 default, 0 interactive, 2 GC (on 4 virtual cores)
Environment:
  JULIA_EDITOR = code
  JULIA_NUM_THREADS = 4

Additional context

if I implement the missing method, then it works fine:

ModelingToolkit.hasmetadata(::Vector{Int64}, ::Type{Symbolics.VariableSource}) = false

sys2 = substitute(sys, x=>y) # Works fine

Metadata

Metadata

Labels

bugSomething isn't working

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions