Make checks optional & opt out of them for internal operations that should not need to validate user inputs. Add tests for structural_simplify that motivated this change.

Author: lamorton

src/systems/abstractsystem.jl

@@ -192,9 +192,10 @@ Setfield.get(obj::AbstractSystem, ::Setfield.PropertyLens{field}) where {field}
                 :(getfield(obj, $(Meta.quot(fn))))
             end
         end
+        kwarg = :($(Expr(:kw, :checks, false))) # Inputs should already be checked
         return Expr(:block,
             Expr(:meta, :inline),
-            Expr(:call,:(constructorof($obj)), args...)
+            Expr(:call, :(constructorof($obj)), args..., kwarg)
         )
     else
         error("This should never happen. Trying to set $(typeof(obj)) with $patch.")

src/systems/control/controlsystem.jl

@@ -72,12 +72,14 @@ struct ControlSystem <: AbstractControlSystem
     parameters are not supplied in `ODEProblem`.
     """
     defaults::Dict
-    function ControlSystem(loss, deqs, iv, dvs, controls, ps, observed, name, systems, defaults)
-        check_variables(dvs, iv)
-        check_parameters(ps, iv)
-        check_equations(deqs, iv)
-        check_equations(observed, iv)
-        check_units(deqs)
+    function ControlSystem(loss, deqs, iv, dvs, controls, ps, observed, name, systems, defaults; checks::Bool = true)
+        if checks
+            check_variables(dvs, iv)
+            check_parameters(ps, iv)
+            check_equations(deqs, iv)
+            check_equations(observed, iv)
+            check_units(deqs)
+        end
         new(loss, deqs, iv, dvs, controls, ps, observed, name, systems, defaults)
     end
 end

src/systems/diffeqs/odesystem.jl

@@ -84,11 +84,13 @@ struct ODESystem <: AbstractODESystem
     """
     connection_type::Any
 
-    function ODESystem(deqs, iv, dvs, ps, var_to_name, ctrls, observed, tgrad, jac, ctrl_jac, Wfact, Wfact_t, name, systems, defaults, structure, connection_type)
-        check_variables(dvs,iv)
-        check_parameters(ps,iv)
-        check_equations(deqs,iv)
-        check_units(deqs)
+    function ODESystem(deqs, iv, dvs, ps, var_to_name, ctrls, observed, tgrad, jac, ctrl_jac, Wfact, Wfact_t, name, systems, defaults, structure, connection_type; checks::Bool = true)
+        if checks
+            check_variables(dvs,iv)
+            check_parameters(ps,iv)
+            check_equations(deqs,iv)
+            check_units(deqs)
+        end
         new(deqs, iv, dvs, ps, var_to_name, ctrls, observed, tgrad, jac, ctrl_jac, Wfact, Wfact_t, name, systems, defaults, structure, connection_type)
     end
 end

src/systems/diffeqs/sdesystem.jl

@@ -86,11 +86,13 @@ struct SDESystem <: AbstractODESystem
     """
     connection_type::Any
 
-    function SDESystem(deqs, neqs, iv, dvs, ps, var_to_name, ctrls, observed, tgrad, jac, ctrl_jac, Wfact, Wfact_t, name, systems, defaults, connection_type)
-        check_variables(dvs,iv)
-        check_parameters(ps,iv)
-        check_equations(deqs,iv)
-        check_units(deqs,neqs)
+    function SDESystem(deqs, neqs, iv, dvs, ps, var_to_name, ctrls, observed, tgrad, jac, ctrl_jac, Wfact, Wfact_t, name, systems, defaults, connection_type; checks::Bool = true)
+        if checks
+            check_variables(dvs,iv)
+            check_parameters(ps,iv)
+            check_equations(deqs,iv)
+            check_units(deqs,neqs)
+        end
         new(deqs, neqs, iv, dvs, ps, var_to_name, ctrls, observed, tgrad, jac, ctrl_jac, Wfact, Wfact_t, name, systems, defaults, connection_type)
     end
 end

src/systems/discrete_system/discrete_system.jl

@@ -54,10 +54,12 @@ struct DiscreteSystem <: AbstractSystem
     in `DiscreteSystem`.
     """
     default_p::Dict
