PassThrus

Author: Brad Carman

Project.toml

@@ -17,7 +17,7 @@ FileIO = "1.16"
 FilterHelpers = "0.2"
 GLMakie = "0.8"
 ModelingToolkit = "8.50"
-ModelingToolkitStandardLibrary = "1.11"
+ModelingToolkitStandardLibrary = "1.12"
 TOML = "1.0"
 julia = "1.6"
 

README.md

@@ -91,6 +91,52 @@ If a component has a double lined box then it is possible to "look under the hoo
 
 Edits made to sub-components can be saved and loaded directly or indirectly.  
 
+# Pass Thrus
+To generate more esthetic diagrams, one can use as special kind of component called a `PassThru`, which simply defines 2 or more connected `connectors` to serve as a corner, tee, or any other junction.  Simply define a component function starting with `PassThru` and ModelingToolkitDesigner.jl will recognize it as a special component type.  For example for a corner with 2 connection points:
+
+
+```julia
+@component function PassThru2(;name)
+    @variables t
+    
+    systems = @named begin
+        p1 = Pin()
+        p2 = Pin()
+    end
+
+    eqs = [
+        connect(p1, p2)
+    ]
+
+    return ODESystem(eqs, t, [], []; name, systems)
+end
+```
+
+And for a tee with 3 connection points
+
+```julia
+@component function PassThru3(;name)
+    @variables t
+    
+    systems = @named begin
+        p1 = Pin()
+        p2 = Pin()
+        p3 = Pin()
+    end
+
+    eqs = [
+        connect(p1, p2, p3)
+    ]
+
+    return ODESystem(eqs, t, [], []; name, systems)
+end
+```
+
+Adding these components to your system will then allow for corners, tees, etc. to be created.  When editing is complete, use the toggle switch to hide the `PassThru` details, showing a more esthetic connection diagram.
+
+![step10-11](https://user-images.githubusercontent.com/40798837/229201536-4444a037-18b3-4efd-bc93-d2c182abf533.png)
+ 
+
 # Icons
 ModelingToolkitDesigner.jl comes with icons for the ModelingToolkitStandardLibrary.jl pre-loaded.  For custom components, icons are loaded from the `path` variable supplied to `ODESystemDesign()`.  To find the path ModelingToolkitDesign.jl is searching, pass the system of interest to `ODESystemDesign()` and replace the `.toml` with `.png`.  For example if we want to make an icon for the `sys.vol` component, we can find the path by running...
 
@@ -105,10 +151,9 @@ Placing a "FixedVolume.png" file in this location will load that icon.
 ModelingToolkitDesigner.jl colors the connections based on `ModelingToolkitDesigner.design_colors`.  Colors for the ModelingToolkitStandardLibrary.jl are already loaded.  To add a custom connector color, simply use `add_color(system::ODESystem, color::Symbol)` where `system` is a reference to the connector (e.g. `sys.vol.port`) and `color` is a named color from [Colors.jl](https://juliagraphics.github.io/Colors.jl/stable/namedcolors/).
 
 # TODO
-
 - Finish adding icons for the ModelingToolkitStandardLibrary.jl
 - Add documentation
-- Support more complex connection paths with bends etc.
 
 # [compat]
-ModelingToolkit = "8.50" > needed for Domain feature
+- ModelingToolkit = "8.50" > needed for Domain feature
+- ModelingToolkitStandardLibrary = "1.12" > needed for Hydraulic components

examples/design/Main/Circuit.jl

@@ -1,5 +1,7 @@
-connect(constant.output, source.V)
-connect(source.p, resistor.p)
+connect(resistor.p, pt2.p1)
+connect(source.p, pt2.p2)
+connect(source.n, pt3.p2)
+connect(capacitor.n, pt3.p1)
 connect(resistor.n, capacitor.p)
-connect(capacitor.n, source.n)
-connect(source.n, ground.g)
+connect(ground.g, pt3.p3)
+connect(source.V, constant.output)

examples/design/Main/Circuit.toml

@@ -1,24 +1,38 @@
 [capacitor]
 n = "S"
-x = 0.52
+x = 0.51
 y = 0.29
 
 [constant]
-x = 0.54
-y = -0.03
+output = "N"
+x = 0.71
+y = -0.08
 
 [ground]
-x = 0.43
+g = "N"
+x = 0.51
+y = -0.08
+
+[pt2]
+p1 = "N"
+p2 = "W"
+x = 0.9
+y = 0.11
+
+[pt3]
+p1 = "N"
+p3 = "S"
+x = 0.51
 y = 0.11
 
 [resistor]
 n = "W"
 p = "S"
-x = 0.8
+x = 0.9
 y = 0.29
 
 [source]
 V = "S"
 n = "W"
-x = 0.66
+x = 0.71
 y = 0.11

examples/electrical.jl

@@ -3,37 +3,86 @@ using ModelingToolkitStandardLibrary.Electrical
 using ModelingToolkitStandardLibrary.Blocks: Constant
 using ModelingToolkitDesigner
 using CairoMakie
+using GLMakie
+
+@component function PassThru2(;name)
+    @variables t
+    
+    systems = @named begin
+        p1 = Pin()
+        p2 = Pin()
+    end
+
+    eqs = [
+        connect(p1, p2)
+    ]
+
+    return ODESystem(eqs, t, [], []; name, systems)
+end
+
+@component function PassThru3(;name)
+    @variables t
+    
+    systems = @named begin
+        p1 = Pin()
+        p2 = Pin()
+        p3 = Pin()
+    end
+
+    eqs = [
+        connect(p1, p2, p3)
+    ]
+
+    return ODESystem(eqs, t, [], []; name, systems)
+end
 
 @component function Circuit(;name)
 
     R = 1.0
     C = 1.0
     V = 1.0
     @variables t
+
     systems = @named begin
         resistor = Resistor(R = R)
         capacitor = Capacitor(C = C)
         source = Voltage()
         constant = Constant(k = V)
         ground = Ground()    
+        pt2 = PassThru2()
+        pt3 = PassThru3()
     end
-    
 
-    eqs = [connect(constant.output, source.V)
-            connect(source.p, resistor.p)
-            connect(resistor.n, capacitor.p)
-            connect(capacitor.n, source.n, ground.g)]
+    eqs = [
+        connect(resistor.p, pt2.p1)
+        connect(source.p, pt2.p2)
+        connect(source.n, pt3.p2)
+        connect(capacitor.n, pt3.p1)
+        connect(resistor.n, capacitor.p)
+        connect(ground.g, pt3.p3)
+        connect(source.V, constant.output)
+    ]
+
+    # eqs = [connect(constant.output, source.V)
+    #         connect(source.p, resistor.p)
+    #         connect(resistor.n, capacitor.p)
+    #         connect(capacitor.n, source.n, ground.g)]
 
     ODESystem(eqs, t, [], [];  systems, name)
 end
 
 @named rc = Circuit()
 
+# using OrdinaryDiffEq
+# sys = structural_simplify(rc)
+# prob = ODEProblem(sys, Pair[], (0, 10.0))
+# sol = solve(prob, Tsit5())
 
 path = joinpath(@__DIR__, "design")
 design = ODESystemDesign(rc, path)
+GLMakie.set_theme!(Theme(;fontsize=12))
 ModelingToolkitDesigner.view(design)
 
-CairoMakie.set_theme!(Theme(;fontsize=12))
-fig = ModelingToolkitDesigner.view(design, false)
-save(joinpath(@__DIR__, "electrical.svg"), fig; resolution=(400,400))
+# CairoMakie.set_theme!(Theme(;fontsize=12))
+# fig = ModelingToolkitDesigner.view(design, false)
+# save(joinpath(@__DIR__, "electrical.svg"), fig; resolution=(400,400))