Change most @parameters t to use @independent_variables t

hersle · hersle · commit 9fd20fdd111d · 2024-07-17T16:17:13.000+02:00
diff --git a/docs/src/basics/Validation.md b/docs/src/basics/Validation.md
@@ -8,7 +8,7 @@ Units may be assigned with the following syntax.
 
 ```@example validation
 using ModelingToolkit, DynamicQuantities
-@parameters t [unit = u"s"]
+@independent_variables t [unit = u"s"]
 @variables x(t) [unit = u"m"] g(t) w(t) [unit = u"Hz"]
 
 @parameters(t, [unit = u"s"])
@@ -50,7 +50,8 @@ Example usage below. Note that `ModelingToolkit` does not force unit conversions
 
 ```@example validation
 using ModelingToolkit, DynamicQuantities
-@parameters t [unit = u"ms"] τ [unit = u"ms"]
+@independent_variables t [unit = u"ms"]
+@parameters τ [unit = u"ms"]
 @variables E(t) [unit = u"kJ"] P(t) [unit = u"MW"]
 D = Differential(t)
 eqs = [D(E) ~ P - E / τ,
@@ -74,7 +75,8 @@ An example of an inconsistent system: at present, `ModelingToolkit` requires tha
 
 ```@example validation
 using ModelingToolkit, DynamicQuantities
-@parameters t [unit = u"ms"] τ [unit = u"ms"]
+@independent_variables t [unit = u"ms"]
+@parameters τ [unit = u"ms"]
 @variables E(t) [unit = u"J"] P(t) [unit = u"MW"]
 D = Differential(t)
 eqs = [D(E) ~ P - E / τ,
@@ -119,7 +121,7 @@ In order for a function to work correctly during both validation & execution, th
 
 ```julia
 using ModelingToolkit, DynamicQuantities
-@parameters t [unit = u"ms"]
+@independent_variables t [unit = u"ms"]
 @variables E(t) [unit = u"J"] P(t) [unit = u"MW"]
 D = Differential(t)
 eqs = [D(E) ~ P - E / 1u"ms"]
@@ -134,7 +136,8 @@ Instead, they should be parameterized:
 
 ```@example validation3
 using ModelingToolkit, DynamicQuantities
-@parameters t [unit = u"ms"] τ [unit = u"ms"]
+@independent_variables t [unit = u"ms"]
+@parameters τ [unit = u"ms"]
 @variables E(t) [unit = u"kJ"] P(t) [unit = u"MW"]
 D = Differential(t)
 eqs = [D(E) ~ P - E / τ]
diff --git a/src/systems/diffeqs/basic_transformations.jl b/src/systems/diffeqs/basic_transformations.jl
@@ -16,7 +16,8 @@ Example:
 ```julia
 using ModelingToolkit, OrdinaryDiffEq, Test
 
-@parameters t α β γ δ
+@independent_variables t
+@parameters α β γ δ
 @variables x(t) y(t)
 D = Differential(t)
 
diff --git a/src/systems/diffeqs/modelingtoolkitize.jl b/src/systems/diffeqs/modelingtoolkitize.jl
@@ -242,7 +242,7 @@ Generate `SDESystem`, dependent variables, and parameters from an `SDEProblem`.
 function modelingtoolkitize(prob::DiffEqBase.SDEProblem; kwargs...)
     prob.f isa DiffEqBase.AbstractParameterizedFunction &&
         return (prob.f.sys, prob.f.sys.unknowns, prob.f.sys.ps)
-    @parameters t
+    @independent_variables t
     p = prob.p
     has_p = !(p isa Union{DiffEqBase.NullParameters, Nothing})
 
diff --git a/src/utils.jl b/src/utils.jl
@@ -418,7 +418,7 @@ collect_differential_variables(sys) = collect_operator_variables(sys, Differenti
 Return  a `Set` with all applied operators in `x`, example:
 
 ```
-@parameters t
+@independent_variables t
 @variables u(t) y(t)
 D = Differential(t)
 eq = D(y) ~ u
diff --git a/test/abstractsystem.jl b/test/abstractsystem.jl
@@ -2,7 +2,7 @@ using ModelingToolkit
 using Test
 MT = ModelingToolkit
 
-@parameters t
+@independent_variables t
 @variables x
 struct MyNLS <: MT.AbstractSystem
     name::Any
diff --git a/test/basic_transformations.jl b/test/basic_transformations.jl
@@ -1,6 +1,7 @@
 using ModelingToolkit, OrdinaryDiffEq, Test
 
-@parameters t α β γ δ
+@independent_variables t
+@parameters α β γ δ
 @variables x(t) y(t)
 D = Differential(t)
 
diff --git a/test/components.jl b/test/components.jl
@@ -304,7 +304,7 @@ sol = solve(prob, Tsit5())
     Hey there, Pin1!
     """
     @connector function Pin1(; name)
-        @parameters t
+        @independent_variables t
         sts = @variables v(t)=1.0 i(t)=1.0
         ODESystem(Equation[], t, sts, []; name = name)
     end
@@ -314,7 +314,7 @@ sol = solve(prob, Tsit5())
     Hey there, Pin2!
     """
     @component function Pin2(; name)
-        @parameters t
+        @independent_variables t
         sts = @variables v(t)=1.0 i(t)=1.0
         ODESystem(Equation[], t, sts, []; name = name)
     end
diff --git a/test/constants.jl b/test/constants.jl
@@ -6,7 +6,7 @@ UMT = ModelingToolkit.UnitfulUnitCheck
 @constants a = 1
 @test_throws MT.ArgumentError @constants b
 
-@parameters t
+@independent_variables t
 @variables x(t) w(t)
 D = Differential(t)
 eqs = [D(x) ~ a]
@@ -29,7 +29,7 @@ simp = structural_simplify(sys)
 @constants β=1 [unit = u"m/s"]
 UMT.get_unit(β)
 @test MT.isconstant(β)
-@parameters t [unit = u"s"]
+@independent_variables t [unit = u"s"]
 @variables x(t) [unit = u"m"]
 D = Differential(t)
 eqs = [D(x) ~ β]
diff --git a/test/direct.jl b/test/direct.jl
@@ -41,7 +41,7 @@ for i in 1:3
     @test eval(ModelingToolkit.toexpr.(eqs)[i]) == eval(simpexpr[i])
 end
 
-@parameters t σ ρ β
+@parameters σ ρ β
 @variables x y z
 ∂ = ModelingToolkit.jacobian(eqs, [x, y, z])
 for i in 1:3
@@ -59,7 +59,7 @@ reference_jac = sparse(ModelingToolkit.jacobian(du, [x, y, z]))
       findnz(reference_jac)[[1, 2]]
 
 let
-    @parameters t
+    @independent_variables t
     @variables x(t) y(t) z(t)
     @test ModelingToolkit.exprs_occur_in([x, y, z], x^2 * y) == [true, true, false]
 end
@@ -197,7 +197,7 @@ test_worldage()
 
 let
     @register_symbolic foo(x)
-    @parameters t
+    @independent_variables t
     D = Differential(t)
 
     @test isequal(expand_derivatives(D(foo(t))), D(foo(t)))
diff --git a/test/downstream/linearization_dd.jl b/test/downstream/linearization_dd.jl
@@ -12,7 +12,7 @@ using ControlSystemsMTK
 using ControlSystemsMTK.ControlSystemsBase: sminreal, minreal, poles
 connect = ModelingToolkit.connect
 
-@parameters t
+@independent_variables t
 D = Differential(t)
 
 @named link1 = Link(; m = 0.2, l = 10, I = 1, g = -9.807)
diff --git a/test/downstream/linearize.jl b/test/downstream/linearize.jl
@@ -1,7 +1,7 @@
 using ModelingToolkit, Test
 
 # r is an input, and y is an output.
-@parameters t
+@independent_variables t
 @variables x(t)=0 y(t)=0 u(t)=0 r(t)=0
 @variables x(t)=0 y(t)=0 u(t)=0 r(t)=0 [input = true]
 @parameters kp = 1
diff --git a/test/inputoutput.jl b/test/inputoutput.jl
@@ -1,6 +1,7 @@
 using ModelingToolkit, OrdinaryDiffEq, Symbolics, Test
 
-@parameters t σ ρ β
+@independent_variables t
+@parameters σ ρ β
 @variables x(t) y(t) z(t) F(t) u(t)
 D = Differential(t)
 
diff --git a/test/linearity.jl b/test/linearity.jl
@@ -3,7 +3,8 @@ using DiffEqBase
 using Test
 
 # Define some variables
-@parameters t σ ρ β
+@independent_variables t
+@parameters σ ρ β
 @variables x(t) y(t) z(t)
 D = Differential(t)
 
diff --git a/test/nonlinearsystem.jl b/test/nonlinearsystem.jl
@@ -9,7 +9,7 @@ using ModelingToolkit: get_default_or_guess, MTKParameters
 canonequal(a, b) = isequal(simplify(a), simplify(b))
 
 # Define some variables
-@parameters t σ ρ β
+@parameters σ ρ β
 @constants h = 1
 @variables x y z
 
@@ -115,7 +115,7 @@ lorenz2 = lorenz(:lorenz2)
 
 # system promotion
 using OrdinaryDiffEq
-@parameters t
+@independent_variables t
 D = Differential(t)
 @named subsys = convert_system(ODESystem, lorenz1, t)
 @named sys = ODESystem([D(subsys.x) ~ subsys.x + subsys.x], t, systems = [subsys])
@@ -126,7 +126,7 @@ sol = solve(prob, FBDF(), reltol = 1e-7, abstol = 1e-7)
 @test sol[subsys.x] + sol[subsys.y] - sol[subsys.z]≈sol[subsys.u] atol=1e-7
 @test_throws ArgumentError convert_system(ODESystem, sys, t)
 
-@parameters t σ ρ β
+@parameters σ ρ β
 @variables x y z
 
 # Define a nonlinear system
@@ -178,7 +178,8 @@ end
 end
 
 # observed variable handling
-@parameters t τ
+@independent_variables t
+@parameters τ
 @variables x(t) RHS(t)
 @named fol = NonlinearSystem([0 ~ (1 - x * h) / τ], [x], [τ];
     observed = [RHS ~ (1 - x) / τ])
@@ -188,7 +189,7 @@ RHS2 = RHS
 @test isequal(RHS, RHS2)
 
 # issue #1358
-@parameters t
+@independent_variables t
 @variables v1(t) v2(t) i1(t) i2(t)
 eq = [v1 ~ sin(2pi * t * h)
       v1 - v2 ~ i1
diff --git a/test/optimizationsystem.jl b/test/optimizationsystem.jl
@@ -180,7 +180,7 @@ end
 end
 
 @testset "time dependent var" begin
-    @parameters t
+    @independent_variables t
     @variables x(t) y
     @parameters a b
     loss = (a - x)^2 + b * (y - x^2)^2
diff --git a/test/precompile_test/ODEPrecompileTest.jl b/test/precompile_test/ODEPrecompileTest.jl
@@ -3,7 +3,8 @@ using ModelingToolkit
 
 function system(; kwargs...)
     # Define some variables
-    @parameters t σ ρ β
+    @independent_variables t
+    @parameters σ ρ β
     @variables x(t) y(t) z(t)
     D = Differential(t)
 
diff --git a/test/sdesystem.jl b/test/sdesystem.jl
@@ -458,7 +458,8 @@ fdif!(du, u0, p, t)
 
 # issue #819
 @testset "Combined system name collisions" begin
-    @parameters t
+    @independent_variables t
+    D = Differential(t)
     eqs_short = [D(x) ~ σ * (y - x),
         D(y) ~ x * (ρ - z) - y
     ]
@@ -619,7 +620,8 @@ solve(prob, LambaEulerHeun(), seed = 1)
 
 # Test ill-formed due to more equations than states in noise equations
 
-@parameters t p d
+@independent_variables t
+@parameters p d
 @variables X(t)
 eqs = [D(X) ~ p - d * X]
 noise_eqs = [sqrt(p), -sqrt(d * X)]
diff --git a/test/simplify.jl b/test/simplify.jl
@@ -2,7 +2,7 @@ using ModelingToolkit
 using ModelingToolkit: value
 using Test
 
-@parameters t
+@independent_variables t
 @variables x(t) y(t) z(t)
 
 null_op = 0 * t
@@ -37,7 +37,8 @@ d3 = Differential(x)(d2)
 
 # 699
 using SymbolicUtils: substitute
-@parameters t a(t) b(t)
+@independent_variables t
+@parameters a(t) b(t)
 
 # back and forth substitution does not work for parameters with dependencies
 term = value(a)
diff --git a/test/test_variable_metadata.jl b/test/test_variable_metadata.jl
@@ -73,7 +73,7 @@ d = FakeNormal()
 @test !haskey(ModelingToolkit.dump_variable_metadata(y), :dist)
 
 ## System interface
-@parameters t
+@independent_variables t
 Dₜ = Differential(t)
 @variables x(t)=0 [bounds = (-10, 10)] u(t)=0 [input = true] y(t)=0 [output = true]
 @parameters T [bounds = (0, Inf)]
@@ -124,7 +124,7 @@ sp = Set(p)
 @test !hasdescription(u)
 @test !haskey(ModelingToolkit.dump_variable_metadata(u), :desc)
 
-@parameters t
+@independent_variables t
 @variables u(t) [description = "A short description of u"]
 @parameters p [description = "A description of p"]
 @named sys = ODESystem([u ~ p], t)
diff --git a/test/units.jl b/test/units.jl
@@ -2,7 +2,8 @@ using ModelingToolkit, OrdinaryDiffEq, JumpProcesses, Unitful
 using Test
 MT = ModelingToolkit
 UMT = ModelingToolkit.UnitfulUnitCheck
-@parameters t [unit = u"ms"] τ [unit = u"ms"] γ
+@independent_variables t [unit = u"ms"]
+@parameters τ [unit = u"ms"] γ
 @variables E(t) [unit = u"kJ"] P(t) [unit = u"MW"]
 D = Differential(t)
 
@@ -94,7 +95,8 @@ bad_length_eqs = [connect(op, lp)]
 @test_throws MT.ValidationError ODESystem(bad_eqs, t, [], []; name = :sys)
 
 # Array variables
-@parameters t [unit = u"s"] v[1:3]=[1, 2, 3] [unit = u"m/s"]
+@independent_variables t [unit = u"s"]
+@parameters v[1:3]=[1, 2, 3] [unit = u"m/s"]
 @variables x(t)[1:3] [unit = u"m"]
 D = Differential(t)
 eqs = D.(x) .~ v
@@ -109,7 +111,8 @@ eqs = [
 @named nls = NonlinearSystem(eqs, [x], [a])
 
 # SDE test w/ noise vector
-@parameters t [unit = u"ms"] τ [unit = u"ms"] Q [unit = u"MW"]
+@independent_variables t [unit = u"ms"]
+@parameters τ [unit = u"ms"] Q [unit = u"MW"]
 @variables E(t) [unit = u"kJ"] P(t) [unit = u"MW"]
 D = Differential(t)
 eqs = [D(E) ~ P - E / τ
@@ -130,7 +133,8 @@ noiseeqs = [0.1u"MW" 0.1u"MW"
 @test !UMT.validate(eqs, noiseeqs)
 
 # Non-trivial simplifications
-@parameters t [unit = u"s"] v [unit = u"m/s"] r [unit = u"m"^3 / u"s"]
+@independent_variables t [unit = u"s"]
+@parameters v [unit = u"m/s"] r [unit = u"m"^3 / u"s"]
 @variables V(t) [unit = u"m"^3] L(t) [unit = u"m"]
 D = Differential(t)
 eqs = [D(L) ~ v,
diff --git a/test/variable_parsing.jl b/test/variable_parsing.jl
@@ -4,7 +4,7 @@ using Test
 using ModelingToolkit: value, Flow
 using SymbolicUtils: FnType
 
-@parameters t
+@independent_variables t
 @variables x(t) y(t) # test multi-arg
 @variables z(t) # test single-arg
 
@@ -60,7 +60,7 @@ end
 # @test isequal(s1, collect(s))
 # @test isequal(σ1, σ)
 
-#@parameters t
+#@independent_variables t
 #@variables x[1:2](t)
 #x1 = Num[Variable{FnType{Tuple{Any}, Real}}(:x, 1)(t.val),
 #      Variable{FnType{Tuple{Any}, Real}}(:x, 2)(t.val)]
@@ -117,7 +117,7 @@ a = rename(value(x), :a)
 @test getmetadata(a, VariableConnectType) == Flow
 @test getmetadata(a, VariableUnit) == u
 
-@parameters t
+@independent_variables t
 @variables x(t)=1 [connect = Flow, unit = u]
 
 @test getmetadata(x, VariableDefaultValue) == 1
diff --git a/test/variable_scope.jl b/test/variable_scope.jl
diff --git a/test/variable_utils.jl b/test/variable_utils.jl
