Merge pull request #1047 from NREL-Sienna/jd/standardptdfmodel_rename

rename StandardPTDFModel to PTDFPowerModel
NREL-Sienna · Jan 23, 2024 · eab23e6 · eab23e6
2 parents e370cbd + fcf4211
commit eab23e6
Show file tree

Hide file tree

Showing 21 changed files with 70 additions and 70 deletions.
diff --git a/docs/src/tutorials/pcm_simulation.md b/docs/src/tutorials/pcm_simulation.md
@@ -78,7 +78,7 @@ example, PSI also provides pre-specified templates for some standard problems:
 
 ```@example pcm
 template_ed = template_economic_dispatch(
-    network = NetworkModel(StandardPTDFModel, use_slacks = true),
+    network = NetworkModel(PTDFPowerModel, use_slacks = true),
 )
 ```
 

diff --git a/src/PowerSimulations.jl b/src/PowerSimulations.jl
@@ -19,7 +19,7 @@ export SimulationPartitionResults
 
 # Network Relevant Exports
 export NetworkModel
-export StandardPTDFModel
+export PTDFPowerModel
 export CopperPlatePowerModel
 export AreaBalancePowerModel
 

diff --git a/src/core/formulations.jl b/src/core/formulations.jl
@@ -152,7 +152,7 @@ struct LossLessLine <: AbstractBranchFormulation end
 # These formulations are taken directly from PowerModels
 
 abstract type AbstractPTDFModel <: PM.AbstractDCPModel end
-struct StandardPTDFModel <: AbstractPTDFModel end
+struct PTDFPowerModel <: AbstractPTDFModel end
 
 struct CopperPlatePowerModel <: PM.AbstractActivePowerModel end
 struct AreaBalancePowerModel <: PM.AbstractActivePowerModel end

diff --git a/src/core/network_model.jl b/src/core/network_model.jl
@@ -24,7 +24,7 @@ Establishes the model for a particular device specified by type.
 # Example
 
 ptdf_array = PTDF(system)
