Merge pull request #2544 from AayushSabharwal/as/sii-default-values

refactor: implement new additions to SII interface

Author: ChrisRackauckas

Project.toml

@@ -102,7 +102,7 @@ SimpleNonlinearSolve = "0.1.0, 1"
 SparseArrays = "1"
 SpecialFunctions = "0.7, 0.8, 0.9, 0.10, 1.0, 2"
 StaticArrays = "0.10, 0.11, 0.12, 1.0"
-SymbolicIndexingInterface = "0.3.1"
+SymbolicIndexingInterface = "0.3.11"
 SymbolicUtils = "1.0"
 Symbolics = "5.24"
 URIs = "1"

docs/src/basics/FAQ.md

@@ -20,17 +20,17 @@ Indexes into the `MTKParameters` object take the form of `ParameterIndex` object
 are similarly undocumented. Following is the list of behaviors that should be relied on for
 `MTKParameters`:
 
-- It implements the SciMLStructures interface.
-- It can be queried for parameters using functions returned from
-  `SymbolicIndexingInterface.getp`.
-- `getindex(::MTKParameters, ::ParameterIndex)` can be used to obtain the value of a
-  parameter with the given index.
-- `setindex!(::MTKParameters, value, ::ParameterIndex)` can be used to set the value of a
-  parameter with the given index.
-- `parameter_values(sys, sym)` will return a `ParameterIndex` object if `sys` has been
-  `complete`d (through `structural_simplify`, `complete` or `@mtkbuild`).
-- `copy(::MTKParameters)` is defined and duplicates the parameter object, including the
-  memory used by the underlying buffers.
+  - It implements the SciMLStructures interface.
+  - It can be queried for parameters using functions returned from
+    `SymbolicIndexingInterface.getp`.
+  - `getindex(::MTKParameters, ::ParameterIndex)` can be used to obtain the value of a
+    parameter with the given index.
+  - `setindex!(::MTKParameters, value, ::ParameterIndex)` can be used to set the value of a
+    parameter with the given index.
+  - `parameter_values(sys, sym)` will return a `ParameterIndex` object if `sys` has been
+    `complete`d (through `structural_simplify`, `complete` or `@mtkbuild`).
+  - `copy(::MTKParameters)` is defined and duplicates the parameter object, including the
+    memory used by the underlying buffers.
 
 Any other behavior of `MTKParameters` (other `getindex`/`setindex!` methods, etc.) is an
 undocumented internal and should not be relied upon.

src/systems/abstractsystem.jl

@@ -495,6 +495,8 @@ function SymbolicIndexingInterface.is_observed(sys::AbstractSystem, sym)
            !is_independent_variable(sys, sym) && symbolic_type(sym) != NotSymbolic()
 end
 
+SymbolicIndexingInterface.default_values(sys::AbstractSystem) = get_defaults(sys)
+
 SymbolicIndexingInterface.is_time_dependent(::AbstractTimeDependentSystem) = true
 SymbolicIndexingInterface.is_time_dependent(::AbstractTimeIndependentSystem) = false
 

src/systems/systemstructure.jl

@@ -630,7 +630,7 @@ function _structural_simplify!(state::TearingState, io; simplify = false,
     if has_io
         ModelingToolkit.markio!(state, orig_inputs, io...)
     end
-    if io !== nothing
+    if io !== nothing || any(isinput, state.fullvars)
         state, input_idxs = ModelingToolkit.inputs_to_parameters!(state, io)
     else
         input_idxs = 0:-1 # Empty range

test/runtests.jl

@@ -24,6 +24,7 @@ end
             @safetestset "Parsing Test" include("variable_parsing.jl")
             @safetestset "Simplify Test" include("simplify.jl")
             @safetestset "Direct Usage Test" include("direct.jl")
+            @safetestset "SymbolicIndeingInterface test" include("symbolic_indexing_interface.jl")
             @safetestset "System Linearity Test" include("linearity.jl")
             @safetestset "Input Output Test" include("input_output_handling.jl")
             @safetestset "Clock Test" include("clock.jl")

test/symbolic_indexing_interface.jl

@@ -1,7 +1,7 @@
 using ModelingToolkit, SymbolicIndexingInterface, SciMLBase
 
 @parameters t a b
-@variables x(t) y(t)
+@variables x(t)=1.0 y(t)=2.0
 D = Differential(t)
 eqs = [D(x) ~ a * y + t, D(y) ~ b * t]
 @named odesys = ODESystem(eqs, t, [x, y], [a, b])
@@ -21,6 +21,9 @@ eqs = [D(x) ~ a * y + t, D(y) ~ b * t]
 @test isequal(independent_variable_symbols(odesys), [t])
 @test is_time_dependent(odesys)
 @test constant_structure(odesys)
+@test !isempty(default_values(odesys))
+@test default_values(odesys)[x] == 1.0
+@test default_values(odesys)[y] == 2.0
 
 @variables x y z
 @parameters σ ρ β