PR#349 rebased, conflicts handled and tested

Author: matthew-kapp

src/Electrical/Analog/ideal_components.jl

@@ -18,7 +18,7 @@ node.
 end
 
 """
-    Resistor(; name, R_ref = 1.0, T_ref = 300.15, alpha = 0, T_dep = false)
+    Resistor(; name, R = 1.0, T_ref = 300.15, alpha = 0, T_dep = false)
 
 Generic resistor with optional temperature dependency.
 
@@ -205,47 +205,6 @@ See [OnePort](@ref)
     end
 end
 
-"""
-    HeatingResistor(; name, R_ref = 1.0, T_ref = 300.15, alpha = 0)
-
-Temperature dependent electrical resistor
-
-# States
-
-  - See [OnePort](@ref)
-  - `R(t)`: [`Ohm`] Temperature dependent resistance `R ~ R_ref*(1 + alpha*(heat_port.T(t) - T_ref))`
-
-# Connectors
-
-  - `p` Positive pin
-  - `n` Negative pin
-
-# Parameters:
-
-  - `R_ref`: [`Ω`] Reference resistance
-  - `T_ref`: [K] Reference temperature
-  - `alpha`: [K⁻¹] Temperature coefficient of resistance
-"""
-@mtkmodel HeatingResistor begin
-    @extend v, i = oneport = OnePort()
-    @components begin
-        heat_port = HeatPort()
-    end
-    @parameters begin
-        R_ref = 1.0, [description = "Reference resistance"]
-        T_ref = 300.15, [description = "Reference temperature"]
-        alpha = 0, [description = "Temperature coefficient of resistance"]
-    end
-    @variables begin
-        R(t), [guess = R_ref]
-    end
-    @equations begin
-        R ~ R_ref * (1 + alpha * (heat_port.T - T_ref))
-        heat_port.Q_flow ~ -v * i # -LossPower
-        v ~ i * R
-    end
-end
-
 """
     EMF(; name, k)
 
@@ -291,7 +250,7 @@ Electromotoric force (electric/mechanic transformer)
 end
 
 """
-    Diode(; name, Is = 1e-6, n = 1, T_ref = 300.15, T_dep = false)
+    Diode(; name, Is = 1e-6, n = 1, T = 300.15, T_dep = false)
 
 Generic diode with optional temperature dependency.
 
@@ -303,13 +262,13 @@ Generic diode with optional temperature dependency.
 
     - `p` Positive pin
     - `n` Negative pin
-    - `port` [HeatPort](@ref) (only if `T_dep = true`) Heat port to model the temperature dependency
+    - `port` [HeatPort](@ref) (only if `T_dep = true`) Heat port to model variable temperature dependency
 
 # Parameters:
     
     - `Is`: [`A`] Saturation current
     - `n`: Ideality factor
-    - `T_ref`: [K] Reference temperature
+    - `T`: [K] Constant ambient temperature - only used if T_dep=false
     - `T_dep`: [bool] Temperature dependency
 """
 @mtkmodel Diode begin
@@ -326,8 +285,7 @@ Generic diode with optional temperature dependency.
     @parameters begin
         Is = 1e-6, [description = "Saturation current (A)"]
         n = 1, [description = "Ideality factor"]
-        T_ref = 300.15, [description = "Reference temperature (K)"]
-        Vt_const = k * T_ref / q, [description = "Constant thermal voltage"]
+        T = 300.15, [description = "Ambient temperature"]
     end
 
     if T_dep
@@ -344,7 +302,7 @@ Generic diode with optional temperature dependency.
         end
     else
         @equations begin
-            i ~ Is * (exp(v / (n * Vt_const)) - 1)  # Shockley diode equation
+            i ~ Is * (exp(v * q / (n * k * T)) - 1)  # Shockley diode equation
         end
     end
 end
@@ -372,20 +330,20 @@ R = R_const + pos * R_ref * (1 + alpha * (port.T - T_ref))
     - `R(t)`: Resistance
 
 # Connectors
-        
-    - `p` Positive pin
-    - `n` Negative pin
-    - `position` RealInput to set the position of the wiper
-    - `port` [HeatPort](@ref) Heat port to model the temperature dependency
+
+        - `p` Positive pin
+        - `n` Negative pin
+        - `position` RealInput to set the position of the wiper
+        - `port` [HeatPort](@ref) Heat port to model the temperature dependency
 
 # Parameters
