refactor: add RealInputArray and RealOutputArray

Author: Sathvik Bhagavan

src/Blocks/Blocks.jl

@@ -7,7 +7,7 @@ import IfElse: ifelse
 import ..@symcheck
 using ModelingToolkit: getdefault, t_nounits as t, D_nounits as D
 
-export RealInput, RealOutput, SISO
+export RealInput, RealInputArray, RealOutput, RealOutputArray, SISO
 include("utils.jl")
 
 export Gain, Sum, MatrixGain, Feedback, Add, Add3, Product, Division

src/Blocks/utils.jl

@@ -1,6 +1,6 @@
-@connector function RealInput(;
-        name, nin = 1, isarray = false, u_start = isarray ? zeros(nin) : 0.0)
-    if nin == 1 && !isarray
+@connector function RealInput(; name, nin = 1, u_start = nin > 1 ? zeros(nin) : 0.0)
+    nin > 1 && @warn "For inputs greater than one, use `RealInputArray`."
+    if nin == 1
         @variables u(t)=u_start [
             input = true,
             description = "Inner variable in RealInput $name"
@@ -15,22 +15,41 @@
     ODESystem(Equation[], t, [u...], []; name = name)
 end
 @doc """
-    RealInput(;name, nin, u_start)
+    RealInput(;name, u_start)
 
 Connector with one input signal of type Real.
 
 # Parameters:
-- `nin=1`: Number of inputs
-- `u_start=0`: Initial value for `u`
-- `isarray=false`: This is only applicable for `nin=1`. Boolean flag to use a scalar or a one element symbolic vector
+- `u_start=0`: Initial value for `u`.
 
 # States:
-- `u`: Value of the connector; if nin=1 this is a scalar
+- `u`: Value of the connector which is a scalar.
 """ RealInput
 
-@connector function RealOutput(;
-        name, nout = 1, isarray = false, u_start = isarray ? zeros(nout) : 0.0)
-    if nout == 1 && !isarray
+@connector function RealInputArray(; name, nin = 2, u_start = zeros(nin))
+    @variables u(t)[1:nin]=u_start [
+        input = true,
+        description = "Inner variable in RealInputArray $name"
+    ]
+    u = collect(u)
+    ODESystem(Equation[], t, [u...], []; name = name)
+end
+@doc """
+    RealInputArray(;name, nin, u_start)
+
+Connector with an array of input signals of type Real.
+
+# Parameters:
+- `nin=2`: Number of inputs.
+- `u_start=zeros(nin)`: Initial value for `u`.
+
+# States:
+- `u`: Value of the connector which is an array.
+""" RealInputArray
+
+@connector function RealOutput(; name, nout = 1, u_start = nout > 1 ? zeros(nout) : 0.0)
+    nout > 1 && @warn "For outputs greater than one, use `RealOutputArray`."
+    if nout == 1
         @variables u(t)=u_start [
             output = true,
             description = "Inner variable in RealOutput $name"
@@ -45,19 +64,38 @@ Connector with one input signal of type Real.
     ODESystem(Equation[], t, [u...], []; name = name)
 end
 @doc """
-    RealOutput(;name, nout, u_start)
+    RealOutput(;name, u_start)
 
 Connector with one output signal of type Real.
 
 # Parameters:
-- `nout=1`: Number of outputs
-- `u_start=0`: Initial value for `u`
-- `isarray=false`: This is only applicable for `nout=1`. Boolean flag to use a scalar or a one element symbolic vector
+- `u_start=0`: Initial value for `u`.
 
 # States:
-- `u`: Value of the connector; if nout=1 this is a scalar
+- `u`: Value of the connector which is a scalar.
 """ RealOutput
 
+@connector function RealOutputArray(; name, nout = 2, u_start = zeros(nout))
+    @variables u(t)[1:nout]=u_start [
+        output = true,
+        description = "Inner variable in RealOutput $name"
+    ]
+    u = collect(u)
+    ODESystem(Equation[], t, [u...], []; name = name)
+end
+@doc """
+    RealOutputArray(;name, nout, u_start)
+
+Connector with an array of output signals of type Real.
+
+# Parameters:
+- `nout=2`: Number of outputs.
+- `u_start=zeros(nout)`: Initial value for `u`.
+
+# States:
+- `u`: Value of the connector which is an array.
+""" RealOutputArray
+
 """
     SISO(;name, u_start = 0.0, y_start = 0.0)