refactor: redefine the components in tutorials with @model

Author: ven-k

docs/src/API/linear_analysis.md

@@ -57,7 +57,7 @@ The following example builds a simple closed-loop system with a plant $P$ and a
 ```@example LINEAR_ANALYSIS
 using ModelingToolkitStandardLibrary.Blocks, ModelingToolkit
 @named P = FirstOrder(k = 1, T = 1) # A first-order system with pole in -1
-@named C = Gain(-1)             # A P controller
+@named C = Gain(; k = -1)             # A P controller
 t = ModelingToolkit.get_iv(P)
 eqs = [connect(P.output, :plant_output, C.input)  # Connect with an automatically created analysis point called :plant_output
     connect(C.output, :plant_input, P.input)]

docs/src/tutorials/rc_circuit.md

@@ -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[], (0, 10.0))
+prob = ODAEProblem(sys, Pair[capacitor.v_start => 1], (0, 10.0))
 sol = solve(prob, Tsit5())
 plot(sol, vars = [capacitor.v, resistor.i],
     title = "RC Circuit Demonstration",

fmt/Project.toml

@@ -0,0 +1,2 @@
+[deps]
+JuliaFormatter = "98e50ef6-434e-11e9-1051-2b60c6c9e899"

format/Project.toml

@@ -0,0 +1,2 @@
+[deps]
+JuliaFormatter = "98e50ef6-434e-11e9-1051-2b60c6c9e899"

src/Blocks/analysis_points.jl

@@ -46,7 +46,7 @@ See also [`get_sensitivity`](@ref), [`get_comp_sensitivity`](@ref), [`get_looptr
 ```julia
 using ModelingToolkitStandardLibrary.Blocks
 @named P = FirstOrder(k = 1, T = 1)
-@named C = Gain(-1)
+@named C = Gain(; k = -1)
 t = ModelingToolkit.get_iv(P)
 eqs = [connect(P.output, C.input)
        connect(C.output, :plant_input, P.input)]

src/Blocks/math.jl

@@ -1,5 +1,5 @@
 """
-    Gain(k; name)
+    Gain(; name, k)
 
 Output the product of a gain value with the input signal.
 
@@ -12,15 +12,16 @@ Output the product of a gain value with the input signal.
   - `input`
   - `output`
 """
-@component function Gain(k; name)
-    @named siso = SISO()
-    @unpack u, y = siso
-    pars = @parameters k=k [description = "Gain of Gain $name"]
-    eqs = [
-        y ~ k * u,
-    ]
-    extend(ODESystem(eqs, t, [], pars; name = name), siso)
+@model Gain begin
+    @extend u, y = siso = SISO()
+    @parameters begin
+        k, [description = "Gain function"]
+    end
+    @equations begin
+        y ~ k * u
+    end
 end
+Gain.f(k; name) = Gain.f(; k, name)
 
 """
     MatrixGain(K::AbstractArray; name)
@@ -78,14 +79,15 @@ Output difference between reference input (input1) and feedback input (input2).
   - `input2`
   - `output`
 """
-@component function Feedback(; name)
-    @named input1 = RealInput()
-    @named input2 = RealInput()
-    @named output = RealOutput()
-    eqs = [
-        output.u ~ input1.u - input2.u,
-    ]
-    return compose(ODESystem(eqs, t, [], []; name = name), input1, input2, output)
+@model Feedback begin
+    @components begin
+        input1 = RealInput()
+        input2 = RealInput()
+        output = RealOutput()
+    end
+    @equations begin
+        output.u ~ input1.u - input2.u
+    end
 end
 
 """

src/Blocks/sources.jl

@@ -69,13 +69,16 @@ Generate constant signal.
 
   - `output`
 """
-@component function Constant(; name, k = 1)
-    @named output = RealOutput()
-    pars = @parameters k=k [description = "Constant output value of block $name"]
-    eqs = [
-        output.u ~ k,
-    ]
-    compose(ODESystem(eqs, t, [], pars; name = name), [output])
+@model Constant begin
+    @components begin
+        output = RealOutput()
+    end
+    @parameters begin
+        k, [description = "Constant output value of block $name"]
+    end
+    @equations begin
+        output.u ~ k
+    end
 end
 
 """
@@ -548,7 +551,7 @@ end
 """
     SampledData(; name, buffer)
 
-data input component.  
+data input component.
 
 # Parameters:
   - `buffer`: a `Parameter` type which holds the data and sample time

src/Blocks/utils.jl

@@ -13,6 +13,12 @@
     end
     ODESystem(Equation[], t, [u...], []; name = name)
 end
+
+#=
+@connector RealInput begin
+    u(t), [input = true]
+end
+=#
 @doc """
     RealInput(;name, nin, u_start)
 
@@ -25,7 +31,6 @@ Connector with one input signal of type Real.
 # States:
 - `u`: Value of the connector; if nin=1 this is a scalar
 """ RealInput
-
 @connector function RealOutput(; name, nout = 1, u_start = nout > 1 ? zeros(nout) : 0.0)
     if nout == 1
         @variables u(t)=u_start [
@@ -41,6 +46,10 @@ Connector with one input signal of type Real.
     end
     ODESystem(Equation[], t, [u...], []; name = name)
 end
+
+#=@connector RealOutput begin
+    u(t), [output = true]
+end=#
 @doc """
     RealOutput(;name, nout, u_start)
 

src/Electrical/Analog/ideal_components.jl

@@ -8,10 +8,13 @@ node.
 
   - `g`
 """
-@component function Ground(; name)
-    @named g = Pin()
-    eqs = [g.v ~ 0]
-    ODESystem(eqs, t, [], []; systems = [g], name = name)
+@model Ground begin
+    @components begin
+        g = Pin()
+    end
+    @equations begin
+        g.v ~ 0
+    end
 end
 
 """
@@ -32,14 +35,14 @@ See [OnePort](@ref)
 
   - `R`: [`Ohm`] Resistance
 """
-@component function Resistor(; name, R)
-    @named oneport = OnePort()
-    @unpack v, i = oneport
-    pars = @parameters R = R
-    eqs = [
-        v ~ i * R,
-    ]
-    extend(ODESystem(eqs, t, [], pars; name = name), oneport)
+@model Resistor begin
+    @extend v, i = oneport = OnePort()
+    @parameters begin
+        R
+    end
+    @equations begin
+        v ~ i * R
+    end
 end
 
 """
@@ -60,18 +63,18 @@ See [OnePort](@ref)
 
   - `G`: [`S`] Conductance
 """
-@component function Conductor(; name, G)
-    @named oneport = OnePort()
-    @unpack v, i = oneport
-    pars = @parameters G = G
-    eqs = [
-        i ~ v * G,
-    ]
-    extend(ODESystem(eqs, t, [], pars; name = name), oneport)
+@model Conductor begin
+    @extend v, i = oneport = OnePort()
+    @parameters begin
+        G
+    end
+    @equations begin
+        i ~ v * G
+    end
 end
 
 """
-    Capacitor(; name, C)
+    Capacitor(; name, C, v_start)
 
 Creates an ideal capacitor.
 
@@ -87,20 +90,23 @@ Creates an ideal capacitor.
 # Parameters:
 
   - `C`: [`F`] Capacitance
-  - `v_start`: [`V`] Initial voltage of capacitor
+  - `v`: [`V`] Initial voltage of capacitor
 """
-@component function Capacitor(; name, C, v_start = 0.0)
-    @named oneport = OnePort(; v_start = v_start)
-    @unpack v, i = oneport
-    pars = @parameters C = C
-    eqs = [
-        D(v) ~ i / C,
-    ]
-    extend(ODESystem(eqs, t, [], pars; name = name), oneport)
+@model Capacitor begin
+    @parameters begin
+      C
+    end
+    @variables begin
+      v
+    end
+    @extend v, i = oneport = OnePort(; v = v)
+    @equations begin
+        D(v) ~ i / C
+    end
 end
 
 """
-    Inductor(; name, L)
+    Inductor(; name, L, i_start)
 
 Creates an ideal Inductor.
 
@@ -116,16 +122,19 @@ See [OnePort](@ref)
 # Parameters:
 
   - `L`: [`H`] Inductance
-  - `i_start`: [`A`] Initial current through inductor
+  - `i`: [`A`] Initial current through inductor
 """
-@component function Inductor(; name, L, i_start = 0.0)
-    @named oneport = OnePort(; i_start = i_start)
-    @unpack v, i = oneport
-    pars = @parameters L = L
-    eqs = [
-        D(i) ~ 1 / L * v,
-    ]
-    extend(ODESystem(eqs, t, [], pars; name = name), oneport)
+@model Inductor begin # name, L, i_start = 0.0)
+    @parameters begin
+      L
+    end
+    @variables begin
+      i
+    end
+    @extend v, i = oneport = OnePort(; i = i)
+    @equations begin
+        D(i) ~ 1 / L * v
+    end
 end
 
 """
@@ -213,7 +222,7 @@ Temperature dependent electrical resistor
 end
 
 """
-    EMF(;name, k)
+    EMF(; name, k)
 
 Electromotoric force (electric/mechanic transformer)
 
@@ -235,19 +244,29 @@ Electromotoric force (electric/mechanic transformer)
 
   - `k`: [`N⋅m/A`] Transformation coefficient
 """
-@component function EMF(; name, k)
-    @named p = Pin()
-    @named n = Pin()
-    @named flange = Flange()
-    @named support = Support()
-    @parameters k = k
-    @variables v(t)=0.0 i(t)=0.0 phi(t)=0.0 w(t)=0.0
-    eqs = [v ~ p.v - n.v
+@model EMF begin
+    @components begin
+        p = Pin()
+        n = Pin()
+        flange = Flange()
+        support = Support()
+    end
+    @parameters begin
+        k
+    end
+    @variables begin
+        v(t) = 0.0
+        i(t) = 0.0
+        phi(t) = 0.0
+        w(t) = 0.0
+    end
+    @equations begin
+        v ~ p.v - n.v
         0 ~ p.i + n.i
         i ~ p.i
         phi ~ flange.phi - support.phi
         D(phi) ~ w
         k * w ~ v
-        flange.tau ~ -k * i]
-    ODESystem(eqs, t, [v, i, phi, w], [k]; name = name, systems = [p, n, flange, support])
+        flange.tau ~ -k * i
+    end
 end

src/Electrical/Analog/sources.jl

@@ -13,15 +13,14 @@ See [OnePort](@ref)
   - `n` Negative pin
   - `V` [RealInput](@ref) Input for the voltage control signal, i.e. `V ~ p.v - n.v`
 """
-@component function Voltage(; name)
-    @named oneport = OnePort()
-    @unpack v, i = oneport
-    @named V = RealInput()
-    eqs = [
-        v ~ V.u,
-    ]
-
-    extend(ODESystem(eqs, t, [], []; name = name, systems = [V]), oneport)
+@model Voltage begin
+    @extend v, i = oneport = OnePort()
+    @components begin
+        V = RealInput()
+    end
+    @equations begin
+        v ~ V.u
+    end
 end
 
 """
@@ -39,13 +38,12 @@ See [OnePort](@ref)
   - `n` Negative pin
   - `I` [RealInput](@ref) Input for the current control signal, i.e. `I ~ p.i
 """
-@component function Current(; name)
-    @named oneport = OnePort()
-    @unpack v, i = oneport
-    @named I = RealInput()
-    eqs = [
-        i ~ I.u,
-    ]
-
-    extend(ODESystem(eqs, t, [], []; name = name, systems = [I]), oneport)
+@model Current begin
+    @extend v, i = oneport = OnePort()
+    @components begin
+        I = RealInput()
+    end
+    @equations begin
+        i ~ I.u
+    end
 end