Merge pull request #1863 from SciML/myb/complete

Define `complete` for hierarchical systems

Author: YingboMa

src/ModelingToolkit.jl

@@ -111,6 +111,7 @@ function parameters end
 
 # this has to be included early to deal with depency issues
 include("structural_transformation/bareiss.jl")
+function complete end
 include("bipartite_graph.jl")
 using .BipartiteGraphs
 
@@ -210,7 +211,7 @@ export simplify, substitute
 export build_function
 export modelingtoolkitize
 export @variables, @parameters
-export @named, @nonamespace, @namespace, extend, compose
+export @named, @nonamespace, @namespace, extend, compose, complete
 export debug_system
 
 end # module

src/bipartite_graph.jl

@@ -1,12 +1,14 @@
 module BipartiteGraphs
 
+import ModelingToolkit: complete
+
 export BipartiteEdge, BipartiteGraph, DiCMOBiGraph, Unassigned, unassigned,
        Matching, ResidualCMOGraph, InducedCondensationGraph, maximal_matching,
        construct_augmenting_path!, MatchedCondensationGraph
 
 export 𝑠vertices, 𝑑vertices, has_𝑠vertex, has_𝑑vertex, 𝑠neighbors, 𝑑neighbors,
        𝑠edges, 𝑑edges, nsrcs, ndsts, SRC, DST, set_neighbors!, invview,
-       complete, delete_srcs!, delete_dsts!
+       delete_srcs!, delete_dsts!
 
 using DocStringExtensions
 using UnPack

src/structural_transformation/StructuralTransformations.jl

@@ -25,7 +25,7 @@ using ModelingToolkit: ODESystem, AbstractSystem, var_from_nested_derivative, Di
                        AliasGraph, filter_kwargs, lower_varname, setio
 
 using ModelingToolkit.BipartiteGraphs
-import .BipartiteGraphs: invview
+import .BipartiteGraphs: invview, complete
 using Graphs
 using ModelingToolkit.SystemStructures
 using ModelingToolkit.SystemStructures: algeqs, EquationsView

src/systems/abstractsystem.jl

@@ -162,6 +162,18 @@ independent_variables(sys::AbstractTimeDependentSystem) = [getfield(sys, :iv)]
 independent_variables(sys::AbstractTimeIndependentSystem) = []
 independent_variables(sys::AbstractMultivariateSystem) = getfield(sys, :ivs)
 
+iscomplete(sys::AbstractSystem) = isdefined(sys, :complete) && getfield(sys, :complete)
+
+"""
+$(TYPEDSIGNATURES)
+
+Mark a system as completed. If a system is complete, the system will no longer
+namespace its subsystems or variables, i.e. `isequal(complete(sys).v.i, v.i)`.
+"""
+function complete(sys::AbstractSystem)
+    isdefined(sys, :complete) ? (@set! sys.complete = true) : sys
+end
+
 for prop in [:eqs
              :noiseeqs
              :iv
@@ -266,10 +278,10 @@ function Base.propertynames(sys::AbstractSystem; private = false)
     end
 end
 
-function Base.getproperty(sys::AbstractSystem, name::Symbol; namespace = true)
+function Base.getproperty(sys::AbstractSystem, name::Symbol; namespace = !iscomplete(sys))
     wrap(getvar(sys, name; namespace = namespace))
 end
-function getvar(sys::AbstractSystem, name::Symbol; namespace = false)
+function getvar(sys::AbstractSystem, name::Symbol; namespace = !iscomplete(sys))
     systems = get_systems(sys)
     if isdefined(sys, name)
         Base.depwarn("`sys.name` like `sys.$name` is deprecated. Use getters like `get_$name` instead.",

src/systems/diffeqs/odesystem.jl

@@ -115,12 +115,16 @@ struct ODESystem <: AbstractODESystem
     substitutions: substitutions generated by tearing.
     """
     substitutions::Any
+    """
+    complete: if a model `sys` is complete, then `sys.x` no longer performs namespacing.
+    """
+    complete::Bool
 
     function ODESystem(deqs, iv, dvs, ps, var_to_name, ctrls, observed, tgrad,
                        jac, ctrl_jac, Wfact, Wfact_t, name, systems, defaults,
                        torn_matching, connector_type, preface, cevents,
                        devents, metadata = nothing, tearing_state = nothing,
-                       substitutions = nothing;
+                       substitutions = nothing, complete = false;
                        checks::Union{Bool, Int} = true)
         if checks == true || (checks & CheckComponents) > 0
             check_variables(dvs, iv)
@@ -134,7 +138,7 @@ struct ODESystem <: AbstractODESystem
         new(deqs, iv, dvs, ps, var_to_name, ctrls, observed, tgrad, jac,
             ctrl_jac, Wfact, Wfact_t, name, systems, defaults, torn_matching,
             connector_type, preface, cevents, devents, metadata, tearing_state,
-            substitutions)
+            substitutions, complete)
     end
 end
 

src/systems/diffeqs/sdesystem.jl

@@ -100,9 +100,14 @@ struct SDESystem <: AbstractODESystem
     metadata: metadata for the system, to be used by downstream packages.
     """
     metadata::Any
+    """
+    complete: if a model `sys` is complete, then `sys.x` no longer performs namespacing.
+    """
+    complete::Bool
+
     function SDESystem(deqs, neqs, iv, dvs, ps, var_to_name, ctrls, observed, tgrad, jac,
                        ctrl_jac, Wfact, Wfact_t, name, systems, defaults, connector_type,
-                       cevents, devents, metadata = nothing;
+                       cevents, devents, metadata = nothing, complete = false;
                        checks::Union{Bool, Int} = true)
         if checks == true || (checks & CheckComponents) > 0
             check_variables(dvs, iv)
@@ -115,7 +120,7 @@ struct SDESystem <: AbstractODESystem
         end
         new(deqs, neqs, iv, dvs, ps, var_to_name, ctrls, observed, tgrad, jac, ctrl_jac,
             Wfact, Wfact_t, name, systems, defaults, connector_type, cevents, devents,
-            metadata)
+            metadata, complete)
     end
 end
 

src/systems/discrete_system/discrete_system.jl

@@ -71,12 +71,16 @@ struct DiscreteSystem <: AbstractTimeDependentSystem
     substitutions: substitutions generated by tearing.
     """
     substitutions::Any
+    """
+    complete: if a model `sys` is complete, then `sys.x` no longer performs namespacing.
+    """
+    complete::Bool
 
     function DiscreteSystem(discreteEqs, iv, dvs, ps, var_to_name, ctrls, observed, name,
                             systems, defaults, preface, connector_type,
                             metadata = nothing,
-                            tearing_state = nothing, substitutions = nothing;
-                            checks::Union{Bool, Int} = true)
+                            tearing_state = nothing, substitutions = nothing,
+                            complete = false; checks::Union{Bool, Int} = true)
         if checks == true || (checks & CheckComponents) > 0
             check_variables(dvs, iv)
             check_parameters(ps, iv)
@@ -85,7 +89,7 @@ struct DiscreteSystem <: AbstractTimeDependentSystem
             all_dimensionless([dvs; ps; iv; ctrls]) || check_units(discreteEqs)
         end
         new(discreteEqs, iv, dvs, ps, var_to_name, ctrls, observed, name, systems, defaults,
-            preface, connector_type, metadata, tearing_state, substitutions)
+            preface, connector_type, metadata, tearing_state, substitutions, complete)
     end
 end
 

src/systems/jumps/jumpsystem.jl

@@ -87,9 +87,14 @@ struct JumpSystem{U <: ArrayPartition} <: AbstractTimeDependentSystem
     metadata: metadata for the system, to be used by downstream packages.
     """
     metadata::Any
+    """
+    complete: if a model `sys` is complete, then `sys.x` no longer performs namespacing.
+    """
+    complete::Bool
+
     function JumpSystem{U}(ap::U, iv, states, ps, var_to_name, observed, name, systems,
                            defaults, connector_type, devents,
-                           metadata = nothing;
+                           metadata = nothing, complete = false;
                            checks::Union{Bool, Int} = true) where {U <: ArrayPartition}
         if checks == true || (checks & CheckComponents) > 0
             check_variables(states, iv)
@@ -99,7 +104,7 @@ struct JumpSystem{U <: ArrayPartition} <: AbstractTimeDependentSystem
             all_dimensionless([states; ps; iv]) || check_units(ap, iv)
         end
         new{U}(ap, iv, states, ps, var_to_name, observed, name, systems, defaults,
-               connector_type, devents, metadata)
+               connector_type, devents, metadata, complete)
     end
 end
 

