Merge pull request #2569 from ven-k/vkb/fix-iv

refactor: use the `t` defined in the module

Author: ChrisRackauckas

docs/src/basics/MTKModel_Connector.md

@@ -39,6 +39,7 @@ Let's explore these in more detail with the following example:
 
 ```@example mtkmodel-example
 using ModelingToolkit
+using ModelingToolkit: t
 
 @mtkmodel ModelA begin
     @parameters begin
@@ -191,6 +192,7 @@ getdefault(model_c3.model_a.k_array[2])
 
 ```@example mtkmodel-example
 using ModelingToolkit
+using ModelingToolkit: t
 
 @mtkmodel M begin
     @parameters begin
@@ -262,6 +264,7 @@ A simple connector can be defined with syntax similar to following example:
 
 ```@example connector
 using ModelingToolkit
+using ModelingToolkit: t
 
 @connector Pin begin
     v(t) = 0.0, [description = "Voltage"]
@@ -344,6 +347,7 @@ The if-elseif-else statements can be used inside `@equations`, `@parameters`,
 
 ```@example branches-in-components
 using ModelingToolkit
+using ModelingToolkit: t
 
 @mtkmodel C begin end
 

src/systems/model_parsing.jl

@@ -92,7 +92,7 @@ function _model_macro(mod, name, expr, isconnector)
 
     iv = get(dict, :independent_variable, nothing)
     if iv === nothing
-        iv = dict[:independent_variable] = variable(:t)
+        iv = dict[:independent_variable] = get_t(mod, :t)
     end
 
     push!(exprs.args, :(push!(equations, $(eqs...))))
@@ -199,7 +199,7 @@ function parse_variable_def!(dict, mod, arg, varclass, kwargs, where_types;
             parse_variable_def!(dict, mod, a, varclass, kwargs, where_types; def, type)
         end
         Expr(:call, a, b) => begin
-            var = generate_var!(dict, a, b, varclass; indices, type)
+            var = generate_var!(dict, a, b, varclass, mod; indices, type)
             update_kwargs_and_metadata!(dict, kwargs, a, def, indices, type, var,
                 varclass, where_types)
             (var, def)
@@ -280,11 +280,10 @@ function generate_var!(dict, a, varclass;
     generate_var(a, varclass; indices, type)
 end
 
-function generate_var!(dict, a, b, varclass;
+function generate_var!(dict, a, b, varclass, mod;
         indices::Union{Vector{UnitRange{Int}}, Nothing} = nothing,
         type = Real)
-    # (type isa Nothing && type = Real)
-    iv = generate_var(b, :variables)
+    iv = b == :t ? get_t(mod, b) : generate_var(b, :variables)
     prev_iv = get!(dict, :independent_variable) do
         iv
     end
@@ -306,6 +305,20 @@ function generate_var!(dict, a, b, varclass;
     var
 end
 
+# Use the `t` defined in the `mod`. When it is unavailable, generate a new `t` with a warning.
+function get_t(mod, t)
+    try
+        get_var(mod, t)
+    catch e
+        if e isa UndefVarError
+            @warn("Could not find a predefined `t` in `$mod`; generating a new one within this model.\nConsider defining it or importing `t` (or `t_nounits`, `t_unitful` as `t`) from ModelingToolkit.")
+            variable(:t)
+        else
+            throw(e)
+        end
+    end
+end
+
 function parse_default(mod, a)
     a = Base.remove_linenums!(deepcopy(a))
     MLStyle.@match a begin
@@ -393,8 +406,9 @@ function parse_constants!(exprs, dict, body, mod)
             Expr(:(=), Expr(:(::), a, type), Expr(:tuple, b, metadata)) || Expr(:(=), Expr(:(::), a, type), b) => begin
                 type = getfield(mod, type)
                 b = _type_check!(get_var(mod, b), a, type, :constants)
-                constant = first(@constants $a::type = b)
-                push!(exprs, :($a = $constant))
+                push!(exprs,
+                    :($(Symbolics._parse_vars(
+                        :constants, type, [:($a = $b), metadata], toconstant))))
                 dict[:constants][a] = Dict(:value => b, :type => type)
                 if @isdefined metadata
                     for data in metadata.args
@@ -403,16 +417,18 @@ function parse_constants!(exprs, dict, body, mod)
                 end
             end
             Expr(:(=), a, Expr(:tuple, b, metadata)) => begin
-                constant = first(@constants $a = b)
-                push!(exprs, :($a = $constant))
+                push!(exprs,
+                    :($(Symbolics._parse_vars(
+                        :constants, Real, [:($a = $b), metadata], toconstant))))
                 dict[:constants][a] = Dict{Symbol, Any}(:value => get_var(mod, b))
                 for data in metadata.args
                     dict[:constants][a][data.args[1]] = data.args[2]
                 end
             end
             Expr(:(=), a, b) => begin
-                constant = first(@constants $a = b)
-                push!(exprs, :($a = $constant))
+                push!(exprs,
+                    :($(Symbolics._parse_vars(
+                        :constants, Real, [:($a = $b)], toconstant))))
                 dict[:constants][a] = Dict(:value => get_var(mod, b))
             end
             _ => error("""Malformed constant definition `$arg`. Please use the following syntax:

test/model_parsing.jl

@@ -47,7 +47,7 @@ end
         output = RealOutput()
     end
     @parameters begin
-        k, [description = "Constant output value of block"]
+        k, [description = "Constant output value of block", unit = u"V"]
     end
     @equations begin
         output.u ~ k
@@ -184,10 +184,15 @@ resistor = getproperty(rc, :resistor; namespace = false)
 @testset "Constants" begin
     @mtkmodel PiModel begin
         @constants begin
-            _p::Irrational = π, [description = "Value of Pi."]
+            _p::Irrational = π, [description = "Value of Pi.", unit = u"V"]
         end
         @parameters begin
             p = _p, [description = "Assign constant `_p` value."]
+            e, [unit = u"V"]
+        end
+        @equations begin
+            # This validates units; indirectly verifies that metadata was correctly passed.
+            e ~ _p
         end
     end
 
@@ -426,6 +431,7 @@ end
     @test A.structure[:components] == [[:cc, :C]]
 end
 
+using ModelingToolkit: D_nounits
 @testset "Event handling in MTKModel" begin
     @mtkmodel M begin
         @variables begin
@@ -434,9 +440,9 @@ end
             z(t)
         end
         @equations begin
-            x ~ -D(x)
-            D(y) ~ 0
-            D(z) ~ 0
+            x ~ -D_nounits(x)
+            D_nounits(y) ~ 0
+            D_nounits(z) ~ 0
         end
         @continuous_events begin
             [x ~ 1.5] => [x ~ 5, y ~ 1]

test/precompile_test/ModelParsingPrecompile.jl

@@ -1,6 +1,7 @@
 module ModelParsingPrecompile
 
 using ModelingToolkit, Unitful
+using ModelingToolkit: t
 
 @mtkmodel ModelWithComponentArray begin
     @constants begin

test/runtests.jl

@@ -99,5 +99,3 @@ end
         @safetestset "BifurcationKit Extension Test" include("extensions/bifurcationkit.jl")
     end
 end
-
-@safetestset "Model Parsing Test" include("model_parsing.jl")