refactor: Blocks/sources.jl (limited)

Author: ven-k

src/Blocks/sources.jl

@@ -59,6 +59,8 @@ function triangular(x, f, amplitude, offset, start_time)
 end
 
 """
+    Constant(; name, k = 0.0)
+
 Generate constant signal.
 
 # Parameters:
@@ -69,17 +71,20 @@ 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])
+@mtkmodel Constant begin
+    @components begin
+        output = RealOutput()
+    end
+    @parameters begin
+        k = 0.0, [description = "Constant output value of block"]
+    end
+    @equations begin
+        output.u ~ k
+    end
 end
 
 """
-    TimeVaryingFunction(f; t=t, name)
+    TimeVaryingFunction(f; name)
 
 Outputs ``f(t)``.
 
@@ -88,15 +93,23 @@ The input variable `t` can be changed by passing a different variable as the key
 # Connectors:
 - `output`
 """
-@component function TimeVaryingFunction(f; t = t, name)
-    @named output = RealOutput()
-    eqs = [
-        output.u ~ f(t),
-    ]
-    compose(ODESystem(eqs, Blocks.t; name = name), [output])
+@mtkmodel TimeVaryingFunction begin
+    @parameters begin
+        f
+    end
+    @components begin
+        output = RealOutput()
+    end
+    @equations begin
+        output.u ~ first(getdefault(f))(t)
+    end
 end
+TimeVaryingFunction.f(f; name) = TimeVaryingFunction.f(; f = [f], name)
 
 """
+    Sine(; name, frequency, amplitude = 1, phase = 0, offset = 0, start_time = 0,
+    smooth = false)
+
 Generate sine signal.
 
 # Parameters:
@@ -138,7 +151,10 @@ Generate sine signal.
 end
 
 """
-Generate cosine signal.
+    Cosine(; name, frequency, amplitude = 1, phase = 0, offset = 0, start_time = 0,
+    smooth = false)
+
+Cosine signal.
 
 # Parameters:
 - `frequency`: [Hz] Frequency of sine wave
@@ -177,6 +193,8 @@ Generate cosine signal.
 end
 
 """
+    ContinuousClock(; name, offset = 0, start_time = 0)
+
 Generate current time signal.
 
 # Parameters:
@@ -199,6 +217,8 @@ Generate current time signal.
 end
 
 """
+Ramp(; name, height = 1, duration = 1, offset = 0, start_time = 0, smooth = false)
+
 Generate ramp signal.
 
 # Parameters:
@@ -239,6 +259,8 @@ Generate ramp signal.
 end
 
 """
+    Square(; name, frequency = 1.0, amplitude = 1.0, offset = 0.0, start_time = 0.0,
+    smooth = false)
 Generate smooth square signal.
 
 # Parameters:
@@ -321,7 +343,9 @@ Generate step signal.
 end
 
 """
-Generate exponentially damped sine signal.
+    ExpSine(; name, frequency, amplitude = 1, damping = 0.1, phase = 0, offset = 0, start_time = 0, smooth = false)
+
+Exponentially damped sine signal.
 
 # Parameters:
 
@@ -367,6 +391,9 @@ Generate exponentially damped sine signal.
 end
 
 """
+    Triangular(; name, amplitude = 1.0, frequency = 1.0, offset = 0.0,
+    start_time = 0.0, smooth = false)
+
 Generate smooth triangular signal for frequencies less than or equal to 25 Hz
 
 # Parameters:
@@ -548,7 +575,7 @@ end
 """
     SampledData(; name, buffer)
 
-data input component.  
+data input component.
 
 # Parameters:
   - `buffer`: a `Parameter` type which holds the data and sample time

src/Electrical/Analog/ideal_components.jl

@@ -89,14 +89,17 @@ Creates an ideal capacitor.
   - `C`: [`F`] Capacitance
   - `v_start`: [`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)
+@mtkmodel 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
 
 """
@@ -118,14 +121,17 @@ See [OnePort](@ref)
   - `L`: [`H`] Inductance
   - `i_start`: [`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)
+@mtkmodel 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
 
 """

test/Blocks/sources.jl

@@ -37,7 +37,7 @@ end
         systems = [int, src])
     sys = structural_simplify(iosys)
 
-    prob = ODEProblem(sys, Pair[int.x => 0.0], (0.0, 10.0))
+    prob = ODEProblem(sys, Pair[], (0.0, 10.0))
 
     sol = solve(prob, Rodas4())
     @test sol.retcode == Success

test/demo.jl

@@ -12,7 +12,7 @@ using Test
     @named capacitor = Capacitor(C = C)
     @named voltage = Voltage()
     @named ground = Ground()
-    @named source = Constant()
+    @named source = Constant(k = 1)
 
     rc_eqs = [connect(source.output, voltage.V)
         connect(voltage.p, resistor.p)