metadata(components): adds units to Magnetic/FluxTubes components

Author: ven-k

src/Magnetic/FluxTubes/basic.jl

@@ -20,7 +20,7 @@ Idle running branch.
 @mtkmodel Idle begin
     @extend (Phi,) = two_port = TwoPort()
     @equations begin
-        Phi ~ 0
+        Phi ~ 0.0
     end
 end
 
@@ -68,7 +68,7 @@ Constant permeance.
 @mtkmodel ConstantPermeance begin
     @extend V_m, Phi = two_port = TwoPort()
     @parameters begin
-        G_m = 1.0, [description = "Magnetic permeance"]
+        G_m = 1.0, [description = "Magnetic permeance", unit = u"H"]
     end
     @equations begin
         Phi ~ G_m * V_m
@@ -87,7 +87,7 @@ Constant reluctance.
 @mtkmodel ConstantReluctance begin
     @extend V_m, Phi = two_port = TwoPort(; Phi = 0.0)
     @parameters begin
-        R_m = 1.0, [description = "Magnetic reluctance"]
+        R_m = 1.0, [description = "Magnetic reluctance", unit = u"H^-1"]
     end
     @equations begin
         V_m ~ Phi * R_m
@@ -114,8 +114,9 @@ Initial magnetic flux flowing into the port_p can be set with `Phi` ([Wb])
         N, [description = "Number of turns"]
     end
     @variables begin
-        v(t)
-        i(t)
+        v(t),
+        [description = "Voltage difference from positive to negative pin", unit = u"V"]
+        i(t), [description = "Current", unit = u"A"]
     end
     @extend V_m, Phi = two_port = TwoPort(; Phi)
     @components begin
@@ -146,10 +147,11 @@ Initial magnetic flux flowing into the port_p can be set with `Phi` ([`Wb`])
 """
 @mtkmodel EddyCurrent begin
     @parameters begin
-        rho = 0.098e-6, [description = "Resistivity of flux tube material"]
-        l = 1, [description = "Average length of eddy current path"]
-        A = 1, [description = "Cross sectional area of eddy current path"]
-        R = rho * l / A # Electrical resistance of eddy current path
+        rho = 0.098e-6, [description = "Resistivity of flux tube material", unit = u"Ω*m"]
+        l = 1, [description = "Average length of eddy current path", unit = u"m"]
+        A = 1, [description = "Cross sectional area of eddy current path", unit = u"m^2"]
+        R = rho * l / A,
+        [description = "Electrical resistance of eddy current path", unit = u"Ω"]
     end
     @extend (V_m, Phi) = two_port = TwoPort(; Phi)
     @equations begin

src/Magnetic/FluxTubes/sources.jl

@@ -13,10 +13,10 @@ Parameters:
         port_n = NegativeMagneticPort()
     end
     @parameters begin
-        V_m = 0.0, [description = "Magnetic potential difference"]
+        V_m = 0.0, [description = "Magnetic potential difference", unit = u"A"]
     end
     @variables begin
-        Phi(t)
+        Phi(t), [description = "Magnetic flux", unit = u"Wb"]
     end
     @equations begin
         V_m ~ port_p.V_m - port_n.V_m
@@ -40,10 +40,10 @@ Parameters:
         port_n = NegativeMagneticPort()
     end
     @parameters begin
-        Phi = 0.0, [description = "Magnetic flux"]
+        Phi = 0.0, [description = "Magnetic flux", unit = u"Wb"]
     end
     @variables begin
-        V_m(t)
+        V_m(t), [description = "Magnetic potential difference", unit = u"A"]
     end
     @equations begin
         V_m ~ port_p.V_m - port_n.V_m

src/Magnetic/FluxTubes/utils.jl

@@ -1,6 +1,7 @@
 @connector MagneticPort begin
-    V_m(t), [description = "Magnetic potential at the port"]
-    Phi(t), [connect = Flow, description = "Magnetic flux flowing into the port"]
+    V_m(t), [description = "Magnetic potential at the port", unit = u"A"]
+    Phi(t),
+    [connect = Flow, description = "Magnetic flux flowing into the port", unit = u"Wb"]
 end
 Base.@doc "Port for a Magnetic system." MagneticPort
 
@@ -30,8 +31,15 @@ Partial component with magnetic potential difference between two magnetic ports
         port_n = NegativeMagneticPort()
     end
     @variables begin
-        V_m(t) = 0.0
-        Phi(t) = 0.0
+        V_m(t) = 0.0, [description = "Magnetic potential at the port", unit = u"A"]
+        function Phi(t)
+            0.0,
+            [
+                connect = Flow,
+                description = "Magnetic flux flowing into the port",
+                unit = u"Wb",
+            ]
+        end
     end
     @equations begin
         V_m ~ port_p.V_m - port_n.V_m