Merge pull request #261 from SciML/myb/ap

Define `isconnection` on AnalysisPoint

Author: YingboMa

README.md

@@ -60,9 +60,9 @@ V = 1.0
 @named ground = Ground()
 
 rc_eqs = [connect(constant.output, source.V)
-    connect(source.p, resistor.p)
-    connect(resistor.n, capacitor.p)
-    connect(capacitor.n, source.n, ground.g)]
+          connect(source.p, resistor.p)
+          connect(resistor.n, capacitor.p)
+          connect(capacitor.n, source.n, ground.g)]
 
 @named rc_model = ODESystem(rc_eqs, t,
     systems = [resistor, capacitor, constant, source, ground])

docs/pages.jl

@@ -5,7 +5,7 @@ pages = [
         "Custom Components" => "tutorials/custom_component.md",
         "Thermal Conduction Model" => "tutorials/thermal_model.md",
         "DC Motor with Speed Controller" => "tutorials/dc_motor_pi.md",
-        "SampledData Component" => "tutorials/input_component.md",
+        "SampledData Component" => "tutorials/input_component.md"
     ],
     "About Acausal Connections" => "connectors/connections.md",
     "API" => [
@@ -15,6 +15,6 @@ pages = [
         "Mechanical Components" => "API/mechanical.md",
         "Thermal Components" => "API/thermal.md",
         "Hydraulic Components" => "API/hydraulic.md",
-        "Linear Analysis" => "API/linear_analysis.md",
-    ],
+        "Linear Analysis" => "API/linear_analysis.md"
+    ]
 ]

docs/src/API/linear_analysis.md

@@ -60,7 +60,7 @@ using ModelingToolkitStandardLibrary.Blocks, ModelingToolkit
 @named C = Gain(-1)             # A P controller
 t = ModelingToolkit.get_iv(P)
 eqs = [connect(P.output, :plant_output, C.input)  # Connect with an automatically created analysis point called :plant_output
-    connect(C.output, :plant_input, P.input)]
+       connect(C.output, :plant_input, P.input)]
 sys = ODESystem(eqs, t, systems = [P, C], name = :feedback_system)
 
 matrices_S = get_sensitivity(sys, :plant_input)[1] # Compute the matrices of a state-space representation of the (input)sensitivity function.

docs/src/connectors/connections.md

@@ -99,7 +99,7 @@ using Plots
 @named ground = Ground()
 
 eqs = [connect(capacitor.p, resistor.p)
-    connect(resistor.n, ground.g, capacitor.n)]
+       connect(resistor.n, ground.g, capacitor.n)]
 
 @named model = ODESystem(eqs, t; systems = [resistor, capacitor, ground])
 
@@ -139,7 +139,7 @@ const TV = ModelingToolkitStandardLibrary.Mechanical.Translational
 @named ground = TV.Fixed()
 
 eqs = [connect(damping.flange_a, body.flange)
-    connect(ground.flange, damping.flange_b)]
+       connect(ground.flange, damping.flange_b)]
 
 @named model = ODESystem(eqs, t; systems = [damping, body, ground])
 
@@ -172,7 +172,7 @@ const TP = ModelingToolkitStandardLibrary.Mechanical.TranslationalPosition
 @named ground = TP.Fixed(s_0 = 0)
 
 eqs = [connect(damping.flange_a, body.flange)
-    connect(ground.flange, damping.flange_b)]
+       connect(ground.flange, damping.flange_b)]
 
 @named model = ODESystem(eqs, t; systems = [damping, body, ground])
 
