Add at component

Author: YingboMa

docs/src/tutorials/acausal_components.md

@@ -28,13 +28,13 @@ using ModelingToolkit, Plots, DifferentialEquations
     ODESystem(Equation[], t, sts, []; name = name)
 end
 
-function Ground(; name)
+@component function Ground(; name)
     @named g = Pin()
     eqs = [g.v ~ 0]
     compose(ODESystem(eqs, t, [], []; name = name), g)
 end
 
-function OnePort(; name)
+@component function OnePort(; name)
     @named p = Pin()
     @named n = Pin()
     sts = @variables v(t)=1.0 i(t)=1.0
@@ -44,7 +44,7 @@ function OnePort(; name)
     compose(ODESystem(eqs, t, sts, []; name = name), p, n)
 end
 
-function Resistor(; name, R = 1.0)
+@component function Resistor(; name, R = 1.0)
     @named oneport = OnePort()
     @unpack v, i = oneport
     ps = @parameters R = R
@@ -54,7 +54,7 @@ function Resistor(; name, R = 1.0)
     extend(ODESystem(eqs, t, [], ps; name = name), oneport)
 end
 
-function Capacitor(; name, C = 1.0)
+@component function Capacitor(; name, C = 1.0)
     @named oneport = OnePort()
     @unpack v, i = oneport
     ps = @parameters C = C
@@ -65,7 +65,7 @@ function Capacitor(; name, C = 1.0)
     extend(ODESystem(eqs, t, [], ps; name = name), oneport)
 end
 
-function ConstantVoltage(; name, V = 1.0)
+@component function ConstantVoltage(; name, V = 1.0)
     @named oneport = OnePort()
     @unpack v = oneport
     ps = @parameters V = V
@@ -149,7 +149,7 @@ this component, we generate an `ODESystem` with a `Pin` subcomponent and specify
 that the voltage in such a `Pin` is equal to zero. This gives:
 
 ```@example acausal
-function Ground(; name)
+@component function Ground(; name)
     @named g = Pin()
     eqs = [g.v ~ 0]
     compose(ODESystem(eqs, t, [], []; name = name), g)
@@ -163,7 +163,7 @@ zero, and the current of the component equals to the current of the positive
 pin.
 
 ```@example acausal
-function OnePort(; name)
+@component function OnePort(; name)
     @named p = Pin()
     @named n = Pin()
     sts = @variables v(t)=1.0 i(t)=1.0
@@ -182,7 +182,7 @@ of charge we know that the current in must equal the current out, which means
 zero. This leads to our resistor equations:
 
 ```@example acausal
-function Resistor(; name, R = 1.0)
+@component function Resistor(; name, R = 1.0)
     @named oneport = OnePort()
     @unpack v, i = oneport
     ps = @parameters R = R
@@ -205,7 +205,7 @@ we can use `@unpack` to avoid the namespacing.
 Using our knowledge of circuits, we similarly construct the `Capacitor`:
 
 ```@example acausal
-function Capacitor(; name, C = 1.0)
+@component function Capacitor(; name, C = 1.0)
     @named oneport = OnePort()
     @unpack v, i = oneport
     ps = @parameters C = C
