Deprecate at derivatives

YingboMa · YingboMa · commit 26e61cdc1694 · 2021-01-18T12:32:21.000-05:00
diff --git a/README.md b/README.md
@@ -30,7 +30,7 @@ using ModelingToolkit, OrdinaryDiffEq
 
 @parameters t σ ρ β
 @variables x(t) y(t) z(t)
-@derivatives D'~t
+D = Differential(t)
 
 eqs = [D(D(x)) ~ σ*(y-x),
        D(y) ~ x*(ρ-z)-y,
@@ -67,7 +67,7 @@ using ModelingToolkit, OrdinaryDiffEq
 
 @parameters t σ ρ β
 @variables x(t) y(t) z(t)
-@derivatives D'~t
+D = Differential(t)
 
 eqs = [D(x) ~ σ*(y-x),
        D(y) ~ x*(ρ-z)-y,
diff --git a/src/differentials.jl b/src/differentials.jl
@@ -16,10 +16,10 @@ julia> using ModelingToolkit
 julia> @variables x y;
 
 julia> D = Differential(x)
-(D'~x())
+(D'~x)
 
 julia> D(y)  # Differentiate y wrt. x
-(D'~x())(y())
+(D'~x)(y)
 ```
 """
 struct Differential <: Function
@@ -31,6 +31,11 @@ end
 (D::Differential)(x::Num) = Num(D(value(x)))
 SymbolicUtils.promote_symtype(::Differential, x) = x
 
+Base.:*(D1, D2::Differential) = D1 ∘ D2
+Base.:*(D1::Differential, D2) = D1 ∘ D2
+Base.:*(D1::Differential, D2::Differential) = D1 ∘ D2
+Base.:^(D::Differential, n::Integer) = _repeat_apply(D, n)
+
 Base.show(io::IO, D::Differential) = print(io, "(D'~", D.x, ")")
 
 Base.:(==)(D1::Differential, D2::Differential) = isequal(D1.x, D2.x)
@@ -229,6 +234,7 @@ end
 _repeat_apply(f, n) = n == 1 ? f : f ∘ _repeat_apply(f, n-1)
 function _differential_macro(x)
     ex = Expr(:block)
+    push!(ex.args,  :(Base.depwarn("`@derivatives D'''~x` is deprecated. Use `Differential(x)^3` instead.", Symbol("@derivatives"), force=true)))
     lhss = Symbol[]
     x = x isa Tuple && first(x).head == :tuple ? first(x).args : x # tuple handling
     x = flatten_expr!(x)
diff --git a/src/systems/control/controlsystem.jl b/src/systems/control/controlsystem.jl
@@ -34,7 +34,7 @@ $(FIELDS)
 using ModelingToolkit
 
 @variables t x(t) v(t) u(t)
-@derivatives D'~t
+D = Differential(t)
 
 loss = (4-x)^2 + 2v^2 + u^2
 eqs = [
diff --git a/src/systems/diffeqs/basic_transformations.jl b/src/systems/diffeqs/basic_transformations.jl
@@ -18,7 +18,7 @@ using ModelingToolkit, OrdinaryDiffEq, Test
 
 @parameters t α β γ δ
 @variables x(t) y(t)
-@derivatives D'~t
+D = Differential(t)
 
 eqs = [D(x) ~ α*x - β*x*y,
        D(y) ~ -δ*y + γ*x*y]
diff --git a/src/systems/diffeqs/modelingtoolkitize.jl b/src/systems/diffeqs/modelingtoolkitize.jl
@@ -19,7 +19,7 @@ function modelingtoolkitize(prob::DiffEqBase.ODEProblem)
     params = p isa DiffEqBase.NullParameters ? [] :
              reshape([Num(Sym{Real}(nameof(Variable(:α, i)))) for i in eachindex(p)],size(p))
 
-    @derivatives D'~t
+    D = Differential(t)
 
     rhs = [D(var) for var in vars]
 
@@ -57,7 +57,7 @@ function modelingtoolkitize(prob::DiffEqBase.SDEProblem)
     params = p isa DiffEqBase.NullParameters ? [] :
              reshape([Num(Sym{Real}(nameof(Variable(:α, i)))) for i in eachindex(p)],size(p))
 
-    @derivatives D'~t
+    D = Differential(t)
 
     rhs = [D(var) for var in vars]
 
diff --git a/src/systems/diffeqs/sdesystem.jl b/src/systems/diffeqs/sdesystem.jl
@@ -13,7 +13,7 @@ using ModelingToolkit
 
 @parameters t σ ρ β
 @variables x(t) y(t) z(t)
-@derivatives D'~t
+D = Differential(t)
 
 eqs = [D(x) ~ σ*(y-x),
        D(y) ~ x*(ρ-z)-y,
diff --git a/test/basic_transformations.jl b/test/basic_transformations.jl
@@ -2,7 +2,7 @@ using ModelingToolkit, OrdinaryDiffEq, Test
 
 @parameters t α β γ δ
 @variables x(t) y(t)
-@derivatives D'~t
+D = Differential(t)
 
 eqs = [D(x) ~ α*x - β*x*y,
        D(y) ~ -δ*y + γ*x*y]
diff --git a/test/build_targets.jl b/test/build_targets.jl
@@ -1,7 +1,7 @@
 using ModelingToolkit, Test
 @parameters t a
 @variables x(t) y(t)
-@derivatives D'~t
+D = Differential(t)
 eqs = [D(x) ~ a*x - x*y,
        D(y) ~ -3y + x*y]
 @test ModelingToolkit.build_function(eqs,[x,y],[a],t,target = ModelingToolkit.StanTarget()) ==
diff --git a/test/ccompile.jl b/test/ccompile.jl
@@ -1,7 +1,7 @@
 using ModelingToolkit, Test
 @parameters t a
 @variables x y
-@derivatives D'~t
+D = Differential(t)
 eqs = [D(x) ~ a*x - x*y,
        D(y) ~ -3y + x*y]
 f = build_function(eqs,[x,y],[a],t,expression=Val{false},target=ModelingToolkit.CTarget())
diff --git a/test/components.jl b/test/components.jl
@@ -5,7 +5,7 @@ using Test
 # Define some variables
 @parameters t σ ρ β
 @variables x(t) y(t) z(t)
-@derivatives D'~t
+D = Differential(t)
 
 eqs = [D(x) ~ σ*(y-x),
        D(y) ~ x*(ρ-z)-y,
@@ -154,7 +154,7 @@ jac2 = Num[connected1₊lorenz1₊x 0 g zeros(1,12)
 
 @parameters t σ ρ β
 @variables x(t) y(t) z(t)
-@derivatives D'~t
+D = Differential(t)
 
 eqs = [D(x) ~ σ*(y-x),
        D(y) ~ x*(ρ-z)-y,
diff --git a/test/controlsystem.jl b/test/controlsystem.jl
@@ -2,7 +2,7 @@ using ModelingToolkit
 
 @variables t x(t) v(t) u(t)
 @parameters p[1:2]
-@derivatives D'~t
+D = Differential(t)
 
 loss = (4-x)^2 + 2v^2 + u^2
 eqs = [
diff --git a/test/dep_graphs.jl b/test/dep_graphs.jl
@@ -110,7 +110,7 @@ using UnPack
 # Define some variables
 @parameters t L g
 @variables x(t) y(t) w(t) z(t) T(t)
-@derivatives D'~t
+D = Differential(t)
 
 # Simple pendulum in cartesian coordinates
 eqs = [D(x) ~ w,
diff --git a/test/derivatives.jl b/test/derivatives.jl
@@ -5,7 +5,9 @@ using Test
 @parameters t σ ρ β
 @variables x y z
 @variables uu(t) uuˍt(t)
-@derivatives D'~t D2''~t Dx'~x
+D = Differential(t)
+D2 = Differential(t)^2
+Dx = Differential(x)
 
 @test Symbol(D(D(uu))) === Symbol("uuˍtt⦗t⦘")
 @test Symbol(D(uuˍt)) === Symbol(D(D(uu)))
@@ -100,12 +102,13 @@ t1 = ModelingToolkit.gradient(tmp, [x1, x2])
 
 @parameters t k
 @variables x(t)
-@derivatives D'~k
+D = Differential(k)
 @test ModelingToolkit.makesym(D(x).val).name === Symbol("xˍk⦗t⦘")
 
 using ModelingToolkit
 @variables t x(t)
-@derivatives ∂ₜ'~t ∂ₓ'~x
+∂ₜ = Differential(t)
+∂ₓ = Differential(x)
 L = .5 * ∂ₜ(x)^2 - .5 * x^2
 @test isequal(expand_derivatives(∂ₓ(L)), -1 * x)
 test_equal(expand_derivatives(Differential(x)(L) - ∂ₜ(Differential(∂ₜ(x))(L))), -1 * (∂ₜ(∂ₜ(x)) + x))
@@ -116,8 +119,8 @@ test_equal(expand_derivatives(Differential(x)(L) - ∂ₜ(Differential(∂ₜ(x)
 
 @parameters x y
 @variables u(..)
-@derivatives Dy'~y
-@derivatives Dx'~x
+Dy = Differential(y)
+Dx = Differential(x)
 dxyu = Dx(Dy(u(x,y)))
 @test isequal(expand_derivatives(dxyu), dxyu)
 dxxu = Dx(Dx(u(x,y)))
diff --git a/test/direct.jl b/test/direct.jl
@@ -7,6 +7,10 @@ canonequal(a, b) = isequal(simplify(a), simplify(b))
 # Calculus
 @parameters t σ ρ β
 @variables x y z
+@test isequal(
+    (Differential(z) * Differential(y) * Differential(x))(t),
+    Differential(z)(Differential(y)(Differential(x)(t)))
+)
 
 eqs = [σ*(y-x),
        x*(ρ-z)-y,
@@ -173,7 +177,7 @@ test_worldage()
 let
     @register foo(x)
     @variables t
-    @derivatives D'~t
+    D = Differential(t)
 
 
     @test isequal(expand_derivatives(D(foo(t))), D(foo(t)))
diff --git a/test/distributed.jl b/test/distributed.jl
@@ -7,7 +7,7 @@ addprocs(2)
 # create the Lorenz system
 @everywhere @parameters t σ ρ β
 @everywhere @variables x(t) y(t) z(t)
-@everywhere @derivatives D'~t
+@everywhere D = Differential(t)
 
 @everywhere eqs = [D(x) ~ σ*(y-x),
        D(y) ~ x*(ρ-z)-y,
diff --git a/test/function_registration.jl b/test/function_registration.jl
@@ -10,7 +10,7 @@ module MyModule
     using ModelingToolkit, DiffEqBase, LinearAlgebra, Test
     @parameters t x
     @variables u(t)
-    @derivatives Dt'~t
+    Dt = Differential(t)
 
     function do_something(a)
         a + 10
@@ -33,7 +33,7 @@ module MyModule2
         using ModelingToolkit, DiffEqBase, LinearAlgebra, Test
         @parameters t x
         @variables u(t)
-        @derivatives Dt'~t
+        Dt = Differential(t)
 
         function do_something_2(a)
             a + 20
@@ -55,7 +55,7 @@ end
 using ModelingToolkit, DiffEqBase, LinearAlgebra, Test
 @parameters t x
 @variables u(t)
-@derivatives Dt'~t
+Dt = Differential(t)
 
 function do_something_3(a)
     a + 30
@@ -73,7 +73,7 @@ u0 = 7.0
 # TEST: Function registration works with derivatives.
 # ---------------------------------------------------
 foo(x, y) = sin(x) * cos(y)
-@parameters t; @variables x(t) y(t) z(t); @derivatives D'~t;
+@parameters t; @variables x(t) y(t) z(t); D = Differential(t)
 @register foo(x, y)
 
 using ModelingToolkit: value, arguments, operation
@@ -99,7 +99,7 @@ end
 function build_ode()
     @parameters t x
     @variables u(t)
-    @derivatives Dt'~t
+    Dt = Differential(t)
     eq  = Dt(u) ~ do_something_4(x) + (@__MODULE__).do_something_4(x)
     sys = ODESystem([eq], t, [u], [x])
     fun = ODEFunction(sys, eval_expression=false)
diff --git a/test/inputoutput.jl b/test/inputoutput.jl
@@ -2,7 +2,7 @@ using ModelingToolkit, OrdinaryDiffEq, Test
 
 @parameters t σ ρ β
 @variables x(t) y(t) z(t) F(t) u(t)
-@derivatives D'~t
+D = Differential(t)
 
 eqs = [D(x) ~ σ*(y-x) + F,
        D(y) ~ x*(ρ-z)-y,
diff --git a/test/labelledarrays.jl b/test/labelledarrays.jl
@@ -5,7 +5,7 @@ using Test
 # Define some variables
 @parameters t σ ρ β
 @variables x(t) y(t) z(t)
-@derivatives D'~t
+D = Differential(t)
 
 # Define a differential equation
 eqs = [D(x) ~ σ*(y-x),
diff --git a/test/latexify.jl b/test/latexify.jl
@@ -20,7 +20,7 @@ using ModelingToolkit
 
 @parameters t σ ρ β
 @variables x(t) y(t) z(t)
-@derivatives D'~t
+D = Differential(t)
 
 eqs = [D(x) ~ σ*(y-x)*D(x-y)/D(z),
        0 ~ σ*x*(ρ-z)/10-y,
@@ -66,7 +66,7 @@ raw"\begin{align}
 
 @parameters t
 @variables x(t)
-@derivatives D'~t
+D = Differential(t)
 eqs = [D(x) ~ (1+cos(t))/(1+2*x)]
 
 @test latexify(eqs) == replace(
diff --git a/test/linearity.jl b/test/linearity.jl
@@ -5,7 +5,7 @@ using Test
 # Define some variables
 @parameters t σ ρ β
 @variables x(t) y(t) z(t)
-@derivatives D'~t
+D = Differential(t)
 
 eqs = [D(x) ~ σ*(y-x),
        D(y) ~ -z-y,
diff --git a/test/lowering_solving.jl b/test/lowering_solving.jl
@@ -2,7 +2,7 @@ using ModelingToolkit, OrdinaryDiffEq, Test, LinearAlgebra
 
 @parameters t σ ρ β
 @variables x(t) y(t) z(t) k(t)
-@derivatives D'~t
+D = Differential(t)
 
 eqs = [D(D(x)) ~ σ*(y-x),
        D(y) ~ x*(ρ-z)-y,
@@ -21,7 +21,7 @@ sys2 = ode_order_lowering(sys2)
 ModelingToolkit.calculate_massmatrix(sys2) == Diagonal([1, 1, 1, 1, 0])
 
 u0 = [D(x) => 2.0,
-	  x => 1.0,
+      x => 1.0,
       y => 0.0,
       z => 0.0]
 
@@ -39,7 +39,7 @@ solexpr = solve(eval(prob),Tsit5())
 
 @parameters t σ ρ β
 @variables x(t) y(t) z(t)
-@derivatives D'~t
+D = Differential(t)
 
 eqs = [D(x) ~ σ*(y-x),
        D(y) ~ x*(ρ-z)-y,
diff --git a/test/mass_matrix.jl b/test/mass_matrix.jl
@@ -2,7 +2,7 @@ using OrdinaryDiffEq, ModelingToolkit, Test
 @parameters t
 @variables y[1:3](t)
 @parameters k[1:3]
-@derivatives D'~t
+D = Differential(t)
 
 eqs = [D(y[1]) ~ -k[1]*y[1] + k[3]*y[2]*y[3],
        D(y[2]) ~  k[1]*y[1] - k[3]*y[2]*y[3] - k[2]*y[2]^2,
diff --git a/test/odesystem.jl b/test/odesystem.jl
diff --git a/test/operation_overloads.jl b/test/operation_overloads.jl
diff --git a/test/pde.jl b/test/pde.jl
diff --git a/test/reduction.jl b/test/reduction.jl
diff --git a/test/sdesystem.jl b/test/sdesystem.jl
diff --git a/test/steadystatesystems.jl b/test/steadystatesystems.jl