@@ -267,7 +267,7 @@ Let's define a quick function to simplify and solve the 2 different systems. Not
 ```@example connections
 function simplify_and_solve(damping, spring, body, ground)
     eqs = [connect(spring.flange_a, body.flange, damping.flange_a)
-        connect(spring.flange_b, damping.flange_b, ground.flange)]
+           connect(spring.flange_b, damping.flange_b, ground.flange)]
 
     @named model = ODESystem(eqs, t; systems = [ground, body, spring, damping])
 

docs/src/tutorials/custom_component.md

@@ -43,10 +43,10 @@ function NonlinearResistor(; name, Ga, Gb, Ve)
     pars = @parameters Ga=Ga Gb=Gb Ve=Ve
     eqs = [
         i ~ ifelse(v < -Ve,
-            Gb * (v + Ve) - Ga * Ve,
-            ifelse(v > Ve,
-                Gb * (v - Ve) + Ga * Ve,
-                Ga * v)),
+        Gb * (v + Ve) - Ga * Ve,
+        ifelse(v > Ve,
+            Gb * (v - Ve) + Ga * Ve,
+            Ga * v))
     ]
     extend(ODESystem(eqs, t, [], pars; name = name), oneport)
 end
@@ -102,14 +102,14 @@ The final model can now be created with the components from the library and the
 @named Gnd = Ground()
 
 connections = [connect(L.p, G.p)
-    connect(G.n, Nr.p)
-    connect(Nr.n, Gnd.g)
-    connect(C1.p, G.n)
-    connect(L.n, Ro.p)
-    connect(G.p, C2.p)
-    connect(C1.n, Gnd.g)
-    connect(C2.n, Gnd.g)
-    connect(Ro.n, Gnd.g)]
+               connect(G.n, Nr.p)
+               connect(Nr.n, Gnd.g)
+               connect(C1.p, G.n)
+               connect(L.n, Ro.p)
+               connect(G.p, C2.p)
+               connect(C1.n, Gnd.g)
+               connect(C2.n, Gnd.g)
+               connect(Ro.n, Gnd.g)]
 
 @named model = ODESystem(connections, t, systems = [L, Ro, G, C1, C2, Nr, Gnd])
 nothing # hide

docs/src/tutorials/dc_motor_pi.md

@@ -50,18 +50,18 @@ The actual model can now be composed.
 @named speed_sensor = SpeedSensor()
 
 connections = [connect(fixed.flange, emf.support, friction.flange_b)
-    connect(emf.flange, friction.flange_a, inertia.flange_a)
-    connect(inertia.flange_b, load.flange)
-    connect(inertia.flange_b, speed_sensor.flange)
-    connect(load_step.output, load.tau)
-    connect(ref.output, feedback.input1)
-    connect(speed_sensor.w, :y, feedback.input2)
-    connect(feedback.output, pi_controller.err_input)
-    connect(pi_controller.ctr_output, :u, source.V)
-    connect(source.p, R1.p)
-    connect(R1.n, L1.p)
-    connect(L1.n, emf.p)
-    connect(emf.n, source.n, ground.g)]
+               connect(emf.flange, friction.flange_a, inertia.flange_a)
+               connect(inertia.flange_b, load.flange)
+               connect(inertia.flange_b, speed_sensor.flange)
+               connect(load_step.output, load.tau)
+               connect(ref.output, feedback.input1)
+               connect(speed_sensor.w, :y, feedback.input2)
+               connect(feedback.output, pi_controller.err_input)
+               connect(pi_controller.ctr_output, :u, source.V)
+               connect(source.p, R1.p)
+               connect(R1.n, L1.p)
+               connect(L1.n, emf.p)
+               connect(emf.n, source.n, ground.g)]
 
 @named model = ODESystem(connections, t,
     systems = [
@@ -78,7 +78,7 @@ connections = [connect(fixed.flange, emf.support, friction.flange_b)
         load_step,
         inertia,
         friction,
-        speed_sensor,
+        speed_sensor
     ])
 nothing # hide
 ```

docs/src/tutorials/input_component.md

