Merge pull request #2044 from SciML/myb/scope

Apply scope recursively

Author: YingboMa

src/systems/abstractsystem.jl

@@ -357,30 +357,54 @@ function Base.setproperty!(sys::AbstractSystem, prop::Symbol, val)
     end
 end
 
+function apply_to_variables(f::F, ex) where {F}
+    ex = value(ex)
+    if isvariable(ex)
+        return f(ex)
+    end
+    istree(ex) || return ex
+    similarterm(ex, apply_to_variables(f, operation(ex)),
+                map(Base.Fix1(apply_to_variables, f), arguments(ex)),
+                metadata = metadata(ex))
+end
+
 abstract type SymScope end
 
 struct LocalScope <: SymScope end
-LocalScope(sym::Union{Num, Symbolic}) = setmetadata(sym, SymScope, LocalScope())
+function LocalScope(sym::Union{Num, Symbolic})
+    apply_to_variables(sym) do sym
+        setmetadata(sym, SymScope, LocalScope())
+    end
+end
 
 struct ParentScope <: SymScope
     parent::SymScope
 end
 function ParentScope(sym::Union{Num, Symbolic})
-    setmetadata(sym, SymScope, ParentScope(getmetadata(value(sym), SymScope, LocalScope())))
+    apply_to_variables(sym) do sym
+        setmetadata(sym, SymScope,
+                    ParentScope(getmetadata(value(sym), SymScope, LocalScope())))
+    end
 end
 
 struct DelayParentScope <: SymScope
     parent::SymScope
     N::Int
 end
 function DelayParentScope(sym::Union{Num, Symbolic}, N)
-    setmetadata(sym, SymScope,
-                DelayParentScope(getmetadata(value(sym), SymScope, LocalScope()), N))
+    apply_to_variables(sym) do sym
+        setmetadata(sym, SymScope,
+                    DelayParentScope(getmetadata(value(sym), SymScope, LocalScope()), N))
+    end
 end
 DelayParentScope(sym::Union{Num, Symbolic}) = DelayParentScope(sym, 1)
 
 struct GlobalScope <: SymScope end
-GlobalScope(sym::Union{Num, Symbolic}) = setmetadata(sym, SymScope, GlobalScope())
+function GlobalScope(sym::Union{Num, Symbolic})
+    apply_to_variables(sym) do sym
+        setmetadata(sym, SymScope, GlobalScope())
+    end
+end
 
 renamespace(sys, eq::Equation) = namespace_equation(eq, sys)
 
@@ -996,7 +1020,15 @@ end
 
 function default_to_parentscope(v)
     uv = unwrap(v)
-    uv isa Symbolic && !hasmetadata(uv, SymScope) ? ParentScope(v) : 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())))
+        else
+            sym
+        end
+    end
 end
 
 function _config(expr, namespace)

test/structural_transformation/bareiss.jl

@@ -16,12 +16,13 @@ function det_bareiss!(M)
 end
 
 @testset "bareiss tests" begin
-# copy gives a dense matrix
-@testset "bareiss tests: $T" for T in (copy, sparse)
-    # matrix determinent pairs
-    for (M, d) in ((BigInt[9 1 8 0; 0 0 8 7; 7 6 8 3; 2 9 7 7], -1),
-                   (BigInt[1 big(2)^65+1; 3 4], 4 - 3 * (big(2)^65 + 1)))
-        # test that the determinent was correctly computed
-        @test det_bareiss!(T(M)) == d
+    # copy gives a dense matrix
+    @testset "bareiss tests: $T" for T in (copy, sparse)
+        # matrix determinent pairs
+        for (M, d) in ((BigInt[9 1 8 0; 0 0 8 7; 7 6 8 3; 2 9 7 7], -1),
+                       (BigInt[1 big(2)^65+1; 3 4], 4 - 3 * (big(2)^65 + 1)))
+            # test that the determinent was correctly computed
+            @test det_bareiss!(T(M)) == d
+        end
     end
-end end
+end

test/variable_scope.jl

@@ -1,4 +1,6 @@
 using ModelingToolkit
+using ModelingToolkit: SymScope
+using Symbolics: arguments, value
 using Test
 
 @parameters t
@@ -13,6 +15,9 @@ LocalScope(e.val)
 ParentScope(e.val)
 GlobalScope(e.val)
 
+ie = ParentScope(1 / e)
+@test getmetadata(arguments(value(ie))[2], SymScope) === ParentScope(LocalScope())
+
 eqs = [0 ~ a
        0 ~ b
        0 ~ c