Merge pull request #1819 from SciML/myb/md

Reorder metadata and pass kwarg

Author: YingboMa

Project.toml

@@ -70,7 +70,7 @@ NonlinearSolve = "0.3.8"
 RecursiveArrayTools = "2.3"
 Reexport = "0.2, 1"
 RuntimeGeneratedFunctions = "0.4.3, 0.5"
-SciMLBase = "1.54"
+SciMLBase = "1.56.1"
 Setfield = "0.7, 0.8, 1"
 SpecialFunctions = "0.7, 0.8, 0.9, 0.10, 1.0, 2"
 StaticArrays = "0.10, 0.11, 0.12, 1.0"

src/ModelingToolkit.jl

@@ -5,6 +5,7 @@ module ModelingToolkit
 using DocStringExtensions
 using AbstractTrees
 using DiffEqBase, SciMLBase, ForwardDiff, Reexport
+using SciMLBase: StandardODEProblem, StandardNonlinearProblem
 using Distributed
 using StaticArrays, LinearAlgebra, SparseArrays, LabelledArrays
 using InteractiveUtils

src/systems/diffeqs/abstractodesystem.jl

@@ -669,10 +669,12 @@ function DiffEqBase.ODEProblem{iip, specialize}(sys::AbstractODESystem, u0map, t
                                  check_length, kwargs...)
     cbs = process_events(sys; callback, has_difference, kwargs...)
     kwargs = filter_kwargs(kwargs)
+    pt = something(get_metadata(sys), StandardODEProblem())
+
     if cbs === nothing
-        ODEProblem{iip}(f, u0, tspan, p; kwargs...)
+        ODEProblem{iip}(f, u0, tspan, p, pt; kwargs...)
     else
-        ODEProblem{iip}(f, u0, tspan, p; callback = cbs, kwargs...)
+        ODEProblem{iip}(f, u0, tspan, p, pt; callback = cbs, kwargs...)
     end
 end
 get_callback(prob::ODEProblem) = prob.kwargs[:callback]

src/systems/diffeqs/odesystem.jl

@@ -89,10 +89,6 @@ struct ODESystem <: AbstractODESystem
     """
     connector_type::Any
     """
-    connections: connections in a system
-    """
-    connections::Any
-    """
     preface: inject assignment statements before the evaluation of the RHS function.
     """
     preface::Any
@@ -108,23 +104,23 @@ struct ODESystem <: AbstractODESystem
     """
     discrete_events::Vector{SymbolicDiscreteCallback}
     """
+    metadata: metadata for the system, to be used by downstream packages.
+    """
+    metadata::Any
+    """
     tearing_state: cache for intermediate tearing state
     """
     tearing_state::Any
     """
     substitutions: substitutions generated by tearing.
     """
     substitutions::Any
-    """
-    metadata: metadata for the system, to be used by downstream packages.
-    """
-    metadata::Any
 
     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, connections, preface, cevents,
-                       devents, tearing_state = nothing, substitutions = nothing,
-                       metadata = nothing;
+                       torn_matching, connector_type, preface, cevents,
+                       devents, metadata = nothing, tearing_state = nothing,
+                       substitutions = nothing;
                        checks::Union{Bool, Int} = true)
         if checks == true || (checks & CheckComponents) > 0
             check_variables(dvs, iv)
@@ -137,8 +133,8 @@ struct ODESystem <: AbstractODESystem
         end
         new(deqs, iv, dvs, ps, var_to_name, ctrls, observed, tgrad, jac,
             ctrl_jac, Wfact, Wfact_t, name, systems, defaults, torn_matching,
-            connector_type, connections, preface, cevents, devents, tearing_state,
-            substitutions, metadata)
+            connector_type, preface, cevents, devents, metadata, tearing_state,
+            substitutions)
     end
 end
 