@@ -28,9 +28,9 @@ function System(f; name)
     pars = @parameters m=10 k=1000 d=1
 
     eqs = [f ~ src.output.u
-        ddx * 10 ~ k * x + d * dx + f
-        D(x) ~ dx
-        D(dx) ~ ddx]
+           ddx * 10 ~ k * x + d * dx + f
+           D(x) ~ dx
+           D(dx) ~ ddx]
 
     ODESystem(eqs, t, vars, pars; systems = [src], name)
 end
@@ -74,9 +74,9 @@ function System(; name)
     pars = @parameters m=10 k=1000 d=1
 
     eqs = [f ~ get_sampled_data(t)
-        ddx * 10 ~ k * x + d * dx + f
-        D(x) ~ dx
-        D(dx) ~ ddx]
+           ddx * 10 ~ k * x + d * dx + f
+           D(x) ~ dx
+           D(dx) ~ ddx]
 
     ODESystem(eqs, t, vars, pars; name)
 end
@@ -115,9 +115,9 @@ function System(; name)
     pars = @parameters m=10 k=1000 d=1
 
     eqs = [f ~ src.output.u
-        ddx * 10 ~ k * x + d * dx + f
-        D(x) ~ dx
-        D(dx) ~ ddx]
+           ddx * 10 ~ k * x + d * dx + f
+           D(x) ~ dx
+           D(dx) ~ ddx]
 
     ODESystem(eqs, t, vars, pars; systems = [src], name)
 end

docs/src/tutorials/rc_circuit.md

@@ -22,9 +22,9 @@ V = 1.0
 @named ground = Ground()
 
 rc_eqs = [connect(constant.output, source.V)
-    connect(source.p, resistor.p)
-    connect(resistor.n, capacitor.p)
-    connect(capacitor.n, source.n, ground.g)]
+          connect(source.p, resistor.p)
+          connect(resistor.n, capacitor.p)
+          connect(capacitor.n, source.n, ground.g)]
 
 @named rc_model = ODESystem(rc_eqs, t,
     systems = [resistor, capacitor, constant, source, ground])

docs/src/tutorials/thermal_model.md

@@ -23,7 +23,7 @@ connections = [
     connect(mass1.port, conduction.port_a),
     connect(conduction.port_b, mass2.port),
     connect(mass1.port, Tsensor1.port),
-    connect(mass2.port, Tsensor2.port),
+    connect(mass2.port, Tsensor2.port)
 ]
 
 @named model = ODESystem(connections, t,

src/Blocks/Blocks.jl

@@ -19,7 +19,7 @@ export Log, Log10
 include("math.jl")
 
 export Constant, TimeVaryingFunction, Sine, Cosine, ContinuousClock, Ramp, Step, ExpSine,
-    Square, Triangular, Parameter, SampledData
+       Square, Triangular, Parameter, SampledData
 include("sources.jl")
 
 export Limiter, DeadZone, SlewRateLimiter
@@ -30,7 +30,7 @@ export PI, LimPI, PID, LimPID
 include("continuous.jl")
 
 export AnalysisPoint, get_sensitivity, get_comp_sensitivity,
-    get_looptransfer, open_loop
+       get_looptransfer, open_loop
 include("analysis_points.jl")
 
 end

src/Blocks/analysis_points.jl

@@ -5,8 +5,18 @@ Base.@kwdef mutable struct AnalysisPoint
     out = nothing
     name::Symbol = :nothing
 end
+Base.broadcastable(x::AnalysisPoint) = Ref(x)
+if Base.isdefined(ModelingToolkit, :isconnection)
+    ModelingToolkit.isconnection(::AnalysisPoint) = true
+end
 
 Base.nameof(ap::AnalysisPoint) = ap.name
+function Base.hash(ap::AnalysisPoint, seed::UInt)
+    h1 = hash(ap.in, seed)
+    h2 = hash(ap.out, h1)
+    h3 = hash(ap.name, h2)
+    h3 ⊻ (0xd29cdc51aa6562d4 % UInt)
+end
 
 function ap_var(sys)
     if hasproperty(sys, :u)
@@ -255,7 +265,7 @@ end
 const SymOrVec = Union{Symbol, Vector{Symbol}}
 
 function get_sensitivity_function(sys, ap_name::SymOrVec; loop_openings = nothing,
-    kwargs...)
+        kwargs...)
     find = namespaced_ap_match(ap_name, loop_openings)
     t = get_iv(sys)
     aps = []
