Name Updates for PowerModels v0.17 (#40)

* function name updates
* remove unused variable_shunt_factor function
* add reactive power control fix to storage devices

Author: ccoffrin

CHANGELOG.md

@@ -3,6 +3,10 @@
 ## Staged
 - nothing
 
+## v0.5.0
+- Update to new function name convention of PowerModels v0.17 details in PR #40 (breaking)
+- Update to PowerModels v0.17 (breaking)
+
 ## v0.4.0
 - Update to PowerModels v0.16 (breaking)
 - Add support for Memento v0.13, v1.0

Project.toml

@@ -1,7 +1,7 @@
 name = "PowerModelsRestoration"
 uuid = "23adbb12-a187-11e9-26a2-eb4d4e6e68fb"
 authors = ["David M Fobes <[email protected]>", "Noah Rhodes"]
-version = "0.4.0"
+version = "0.5.0"
 
 [deps]
 InfrastructureModels = "2030c09a-7f63-5d83-885d-db604e0e9cc0"
@@ -11,11 +11,11 @@ Memento = "f28f55f0-a522-5efc-85c2-fe41dfb9b2d9"
 PowerModels = "c36e90e8-916a-50a6-bd94-075b64ef4655"
 
 [compat]
-InfrastructureModels = "~0.4"
+InfrastructureModels = "~0.5"
 JuMP = "~0.19.1, ~0.20, ~0.21"
 MathOptInterface = "~0.8, ~0.9"
 Memento = "~0.10, ~0.11, ~0.12, ~0.13, ~1.0"
-PowerModels = "~0.16"
+PowerModels = "~0.17"
 julia = "^1"
 
 [extras]

src/core/constraint.jl

@@ -6,10 +6,10 @@ function constraint_restoration_cardinality_ub(pm::_PM.AbstractPowerModel, n::In
     z_bus = _PM.var(pm, n, :z_bus)
 
     JuMP.@constraint(pm.model,
-        sum(z_branch[i] for (i,branch) in _PM.ref(pm, n, :damaged_branch))
-        + sum(z_gen[i] for (i,gen) in _PM.ref(pm, n, :damaged_gen))
-        + sum(z_storage[i] for (i,storage) in _PM.ref(pm, n, :damaged_storage))
-        + sum(z_bus[i] for (i,bus) in _PM.ref(pm, n, :damaged_bus))
+        sum(z_branch[i] for (i,branch) in _PM.ref(pm, n, :branch_damage))
+        + sum(z_gen[i] for (i,gen) in _PM.ref(pm, n, :gen_damage))
+        + sum(z_storage[i] for (i,storage) in _PM.ref(pm, n, :storage_damage))
+        + sum(z_bus[i] for (i,bus) in _PM.ref(pm, n, :bus_damage))
         <= cumulative_repairs
     )
 end
@@ -23,10 +23,10 @@ function constraint_restoration_cardinality_lb(pm::_PM.AbstractPowerModel, n::In
     z_bus = _PM.var(pm, n, :z_bus)
 
     JuMP.@constraint(pm.model,
-        sum(z_branch[i] for (i,branch) in _PM.ref(pm, n, :damaged_branch))
-        + sum(z_gen[i] for (i,gen) in _PM.ref(pm, n, :damaged_gen))
-        + sum(z_storage[i] for (i,storage) in _PM.ref(pm, n, :damaged_storage))
-        + sum(z_bus[i] for (i,bus) in _PM.ref(pm, n, :damaged_bus))
+        sum(z_branch[i] for (i,branch) in _PM.ref(pm, n, :branch_damage))
+        + sum(z_gen[i] for (i,gen) in _PM.ref(pm, n, :gen_damage))
+        + sum(z_storage[i] for (i,storage) in _PM.ref(pm, n, :storage_damage))
+        + sum(z_bus[i] for (i,bus) in _PM.ref(pm, n, :bus_damage))
         >= cumulative_repairs
     )
 end
@@ -47,24 +47,24 @@ function constraint_restore_all_items(pm, n)
         JuMP.@constraint(pm.model, z_shunt[i] == 1)
     end
 
-    for (i,storage) in  _PM.ref(pm, n, :damaged_storage)
+    for (i,storage) in  _PM.ref(pm, n, :storage_damage)
         JuMP.@constraint(pm.model, z_storage[i] == 1)
     end
-    for (i,gen) in  _PM.ref(pm, n, :damaged_gen)
+    for (i,gen) in  _PM.ref(pm, n, :gen_damage)
         JuMP.@constraint(pm.model, z_gen[i] == 1)
     end
-    for (i,branch) in  _PM.ref(pm, n, :damaged_branch)
+    for (i,branch) in  _PM.ref(pm, n, :branch_damage)
         JuMP.@constraint(pm.model, z_branch[i] == 1)
     end
-    for (i,bus) in  _PM.ref(pm, n, :damaged_bus)
+    for (i,bus) in  _PM.ref(pm, n, :bus_damage)
         JuMP.@constraint(pm.model, z_bus[i] == 1)
     end
 end
 
 
 ""
-function constraint_active_gen(pm::_PM.AbstractPowerModel,  i::Int, nw_1::Int, nw_2::Int)
-    if haskey(_PM.ref(pm, nw_1, :damaged_gen), i)
+function constraint_gen_energized(pm::_PM.AbstractPowerModel,  i::Int, nw_1::Int, nw_2::Int)
+    if haskey(_PM.ref(pm, nw_1, :gen_damage), i)
         z_gen_1 = _PM.var(pm, nw_1, :z_gen, i)
         z_gen_2 = _PM.var(pm, nw_2, :z_gen, i)
 
@@ -73,8 +73,8 @@ function constraint_active_gen(pm::_PM.AbstractPowerModel,  i::Int, nw_1::Int, n
 end
 
 ""
-function constraint_active_bus(pm::_PM.AbstractPowerModel,  i::Int, nw_1::Int, nw_2::Int)
-    if haskey(_PM.ref(pm, nw_1, :damaged_gen), i)
+function constraint_bus_energized(pm::_PM.AbstractPowerModel,  i::Int, nw_1::Int, nw_2::Int)
+    if haskey(_PM.ref(pm, nw_1, :gen_damage), i)
         z_bus_1 = _PM.var(pm, nw_1, :z_bus, i)
         z_bus_2 = _PM.var(pm, nw_2, :z_bus, i)
 
@@ -84,8 +84,8 @@ end
 
 
 ""
-function constraint_active_storage(pm::_PM.AbstractPowerModel,  i::Int, nw_1::Int, nw_2::Int)
-    if haskey(_PM.ref(pm, nw_1, :damaged_storage), i)
+function constraint_storage_energized(pm::_PM.AbstractPowerModel,  i::Int, nw_1::Int, nw_2::Int)
+    if haskey(_PM.ref(pm, nw_1, :storage_damage), i)
         z_storage_1 = _PM.var(pm, nw_1, :z_storage, i)
         z_storage_2 = _PM.var(pm, nw_2, :z_storage, i)
 
@@ -95,8 +95,8 @@ end
 
 
 ""
-function constraint_active_branch(pm::_PM.AbstractPowerModel,  i::Int, nw_1::Int, nw_2::Int)
-    if haskey(_PM.ref(pm, nw_1, :damaged_branch), i)
+function constraint_branch_energized(pm::_PM.AbstractPowerModel,  i::Int, nw_1::Int, nw_2::Int)
+    if haskey(_PM.ref(pm, nw_1, :branch_damage), i)
         z_branch_1 = _PM.var(pm, nw_1, :z_branch, i)
         z_branch_2 = _PM.var(pm, nw_2, :z_branch, i)
 
@@ -106,7 +106,7 @@ end
 
 
 "Load delivered at each node must be greater than or equal the previous time period"
-function constraint_increasing_load(pm::_PM.AbstractPowerModel,  i::Int, nw_1::Int, nw_2::Int)
+function constraint_load_increasing(pm::_PM.AbstractPowerModel,  i::Int, nw_1::Int, nw_2::Int)
 
     z_demand_1 = _PM.var(pm, nw_1, :z_demand, i)
     z_demand_2 = _PM.var(pm, nw_2, :z_demand, i)

src/core/constraint_template.jl

@@ -22,14 +22,14 @@ end
 
 
 ""
-function constraint_generation_damage(pm::_PM.AbstractPowerModel, i::Int; nw::Int=pm.cnw)
+function constraint_gen_damage(pm::_PM.AbstractPowerModel, i::Int; nw::Int=pm.cnw)
     gen = _PM.ref(pm, nw, :gen, i)
 
-    gen_damaged = haskey(_PM.ref(pm, nw, :damaged_gen), i)
-    bus_damaged = haskey(_PM.ref(pm, nw, :damaged_bus), gen["gen_bus"])
+    gen_damaged = haskey(_PM.ref(pm, nw, :gen_damage), i)
+    bus_damaged = haskey(_PM.ref(pm, nw, :bus_damage), gen["gen_bus"])
 
     if gen_damaged
-        _PM.constraint_generation_on_off(pm, nw, i, gen["pmin"], gen["pmax"], gen["qmin"], gen["qmax"])
+        _PM.constraint_gen_power_on_off(pm, nw, i, gen["pmin"], gen["pmax"], gen["qmin"], gen["qmax"])
         if bus_damaged
             constraint_gen_bus_connection(pm, nw, i, gen["gen_bus"])
         end
@@ -45,7 +45,7 @@ function constraint_load_damage(pm::_PM.AbstractPowerModel, i::Int; nw::Int=pm.c
     if haskey(_PM.ref(pm, nw, :load), i)
         load = _PM.ref(pm, nw, :load, i)
 
-        bus_damaged = haskey(_PM.ref(pm, nw, :damaged_bus), load["load_bus"])
+        bus_damaged = haskey(_PM.ref(pm, nw, :bus_damage), load["load_bus"])
 
         if bus_damaged
             constraint_load_bus_connection(pm, nw, i, load["load_bus"])
@@ -58,7 +58,7 @@ end
 function constraint_shunt_damage(pm::_PM.AbstractPowerModel, i::Int; nw::Int=pm.cnw)
     if haskey(_PM.ref(pm, nw, :shunt), i)
         shunt = _PM.ref(pm, nw, :shunt, i)
-        bus_damaged = haskey(_PM.ref(pm, nw, :damaged_bus), shunt["shunt_bus"])
+        bus_damaged = haskey(_PM.ref(pm, nw, :bus_damage), shunt["shunt_bus"])
 
         if bus_damaged
             constraint_shunt_bus_connection(pm, nw, i, shunt["shunt_bus"])
@@ -71,9 +71,9 @@ end
 function constraint_branch_damage(pm::_PM.AbstractPowerModel, i::Int; nw::Int=pm.cnw)
     branch = _PM.ref(pm, nw, :branch, i)
 
-    branch_damaged = haskey(_PM.ref(pm, nw, :damaged_branch), i)
-    bus_fr_damaged = haskey(_PM.ref(pm, nw, :damaged_bus), branch["f_bus"])
-    bus_to_damaged = haskey(_PM.ref(pm, nw, :damaged_bus), branch["t_bus"])
+    branch_damaged = haskey(_PM.ref(pm, nw, :branch_damage), i)
+    bus_fr_damaged = haskey(_PM.ref(pm, nw, :bus_damage), branch["f_bus"])
+    bus_to_damaged = haskey(_PM.ref(pm, nw, :bus_damage), branch["t_bus"])
 
     if branch_damaged
         if bus_fr_damaged
@@ -109,7 +109,7 @@ function constraint_ohms_yt_from_damage(pm::_PM.AbstractPowerModel, i::Int; nw::
     # TODO make indexing of :wi,:wr standardized
     ## Because :wi, :wr are indexed by bus_id or bus_pairs depending on if the value is on_off or
     # standard, there are indexing issues.  Temporary solution: always call *_on_off variant
-    if haskey(_PM.ref(pm, nw, :damaged_branch), i)
+    if haskey(_PM.ref(pm, nw, :branch_damage), i)
         vad_min = _PM.ref(pm, nw, :off_angmin)
         vad_max = _PM.ref(pm, nw, :off_angmax)
         _PM.constraint_ohms_yt_from_on_off(pm, nw, i, f_bus, t_bus, f_idx, t_idx, g, b, g_fr, b_fr, tr, ti, tm, vad_min, vad_max)
@@ -139,7 +139,7 @@ function constraint_ohms_yt_to_damage(pm::_PM.AbstractPowerModel, i::Int; nw::In
     # TODO make indexing of :wi,:wr standardized
     ## Because :wi, :wr are indexed by bus_id or bus_pairs depending on if the value is on_off or
     # standard, there are indexing issues.  Temporary solution: always call *_on_off variant
-    if haskey(_PM.ref(pm, nw, :damaged_branch), i)
+    if haskey(_PM.ref(pm, nw, :branch_damage), i)
         vad_min = _PM.ref(pm, nw, :off_angmin)
         vad_max = _PM.ref(pm, nw, :off_angmax)
 
@@ -161,7 +161,7 @@ function constraint_voltage_angle_difference_damage(pm::_PM.AbstractPowerModel,
     # TODO make indexing of :wi,:wr standardized
     # Because :wi, :wr are indexed by bus_id or bus_pairs depending on if the value is on_off or
     # standard, there are indexing issues.  Temporary solution: always call *_on_off variant
-    if haskey(_PM.ref(pm, nw, :damaged_branch), i)
+    if haskey(_PM.ref(pm, nw, :branch_damage), i)
 
         vad_min = _PM.ref(pm, nw, :off_angmin)
         vad_max = _PM.ref(pm, nw, :off_angmax)
@@ -190,7 +190,7 @@ function constraint_thermal_limit_from_damage(pm::_PM.AbstractPowerModel, i::Int
     t_bus = branch["t_bus"]
     f_idx = (i, f_bus, t_bus)
 
-    if haskey(_PM.ref(pm, nw, :damaged_branch), i)
+    if haskey(_PM.ref(pm, nw, :branch_damage), i)
         _PM.constraint_thermal_limit_from_on_off(pm, nw, i, f_idx, branch["rate_a"])
     else
         if !haskey(_PM.con(pm, nw), :sm_fr)
@@ -208,7 +208,7 @@ function constraint_thermal_limit_to_damage(pm::_PM.AbstractPowerModel, i::Int;
     t_bus = branch["t_bus"]
     t_idx = (i, t_bus, f_bus)
 
-    if haskey(_PM.ref(pm, nw, :damaged_branch), i)
+    if haskey(_PM.ref(pm, nw, :branch_damage), i)
         _PM.constraint_thermal_limit_to_on_off(pm, nw, i, t_idx, branch["rate_a"])
     else
         if !haskey(_PM.con(pm, nw), :sm_to)
@@ -223,8 +223,8 @@ end
 function constraint_storage_damage(pm::_PM.AbstractPowerModel, i::Int; nw::Int=pm.cnw)
     storage = _PM.ref(pm, nw, :storage, i)
 
-    storage_damaged = haskey(_PM.ref(pm, nw, :damaged_storage), i)
-    bus_damaged = haskey(_PM.ref(pm, nw, :damaged_bus), storage["storage_bus"])
+    storage_damaged = haskey(_PM.ref(pm, nw, :storage_damage), i)
+    bus_damaged = haskey(_PM.ref(pm, nw, :bus_damage), storage["storage_bus"])
 
 
     if storage_damaged
@@ -248,18 +248,18 @@ function constraint_storage_damage(pm::_PM.AbstractPowerModel, i::Int; nw::Int=p
 end
 
 ""
-function constraint_bus_voltage_violation_damage(pm::_PM.AbstractPowerModel, i::Int; nw::Int=pm.cnw)
+function constraint_bus_damage_soft(pm::_PM.AbstractPowerModel, i::Int; nw::Int=pm.cnw)
     bus = _PM.ref(pm, nw, :bus, i)
 
-    constraint_bus_voltage_violation_damage(pm, nw, i, bus["vmin"], bus["vmax"])
+    constraint_bus_damage_soft(pm, nw, i, bus["vmin"], bus["vmax"])
 end
 
 
 ""
-function constraint_bus_voltage_violation(pm::_PM.AbstractPowerModel, i::Int; nw::Int=pm.cnw)
+function constraint_voltage_magnitude_bounds_soft(pm::_PM.AbstractPowerModel, i::Int; nw::Int=pm.cnw)
     bus = _PM.ref(pm, nw, :bus, i)
 
-    constraint_bus_voltage_violation(pm, nw, i, bus["vmin"], bus["vmax"])
+    constraint_voltage_magnitude_bounds_soft(pm, nw, i, bus["vmin"], bus["vmax"])
 end
 
 

src/core/ref.jl

@@ -18,9 +18,8 @@ function ref_add_damaged_gens!(ref::Dict{Symbol,<:Any}, data::Dict{String,<:Any}
                 damaged_gen[i]=gen
             end
         end
-        nw_ref[:damaged_gen] = damaged_gen
+        nw_ref[:gen_damage] = damaged_gen
     end
-    #_PM.ref(pm,:damaged_gen)
 end
 
 ""
@@ -32,7 +31,7 @@ function ref_add_damaged_buses!(ref::Dict{Symbol,<:Any}, data::Dict{String,<:Any
                 damaged_bus[i]=bus
             end
         end
-        nw_ref[:damaged_bus] = damaged_bus
+        nw_ref[:bus_damage] = damaged_bus
     end
 end
 
@@ -46,7 +45,7 @@ function ref_add_damaged_branches!(ref::Dict{Symbol,<:Any}, data::Dict{String,<:
                 damaged_branch[i]=branch
             end
         end
-        nw_ref[:damaged_branch] = damaged_branch
+        nw_ref[:branch_damage] = damaged_branch
     end
 end
 
@@ -60,6 +59,6 @@ function ref_add_damaged_storage!(ref::Dict{Symbol,<:Any}, data::Dict{String,<:A
                 damaged_storage[i]=storage
             end
         end
-        nw_ref[:damaged_storage] = damaged_storage
+        nw_ref[:storage_damage] = damaged_storage
     end
 end