-    function DiscreteSystem(discreteEqs, iv, dvs, ps, var_to_name, ctrls, observed, name, systems, default_u0, default_p)
-        check_variables(dvs,iv)
-        check_parameters(ps,iv)
-        check_units(discreteEqs)
+    function DiscreteSystem(discreteEqs, iv, dvs, ps, var_to_name, ctrls, observed, name, systems, default_u0, default_p; checks::Bool = true)
+        if checks
+            check_variables(dvs, iv)
+            check_parameters(ps, iv)
+            check_units(discreteEqs)
+        end
         new(discreteEqs, iv, dvs, ps, var_to_name, ctrls, observed, name, systems, default_u0, default_p)
     end
 end

src/systems/jumps/jumpsystem.jl

@@ -53,9 +53,11 @@ struct JumpSystem{U <: ArrayPartition} <: AbstractSystem
     type: type of the system
     """
     connection_type::Any
-    function JumpSystem{U}(ap::U, iv, states, ps, var_to_name, observed, name, systems, defaults, connection_type) where U <: ArrayPartition
-        check_variables(states, iv)
-        check_parameters(ps, iv)
+    function JumpSystem{U}(ap::U, iv, states, ps, var_to_name, observed, name, systems, defaults, connection_type; checks::Bool = true) where U <: ArrayPartition
+        if checks
+            check_variables(states, iv)
+            check_parameters(ps, iv)
+        end
         new{U}(ap, iv, states, ps, var_to_name, observed, name, systems, defaults, connection_type)
     end
 end

src/systems/nonlinear/nonlinearsystem.jl

@@ -54,8 +54,10 @@ struct NonlinearSystem <: AbstractSystem
     type: type of the system
     """
     connection_type::Any
-    function NonlinearSystem(eqs, states, ps, var_to_name, observed, jac, name, systems, defaults, structure, connection_type)
-        check_units(eqs)
+    function NonlinearSystem(eqs, states, ps, var_to_name, observed, jac, name, systems, defaults, structure, connection_type; checks::Bool = true)
+        if checks
+            check_units(eqs)
+        end
         new(eqs, states, ps, var_to_name, observed, jac, name, systems, defaults, structure, connection_type)
     end
 end

src/systems/optimization/optimizationsystem.jl

@@ -41,6 +41,9 @@ struct OptimizationSystem <: AbstractSystem
     parameters are not supplied in `ODEProblem`.
     """
     defaults::Dict
+    function OptimizationSystem(op, states, ps, var_to_name, observed, equality_constraints, inequality_constraints, name, systems, defaults; checks::Bool = true)
+        new(op, states, ps, var_to_name, observed, equality_constraints, inequality_constraints, name, systems, defaults)
+    end
 end
 
 function OptimizationSystem(op, states, ps;

src/systems/pde/pdesystem.jl

@@ -59,9 +59,12 @@ struct PDESystem <: ModelingToolkit.AbstractSystem
     @add_kwonly function PDESystem(eqs, bcs, domain, indvars, depvars,
                                    ps=SciMLBase.NullParameters();
                                    defaults=Dict(),
-                                   connection_type=nothing,
+                                   connection_type = nothing,
+                                   checks::Bool = true
                                   )
-        check_units(eqs)
+        if checks
+            check_units(eqs)
+        end
         new(eqs, bcs, domain, indvars, depvars, ps, defaults, connection_type)
     end
 end

src/systems/reaction/reactionsystem.jl

@@ -155,12 +155,14 @@ struct ReactionSystem <: AbstractSystem
     connection_type::Any
 
 
-    function ReactionSystem(eqs, iv, states, ps, observed, name, systems, defaults, connection_type)
-        iv′ = value(iv)
-        states′ = value.(states)
-        ps′ = value.(ps)
-        check_variables(states′, iv′)
-        check_parameters(ps′, iv′)
+    function ReactionSystem(eqs, iv, states, ps, observed, name, systems, defaults, connection_type; checks::Bool = true)
+        if checks
+            iv′ = value(iv)
+            states′ = value.(states)
+            ps′ = value.(ps)
+            check_variables(states′, iv′)
+            check_parameters(ps′, iv′)
+        end
         new(collect(eqs), iv′, states′, ps′, observed, name, systems, defaults, connection_type)
     end
 end