@@ -284,7 +294,7 @@ function get_sensitivity_function(sys, ap_name::SymOrVec; loop_openings = nothin
 end
 
 function get_comp_sensitivity_function(sys, ap_name::SymOrVec; loop_openings = nothing,
-    kwargs...)
+        kwargs...)
     find = namespaced_ap_match(ap_name, loop_openings)
     t = get_iv(sys)
     aps = []
@@ -313,7 +323,7 @@ function get_comp_sensitivity_function(sys, ap_name::SymOrVec; loop_openings = n
 end
 
 function get_looptransfer_function(sys, ap_name::SymOrVec; loop_openings = nothing,
-    kwargs...)
+        kwargs...)
     find = namespaced_ap_match(ap_name, loop_openings)
     t = get_iv(sys)
     aps = []
@@ -380,9 +390,9 @@ function open_loop(sys, ap_name::Symbol; ground_input = false, kwargs...)
 end
 
 function ModelingToolkit.linearization_function(sys::ModelingToolkit.AbstractSystem,
-    input_name::SymOrVec, output_name;
-    loop_openings = nothing,
-    kwargs...)
+        input_name::SymOrVec, output_name;
+        loop_openings = nothing,
+        kwargs...)
     t = get_iv(sys)
     @variables u(t)=0 [input = true]
     names = [input_name;]
@@ -417,7 +427,7 @@ function ModelingToolkit.linearization_function(sys::ModelingToolkit.AbstractSys
             push!(multiplicities_y, length(yi))
             append!(y, yi)
             [ap_var(ap.in) .~ yi;
-                ap_var(ap.out) .~ ap_var(ap.in)], yi
+             ap_var(ap.out) .~ ap_var(ap.in)], yi
         else # loop opening
             [ap_var(ap.out) .~ 0;], []
         end
@@ -444,19 +454,19 @@ for f in [:get_sensitivity, :get_comp_sensitivity, :get_looptransfer, :open_loop
 end
 
 function ModelingToolkit.linearize(sys, input::AnalysisPoint, output::AnalysisPoint;
-    kwargs...)
+        kwargs...)
     ModelingToolkit.linearize(sys, nameof(input), nameof(output); kwargs...)
 end
 
 # Methods above are implemented in terms of linearization_function, the method below creates wrappers for linearize
 for f in [:get_sensitivity, :get_comp_sensitivity, :get_looptransfer]
     @eval function $f(sys,
-        ap,
-        args...;
-        loop_openings = nothing,
-        op = Dict(),
-        p = DiffEqBase.NullParameters(),
-        kwargs...)
+            ap,
+            args...;
+            loop_openings = nothing,
+            op = Dict(),
+            p = DiffEqBase.NullParameters(),
+            kwargs...)
         lin_fun, ssys = $(Symbol(string(f) * "_function"))(sys, ap, args...; op, p,
             loop_openings,
             kwargs...)
@@ -472,7 +482,7 @@ Linearize a system between two analysis points. To get a loop-transfer function,
 The output is allowed to be either an analysis-point name, or a vector of symbolic variables like the standard interface to `linearize`. The input must be an analysis-point name.
 """
 function ModelingToolkit.linearize(sys, input_name::SymOrVec, output_name;
-    loop_openings = nothing, kwargs...)
+        loop_openings = nothing, kwargs...)
     lin_fun, ssys = linearization_function(sys, input_name, output_name; loop_openings,
         kwargs...)
     ModelingToolkit.linearize(ssys, lin_fun; kwargs...), ssys