refactor: @model -> @mtkmodel

Author: ven-k

docs/src/tutorials/rc_circuit.md

@@ -16,7 +16,7 @@ C = 1.0
 V = 1.0
 @variables t
 @named resistor = Resistor(R = R)
-@named capacitor = Capacitor(C = C)
+@named capacitor = Capacitor(C = C, v = 0.0)
 @named source = Voltage()
 @named constant = Constant(k = V)
 @named ground = Ground()
@@ -29,7 +29,7 @@ rc_eqs = [connect(constant.output, source.V)
 @named rc_model = ODESystem(rc_eqs, t,
     systems = [resistor, capacitor, constant, source, ground])
 sys = structural_simplify(rc_model)
-prob = ODAEProblem(sys, Pair[capacitor.v_start => 1], (0, 10.0))
+prob = ODAEProblem(sys, Pair[], (0, 10.0))
 sol = solve(prob, Tsit5())
 plot(sol, vars = [capacitor.v, resistor.i],
     title = "RC Circuit Demonstration",

src/Blocks/math.jl

@@ -12,7 +12,7 @@ Output the product of a gain value with the input signal.
   - `input`
   - `output`
 """
-@model Gain begin
+@mtkmodel Gain begin
     @extend u, y = siso = SISO()
     @parameters begin
         k, [description = "Gain function"]
@@ -79,7 +79,7 @@ Output difference between reference input (input1) and feedback input (input2).
   - `input2`
   - `output`
 """
-@model Feedback begin
+@mtkmodel Feedback begin
     @components begin
         input1 = RealInput()
         input2 = RealInput()

src/Blocks/sources.jl

@@ -69,7 +69,7 @@ Generate constant signal.
 
   - `output`
 """
-@model Constant begin
+@mtkmodel Constant begin
     @components begin
         output = RealOutput()
     end

src/Electrical/Analog/ideal_components.jl

@@ -8,7 +8,7 @@ node.
 
   - `g`
 """
-@model Ground begin
+@mtkmodel Ground begin
     @components begin
         g = Pin()
     end
@@ -35,7 +35,7 @@ See [OnePort](@ref)
 
   - `R`: [`Ohm`] Resistance
 """
-@model Resistor begin
+@mtkmodel Resistor begin
     @extend v, i = oneport = OnePort()
     @parameters begin
         R
@@ -63,7 +63,7 @@ See [OnePort](@ref)
 
   - `G`: [`S`] Conductance
 """
-@model Conductor begin
+@mtkmodel Conductor begin
     @extend v, i = oneport = OnePort()
     @parameters begin
         G
@@ -92,7 +92,7 @@ Creates an ideal capacitor.
   - `C`: [`F`] Capacitance
   - `v`: [`V`] Initial voltage of capacitor
 """
-@model Capacitor begin
+@mtkmodel Capacitor begin
     @parameters begin
       C
     end
@@ -124,7 +124,7 @@ See [OnePort](@ref)
   - `L`: [`H`] Inductance
   - `i`: [`A`] Initial current through inductor
 """
-@model Inductor begin # name, L, i_start = 0.0)
+@mtkmodel Inductor begin # name, L, i_start = 0.0)
     @parameters begin
       L
     end
@@ -244,7 +244,7 @@ Electromotoric force (electric/mechanic transformer)
 
   - `k`: [`N⋅m/A`] Transformation coefficient
 """
-@model EMF begin
+@mtkmodel EMF begin
     @components begin
         p = Pin()
         n = Pin()

src/Electrical/Analog/sources.jl

@@ -13,7 +13,7 @@ See [OnePort](@ref)
   - `n` Negative pin
   - `V` [RealInput](@ref) Input for the voltage control signal, i.e. `V ~ p.v - n.v`
 """
-@model Voltage begin
+@mtkmodel Voltage begin
     @extend v, i = oneport = OnePort()
     @components begin
         V = RealInput()
@@ -38,7 +38,7 @@ See [OnePort](@ref)
   - `n` Negative pin
   - `I` [RealInput](@ref) Input for the current control signal, i.e. `I ~ p.i
 """
-@model Current begin
+@mtkmodel Current begin
     @extend v, i = oneport = OnePort()
     @components begin
         I = RealInput()

src/Electrical/utils.jl

@@ -32,7 +32,7 @@ Component with two electrical pins `p` and `n` and current `i` flows from `p` to
   - `p` Positive pin
   - `n` Negative pin
 """
-@model OnePort begin
+@mtkmodel OnePort begin
     @components begin
         p = Pin()
         n = Pin()

src/Mechanical/Rotational/components.jl

@@ -11,7 +11,7 @@ Flange fixed in housing at a given angle.
 
   - `phi0`: [`rad`] Fixed offset angle of housing
 """
-@model Fixed begin
+@mtkmodel Fixed begin
     @components begin
         flange = Flange()
     end
@@ -115,7 +115,7 @@ Linear 1D rotational damper
 
   - `d`: [`N.m.s/rad`] Damping constant
 """
-@model Damper begin
+@mtkmodel Damper begin
     @extend w_rel, tau = partial_comp = PartialCompliantWithRelativeStates()
     begin
         @symcheck d > 0 || throw(ArgumentError("Expected `d` to be positive"))

src/Mechanical/Rotational/sensors.jl

@@ -26,7 +26,7 @@ Ideal sensor to measure the absolute flange angular velocity
   - `flange`: [Flange](@ref) Flange of shaft from which sensor information shall be measured
   - `w`: [RealOutput](@ref) Absolute angular velocity of flange
 """
-@model SpeedSensor begin
+@mtkmodel SpeedSensor begin
     @components begin
         flange = Flange()
         w = RealOutput()

test/Electrical/analog.jl

@@ -13,7 +13,7 @@ using OrdinaryDiffEq: ReturnCode.Success
     @named source = Sine(offset = 1, amplitude = 10, frequency = 5)
     @named voltage = Voltage()
     @named resistor = Resistor(R = 1)
-    @named capacitor = Capacitor(C = 1)
+    @named capacitor = Capacitor(C = 1, v = 0.0)
     @named ground = Ground()
 
     @named voltage_sensor = VoltageSensor()
@@ -43,7 +43,7 @@ using OrdinaryDiffEq: ReturnCode.Success
             power_sensor,
         ])
     sys = structural_simplify(model)
-    prob = ODAEProblem(sys, Pair[capacitor.v => 0.0], (0.0, 10.0))
+    prob = ODAEProblem(sys, [], (0.0, 10.0))
     sol = solve(prob, Tsit5())
 
     # Plots.plot(sol; vars=[capacitor.v, voltage_sensor.v])
@@ -89,7 +89,7 @@ end
     @named source = Constant(k = 10)
     @named voltage = Voltage()
     @named resistor = Resistor(R = 1)
-    @named capacitor = Capacitor(C = 1)
+    @named capacitor = Capacitor(C = 1, v = 0.0)
     @named ground = Ground()
 
     connections = [connect(source.output, voltage.V)
@@ -100,7 +100,7 @@ end
     @named model = ODESystem(connections, t;
         systems = [resistor, capacitor, source, voltage, ground])
     sys = structural_simplify(model)
-    prob = ODAEProblem(sys, [capacitor.v => 0.0], (0.0, 10.0))
+    prob = ODAEProblem(sys, Pair[], (0.0, 10.0))
     sol = solve(prob, Tsit5())
 
     # Plots.plot(sol; vars=[source.v, capacitor.v])
@@ -113,7 +113,7 @@ end
     @named source = Constant(k = 10)
     @named voltage = Voltage()
     @named resistor = Resistor(R = 1)
-    @named inductor = Inductor(L = 1.0)
+    @named inductor = Inductor(L = 1.0, i = 0.0)
     @named ground = Ground()
 
     connections = [connect(source.output, voltage.V)
@@ -124,7 +124,7 @@ end
     @named model = ODESystem(connections, t;
         systems = [resistor, inductor, source, voltage, ground])
     sys = structural_simplify(model)
-    prob = ODAEProblem(sys, [inductor.i => 0.0], (0.0, 10.0))
+    prob = ODAEProblem(sys, Pair[], (0.0, 10.0))
     sol = solve(prob, Tsit5())
 
     # Plots.plot(sol; vars=[inductor.i, inductor.i])
@@ -147,7 +147,7 @@ end
     sources = [source_const, source_sin, source_step, source_tri, source_dsin, source_ramp]
 
     @named resistor = Resistor(; R)
-    @named capacitor = Capacitor(; C)
+    @named capacitor = Capacitor(; C, v = 0.0)
     @named ground = Ground()
 
     for source in sources
@@ -159,7 +159,7 @@ end
         @named model = ODESystem(connections, t;
             systems = [resistor, capacitor, source, ground, voltage])
         sys = structural_simplify(model)
-        prob = ODAEProblem(sys, [capacitor.v => 0.0], (0.0, 10.0))
+        prob = ODAEProblem(sys, Pair[], (0.0, 10.0))
         sol = solve(prob, Tsit5())
         @test sol.retcode == Success
         sol = solve(prob, Rodas4())
@@ -175,7 +175,7 @@ end
     @named current = Current()
     @named source = Step(start_time = 2)
     @named resistor = Resistor(R = 1)
-    @named capacitor = Capacitor(C = 1)
+    @named capacitor = Capacitor(C = 1, v = 0.0)
     @named ground = Ground()
 
     connections = [connect(source.output, current.I)
@@ -186,7 +186,7 @@ end
     @named model = ODESystem(connections, t;
         systems = [ground, resistor, current, capacitor, source])
     sys = structural_simplify(model)
-    prob = ODAEProblem(sys, [capacitor.v => 0.0], (0.0, 10.0))
+    prob = ODAEProblem(sys, Pair[], (0.0, 10.0))
     sol = solve(prob, Tsit5())
     y(x, st) = (x .> st) .* abs.(collect(x) .- st)
     @test sol.retcode == Success
@@ -200,7 +200,7 @@ end
     @named ground = Ground()
     @named R1 = Resistor(R = R)
     @named R2 = Resistor(R = 100 * R)
-    @named C1 = Capacitor(C = 1 / (2 * pi * f * R))
+    @named C1 = Capacitor(C = 1 / (2 * pi * f * R), v = 0.0)
     @named opamp = IdealOpAmp()
     @named square_source = Square(amplitude = Vin)
     @named voltage = Voltage()
@@ -247,7 +247,7 @@ _damped_sine_wave(x, f, A, st, ϕ, d) = exp((st - x) * d) * A * sin(2 * π * f *
     st, o, h, f, A, et, ϕ, d, δ = 0.7, 1.25, 3, 2, 2.5, 2, π / 4, 0.1, 0.0001
 
     @named res = Resistor(R = 1)
-    @named cap = Capacitor(C = 1)
+    @named cap = Capacitor(C = 1, v = 0.0)
     @named ground = Ground()
     @named voltage = Voltage()
     @named voltage_sensor = VoltageSensor()
@@ -311,7 +311,7 @@ end
 
     @named ground = Ground()
     @named res = Resistor(R = 1.0)
-    @named cap = Capacitor(C = 1)
+    @named cap = Capacitor(C = 1, v = 0.0)
     @named current_sensor = CurrentSensor()
     @named current = Current()
     @named step = Step(start_time = st, offset = o, height = h)

test/demo.jl

@@ -57,7 +57,7 @@ D = Differential(t)
         ])
     sys = structural_simplify(model)
 
-    prob = ODEProblem(sys, [], (0, 6.0))
+    prob = ODEProblem(sys, Pair[], (0, 6.0))
     sol = solve(prob, Rodas4())
     @test sol.retcode == Success
     # EMF equations

test/multi_domain.jl

@@ -31,9 +31,6 @@ end
 @safetestset "Digital Circuits" begin
     include("Electrical/digital.jl")
 end
-@safetestset "RC Circuit Demo" begin
-    include("demo.jl")
-end
 @safetestset "Chua Circuit Demo" begin
     include("chua_circuit.jl")
 end
@@ -66,4 +63,3 @@ end
 @safetestset "Hydraulic IsothermalCompressible" begin
     include("Hydraulic/isothermal_compressible.jl")
 end
-