Merge pull request #2078 from SciML/myb/gui

Add GUIMetadata

Author: YingboMa

src/systems/abstractsystem.jl

@@ -1,5 +1,12 @@
 const SYSTEM_COUNT = Threads.Atomic{UInt}(0)
 
+struct GUIMetadata
+    icon_name::String
+    layout::Any
+end
+
+GUIMetadata(icon_name) = GUIMetadata(icon_name, nothing)
+
 """
 ```julia
 calculate_tgrad(sys::AbstractTimeDependentSystem)
@@ -219,6 +226,7 @@ for prop in [:eqs
              :tearing_state
              :substitutions
              :metadata
+             :gui_metadata
              :discrete_subsystems
              :unknown_states]
     fname1 = Symbol(:get_, prop)

src/systems/diffeqs/odesystem.jl

@@ -115,6 +115,10 @@ struct ODESystem <: AbstractODESystem
     """
     metadata::Any
     """
+    gui_metadata: metadata for MTK GUI.
+    """
+    gui_metadata::Union{Nothing, GUIMetadata}
+    """
     tearing_state: cache for intermediate tearing state
     """
     tearing_state::Any
@@ -139,7 +143,8 @@ struct ODESystem <: AbstractODESystem
     function ODESystem(tag, deqs, iv, dvs, ps, tspan, 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,
+                       devents, metadata = nothing, gui_metadata = nothing,
+                       tearing_state = nothing,
                        substitutions = nothing, complete = false,
                        discrete_subsystems = nothing, unknown_states = nothing;
                        checks::Union{Bool, Int} = true)
@@ -154,8 +159,9 @@ struct ODESystem <: AbstractODESystem
         end
         new(tag, deqs, iv, dvs, ps, tspan, 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, complete, discrete_subsystems, unknown_states)
+            connector_type, preface, cevents, devents, metadata, gui_metadata,
+            tearing_state, substitutions, complete, discrete_subsystems,
+            unknown_states)
     end
 end
 
@@ -173,7 +179,8 @@ function ODESystem(deqs::AbstractVector{<:Equation}, iv, dvs, ps;
                    continuous_events = nothing,
                    discrete_events = nothing,
                    checks = true,
-                   metadata = nothing)
+                   metadata = nothing,
+                   gui_metadata = nothing)
     name === nothing &&
         throw(ArgumentError("The `name` keyword must be provided. Please consider using the `@named` macro"))
     deqs = scalarize(deqs)
@@ -211,7 +218,7 @@ function ODESystem(deqs::AbstractVector{<:Equation}, iv, dvs, ps;
               deqs, iv′, dvs′, ps′, tspan, var_to_name, ctrl′, observed, tgrad, jac,
               ctrl_jac, Wfact, Wfact_t, name, systems, defaults, nothing,
               connector_type, preface, cont_callbacks, disc_callbacks,
-              metadata, checks = checks)
+              metadata, gui_metadata, checks = checks)
 end
 
 function ODESystem(eqs, iv = nothing; kwargs...)

src/systems/diffeqs/sdesystem.jl

@@ -108,6 +108,10 @@ struct SDESystem <: AbstractODESystem
     """
     metadata::Any
     """
+    gui_metadata: metadata for MTK GUI.
+    """
+    gui_metadata::Union{Nothing, GUIMetadata}
+    """
     complete: if a model `sys` is complete, then `sys.x` no longer performs namespacing.
     """
     complete::Bool
@@ -116,7 +120,8 @@ struct SDESystem <: AbstractODESystem
                        tgrad,
                        jac,
                        ctrl_jac, Wfact, Wfact_t, name, systems, defaults, connector_type,
-                       cevents, devents, metadata = nothing, complete = false;
+                       cevents, devents, metadata = nothing, gui_metadata = nothing,
+                       complete = false;
                        checks::Union{Bool, Int} = true)
         if checks == true || (checks & CheckComponents) > 0
             check_variables(dvs, iv)
@@ -130,7 +135,7 @@ struct SDESystem <: AbstractODESystem
         new(tag, deqs, neqs, iv, dvs, ps, tspan, var_to_name, ctrls, observed, tgrad, jac,
             ctrl_jac,
             Wfact, Wfact_t, name, systems, defaults, connector_type, cevents, devents,
-            metadata, complete)
+            metadata, gui_metadata, complete)
     end
 end
 
@@ -147,7 +152,8 @@ function SDESystem(deqs::AbstractVector{<:Equation}, neqs::AbstractArray, iv, dv
                    checks = true,
                    continuous_events = nothing,
                    discrete_events = nothing,
-                   metadata = nothing)
+                   metadata = nothing,
+                   gui_metadata = nothing)
     name === nothing &&
         throw(ArgumentError("The `name` keyword must be provided. Please consider using the `@named` macro"))
     deqs = scalarize(deqs)
@@ -183,7 +189,7 @@ function SDESystem(deqs::AbstractVector{<:Equation}, neqs::AbstractArray, iv, dv
     SDESystem(Threads.atomic_add!(SYSTEM_COUNT, UInt(1)),
               deqs, neqs, iv′, dvs′, ps′, tspan, var_to_name, ctrl′, observed, tgrad, jac,
               ctrl_jac, Wfact, Wfact_t, name, systems, defaults, connector_type,
-              cont_callbacks, disc_callbacks, metadata; checks = checks)
+              cont_callbacks, disc_callbacks, metadata, gui_metadata; checks = checks)
 end
 
 function SDESystem(sys::ODESystem, neqs; kwargs...)

src/systems/discrete_system/discrete_system.jl

@@ -71,6 +71,10 @@ struct DiscreteSystem <: AbstractTimeDependentSystem
     """
     metadata::Any
     """
+    gui_metadata: metadata for MTK GUI.
+    """
+    gui_metadata::Union{Nothing, GUIMetadata}
+    """
     tearing_state: cache for intermediate tearing state
     """
     tearing_state::Any