-    
-    - `R_ref`: [`Ω`] Resistance at temperature T_ref when fully closed (pos=1.0)
-    - `T_ref`: [K] Reference temperature
-    - `R_const`: [`Ω`] Constant resistance between p and n
-    - `T_dep`: [bool] Temperature dependency
-    - `alpha`: [K⁻¹] Temperature coefficient of resistance
-    - `enforce_bounds`: Enforce bounds for the position of the wiper (0-1)
+
+        - `R_ref`: [`Ω`] Resistance at temperature T_ref when fully closed (pos=1.0)
+        - `T_ref`: [K] Reference temperature
+        - `R_const`: [`Ω`] Constant resistance between p and n
+        - `T_dep`: Temperature dependency
+        - `alpha`: [K⁻¹] Temperature coefficient of resistance
+        - `enforce_bounds`: Enforce bounds for the position of the wiper (0-1)
 """
 @mtkmodel VariableResistor begin
     @extend v, i = oneport = OnePort()

test/Electrical/analog.jl

@@ -423,38 +423,38 @@ end
     # savefig(plt, "diode_test")
 end
 
-@testset "Diode with temperature dependency component test" begin
-    # Parameter values
-    R = 1.0
-    C = 1.0
-    V = 10.0
-    T = 300.0 # Ambient temperature in Kelvin
-    n = 2.0
-    Is = 1e-6
-    f = 1.0
-
-    # Components
-    @named resistor = Resistor(R = R)
-    @named capacitor = Capacitor(C = C, v = 0.0)
-    @named source = Voltage()
-    @named heating_diode = Diode(n = n, Is = Is, T_dep = true)
-    @named ac = Sine(frequency = f, amplitude = V)
-    @named ground = Ground()
-    @named temp = FixedTemperature(T = T)
-
-    # Connections
-    connections = [connect(ac.output, source.V),
-        connect(source.p, heating_diode.p),
-        connect(heating_diode.n, resistor.p),
-        connect(resistor.n, capacitor.p),
-        connect(capacitor.n, ground.g),
-        connect(source.n, ground.g),
-        connect(temp.port, heating_diode.port)]
-
-    # Model
-    @named model = ODESystem(connections, t;
-        systems = [resistor, capacitor, source, heating_diode, ac, ground, temp])
-    sys = structural_simplify(model)
+@testset "HeatingDiode component test" begin
+    @mtkmodel HeatingDiodeTest begin
+        @parameters begin
+            R = 1.0
+            C = 1.0
+            V = 10.0
+            T = 300.0 # Ambient temperature in Kelvin
+            n = 2.0
+            Is = 1e-6
+            f = 1.0
+        end
+        @components begin
+            resistor = Resistor(R = R)
+            capacitor = Capacitor(C = C, v = 0.0)
+            source = Voltage()
+            heating_diode = Diode(n = n, Is = Is, T_dep = true)
+            ac = Sine(frequency = f, amplitude = V)
+            ground = Ground()
+            temp = FixedTemperature(T = T)
+        end
+        @equations begin
+            connect(ac.output, source.V)
+            connect(source.p, heating_diode.p)
+            connect(heating_diode.n, resistor.p)
+            connect(resistor.n, capacitor.p)
+            connect(capacitor.n, ground.g)
+            connect(source.n, ground.g)
+            connect(temp.port, heating_diode.port)
+        end
+    end
+
+    @mtkbuild sys = HeatingDiodeTest()
     prob = ODEProblem(sys, Pair[], (0.0, 10.0))
     sol = solve(prob, Rodas4())
 
@@ -473,10 +473,10 @@ end
     @test capacitor_voltage[end]≈7.75 rtol=3e-1 # Final capacitor voltage close to input voltage
 
     # For visual inspection
-    # plt = plot(sol; idxs = [heating_diode.i, resistor.i, capacitor.v],
+    # plt = plot(sol; vars = [heating_diode.i, resistor.i, capacitor.v],
     #     size = (800, 600), dpi = 300,
-    #     labels = ["Diode Current" "Resistor Current" "Capacitor Voltage"],
-    #     title = "Diode Test")
+    #     labels = ["HeatingDiode Current" "Resistor Current" "Capacitor Voltage"],
+    #     title = "HeatingDiode Test")
     # savefig(plt, "heating_diode_test")
 
     # Remake model with higher amb. temperature, final capacitor voltage should be lower

test/multi_domain.jl

@@ -175,7 +175,7 @@ end
     end
 end
 
-@testset "El. Heating Circuit" begin
+@testset "Electrical Heating Circuit" begin
     @mtkmodel ElHeatingCircuit begin
         @components begin
             ground = Ground()