src/systems/nonlinear/nonlinearsystem.jl

@@ -62,16 +62,20 @@ struct NonlinearSystem <: AbstractTimeIndependentSystem
     substitutions: substitutions generated by tearing.
     """
     substitutions::Any
+    """
+    complete: if a model `sys` is complete, then `sys.x` no longer performs namespacing.
+    """
+    complete::Bool
 
     function NonlinearSystem(eqs, states, ps, var_to_name, observed, jac, name, systems,
                              defaults, connector_type, metadata = nothing,
-                             tearing_state = nothing, substitutions = nothing;
-                             checks::Union{Bool, Int} = true)
+                             tearing_state = nothing, substitutions = nothing,
+                             complete = false; checks::Union{Bool, Int} = true)
         if checks == true || (checks & CheckUnits) > 0
             all_dimensionless([states; ps]) || check_units(eqs)
         end
         new(eqs, states, ps, var_to_name, observed, jac, name, systems, defaults,
-            connector_type, metadata, tearing_state, substitutions)
+            connector_type, metadata, tearing_state, substitutions, complete)
     end
 end
 

src/systems/optimization/optimizationsystem.jl

@@ -41,16 +41,21 @@ struct OptimizationSystem <: AbstractTimeIndependentSystem
     metadata: metadata for the system, to be used by downstream packages.
     """
     metadata::Any
+    """
+    complete: if a model `sys` is complete, then `sys.x` no longer performs namespacing.
+    """
+    complete::Bool
+
     function OptimizationSystem(op, states, ps, var_to_name, observed,
-                                constraints, name, systems, defaults, metadata = nothing;
-                                checks::Union{Bool, Int} = true)
+                                constraints, name, systems, defaults, metadata = nothing,
+                                complete = false; checks::Union{Bool, Int} = true)
         if checks == true || (checks & CheckUnits) > 0
             unwrap(op) isa Symbolic && check_units(op)
             check_units(observed)
             all_dimensionless([states; ps]) || check_units(constraints)
         end
         new(op, states, ps, var_to_name, observed,
-            constraints, name, systems, defaults, metadata)
+            constraints, name, systems, defaults, metadata, complete)
     end
 end
 
@@ -143,7 +148,7 @@ namespace_constraint(eq::Equation, sys) = namespace_equation(eq, sys)
 #     _lhs = namespace_expr(ineq.lhs, sys, n)
 #     _rhs = namespace_expr(ineq.rhs, sys, n)
 #     Inequality(
-#         namespace_expr(_lhs, sys, n), 
+#         namespace_expr(_lhs, sys, n),
 #         namespace_expr(_rhs, sys, n),
 #         ineq.relational_op,
 #     )