@@ -87,7 +91,7 @@ struct DiscreteSystem <: AbstractTimeDependentSystem
                             observed,
                             name,
                             systems, defaults, preface, connector_type,
-                            metadata = nothing,
+                            metadata = nothing, gui_metadata = nothing,
                             tearing_state = nothing, substitutions = nothing,
                             complete = false; checks::Union{Bool, Int} = true)
         if checks == true || (checks & CheckComponents) > 0
@@ -100,7 +104,8 @@ struct DiscreteSystem <: AbstractTimeDependentSystem
         new(tag, discreteEqs, iv, dvs, ps, tspan, var_to_name, ctrls, observed, name,
             systems,
             defaults,
-            preface, connector_type, metadata, tearing_state, substitutions, complete)
+            preface, connector_type, metadata, gui_metadata,
+            tearing_state, substitutions, complete)
     end
 end
 
@@ -121,6 +126,7 @@ function DiscreteSystem(eqs::AbstractVector{<:Equation}, iv, dvs, ps;
                         preface = nothing,
                         connector_type = nothing,
                         metadata = nothing,
+                        gui_metadata = nothing,
                         kwargs...)
     name === nothing &&
         throw(ArgumentError("The `name` keyword must be provided. Please consider using the `@named` macro"))
@@ -148,7 +154,7 @@ function DiscreteSystem(eqs::AbstractVector{<:Equation}, iv, dvs, ps;
     end
     DiscreteSystem(Threads.atomic_add!(SYSTEM_COUNT, UInt(1)),
                    eqs, iv′, dvs′, ps′, tspan, var_to_name, ctrl′, observed, name, systems,
-                   defaults, preface, connector_type, metadata, kwargs...)
+                   defaults, preface, connector_type, metadata, gui_metadata, kwargs...)
 end
 
 function DiscreteSystem(eqs, iv = nothing; kwargs...)

src/systems/jumps/jumpsystem.jl

@@ -93,13 +93,18 @@ struct JumpSystem{U <: ArrayPartition} <: AbstractTimeDependentSystem
     """
     metadata::Any
     """
+    gui_metadata: metadata for MTK GUI.
+    """
+    gui_metadata::Union{Nothing, GUIMetadata}
+    """
     complete: if a model `sys` is complete, then `sys.x` no longer performs namespacing.
     """
     complete::Bool
 
     function JumpSystem{U}(tag, ap::U, iv, states, ps, var_to_name, observed, name, systems,
                            defaults, connector_type, devents,
-                           metadata = nothing, complete = false;
+                           metadata = nothing, gui_metadata = nothing,
+                           complete = false;
                            checks::Union{Bool, Int} = true) where {U <: ArrayPartition}
         if checks == true || (checks & CheckComponents) > 0
             check_variables(states, iv)
@@ -109,7 +114,7 @@ struct JumpSystem{U <: ArrayPartition} <: AbstractTimeDependentSystem
             all_dimensionless([states; ps; iv]) || check_units(ap, iv)
         end
         new{U}(tag, ap, iv, states, ps, var_to_name, observed, name, systems, defaults,
-               connector_type, devents, metadata, complete)
+               connector_type, devents, metadata, gui_metadata, complete)
     end
 end
 
@@ -125,6 +130,7 @@ function JumpSystem(eqs, iv, states, ps;
                     continuous_events = nothing,
                     discrete_events = nothing,
                     metadata = nothing,
+                    gui_metadata = nothing,
                     kwargs...)
     name === nothing &&
         throw(ArgumentError("The `name` keyword must be provided. Please consider using the `@named` macro"))
@@ -163,7 +169,7 @@ function JumpSystem(eqs, iv, states, ps;
 
     JumpSystem{typeof(ap)}(Threads.atomic_add!(SYSTEM_COUNT, UInt(1)),
                            ap, value(iv), states, ps, var_to_name, observed, name, systems,
-                           defaults, connector_type, disc_callbacks, metadata,
+                           defaults, connector_type, disc_callbacks, metadata, gui_metadata,
                            checks = checks)
 end
 

src/systems/nonlinear/nonlinearsystem.jl

@@ -60,6 +60,10 @@ struct NonlinearSystem <: AbstractTimeIndependentSystem
     """
     metadata::Any
     """
+    gui_metadata: metadata for MTK GUI.
+    """
+    gui_metadata::Union{Nothing, GUIMetadata}
+    """
     tearing_state: cache for intermediate tearing state
     """
     tearing_state::Any