@@ -191,7 +187,7 @@ function ODESystem(deqs::AbstractVector{<:Equation}, iv, dvs, ps;
     disc_callbacks = SymbolicDiscreteCallbacks(discrete_events)
     ODESystem(deqs, iv′, dvs′, ps′, var_to_name, ctrl′, observed, tgrad, jac,
               ctrl_jac, Wfact, Wfact_t, name, systems, defaults, nothing,
-              connector_type, nothing, preface, cont_callbacks, disc_callbacks,
+              connector_type, preface, cont_callbacks, disc_callbacks,
               metadata, checks = checks)
 end
 

src/systems/discrete_system/discrete_system.jl

@@ -60,22 +60,22 @@ struct DiscreteSystem <: AbstractTimeDependentSystem
     """
     connector_type::Any
     """
+    metadata: metadata for the system, to be used by downstream packages.
+    """
+    metadata::Any
+    """
     tearing_state: cache for intermediate tearing state
     """
     tearing_state::Any
     """
     substitutions: substitutions generated by tearing.
     """
     substitutions::Any
-    """
-    metadata: metadata for the system, to be used by downstream packages.
-    """
-    metadata::Any
 
     function DiscreteSystem(discreteEqs, iv, dvs, ps, var_to_name, ctrls, observed, name,
                             systems, defaults, preface, connector_type,
-                            tearing_state = nothing, substitutions = nothing,
-                            metadata = nothing;
+                            metadata = nothing,
+                            tearing_state = nothing, substitutions = nothing;
                             checks::Union{Bool, Int} = true)
         if checks == true || (checks & CheckComponents) > 0
             check_variables(dvs, iv)
@@ -85,7 +85,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, tearing_state, substitutions, metadata)
+            preface, connector_type, metadata, tearing_state, substitutions)
     end
 end
 

src/systems/nonlinear/nonlinearsystem.jl

@@ -51,9 +51,9 @@ struct NonlinearSystem <: AbstractTimeIndependentSystem
     """
     connector_type::Any
     """
-    connections: connections in a system
+    metadata: metadata for the system, to be used by downstream packages.
     """
-    connections::Any
+    metadata::Any
     """
     tearing_state: cache for intermediate tearing state
     """
@@ -62,20 +62,16 @@ struct NonlinearSystem <: AbstractTimeIndependentSystem
     substitutions: substitutions generated by tearing.
     """
     substitutions::Any
-    """
-    metadata: metadata for the system, to be used by downstream packages.
-    """
-    metadata::Any
 
     function NonlinearSystem(eqs, states, ps, var_to_name, observed, jac, name, systems,
-                             defaults, connector_type, connections, tearing_state = nothing,
-                             substitutions = nothing, metadata = nothing;
+                             defaults, connector_type, metadata = nothing,
+                             tearing_state = nothing, substitutions = nothing;
                              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, connections, tearing_state, substitutions, metadata)
+            connector_type, metadata, tearing_state, substitutions)
     end
 end
 
@@ -125,7 +121,7 @@ function NonlinearSystem(eqs, states, ps;
     isempty(observed) || collect_var_to_name!(var_to_name, (eq.lhs for eq in observed))
 
     NonlinearSystem(eqs, states, ps, var_to_name, observed, jac, name, systems, defaults,
-                    connector_type, nothing, metadata, checks = checks)
+                    connector_type, metadata, checks = checks)
 end
 
 function calculate_jacobian(sys::NonlinearSystem; sparse = false, simplify = false)
@@ -344,7 +340,8 @@ function DiffEqBase.NonlinearProblem{iip}(sys::NonlinearSystem, u0map,
                                           check_length = true, kwargs...) where {iip}
     f, u0, p = process_NonlinearProblem(NonlinearFunction{iip}, sys, u0map, parammap;
                                         check_length, kwargs...)
-    NonlinearProblem{iip}(f, u0, p; kwargs...)
+    pt = something(get_metadata(sys), StandardNonlinearProblem())
+    NonlinearProblem{iip}(f, u0, p, pt; kwargs...)
 end
 
 """

test/discretesystem.jl

@@ -4,6 +4,7 @@
 - https://en.wikipedia.org/wiki/Compartmental_models_in_epidemiology#Deterministic_versus_stochastic_epidemic_models
 =#
 using ModelingToolkit, Test
+using ModelingToolkit: get_metadata
 
 @inline function rate_to_proportion(r, t)
     1 - exp(-r * t)
@@ -179,3 +180,10 @@ RHS2 = RHS
     sol = solve(prob, FunctionMap(); dt = dt)
     @test c[1] + 1 == length(sol)
 end
+
+@parameters t
+@variables x(t) y(t)
+D = Difference(t; dt = 0.1)
+testdict = Dict([:test => 1])
+@named sys = DiscreteSystem([D(x) ~ 1.0]; metadata = testdict)
+@test get_metadata(sys) == testdict

test/nonlinearsystem.jl

@@ -1,4 +1,5 @@
 using ModelingToolkit, StaticArrays, LinearAlgebra
+using ModelingToolkit: get_metadata
 using DiffEqBase, SparseArrays
 using Test
 using NonlinearSolve
@@ -202,3 +203,11 @@ let
 
     @test sol[u] ≈ ones(4)
 end
+
+@variables x(t)
+@parameters a
+eqs = [0 ~ a * x]
+
+testdict = Dict([:test => 1])
+@named sys = NonlinearSystem(eqs, [x], [a], metadata = testdict)
+@test get_metadata(sys) == testdict

test/odesystem.jl

@@ -1,4 +1,5 @@
 using ModelingToolkit, StaticArrays, LinearAlgebra
+using ModelingToolkit: get_metadata
 using OrdinaryDiffEq, Sundials
 using DiffEqBase, SparseArrays
 using StaticArrays
@@ -878,3 +879,14 @@ let
            ∂t(P) ~ -80.0sin(Q)]
     @test_throws ArgumentError @named sys = ODESystem(eqs)
 end
+
+@parameters C L R
+@variables t q(t) p(t) F(t)
+D = Differential(t)
+
+eqs = [D(q) ~ -p / L - F
+       D(p) ~ q / C
+       0 ~ q / C - R * F]
+testdict = Dict([:name => "test"])
+@named sys = ODESystem(eqs, t, metadata = testdict)
+@test get_metadata(sys) == testdict

test/optimizationsystem.jl

@@ -1,5 +1,6 @@
 using ModelingToolkit, SparseArrays, Test, Optimization, OptimizationOptimJL,
       OptimizationMOI, Ipopt, AmplNLWriter, Ipopt_jll
+using ModelingToolkit: get_metadata
 
 @variables x y
 @parameters a b
@@ -174,3 +175,13 @@ end
     sol = solve(prob, Ipopt.Optimizer())
     @test sol.minimum < 1.0
 end
+
+@variables x
+o1 = (x - 1)^2
+c1 = [
+    x ~ 1,
+]
+testdict = Dict(["test" => 1])
+sys1 = OptimizationSystem(o1, [x], [], name = :sys1, constraints = c1,
+                          metadata = testdict)
+@test get_metadata(sys1) == testdict