fix: fix SymScope metadata for array variables

Co-authored-by: contradict <[email protected]>

Author: AayushSabharwal

src/systems/abstractsystem.jl

@@ -746,38 +746,64 @@ end
 abstract type SymScope end
 
 struct LocalScope <: SymScope end
-function LocalScope(sym::Union{Num, Symbolic})
+function LocalScope(sym::Union{Num, Symbolic, Symbolics.Arr{Num}})
     apply_to_variables(sym) do sym
-        setmetadata(sym, SymScope, LocalScope())
+        if istree(sym) && operation(sym) === getindex
+            args = arguments(sym)
+            a1 = setmetadata(args[1], SymScope, LocalScope())
+            similarterm(sym, operation(sym), [a1, args[2:end]...])
+        else
+            setmetadata(sym, SymScope, LocalScope())
+        end
     end
 end
 
 struct ParentScope <: SymScope
     parent::SymScope
 end
-function ParentScope(sym::Union{Num, Symbolic})
+function ParentScope(sym::Union{Num, Symbolic, Symbolics.Arr{Num}})
     apply_to_variables(sym) do sym
-        setmetadata(sym, SymScope,
-            ParentScope(getmetadata(value(sym), SymScope, LocalScope())))
+        if istree(sym) && operation(sym) == getindex
+            args = arguments(sym)
+            a1 = setmetadata(args[1], SymScope,
+                ParentScope(getmetadata(value(args[1]), SymScope, LocalScope())))
+            similarterm(sym, operation(sym), [a1, args[2:end]...])
+        else
+            setmetadata(sym, SymScope,
+                ParentScope(getmetadata(value(sym), SymScope, LocalScope())))
+        end
     end
 end
 
 struct DelayParentScope <: SymScope
     parent::SymScope
     N::Int
 end
-function DelayParentScope(sym::Union{Num, Symbolic}, N)
+function DelayParentScope(sym::Union{Num, Symbolic, Symbolics.Arr{Num}}, N)
     apply_to_variables(sym) do sym
-        setmetadata(sym, SymScope,
-            DelayParentScope(getmetadata(value(sym), SymScope, LocalScope()), N))
+        if istree(sym) && operation(sym) == getindex
+            args = arguments(sym)
+            a1 = setmetadata(args[1], SymScope,
+                DelayParentScope(getmetadata(value(args[1]), SymScope, LocalScope()), N))
+            similarterm(sym, operation(sym), [a1, args[2:end]...])
+        else
+            setmetadata(sym, SymScope,
+                DelayParentScope(getmetadata(value(sym), SymScope, LocalScope()), N))
+        end
     end
 end
-DelayParentScope(sym::Union{Num, Symbolic}) = DelayParentScope(sym, 1)
+DelayParentScope(sym::Union{Num, Symbolic, Symbolics.Arr{Num}}) = DelayParentScope(sym, 1)
 
 struct GlobalScope <: SymScope end
-function GlobalScope(sym::Union{Num, Symbolic})
+function GlobalScope(sym::Union{Num, Symbolic, Symbolics.Arr{Num}})
     apply_to_variables(sym) do sym
-        setmetadata(sym, SymScope, GlobalScope())
+        if istree(sym) && operation(sym) == getindex
+            args = arguments(sym)
+            a1 = setmetadata(args[1], SymScope, GlobalScope())
+            similarterm(sym, operation(sym), [a1, args[2:end]...])
+        else
+            setmetadata(sym, SymScope, GlobalScope())
+        end
     end
 end
 
@@ -1500,8 +1526,7 @@ function default_to_parentscope(v)
     uv isa Symbolic || return v
     apply_to_variables(v) do sym
         if !hasmetadata(uv, SymScope)
-            setmetadata(sym, SymScope,
-                ParentScope(getmetadata(value(sym), SymScope, LocalScope())))
+            ParentScope(sym)
         else
             sym
         end

test/variable_scope.jl

@@ -73,3 +73,13 @@ ps = ModelingToolkit.getname.(parameters(level3))
 @test isequal(ps[4], :level2₊level0₊d)
 @test isequal(ps[5], :level1₊level0₊e)
 @test isequal(ps[6], :f)
+
+# Issue@2252
+# Tests from PR#2354
+@parameters xx[1:2]
+arr_p = [ParentScope(xx[1]), xx[2]]
+arr0 = ODESystem(Equation[], t, [], arr_p; name = :arr0)
+arr1 = ODESystem(Equation[], t, [], []; name = :arr1) ∘ arr0
+arr_ps = ModelingToolkit.getname.(parameters(arr1))
+@test isequal(arr_ps[1], Symbol("xx"))
+@test isequal(arr_ps[2], Symbol("arr0₊xx"))