-thermal_gens = NetworkModel(StandardPTDFModel, ptdf = ptdf_array),
+thermal_gens = NetworkModel(PTDFPowerModel, ptdf = ptdf_array),
 """
 mutable struct NetworkModel{T <: PM.AbstractPowerModel}
     use_slacks::Bool
@@ -113,7 +113,7 @@ function instantiate_network_model(
     return
 end
 
-function instantiate_network_model(model::NetworkModel{StandardPTDFModel}, sys::PSY.System)
+function instantiate_network_model(model::NetworkModel{PTDFPowerModel}, sys::PSY.System)
     if get_PTDF_matrix(model) === nothing
         @info "PTDF Matrix not provided. Calculating using PowerNetworkMatrices.PTDF"
         model.PTDF_matrix =
@@ -135,7 +135,7 @@ end
 function _assign_subnetworks_to_buses(
     model::NetworkModel{T},
     sys::PSY.System,
-) where {T <: Union{CopperPlatePowerModel, StandardPTDFModel}}
+) where {T <: Union{CopperPlatePowerModel, PTDFPowerModel}}
     subnetworks = model.subnetworks
     temp_bus_map = Dict{Int, Int}()
     radial_network_reduction = PSI.get_radial_network_reduction(model)

diff --git a/src/core/optimization_container.jl b/src/core/optimization_container.jl
@@ -494,7 +494,7 @@ function _make_system_expressions!(
     dc_bus_numbers::Vector{Int},
     ::Type{T},
     bus_reduction_map::Dict{Int64, Set{Int64}},
-) where {T <: StandardPTDFModel}
+) where {T <: PTDFPowerModel}
     time_steps = get_time_steps(container)
     if isempty(bus_reduction_map)
         ac_bus_numbers = collect(Iterators.flatten(values(subnetworks)))

diff --git a/src/devices_models/device_constructors/branch_constructor.jl b/src/devices_models/device_constructors/branch_constructor.jl
@@ -211,7 +211,7 @@ function construct_device!(
     sys::PSY.System,
     ::ArgumentConstructStage,
     device_model::DeviceModel{T, StaticBranch},
-    network_model::NetworkModel{StandardPTDFModel},
+    network_model::NetworkModel{PTDFPowerModel},
 ) where {T <: PSY.ACBranch}
     devices =
         get_available_components(T, sys, get_attribute(device_model, "filter_function"))
@@ -230,7 +230,7 @@ function construct_device!(
     sys::PSY.System,
     ::ModelConstructStage,
     device_model::DeviceModel{T, StaticBranch},
-    network_model::NetworkModel{StandardPTDFModel},
+    network_model::NetworkModel{PTDFPowerModel},
 ) where {T <: PSY.ACBranch}
     devices =
         get_available_components(T, sys, get_attribute(device_model, "filter_function"))
@@ -245,7 +245,7 @@ function construct_device!(
     sys::PSY.System,
     ::ArgumentConstructStage,
     device_model::DeviceModel{T, StaticBranchBounds},
-    network_model::NetworkModel{StandardPTDFModel},
+    network_model::NetworkModel{PTDFPowerModel},
 ) where {T <: PSY.ACBranch}
     devices =
         get_available_components(T, sys, get_attribute(device_model, "filter_function"))
@@ -264,7 +264,7 @@ function construct_device!(
     sys::PSY.System,
     ::ModelConstructStage,
     device_model::DeviceModel{T, StaticBranchBounds},
-    network_model::NetworkModel{StandardPTDFModel},
+    network_model::NetworkModel{PTDFPowerModel},
 ) where {T <: PSY.ACBranch}
     devices =
         get_available_components(T, sys, get_attribute(device_model, "filter_function"))
@@ -284,7 +284,7 @@ function construct_device!(
     sys::PSY.System,
     ::ArgumentConstructStage,
     device_model::DeviceModel{T, StaticBranchUnbounded},
-    network_model::NetworkModel{StandardPTDFModel},
+    network_model::NetworkModel{PTDFPowerModel},
 ) where {T <: PSY.ACBranch}
     devices =
         get_available_components(T, sys, get_attribute(device_model, "filter_function"))
@@ -303,7 +303,7 @@ function construct_device!(
     sys::PSY.System,
     ::ModelConstructStage,
     model::DeviceModel{T, StaticBranchUnbounded},
-    network_model::NetworkModel{StandardPTDFModel},
+    network_model::NetworkModel{PTDFPowerModel},
 ) where {T <: PSY.ACBranch}
     devices =
         get_available_components(T, sys, get_attribute(model, "filter_function"))
@@ -439,7 +439,7 @@ function construct_device!(
     sys::PSY.System,
     ::ArgumentConstructStage,
     model::DeviceModel{T, HVDCTwoTerminalUnbounded},
-    network_model::NetworkModel{StandardPTDFModel},
+    network_model::NetworkModel{PTDFPowerModel},
 ) where {T <: TwoTerminalHVDCTypes}
     devices =
         get_available_components(T, sys, get_attribute(model, "filter_function"))
@@ -461,7 +461,7 @@ function construct_device!(
     sys::PSY.System,
     ::ModelConstructStage,
     model::DeviceModel{<:TwoTerminalHVDCTypes, HVDCTwoTerminalUnbounded},
-    network_model::NetworkModel{StandardPTDFModel},
+    network_model::NetworkModel{PTDFPowerModel},
 )
     add_constraint_dual!(container, sys, model)
     return
@@ -497,7 +497,7 @@ function construct_device!(
     sys::PSY.System,
     ::ArgumentConstructStage,
     model::DeviceModel{T, HVDCTwoTerminalLossless},
-    network_model::NetworkModel{StandardPTDFModel},
+    network_model::NetworkModel{PTDFPowerModel},
 ) where {T <: TwoTerminalHVDCTypes}
     devices =
         get_available_components(T, sys, get_attribute(model, "filter_function"))
@@ -522,7 +522,7 @@ function construct_device!(
     network_model::NetworkModel{U},
 ) where {
     T <: TwoTerminalHVDCTypes,
-    U <: StandardPTDFModel,
+    U <: PTDFPowerModel,
 }
     devices =
         get_available_components(T, sys, get_attribute(model, "filter_function"))
@@ -536,7 +536,7 @@ function construct_device!(
     sys::PSY.System,
     ::ArgumentConstructStage,
     model::DeviceModel{T, HVDCTwoTerminalDispatch},
-    network_model::NetworkModel{StandardPTDFModel},
+    network_model::NetworkModel{PTDFPowerModel},
 ) where {T <: TwoTerminalHVDCTypes}
     devices =
         get_available_components(T, sys, get_attribute(model, "filter_function"))
@@ -586,7 +586,7 @@ function construct_device!(
     sys::PSY.System,
     ::ModelConstructStage,
     model::DeviceModel{T, HVDCTwoTerminalDispatch},
-    network_model::NetworkModel{StandardPTDFModel},
+    network_model::NetworkModel{PTDFPowerModel},
 ) where {T <: TwoTerminalHVDCTypes}
     devices =
         get_available_components(T, sys, get_attribute(model, "filter_function"))
@@ -705,7 +705,7 @@ function construct_device!(
     sys::PSY.System,
     ::ArgumentConstructStage,
     model::DeviceModel{PSY.PhaseShiftingTransformer, PhaseAngleControl},
-    network_model::NetworkModel{StandardPTDFModel},
+    network_model::NetworkModel{PTDFPowerModel},
 )
     devices = get_available_components(
         PSY.PhaseShiftingTransformer,
@@ -749,7 +749,7 @@ function construct_device!(
     sys::PSY.System,
     ::ModelConstructStage,
     model::DeviceModel{PSY.PhaseShiftingTransformer, PhaseAngleControl},
-    network_model::NetworkModel{StandardPTDFModel},
+    network_model::NetworkModel{PTDFPowerModel},
 )
     devices = get_available_components(
         PSY.PhaseShiftingTransformer,

diff --git a/src/devices_models/devices/AC_branches.jl b/src/devices_models/devices/AC_branches.jl
@@ -46,7 +46,7 @@ end
 function add_variables!(
     container::OptimizationContainer,
     ::Type{FlowActivePowerVariable},
-    network_model::NetworkModel{StandardPTDFModel},
+    network_model::NetworkModel{PTDFPowerModel},
     devices::IS.FlattenIteratorWrapper{T},
     formulation::AbstractBranchFormulation,
 ) where {T <: PSY.ACBranch}
@@ -345,14 +345,14 @@ function add_constraints!(
 end
 
 """
