Add checks for unique subsystem names. Fixes #819.

Author: lamorton

src/systems/control/controlsystem.jl

@@ -60,7 +60,7 @@ struct ControlSystem <: AbstractControlSystem
     ps::Vector
     observed::Vector{Equation}
     """
-    Name: the name of the system
+    Name: the name of the system. These are required to have unique names.
     """
     name::Symbol
     """
@@ -84,6 +84,10 @@ function ControlSystem(loss, deqs::AbstractVector{<:Equation}, iv, dvs, controls
     if !(isempty(default_u0) && isempty(default_p))
         Base.depwarn("`default_u0` and `default_p` are deprecated. Use `defaults` instead.", :ControlSystem, force=true)
     end
+    sysnames = nameof.(systems)
+    if length(unique(sysnames)) != length(sysnames)
+        throw(ArgumentError("System names must be unique."))
+    end
     iv′ = value(iv)
     dvs′ = value.(dvs)
     controls′ = value.(controls)

src/systems/diffeqs/sdesystem.jl

@@ -63,7 +63,7 @@ struct SDESystem <: AbstractODESystem
     """
     name::Symbol
     """
-    Systems: the internal systems
+    Systems: the internal systems. These are required to have unique names.
     """
     systems::Vector{SDESystem}
     """
@@ -89,7 +89,10 @@ function SDESystem(deqs::AbstractVector{<:Equation}, neqs, iv, dvs, ps;
     iv′ = value(iv)
     dvs′ = value.(dvs)
     ps′ = value.(ps)
-
+    sysnames = nameof.(systems)
+    if length(unique(sysnames)) != length(sysnames)
+        throw(ArgumentError("System names must be unique."))
+    end
     if !(isempty(default_u0) && isempty(default_p))
         Base.depwarn("`default_u0` and `default_p` are deprecated. Use `defaults` instead.", :SDESystem, force=true)
     end

src/systems/jumps/jumpsystem.jl

@@ -38,7 +38,7 @@ struct JumpSystem{U <: ArrayPartition} <: AbstractSystem
     """The parameters of the system."""
     ps::Vector
     observed::Vector{Equation}
-    """The name of the system."""
+    """The name of the system. . These are required to have unique names."""
     name::Symbol
     """The internal systems."""
     systems::Vector{JumpSystem}
@@ -62,7 +62,10 @@ function JumpSystem(eqs, iv, states, ps;
                     name = gensym(:JumpSystem),
                     connection_type=nothing,
                     )
-
+    sysnames = nameof.(systems)
+    if length(unique(sysnames)) != length(sysnames)
+        throw(ArgumentError("System names must be unique."))
+    end
     ap = ArrayPartition(MassActionJump[], ConstantRateJump[], VariableRateJump[])
     for eq in eqs
         if eq isa MassActionJump

src/systems/nonlinear/nonlinearsystem.jl

@@ -32,7 +32,7 @@ struct NonlinearSystem <: AbstractSystem
     """
     jac::RefValue{Any}
     """
-    Name: the name of the system
+    Name: the name of the system. These are required to have unique names.
     """
     name::Symbol
     """
@@ -66,6 +66,10 @@ function NonlinearSystem(eqs, states, ps;
     if !(isempty(default_u0) && isempty(default_p))
         Base.depwarn("`default_u0` and `default_p` are deprecated. Use `defaults` instead.", :NonlinearSystem, force=true)
     end
+    sysnames = nameof.(systems)
+    if length(unique(sysnames)) != length(sysnames)
+        throw(ArgumentError("System names must be unique."))
+    end
     jac = RefValue{Any}(Matrix{Num}(undef, 0, 0))
     defaults = todict(defaults)
     defaults = Dict(value(k) => value(v) for (k, v) in pairs(defaults))

src/systems/optimization/optimizationsystem.jl

@@ -27,7 +27,7 @@ struct OptimizationSystem <: AbstractSystem
     equality_constraints::Vector{Equation}
     inequality_constraints::Vector
     """
-    Name: the name of the system
+    Name: the name of the system.  These are required to have unique names. 
     """
     name::Symbol
     """