@@ -75,13 +79,14 @@ struct NonlinearSystem <: AbstractTimeIndependentSystem
     function NonlinearSystem(tag, eqs, states, ps, var_to_name, observed, jac, name,
                              systems,
                              defaults, connector_type, metadata = nothing,
+                             gui_metadata = nothing,
                              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(tag, eqs, states, ps, var_to_name, observed, jac, name, systems, defaults,
-            connector_type, metadata, tearing_state, substitutions, complete)
+            connector_type, metadata, gui_metadata, tearing_state, substitutions, complete)
     end
 end
 
@@ -96,7 +101,8 @@ function NonlinearSystem(eqs, states, ps;
                          continuous_events = nothing, # this argument is only required for ODESystems, but is added here for the constructor to accept it without error
                          discrete_events = nothing,   # this argument is only required for ODESystems, but is added here for the constructor to accept it without error
                          checks = true,
-                         metadata = nothing)
+                         metadata = nothing,
+                         gui_metadata = nothing)
     continuous_events === nothing || isempty(continuous_events) ||
         throw(ArgumentError("NonlinearSystem does not accept `continuous_events`, you provided $continuous_events"))
     discrete_events === nothing || isempty(discrete_events) ||
@@ -132,7 +138,7 @@ function NonlinearSystem(eqs, states, ps;
 
     NonlinearSystem(Threads.atomic_add!(SYSTEM_COUNT, UInt(1)),
                     eqs, states, ps, var_to_name, observed, jac, name, systems, defaults,
-                    connector_type, metadata, checks = checks)
+                    connector_type, metadata, gui_metadata, checks = checks)
 end
 
 function calculate_jacobian(sys::NonlinearSystem; sparse = false, simplify = false)

src/systems/optimization/optimizationsystem.jl

@@ -49,20 +49,25 @@ struct OptimizationSystem <: AbstractOptimizationSystem
     """
     metadata::Any
     """
+    gui_metadata: metadata for MTK GUI.
+    """
+    gui_metadata::Union{Nothing, GUIMetadata}
+    """
     complete: if a model `sys` is complete, then `sys.x` no longer performs namespacing.
     """
     complete::Bool
 
     function OptimizationSystem(tag, op, states, ps, var_to_name, observed,
                                 constraints, name, systems, defaults, metadata = nothing,
-                                complete = false; checks::Union{Bool, Int} = true)
+                                gui_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(tag, op, states, ps, var_to_name, observed,
-            constraints, name, systems, defaults, metadata, complete)
+            constraints, name, systems, defaults, metadata, gui_metadata, complete)
     end
 end
 
@@ -77,7 +82,8 @@ function OptimizationSystem(op, states, ps;
                             name = nothing,
                             systems = OptimizationSystem[],
                             checks = true,
-                            metadata = nothing)
+                            metadata = nothing,
+                            gui_metadata = nothing)
     name === nothing &&
         throw(ArgumentError("The `name` keyword must be provided. Please consider using the `@named` macro"))
     constraints = value.(scalarize(constraints))
@@ -105,7 +111,8 @@ function OptimizationSystem(op, states, ps;
                        op′, states′, ps′, var_to_name,
                        observed,
                        constraints,
-                       name, systems, defaults, metadata; checks = checks)
+                       name, systems, defaults, metadata, gui_metadata;
+                       checks = checks)
 end
 
 function calculate_gradient(sys::OptimizationSystem)

src/systems/pde/pdesystem.jl

@@ -68,20 +68,25 @@ struct PDESystem <: ModelingToolkit.AbstractMultivariateSystem
     metadata: metadata for the system, to be used by downstream packages.
     """
     metadata::Any
+    """
+    gui_metadata: metadata for MTK GUI.
+    """
+    gui_metadata::Union{Nothing, GUIMetadata}
     @add_kwonly function PDESystem(eqs, bcs, domain, ivs, dvs,
                                    ps = SciMLBase.NullParameters();
                                    defaults = Dict(),
                                    systems = [],
                                    connector_type = nothing,
                                    metadata = nothing,
+                                   gui_metadata = nothing,
                                    checks::Union{Bool, Int} = true,
                                    name)
         if checks == true || (checks & CheckUnits) > 0
             all_dimensionless([dvs; ivs; ps]) || check_units(eqs)
         end
         eqs = eqs isa Vector ? eqs : [eqs]
         new(eqs, bcs, domain, ivs, dvs, ps, defaults, connector_type, systems, name,
-            metadata)
+            metadata, gui_metadata)
     end
 end