Remove unused functions in solution.jl (#638)

* clean up dead-code functions from v0.12 solution update.

removes
- get_solution
- add_generator_power_setpoint
- add_storage_setpoint
- add_branch_flow_setpoint
- add_dcline_flow_setpoint
- add_generator_power_setpoint
- add_storage_setpoint

Author: frederikgeth

CHANGELOG.md

@@ -2,7 +2,7 @@ PowerModels.jl Change Log
 =========================
 
 ### Staged
-- nothing
+- Removal of unused functions in `solution.jl`: `get_solution`, `add_generator_power_setpoint`, `add_storage_setpoint`, `add_branch_flow_setpoint`, `add_dcline_flow_setpoint` (breaking) (#637) 
 
 ### v0.13.1
 - Added DCMPPowerModel for replication of Matpower's DC model (#612)

src/core/solution.jl

@@ -59,24 +59,6 @@ function _init_solution(pm::AbstractPowerModel)
     return Dict{String,Any}(key => pm.data[key] for key in data_keys)
 end
 
-""
-function get_solution(pm::AbstractPowerModel, sol::Dict{String,<:Any})
-    add_bus_voltage_setpoint(sol, pm)
-    add_generator_power_setpoint(sol, pm)
-    add_storage_setpoint(sol, pm)
-    add_branch_flow_setpoint(sol, pm)
-    add_dcline_flow_setpoint(sol, pm)
-
-    add_kcl_duals(sol, pm)
-    add_sm_duals(sol, pm) # Adds the duals of the transmission lines' thermal limits.
-end
-
-""
-function add_bus_voltage_setpoint(sol, pm::AbstractPowerModel)
-    add_setpoint(sol, pm, "bus", "vm", :vm)
-    add_setpoint(sol, pm, "bus", "va", :va)
-end
-
 ""
 function solution_opf!(pm::AbstractPowerModel, sol::Dict{String,<:Any})
     add_setpoint_bus_voltage!(sol, pm)
@@ -112,46 +94,6 @@ function add_dual_sm!(sol, pm::AbstractPowerModel)
     end
 end
 
-""
-function add_generator_power_setpoint(sol, pm::AbstractPowerModel)
-    add_setpoint(sol, pm, "gen", "pg", :pg)
-    add_setpoint(sol, pm, "gen", "qg", :qg)
-end
-
-""
-function add_generator_status_setpoint(sol, pm::AbstractPowerModel)
-    add_setpoint(sol, pm, "gen", "gen_status", :z_gen; conductorless=true, default_value = (item) -> item["gen_status"]*1.0)
-end
-
-""
-function add_storage_setpoint(sol, pm::AbstractPowerModel)
-    add_setpoint(sol, pm, "storage", "ps", :ps)
-    add_setpoint(sol, pm, "storage", "qs", :qs)
-    add_setpoint(sol, pm, "storage", "se", :se, conductorless=true)
-    # useful for model debugging
-    #add_setpoint(sol, pm, "storage", "sc", :sc, conductorless=true)
-    #add_setpoint(sol, pm, "storage", "sd", :sd, conductorless=true)
-end
-
-""
-function add_branch_flow_setpoint(sol, pm::AbstractPowerModel)
-    # check the branch flows were requested
-    if haskey(pm.setting, "output") && haskey(pm.setting["output"], "branch_flows") && pm.setting["output"]["branch_flows"] == true
-        add_setpoint(sol, pm, "branch", "pf", :p; extract_var = (var,idx,item) -> var[(idx, item["f_bus"], item["t_bus"])])
-        add_setpoint(sol, pm, "branch", "qf", :q; extract_var = (var,idx,item) -> var[(idx, item["f_bus"], item["t_bus"])])
-        add_setpoint(sol, pm, "branch", "pt", :p; extract_var = (var,idx,item) -> var[(idx, item["t_bus"], item["f_bus"])])
-        add_setpoint(sol, pm, "branch", "qt", :q; extract_var = (var,idx,item) -> var[(idx, item["t_bus"], item["f_bus"])])
-    end
-end
-
-""
-function add_dcline_flow_setpoint(sol, pm::AbstractPowerModel)
-    add_setpoint(sol, pm, "dcline", "pf", :p_dc; extract_var = (var,idx,item) -> var[(idx, item["f_bus"], item["t_bus"])])
-    add_setpoint(sol, pm, "dcline", "qf", :q_dc; extract_var = (var,idx,item) -> var[(idx, item["f_bus"], item["t_bus"])])
-    add_setpoint(sol, pm, "dcline", "pt", :p_dc; extract_var = (var,idx,item) -> var[(idx, item["t_bus"], item["f_bus"])])
-    add_setpoint(sol, pm, "dcline", "qt", :q_dc; extract_var = (var,idx,item) -> var[(idx, item["t_bus"], item["f_bus"])])
-end
-
 ""
 function add_setpoint_generator_power!(sol, pm::AbstractPowerModel)
     add_setpoint!(sol, pm, "gen", "pg", :pg, status_name=pm_component_status["gen"])

src/form/apo.jl

@@ -185,27 +185,13 @@ function constraint_storage_loss(pm::AbstractActivePowerModel, n::Int, i, bus, c
     sc = var(pm, n, :sc, i)
     sd = var(pm, n, :sd, i)
 
-    JuMP.@constraint(pm.model, 
+    JuMP.@constraint(pm.model,
         sum(ps[c] for c in conductors) + (sd - sc)
         ==
         p_loss + sum(r[c]*ps[c]^2 for c in conductors)
     )
 end
 
-
-""
-function add_generator_power_setpoint(sol, pm::AbstractActivePowerModel)
-    add_setpoint(sol, pm, "gen", "pg", :pg)
-    add_setpoint_fixed(sol, pm, "gen", "qg")
-end
-
-""
-function add_storage_setpoint(sol, pm::AbstractActivePowerModel)
-    add_setpoint(sol, pm, "storage", "ps", :ps)
-    add_setpoint_fixed(sol, pm, "storage", "qs")
-    add_setpoint(sol, pm, "storage", "se", :se, conductorless=true)
-end
-
 function constraint_storage_on_off(pm::AbstractActivePowerModel, n::Int, c::Int, i, pmin, pmax, qmin, qmax, charge_ub, discharge_ub)
     z_storage = var(pm, n, :z_storage, i)
     ps = var(pm, n, c, :ps, i)
@@ -220,4 +206,3 @@ function add_setpoint_switch_flow!(sol, pm::AbstractActivePowerModel)
     add_setpoint!(sol, pm, "switch", "psw", :psw, var_key = (idx,item) -> (idx, item["f_bus"], item["t_bus"]))
     add_setpoint_fixed!(sol, pm, "switch", "qsw")
 end
-

test/output.jl

@@ -69,6 +69,53 @@ end
         @test isnan(branches["3"]["qf"])
         @test isnan(branches["3"]["qt"])
     end
+
+    @testset "24-bus rts case ac pf" begin
+        result = run_pf("../test/data/matpower/case24.m", ACPPowerModel, ipopt_solver; setting = Dict("output" => Dict("branch_flows" => true)))
+
+        @test haskey(result, "optimizer") == true
+        @test haskey(result, "termination_status") == true
+        @test haskey(result, "primal_status") == true
+        @test haskey(result, "dual_status") == true
+        @test haskey(result, "objective") == true
+        @test haskey(result, "objective_lb") == true
+        @test haskey(result, "solve_time") == true
+        @test haskey(result, "machine") == true
+        @test haskey(result, "data") == true
+        @test haskey(result, "solution") == true
+        @test haskey(result["solution"], "branch") == true
+
+        @test length(result["solution"]["bus"]) == 24
+        @test length(result["solution"]["gen"]) == 33
+        @test length(result["solution"]["branch"]) == 38
+
+        branches = result["solution"]["branch"]
+
+        @test isapprox(branches["2"]["pf"],  0.2001; atol = 1e-3)
+        @test isapprox(branches["2"]["pt"], -0.1980; atol = 1e-3)
+        @test isapprox(branches["2"]["qf"],  0.0055; atol = 1e-3)
+        @test isapprox(branches["2"]["qt"], -0.0571; atol = 1e-3)
+    end
+
+    # A DCPPowerModel test is important because it does have variables for the reverse side of the branchs
+    @testset "3-bus case dc pf" begin
+        result = run_pf("../test/data/matpower/case3.m", DCPPowerModel, ipopt_solver; setting = Dict("output" => Dict("branch_flows" => true)))
+
+        @test haskey(result, "solution") == true
+        @test haskey(result["solution"], "branch") == true
+
+        @test length(result["solution"]["bus"]) == 3
+        @test length(result["solution"]["gen"]) == 3
+        @test length(result["solution"]["branch"]) == 3
+        @test length(result["solution"]["dcline"]) == 1
+
+        branches = result["solution"]["branch"]
+
+        @test isapprox(branches["3"]["pf"], -0.101419; atol = 1e-3)
+        @test isapprox(branches["3"]["pt"],  0.101419; atol = 1e-3)
+        @test isnan(branches["3"]["qf"])
+        @test isnan(branches["3"]["qt"])
+    end
 end
 
 
@@ -143,7 +190,7 @@ end
 end
 
 
-# recomended by @lroald
+# recommended by @lroald
 @testset "test solution feedback" begin
 
     function solution_feedback(case, ac_opf_obj)