@@ -53,6 +53,10 @@ function OptimizationSystem(op, states, ps;
     if !(isempty(default_u0) && isempty(default_p))
         Base.depwarn("`default_u0` and `default_p` are deprecated. Use `defaults` instead.", :OptimizationSystem, force=true)
     end
+    sysnames = nameof.(systems)
+    if length(unique(sysnames)) != length(sysnames)
+        throw(ArgumentError("System names must be unique."))
+    end
     defaults = todict(defaults)
     defaults = Dict(value(k) => value(v) for (k, v) in pairs(defaults))
 

test/controlsystem.jl

@@ -18,3 +18,14 @@ sys = runge_kutta_discretize(sys,dt,tspan)
 u0 = rand(length(states(sys))) # guess for the state values
 prob = OptimizationProblem(sys,u0,[0.1,0.1],grad=true)
 sol = solve(prob,BFGS())
+
+# issue #819
+@testset "Combined system name collisions" begin
+    eqs_short = [
+        D(x) ~ - p[2]*x
+        D(v) ~ p[1]*u^3
+    ]
+    sys1 = ControlSystem(loss,eqs_short,t,[x,v],[u],p,name=:sys1)
+    sys2 = ControlSystem(loss,eqs_short,t,[x,v],[u],p,name=:sys1)
+    @test_throws ArgumentError ControlSystem(loss,[sys2.v ~ sys1.v],t, [],[],[],systems=[sys1, sys2])
+end

test/jumpsystem.jl

@@ -153,3 +153,9 @@ dprob = DiscreteProblem(js4, [S => 999], (0,1000.), [β => 100.,γ => .01])
 jprob = JumpProblem(js4, dprob, Direct())
 sol = solve(jprob, SSAStepper());
 
+# issue #819
+@testset "Combined system name collisions" begin
+  sys1 = JumpSystem([maj1,maj2], t, [S], [β,γ],name=:sys1)
+  sys2 = JumpSystem([maj1,maj2], t, [S], [β,γ],name=:sys1)
+  @test_throws ArgumentError JumpSystem([sys1.γ ~ sys2.γ], t,[],[], systems=[sys1, sys2])
+end

test/nonlinearsystem.jl

@@ -118,3 +118,20 @@ eqs = [0 ~ σ*(y-x),
 ns = NonlinearSystem(eqs, [x,y,z], [σ,ρ,β])
 np = NonlinearProblem(ns, [0,0,0], [1,2,3], jac=true, sparse=true)
 @test ModelingToolkit.get_jac(ns)[] isa SparseMatrixCSC
+
+# issue #819
+@testset "Combined system name collisions" begin
+       function makesys(name)
+           @parameters a
+           @variables x f
+   
+           NonlinearSystem([0 ~ -a*x + f],[x,f],[a], name=name)
+       end
+   
+       function issue819()
+           sys1 = makesys(:sys1)
+           sys2 = makesys(:sys1)
+           @test_throws ArgumentError NonlinearSystem([sys2.f ~ sys1.x, sys1.f ~ 0],[],[], systems=[sys1, sys2])
+       end
+       issue819()
+end

test/optimizationsystem.jl

@@ -54,3 +54,9 @@ _p  = [1.0, 100.0]
 f = OptimizationFunction(rosenbrock,ModelingToolkit.AutoModelingToolkit(),x0,_p,grad=true,hess=true)
 prob = OptimizationProblem(f,x0,_p)
 sol = solve(prob,Optim.Newton())
+
+# issue #819
+@testset "Combined system name collisions" begin
+    sys2 = OptimizationSystem(loss,[x,y],[a,b],name=:sys1)
+    @test_throws ArgumentError OptimizationSystem(loss2,[z],[β],systems=[sys1,sys2])
+end

test/sdesystem.jl

@@ -432,3 +432,14 @@ du = similar(u0, size(prob.noise_rate_prototype))
 fdif!(du,u0,p,t)
 @test du == [ cos(p[1])*sin(u0[1])   cos(p[1])*cos(u0[1])   -sin(p[1])*sin(u0[2])   -sin(p[1])*cos(u0[2])
               sin(p[1])*sin(u0[1])   sin(p[1])*cos(u0[1])    cos(p[1])*sin(u0[2])    cos(p[1])*cos(u0[2])]
+
+# issue #819
+@testset "Combined system name collisions" begin
+    @variables t
+    eqs_short = [D(x) ~ σ*(y-x),
+                D(y) ~ x*(ρ-z)-y,
+                ]
+    sys1 = SDESystem(eqs_short,noiseeqs,t,[x,y,z],[σ,ρ,β],name=:sys1)
+    sys2 = SDESystem(eqs_short,noiseeqs,t,[x,y,z],[σ,ρ,β],name=:sys1)
+    @test_throws ArgumentError SDESystem([sys2.y ~ sys1.z], t,[],[],[], systems=[sys1, sys2])
+end