Merge pull request #3656 from AayushSabharwal/as/mtkcompile

refactor: rename `@mtkbuild` to `@mtkcompile` and `structural_simplify` to `mtkcompile`

Author: ChrisRackauckas

src/ModelingToolkit.jl

@@ -214,6 +214,7 @@ include("structural_transformation/StructuralTransformations.jl")
 include("inputoutput.jl")
 
 include("adjoints.jl")
+include("deprecations.jl")
 
 const t_nounits = let
     only(@independent_variables t)
@@ -233,7 +234,7 @@ PrecompileTools.@compile_workload begin
     using ModelingToolkit
     @variables x(ModelingToolkit.t_nounits)
     @named sys = System([ModelingToolkit.D_nounits(x) ~ -x], ModelingToolkit.t_nounits)
-    prob = ODEProblem(structural_simplify(sys), [x => 30.0], (0, 100), [], jac = true)
+    prob = ODEProblem(mtkcompile(sys), [x => 30.0], (0, 100), [], jac = true)
     @mtkmodel __testmod__ begin
         @constants begin
             c = 1.0
@@ -288,7 +289,7 @@ export alias_elimination, flatten
 export connect, domain_connect, @connector, Connection, AnalysisPoint, Flow, Stream,
        instream
 export initial_state, transition, activeState, entry, ticksInState, timeInState
-export @component, @mtkmodel, @mtkbuild
+export @component, @mtkmodel, @mtkcompile, @mtkbuild
 export isinput, isoutput, getbounds, hasbounds, getguess, hasguess, isdisturbance,
        istunable, getdist, hasdist,
        tunable_parameters, isirreducible, getdescription, hasdescription,
@@ -304,8 +305,8 @@ export SymScope, LocalScope, ParentScope, GlobalScope
 export independent_variable, equations, controls, observed, full_equations, jumps, cost,
        brownians
 export initialization_equations, guesses, defaults, parameter_dependencies, hierarchy
-export structural_simplify, expand_connections, linearize, linearization_function,
-       LinearizationProblem
+export mtkcompile, expand_connections, linearize, linearization_function,
+       LinearizationProblem, structural_simplify
 export solve
 export Pre
 

src/deprecations.jl

@@ -0,0 +1,11 @@
+@deprecate structural_simplify(sys; kwargs...) mtkcompile(sys; kwargs...)
+@deprecate structural_simplify(sys, io; kwargs...) mtkcompile(
+    sys; inputs = io[1], outputs = io[2], kwargs...)
+
+macro mtkbuild(exprs...)
+    return quote
+        Base.depwarn("`@mtkbuild` is deprecated. Use `@mtkcompile` instead.", :mtkbuild)
+        @mtkcompile $(exprs...)
+    end |> esc
+end
+

src/inputoutput.jl

@@ -202,7 +202,7 @@ function generate_control_function(sys::AbstractSystem, inputs = unbound_inputs(
         kwargs...)
     # Remove this when the ControlFunction gets merged.
     if check_simplified && !iscomplete(sys)
-        error("A completed `ODESystem` is required. Call `complete` or `structural_simplify` on the system before creating the control function.")
+        error("A completed `ODESystem` is required. Call `complete` or `mtkcompile` on the system before creating the control function.")
     end
     isempty(inputs) && @warn("No unbound inputs were found in system.")
     if disturbance_inputs !== nothing
@@ -417,7 +417,7 @@ function add_input_disturbance(sys, dist::DisturbanceModel, inputs = Any[]; kwar
            dist.input ~ u + dsys.output.u[1]]
     augmented_sys = System(eqs, t, systems = [dsys], name = gensym(:outer))
     augmented_sys = extend(augmented_sys, sys)
-    ssys = structural_simplify(augmented_sys, inputs = all_inputs, disturbance_inputs = [d])
+    ssys = mtkcompile(augmented_sys, inputs = all_inputs, disturbance_inputs = [d])
 
     f, dvs, p, io_sys = generate_control_function(ssys, all_inputs,
         [d]; kwargs...)

src/linearization.jl

@@ -15,7 +15,7 @@ y &= h(x, z, u)
 
 where `x` are differential unknown variables, `z` algebraic variables, `u` inputs and `y` outputs. To obtain a linear statespace representation, see [`linearize`](@ref). The input argument `variables` is a vector defining the operating point, corresponding to `unknowns(simplified_sys)` and `p` is a vector corresponding to the parameters of `simplified_sys`. Note: all variables in `inputs` have been converted to parameters in `simplified_sys`.
 
-The `simplified_sys` has undergone [`structural_simplify`](@ref) and had any occurring input or output variables replaced with the variables provided in arguments `inputs` and `outputs`. The unknowns of this system also indicate the order of the unknowns that holds for the linearized matrices.
+The `simplified_sys` has undergone [`mtkcompile`](@ref) and had any occurring input or output variables replaced with the variables provided in arguments `inputs` and `outputs`. The unknowns of this system also indicate the order of the unknowns that holds for the linearized matrices.
 
 # Arguments:
 
@@ -58,7 +58,7 @@ function linearization_function(sys::AbstractSystem, inputs,
     outputs = mapreduce(vcat, outputs; init = []) do var
         symbolic_type(var) == ArraySymbolic() ? collect(var) : [var]
     end
-    ssys = structural_simplify(sys; inputs, outputs, simplify, kwargs...)
+    ssys = mtkcompile(sys; inputs, outputs, simplify, kwargs...)
     diff_idxs, alge_idxs = eq_idxs(ssys)
     if zero_dummy_der
         dummyder = setdiff(unknowns(ssys), unknowns(sys))
@@ -498,7 +498,7 @@ function linearize_symbolic(sys::AbstractSystem, inputs,
         outputs; simplify = false, allow_input_derivatives = false,
         eval_expression = false, eval_module = @__MODULE__,
         kwargs...)
-    sys = structural_simplify(sys; inputs, outputs, simplify, kwargs...)
+    sys = mtkcompile(sys; inputs, outputs, simplify, kwargs...)
     diff_idxs, alge_idxs = eq_idxs(sys)
     sts = unknowns(sys)
     t = get_iv(sys)

src/problems/bvproblem.jl

@@ -30,7 +30,7 @@ If a `System` without `constraints` is specified, it will be treated as an initi
            D(D(y)) ~ λ * y - g
            x(t)^2 + y^2 ~ 1]
     cstr = [x(0.5) ~ 1]
-    @mtkbuild pend = System(eqs, t; constraints = cstrs)
+    @mtkcompile pend = System(eqs, t; constraints = cstrs)
 
     tspan = (0.0, 1.5)
     u0map = [x(t) => 0.6, y => 0.8]

src/problems/compatibility.jl

@@ -120,7 +120,7 @@ function check_has_noise(sys::System, T)
         if !isempty(brownians(sys))
             msg = """
             Systems constructed by defining Brownian variables with `@brownian` must be \
-            simplified by calling `structural_simplify` before a `$T` can be constructed.
+            simplified by calling `mtkcompile` before a `$T` can be constructed.
             """
         end
         throw(SystemCompatibilityError(msg))
@@ -131,7 +131,7 @@ function check_is_discrete(sys::System, T)
     if !is_discrete_system(sys)
         throw(SystemCompatibilityError("""
         `$T` expects a discrete system. Consider an `ODEProblem` instead. If your system \
-        is discrete, ensure `structural_simplify` has been run on it.
+        is discrete, ensure `mtkcompile` has been run on it.
         """))
     end
 end

src/problems/initializationproblem.jl

@@ -35,7 +35,7 @@ initial conditions for the given DAE.
         time_dependent_init = is_time_dependent(sys),
         kwargs...) where {iip, specialize}
     if !iscomplete(sys)
