Merge pull request #2471 from SciML/myb/array

Format

Author: YingboMa

NEWS.md

@@ -2,39 +2,43 @@
 
 ### Upgrade guide
 
-- The function `states` is renamed to `unknowns`. In a similar vein:
-  - `unknown_states` is now `solved_unknowns`.
-  - `get_states` is `get_unknowns`.
-  - `get_unknown_states` is now `get_solved_unknowns`.
-- The default backend for using units in models is now `DynamicQuantities.jl` instead of
-  `Unitful.jl`.
-- ModelingToolkit.jl now exports common definitions of `t` (time independent variable)
-  and `D` (the first derivative with respect to `t`). Any models made using ModelingToolkit.jl
-  should leverage these common definitions. There are three variants:
-  - `t` and `D` use DynamicQuantities.jl units. This is the default for standard library
-    components.
-  - `t_unitful` and `D_unitful` use Unitful.jl units.
-  - `t_nounits` and `D_nounits` are unitless.
-- `ODAEProblem` is deprecated in favor of `ODEProblem`.
-- Specifying the independent variable for an `ODESystem` is now mandatory. The `ODESystem(eqs)`
-  constructor is removed.
-- Systems must be marked as `complete` before creating `*Function`/`*FunctionExpr`/`*Problem`/
-  `*ProblemExpr`. Typically this involved using `@mtkbuild` to create the system or calling
-  `structural_simplify` on an existing system.
-- All systems will perform parameter splitting by default. Problems created using ModelingToolkit.jl
-  systems will have a custom struct instead of a `Vector` of parameters. The internals of this
-  type are undocumented and subject to change without notice or a breaking release. Parameter values
-  can be queried, updated or manipulated using SciMLStructures.jl or SymbolicIndexingInterface.jl.
-  This also requires that the symbolic type of a parameter match its assigned value. For example,
-  `@parameters p` will always use a `Float64` value for `p`. To use `Int` instead, use
-  `@parameters p::Int`. Array-valued parameters must be array symbolics; `@parameters p = [1.0, 2.0]`
-  is now invalid and must be changed to `@parameters p[1:2] = [1.0, 2.0]`. The index of a parameter
-  in the system is also not guaranteed to be an `Int`, and will instead be a custom undocumented type.
-  To restore the old behavior:
-  - Pass the `split = false` keyword to `structural_simplify`. E.g. `ss = structural_simplify(sys; split = false)`.
-  - Pass `split = false` to `@mtkbuild`. E.g. `@mtkbuild sys = ODESystem(...) split = false`.
-- Discrete-time system using `Difference` are unsupported. Instead, use the new `Clock`-based syntax.
-- Automatic scalarization has been removed, meaning that vector variables need to be treated with proper vector
-  equations. For example, `[p[1] => 1.0, p[2] => 2.0]` is no longer allowed in default equations, use
-  `[p => [1.0, 2.0]]` instead. Also, array equations like for `@variables u[1:2]` have `D(u) ~ A*u` as an
-  array equation. If the scalarized version is desired, use `scalarize(u)`.
+  - The function `states` is renamed to `unknowns`. In a similar vein:
+    
+      + `unknown_states` is now `solved_unknowns`.
+      + `get_states` is `get_unknowns`.
+      + `get_unknown_states` is now `get_solved_unknowns`.
+
+  - The default backend for using units in models is now `DynamicQuantities.jl` instead of
+    `Unitful.jl`.
+  - ModelingToolkit.jl now exports common definitions of `t` (time independent variable)
+    and `D` (the first derivative with respect to `t`). Any models made using ModelingToolkit.jl
+    should leverage these common definitions. There are three variants:
+    
+      + `t` and `D` use DynamicQuantities.jl units. This is the default for standard library
+        components.
+      + `t_unitful` and `D_unitful` use Unitful.jl units.
+      + `t_nounits` and `D_nounits` are unitless.
+  - `ODAEProblem` is deprecated in favor of `ODEProblem`.
+  - Specifying the independent variable for an `ODESystem` is now mandatory. The `ODESystem(eqs)`
+    constructor is removed.
+  - Systems must be marked as `complete` before creating `*Function`/`*FunctionExpr`/`*Problem`/
+    `*ProblemExpr`. Typically this involved using `@mtkbuild` to create the system or calling
+    `structural_simplify` on an existing system.
+  - All systems will perform parameter splitting by default. Problems created using ModelingToolkit.jl
+    systems will have a custom struct instead of a `Vector` of parameters. The internals of this
+    type are undocumented and subject to change without notice or a breaking release. Parameter values
+    can be queried, updated or manipulated using SciMLStructures.jl or SymbolicIndexingInterface.jl.
+    This also requires that the symbolic type of a parameter match its assigned value. For example,
+    `@parameters p` will always use a `Float64` value for `p`. To use `Int` instead, use
+    `@parameters p::Int`. Array-valued parameters must be array symbolics; `@parameters p = [1.0, 2.0]`
+    is now invalid and must be changed to `@parameters p[1:2] = [1.0, 2.0]`. The index of a parameter
+    in the system is also not guaranteed to be an `Int`, and will instead be a custom undocumented type.
+    To restore the old behavior:
+    
+      + Pass the `split = false` keyword to `structural_simplify`. E.g. `ss = structural_simplify(sys; split = false)`.
+      + Pass `split = false` to `@mtkbuild`. E.g. `@mtkbuild sys = ODESystem(...) split = false`.
+  - Discrete-time system using `Difference` are unsupported. Instead, use the new `Clock`-based syntax.
+  - Automatic scalarization has been removed, meaning that vector variables need to be treated with proper vector
+    equations. For example, `[p[1] => 1.0, p[2] => 2.0]` is no longer allowed in default equations, use
+    `[p => [1.0, 2.0]]` instead. Also, array equations like for `@variables u[1:2]` have `D(u) ~ A*u` as an
+    array equation. If the scalarized version is desired, use `scalarize(u)`.

