Merge pull request SciML#2887 from AayushSabharwal/as/default-nothing

feat: allow specifying `nothing` as default value to skip it

Author: ChrisRackauckas

src/systems/diffeqs/odesystem.jl

@@ -238,7 +238,8 @@ function ODESystem(deqs::AbstractVector{<:Equation}, iv, dvs, ps;
             :ODESystem, force = true)
     end
     defaults = todict(defaults)
-    defaults = Dict{Any, Any}(value(k) => value(v) for (k, v) in pairs(defaults))
+    defaults = Dict{Any, Any}(value(k) => value(v)
+    for (k, v) in pairs(defaults) if value(v) !== nothing)
     var_to_name = Dict()
     process_variables!(var_to_name, defaults, dvs′)
     process_variables!(var_to_name, defaults, ps′)

src/systems/diffeqs/sdesystem.jl

@@ -203,7 +203,8 @@ function SDESystem(deqs::AbstractVector{<:Equation}, neqs::AbstractArray, iv, dv
             :SDESystem, force = true)
     end
     defaults = todict(defaults)
-    defaults = Dict(value(k) => value(v) for (k, v) in pairs(defaults))
+    defaults = Dict(value(k) => value(v)
+    for (k, v) in pairs(defaults) if value(v) !== nothing)
 
     var_to_name = Dict()
     process_variables!(var_to_name, defaults, dvs′)

src/systems/discrete_system/discrete_system.jl

@@ -149,7 +149,8 @@ function DiscreteSystem(eqs::AbstractVector{<:Equation}, iv, dvs, ps;
             :DiscreteSystem, force = true)
     end
     defaults = todict(defaults)
-    defaults = Dict(value(k) => value(v) for (k, v) in pairs(defaults))
+    defaults = Dict(value(k) => value(v)
+    for (k, v) in pairs(defaults) if value(v) !== nothing)
 
     var_to_name = Dict()
     process_variables!(var_to_name, defaults, dvs′)

src/systems/jumps/jumpsystem.jl

@@ -176,7 +176,8 @@ function JumpSystem(eqs, iv, unknowns, ps;
             :JumpSystem, force = true)
     end
     defaults = todict(defaults)
-    defaults = Dict(value(k) => value(v) for (k, v) in pairs(defaults))
+    defaults = Dict(value(k) => value(v)
+    for (k, v) in pairs(defaults) if value(v) !== nothing)
 
     unknowns, ps = value.(unknowns), value.(ps)
     var_to_name = Dict()

src/systems/nonlinear/nonlinearsystem.jl

@@ -146,7 +146,8 @@ function NonlinearSystem(eqs, unknowns, ps;
     end
     jac = RefValue{Any}(EMPTY_JAC)
     defaults = todict(defaults)
-    defaults = Dict{Any, Any}(value(k) => value(v) for (k, v) in pairs(defaults))
+    defaults = Dict{Any, Any}(value(k) => value(v)
+    for (k, v) in pairs(defaults) if value(v) !== nothing)
 
     unknowns, ps = value.(unknowns), value.(ps)
     var_to_name = Dict()

src/systems/optimization/constraints_system.jl

@@ -133,7 +133,8 @@ function ConstraintsSystem(constraints, unknowns, ps;
 
     jac = RefValue{Any}(EMPTY_JAC)
     defaults = todict(defaults)
-    defaults = Dict(value(k) => value(v) for (k, v) in pairs(defaults))
+    defaults = Dict(value(k) => value(v)
+    for (k, v) in pairs(defaults) if value(v) !== nothing)
 
     var_to_name = Dict()
     process_variables!(var_to_name, defaults, unknowns′)

src/systems/optimization/optimizationsystem.jl

@@ -111,7 +111,8 @@ function OptimizationSystem(op, unknowns, ps;
         throw(ArgumentError("System names must be unique."))
     end
     defaults = todict(defaults)
-    defaults = Dict(value(k) => value(v) for (k, v) in pairs(defaults))
+    defaults = Dict(value(k) => value(v)
+    for (k, v) in pairs(defaults) if value(v) !== nothing)
 
     var_to_name = Dict()
     process_variables!(var_to_name, defaults, unknowns′)

src/utils.jl

@@ -252,7 +252,9 @@ end
 
 function collect_defaults!(defs, vars)
     for v in vars
-        (haskey(defs, v) || !hasdefault(unwrap(v))) && continue
+        if haskey(defs, v) || !hasdefault(unwrap(v)) || (def = getdefault(v)) === nothing
+            continue
+        end
         defs[v] = getdefault(v)
     end
     return defs

test/initial_values.jl

@@ -91,3 +91,20 @@ eqs = [D(D(z)) ~ ones(2, 2)]
 prob = ODEProblem(sys, [], (0.0, 1.0), [A1 => 0.3])
 @test prob.ps[B1] == 0.3
 @test prob.ps[B2] == 0.7
+
+@testset "default=nothing is skipped" begin
+    @parameters p = nothing
+    @variables x(t)=nothing y(t)
+    for sys in [
+        ODESystem(Equation[], t, [x, y], [p]; defaults = [y => nothing], name = :osys),
+        SDESystem(Equation[], [], t, [x, y], [p]; defaults = [y => nothing], name = :ssys),
+        JumpSystem(Equation[], t, [x, y], [p]; defaults = [y => nothing], name = :jsys),
+        NonlinearSystem(Equation[], [x, y], [p]; defaults = [y => nothing], name = :nsys),
+        OptimizationSystem(
+            Equation[], [x, y], [p]; defaults = [y => nothing], name = :optsys),
+        ConstraintsSystem(
+            Equation[], [x, y], [p]; defaults = [y => nothing], name = :conssys)
+    ]
+        @test isempty(ModelingToolkit.defaults(sys))
+    end
+end