-Add network flow constraints for ACBranch and NetworkModel with StandardPTDFModel
+Add network flow constraints for ACBranch and NetworkModel with PTDFPowerModel
 """
 function add_constraints!(
     container::OptimizationContainer,
     ::Type{NetworkFlowConstraint},
     devices::IS.FlattenIteratorWrapper{B},
     model::DeviceModel{B, <:AbstractBranchFormulation},
-    network_model::NetworkModel{StandardPTDFModel},
+    network_model::NetworkModel{PTDFPowerModel},
 ) where {B <: PSY.ACBranch}
     ptdf = get_PTDF_matrix(network_model)
     # This is a workaround to not call the same list comprehension to find
@@ -388,14 +388,14 @@ function add_constraints!(
 end
 
 """
-Add network flow constraints for PhaseShiftingTransformer and NetworkModel with StandardPTDFModel
+Add network flow constraints for PhaseShiftingTransformer and NetworkModel with PTDFPowerModel
 """
 function add_constraints!(
     container::OptimizationContainer,
     ::Type{NetworkFlowConstraint},
     devices::IS.FlattenIteratorWrapper{T},
     model::DeviceModel{T, PhaseAngleControl},
-    network_model::NetworkModel{StandardPTDFModel},
+    network_model::NetworkModel{PTDFPowerModel},
 ) where {T <: PSY.PhaseShiftingTransformer}
     ptdf = get_PTDF_matrix(network_model)
     branches = PSY.get_name.(devices)

diff --git a/src/devices_models/devices/HVDCsystems.jl b/src/devices_models/devices/HVDCsystems.jl
@@ -215,7 +215,7 @@ function add_to_expression!(
     U <: ActivePowerVariable,
     V <: PSY.InterconnectingConverter,
     W <: AbstractConverterFormulation,
-    X <: StandardPTDFModel
+    X <: PTDFPowerModel
 }
     variable = get_variable(container, U(), V)
     expression_dc = get_expression(container, T(), PSY.DCBus)

diff --git a/src/devices_models/devices/common/add_constraint_dual.jl b/src/devices_models/devices/common/add_constraint_dual.jl
@@ -31,7 +31,7 @@ function add_constraint_dual!(
     container::OptimizationContainer,
     sys::PSY.System,
     model::NetworkModel{T},
-) where {T <: Union{CopperPlatePowerModel, StandardPTDFModel}}
+) where {T <: Union{CopperPlatePowerModel, PTDFPowerModel}}
     if !isempty(get_duals(model))
         for constraint_type in get_duals(model)
             assign_dual_variable!(container, constraint_type, sys, model)

diff --git a/src/devices_models/devices/common/add_to_expression.jl b/src/devices_models/devices/common/add_to_expression.jl
@@ -178,7 +178,7 @@ function add_to_expression!(
     U <: HVDCLosses,
     V <: TwoTerminalHVDCTypes,
     W <: HVDCTwoTerminalDispatch,
-    X <: Union{StandardPTDFModel, CopperPlatePowerModel},
+    X <: Union{PTDFPowerModel, CopperPlatePowerModel},
 }
     variable = get_variable(container, U(), V)
     expression = get_expression(container, T(), PSY.System)
@@ -212,7 +212,7 @@ function add_to_expression!(
     U <: FlowActivePowerToFromVariable,
     V <: TwoTerminalHVDCTypes,
     W <: AbstractDeviceFormulation,
-    X <: StandardPTDFModel,
+    X <: PTDFPowerModel,
 }
     var = get_variable(container, U(), V)
     nodal_expr = get_expression(container, T(), PSY.ACBus)
@@ -248,7 +248,7 @@ function add_to_expression!(
     U <: FlowActivePowerFromToVariable,
     V <: TwoTerminalHVDCTypes,
     W <: AbstractTwoTerminalDCLineFormulation,
-    X <: StandardPTDFModel,
+    X <: PTDFPowerModel,
 }
     var = get_variable(container, U(), V)
     nodal_expr = get_expression(container, T(), PSY.ACBus)
@@ -579,7 +579,7 @@ function add_to_expression!(
     U <: TimeSeriesParameter,
     V <: PSY.StaticInjection,
     W <: AbstractDeviceFormulation,
-    X <: StandardPTDFModel,
+    X <: PTDFPowerModel,
 }
     param_container = get_parameter(container, U(), V)
     multiplier = get_multiplier_array(param_container)
@@ -613,7 +613,7 @@ function add_to_expression!(
     U <: OnStatusParameter,
     V <: PSY.ThermalGen,
     W <: AbstractDeviceFormulation,
-    X <: StandardPTDFModel,
+    X <: PTDFPowerModel,
 }
     parameter = get_parameter_array(container, U(), V)
     sys_expr = get_expression(container, T(), PSY.System)
@@ -647,7 +647,7 @@ function add_to_expression!(
     U <: VariableType,
     V <: PSY.StaticInjection,
     W <: AbstractDeviceFormulation,
-    X <: StandardPTDFModel,
+    X <: PTDFPowerModel,
 }
     variable = get_variable(container, U(), V)
     sys_expr = get_expression(container, T(), PSY.System)
@@ -686,7 +686,7 @@ function add_to_expression!(
     U <: OnVariable,
     V <: PSY.ThermalGen,
     W <: Union{AbstractCompactUnitCommitment, ThermalCompactDispatch},
-    X <: StandardPTDFModel,
+    X <: PTDFPowerModel,
 }
     variable = get_variable(container, U(), V)
     sys_expr = get_expression(container, T(), PSY.System)
@@ -762,7 +762,7 @@ function add_to_expression!(
     ::Type{U},
     devices::IS.FlattenIteratorWrapper{V},
     ::DeviceModel{V, W},
-    network_model::NetworkModel{StandardPTDFModel},
+    network_model::NetworkModel{PTDFPowerModel},
 ) where {
     T <: ActivePowerBalance,
     U <: FlowActivePowerVariable,
@@ -844,7 +844,7 @@ function add_to_expression!(
     ::Type{U},
     devices::IS.FlattenIteratorWrapper{PSY.PhaseShiftingTransformer},
     ::DeviceModel{PSY.PhaseShiftingTransformer, V},
-    network_model::NetworkModel{StandardPTDFModel},
+    network_model::NetworkModel{PTDFPowerModel},
 ) where {T <: ActivePowerBalance, U <: PhaseShifterAngle, V <: PhaseAngleControl}
     var = get_variable(container, U(), PSY.PhaseShiftingTransformer)
     expression = get_expression(container, T(), PSY.ACBus)
@@ -1076,7 +1076,7 @@ function add_to_expression!(
 ) where {
     T <: ActivePowerBalance,
     U <: Union{SystemBalanceSlackUp, SystemBalanceSlackDown},
-    W <: Union{CopperPlatePowerModel, StandardPTDFModel},
+    W <: Union{CopperPlatePowerModel, PTDFPowerModel},
 }
     variable = get_variable(container, U(), PSY.System)
     expression = get_expression(container, T(), PSY.System)

diff --git a/src/network_models/copperplate_model.jl b/src/network_models/copperplate_model.jl
@@ -6,7 +6,7 @@ function add_constraints!(
 ) where {
     T <: CopperPlateBalanceConstraint,
     U <: PSY.System,
-    V <: Union{CopperPlatePowerModel, StandardPTDFModel},
+    V <: Union{CopperPlatePowerModel, PTDFPowerModel},
 }
     time_steps = get_time_steps(container)
     expressions = get_expression(container, ActivePowerBalance(), U)

diff --git a/src/network_models/network_constructor.jl b/src/network_models/network_constructor.jl
@@ -53,7 +53,7 @@ end
 function construct_network!(
     container::OptimizationContainer,
     sys::PSY.System,
-    model::NetworkModel{StandardPTDFModel},
+    model::NetworkModel{PTDFPowerModel},
     ::ProblemTemplate,
 )
     if get_use_slacks(model)

diff --git a/src/network_models/network_slack_variables.jl b/src/network_models/network_slack_variables.jl
@@ -10,7 +10,7 @@ function add_variables!(
     network_model::NetworkModel{U},
 ) where {
     T <: Union{SystemBalanceSlackUp, SystemBalanceSlackDown},
-    U <: Union{CopperPlatePowerModel, StandardPTDFModel},
+    U <: Union{CopperPlatePowerModel, PTDFPowerModel},
 }
     time_steps = get_time_steps(container)
     reference_buses = get_reference_buses(network_model)
@@ -95,7 +95,7 @@ function objective_function!(
     container::OptimizationContainer,
     ::Type{PSY.System},
     network_model::NetworkModel{T},
-) where {T <: Union{CopperPlatePowerModel, StandardPTDFModel}}
+) where {T <: Union{CopperPlatePowerModel, PTDFPowerModel}}
     variable_up = get_variable(container, SystemBalanceSlackUp(), PSY.System)
     variable_dn = get_variable(container, SystemBalanceSlackDown(), PSY.System)
     reference_buses = get_reference_buses(network_model)

diff --git a/test/performance/performance_test.jl b/test/performance/performance_test.jl
@@ -23,7 +23,7 @@ try
     for i in 1:2
         template_uc = ProblemTemplate(
             NetworkModel(
-                StandardPTDFModel;
+                PTDFPowerModel;
                 use_slacks = true,
                 PTDF_matrix = PTDF(sys_rts_da),
                 duals = [CopperPlateBalanceConstraint],

diff --git a/test/run_partitioned_simulation.jl b/test/run_partitioned_simulation.jl
@@ -113,7 +113,7 @@ function build_simulation(
     set_network_model!(
         template_uc,
         NetworkModel(
-            StandardPTDFModel;
+            PTDFPowerModel;
             PTDF_matrix = PTDF(c_sys5_pjm_da),
             # duals = [CopperPlateBalanceConstraint]
         ),