docs/src/basics/Validation.md

@@ -10,7 +10,7 @@ Units may be assigned with the following syntax.
 using ModelingToolkit, Unitful
 @variables t [unit = u"s"] x(t) [unit = u"m"] g(t) w(t) [unit = "Hz"]
 
-@variables(t, [unit = u"s"], x(t), [unit = u"m"], g(t), w(t),[unit = "Hz"])
+@variables(t, [unit = u"s"], x(t), [unit = u"m"], g(t), w(t), [unit = "Hz"])
 
 @variables(begin
     t, [unit = u"s"],

src/systems/abstractsystem.jl

@@ -1393,11 +1393,11 @@ macro mtkbuild(exprs...)
     named_expr = ModelingToolkit.named_expr(expr)
     name = named_expr.args[1]
     kwargs = if length(exprs) > 1
-        NamedTuple{Tuple(ex.args[1] for ex in Base.tail(exprs))}(Tuple(ex.args[2] for ex in Base.tail(exprs)))
+        NamedTuple{Tuple(ex.args[1] for ex in Base.tail(exprs))}(Tuple(ex.args[2]
+        for ex in Base.tail(exprs)))
     else
         (;)
     end
-        @show kwargs
     esc(quote
         $named_expr
         $name = $structural_simplify($name; $(kwargs)...)

src/systems/systems.jl

@@ -16,7 +16,8 @@ The optional argument `io` may take a tuple `(inputs, outputs)`.
 This will convert all `inputs` to parameters and allow them to be unconnected, i.e.,
 simplification will allow models where `n_unknowns = n_equations - n_inputs`.
 """
-function structural_simplify(sys::AbstractSystem, io = nothing; simplify = false, split = true,
+function structural_simplify(
+        sys::AbstractSystem, io = nothing; simplify = false, split = true,
         kwargs...)
     newsys′ = __structural_simplify(sys, io; simplify, kwargs...)
     if newsys′ isa Tuple

test/dq_units.jl

@@ -43,12 +43,12 @@ ODESystem(eqs, t, name = :sys, checks = false)
 # connection validation
 @connector function Pin(; name)
     sts = @variables(v(t)=1.0, [unit = u"V"],
-        i(t)=1.0,[unit = u"A", connect = Flow])
+        i(t)=1.0, [unit = u"A", connect = Flow])
     ODESystem(Equation[], t, sts, []; name = name)
 end
 @connector function OtherPin(; name)
     sts = @variables(v(t)=1.0, [unit = u"mV"],
-        i(t)=1.0,[unit = u"mA", connect = Flow])
+        i(t)=1.0, [unit = u"mA", connect = Flow])
     ODESystem(Equation[], t, sts, []; name = name)
 end
 @connector function LongPin(; name)

test/modelingtoolkitize.jl

@@ -253,8 +253,8 @@ problem = ODEProblem(SIR!, u0, tspan, p)
 sys = complete(modelingtoolkitize(problem))
 
 @parameters t
-@test all(isequal.(parameters(sys), getproperty.(@variables(β, η, ω, φ, σ,μ), :val)))
-@test all(isequal.(Symbol.(unknowns(sys)), Symbol.(@variables(S(t), I(t), R(t),C(t)))))
+@test all(isequal.(parameters(sys), getproperty.(@variables(β, η, ω, φ, σ, μ), :val)))
+@test all(isequal.(Symbol.(unknowns(sys)), Symbol.(@variables(S(t), I(t), R(t), C(t)))))
 
 # https://github.com/SciML/ModelingToolkit.jl/issues/1158
 

test/units.jl

@@ -66,18 +66,18 @@ ODESystem(eqs, t, name = :sys, checks = false)
 # connection validation
 @connector function Pin(; name)
     sts = @variables(v(t)=1.0, [unit = u"V"],
-        i(t)=1.0,[unit = u"A", connect = Flow])
+        i(t)=1.0, [unit = u"A", connect = Flow])
     ODESystem(Equation[], t, sts, []; name = name)
 end
 @connector function OtherPin(; name)
     sts = @variables(v(t)=1.0, [unit = u"mV"],
-        i(t)=1.0,[unit = u"mA", connect = Flow])
+        i(t)=1.0, [unit = u"mA", connect = Flow])
     ODESystem(Equation[], t, sts, []; name = name)
 end
 @connector function LongPin(; name)
     sts = @variables(v(t)=1.0, [unit = u"V"],
         i(t)=1.0, [unit = u"A", connect = Flow],
-        x(t)=1.0,[unit = NoUnits])
+        x(t)=1.0, [unit = NoUnits])
     ODESystem(Equation[], t, sts, []; name = name)
 end
 @named p1 = Pin()