@@ -223,7 +223,7 @@ constant voltage, essentially generating the electric current. We would then
 model this as:
 
 ```@example acausal
-function ConstantVoltage(; name, V = 1.0)
+@component function ConstantVoltage(; name, V = 1.0)
     @named oneport = OnePort()
     @unpack v = oneport
     ps = @parameters V = V

examples/electrical_components.jl

@@ -7,13 +7,13 @@ using ModelingToolkit, OrdinaryDiffEq
     ODESystem(Equation[], t, sts, []; name = name)
 end
 
-function Ground(; name)
+@component function Ground(; name)
     @named g = Pin()
     eqs = [g.v ~ 0]
     compose(ODESystem(eqs, t, [], []; name = name), g)
 end
 
-function OnePort(; name)
+@component function OnePort(; name)
     @named p = Pin()
     @named n = Pin()
     sts = @variables v(t)=1.0 i(t)=1.0
@@ -23,7 +23,7 @@ function OnePort(; name)
     compose(ODESystem(eqs, t, sts, []; name = name), p, n)
 end
 
-function Resistor(; name, R = 1.0)
+@component function Resistor(; name, R = 1.0)
     @named oneport = OnePort()
     @unpack v, i = oneport
     ps = @parameters R = R
@@ -33,7 +33,7 @@ function Resistor(; name, R = 1.0)
     extend(ODESystem(eqs, t, [], ps; name = name), oneport)
 end
 
-function Capacitor(; name, C = 1.0)
+@component function Capacitor(; name, C = 1.0)
     @named oneport = OnePort()
     @unpack v, i = oneport
     ps = @parameters C = C
@@ -44,7 +44,7 @@ function Capacitor(; name, C = 1.0)
     extend(ODESystem(eqs, t, [], ps; name = name), oneport)
 end
 
-function ConstantVoltage(; name, V = 1.0)
+@component function ConstantVoltage(; name, V = 1.0)
     @named oneport = OnePort()
     @unpack v = oneport
     ps = @parameters V = V
@@ -54,7 +54,7 @@ function ConstantVoltage(; name, V = 1.0)
     extend(ODESystem(eqs, t, [], ps; name = name), oneport)
 end
 
-function Inductor(; name, L = 1.0)
+@component function Inductor(; name, L = 1.0)
     @named oneport = OnePort()
     @unpack v, i = oneport
     ps = @parameters L = L
@@ -70,7 +70,7 @@ end
     ODESystem(Equation[], t, [T, Q_flow], [], name = name)
 end
 
-function HeatingResistor(; name, R = 1.0, TAmbient = 293.15, alpha = 1.0)
+@component function HeatingResistor(; name, R = 1.0, TAmbient = 293.15, alpha = 1.0)
     @named p = Pin()
     @named n = Pin()
     @named h = HeatPort()
@@ -85,7 +85,7 @@ function HeatingResistor(; name, R = 1.0, TAmbient = 293.15, alpha = 1.0)
                       name = name), p, n, h)
 end
 
-function HeatCapacitor(; name, rho = 8050, V = 1, cp = 460, TAmbient = 293.15)
+@component function HeatCapacitor(; name, rho = 8050, V = 1, cp = 460, TAmbient = 293.15)
     @parameters rho=rho V=V cp=cp
     C = rho * V * cp
     @named h = HeatPort()

src/ModelingToolkit.jl

@@ -181,6 +181,7 @@ export JumpProblem, DiscreteProblem
 export NonlinearSystem, OptimizationSystem, ConstraintsSystem
 export alias_elimination, flatten
 export connect, @connector, Connection, Flow, Stream, instream
+export @component
 export isinput, isoutput, getbounds, hasbounds, isdisturbance, istunable, getdist, hasdist,
        tunable_parameters, isirreducible, getdescription, hasdescription, isbinaryvar,
        isintegervar

src/systems/abstractsystem.jl

@@ -1,7 +1,7 @@
 const SYSTEM_COUNT = Threads.Atomic{UInt}(0)
 
 struct GUIMetadata
-    type::String
+    type::Symbol
     layout::Any
 end
 
@@ -1117,6 +1117,40 @@ macro namespace(expr)
     esc(_config(expr, true))
 end
 
+function component_post_processing(expr, isconnector)
+    @assert expr isa Expr && (expr.head == :function || (expr.head == :(=) &&
+              expr.args[1] isa Expr &&
+              expr.args[1].head == :call))
+
+    sig = expr.args[1]
+    body = expr.args[2]
+
+    fname = sig.args[1]
+    args = sig.args[2:end]
+
+    quote
+        function $fname($(args...))
+            function f()
+                $body
+            end
+            res = f()
+            if $isdefined(res, :gui_metadata) && $getfield(res, :gui_metadata) === nothing
+                name = $(Meta.quot(fname))
+                if $isconnector
+                    $Setfield.@set!(res.connector_type=$connector_type(res))
+                end
+                $Setfield.@set!(res.gui_metadata=$GUIMetadata(name))
+            else
+                res
+            end
+        end
+    end
+end
+
+macro component(expr)
+    esc(component_post_processing(expr, false))
+end
+
 """
 $(SIGNATURES)
 

src/systems/connectors.jl

@@ -6,32 +6,8 @@ function get_connection_type(s)
     getmetadata(s, VariableConnectType, Equality)
 end
 
-function with_connector_type(expr)
-    @assert expr isa Expr && (expr.head == :function || (expr.head == :(=) &&
-              expr.args[1] isa Expr &&
-              expr.args[1].head == :call))
-
-    sig = expr.args[1]
-    body = expr.args[2]
-
-    fname = sig.args[1]
-    args = sig.args[2:end]
-
-    quote
-        function $fname($(args...))
-            function f()
-                $body
-            end
-            res = f()
-            $isdefined(res, :connector_type) &&
-                $getfield(res, :connector_type) === nothing ?
-            $Setfield.@set!(res.connector_type=$connector_type(res)) : res
-        end
-    end
-end
-
 macro connector(expr)
-    esc(with_connector_type(expr))
+    esc(component_post_processing(expr, true))
 end
 
 abstract type AbstractConnectorType end

test/components.jl

@@ -1,5 +1,6 @@
 using Test
 using ModelingToolkit, OrdinaryDiffEq
+using ModelingToolkit: get_gui_metadata
 using ModelingToolkit.BipartiteGraphs
 using ModelingToolkit.StructuralTransformations
 include("../examples/rc_model.jl")
@@ -33,7 +34,9 @@ function check_rc_sol(sol)
           sol[source.p.v] - sol[capacitor.p.v]
 end
 
-include("../examples/rc_model.jl")
+@named pin = Pin()
+@test get_gui_metadata(pin).type == :Pin
+@test get_gui_metadata(rc_model.resistor).type == :Resistor
 
 completed_rc_model = complete(rc_model)
 @test isequal(completed_rc_model.resistor.n.i, resistor.n.i)