-        error("A completed system is required. Call `complete` or `structural_simplify` on the system before creating an `ODEProblem`")
+        error("A completed system is required. Call `complete` or `mtkcompile` on the system before creating an `ODEProblem`")
     end
     if isempty(u0map) && get_initializesystem(sys) !== nothing
         isys = get_initializesystem(sys; initialization_eqs, check_units)
@@ -60,7 +60,7 @@ initial conditions for the given DAE.
     end
 
     if simplify_system
-        isys = structural_simplify(isys; fully_determined, split = is_split(sys))
+        isys = mtkcompile(isys; fully_determined, split = is_split(sys))
     end
 
     ts = get_tearing_state(isys)

src/problems/sccnonlinearproblem.jl

@@ -73,11 +73,11 @@ function SciMLBase.SCCNonlinearProblem{iip}(sys::System, u0map,
         parammap = SciMLBase.NullParameters(); eval_expression = false, eval_module = @__MODULE__,
         cse = true, kwargs...) where {iip}
     if !iscomplete(sys) || get_tearing_state(sys) === nothing
-        error("A simplified `System` is required. Call `structural_simplify` on the system before creating an `SCCNonlinearProblem`.")
+        error("A simplified `System` is required. Call `mtkcompile` on the system before creating an `SCCNonlinearProblem`.")
     end
 
     if !is_split(sys)
-        error("The system has been simplified with `split = false`. `SCCNonlinearProblem` is not compatible with this system. Pass `split = true` to `structural_simplify` to use `SCCNonlinearProblem`.")
+        error("The system has been simplified with `split = false`. `SCCNonlinearProblem` is not compatible with this system. Pass `split = true` to `mtkcompile` to use `SCCNonlinearProblem`.")
     end
 
     ts = get_tearing_state(sys)

src/structural_transformation/StructuralTransformations.jl

@@ -35,7 +35,7 @@ import ModelingToolkit: var_derivative!, var_derivative_graph!
 using Graphs
 using ModelingToolkit: algeqs, EquationsView,
                        SystemStructure, TransformationState, TearingState,
-                       structural_simplify!,
+                       mtkcompile!,
                        isdiffvar, isdervar, isalgvar, isdiffeq, algeqs, is_only_discrete,
                        dervars_range, diffvars_range, algvars_range,
                        DiffGraph, complete!,

src/structural_transformation/pantelides.jl

@@ -210,7 +210,7 @@ end
     dae_index_lowering(sys::System; kwargs...) -> System
 
 Perform the Pantelides algorithm to transform a higher index DAE to an index 1
-DAE. `kwargs` are forwarded to [`pantelides!`](@ref). End users are encouraged to call [`structural_simplify`](@ref)
+DAE. `kwargs` are forwarded to [`pantelides!`](@ref). End users are encouraged to call [`mtkcompile`](@ref)
 instead, which calls this function internally.
 """
 function dae_index_lowering(sys::System; kwargs...)