Merge pull request #1529 from NREL-Sienna/rh/remove_hydroenergyreservoir

[BREAKING] Remove HydroEnergyReservoir struct

Author: jd-lara

Project.toml

@@ -24,7 +24,7 @@ YAML = "ddb6d928-2868-570f-bddf-ab3f9cf99eb6"
 [compat]
 CSV = "~0.10"
 DataFrames = "1"
-DataStructures = "~0.18"
+DataStructures = "^0.19"
 Dates = "1"
 DocStringExtensions = "0.8, 0.9.2"
 InfrastructureSystems = "^2.6"
@@ -33,8 +33,8 @@ JSON3 = "1"
 LinearAlgebra = "1"
 Logging = "1"
 PowerFlowData = "^1.5"
-PrettyTables = "1, 2"
-TimeSeries = "0.24"
+PrettyTables = "2"
+TimeSeries = "0.25"
 UUIDs = "1"
 Unicode = "1"
 YAML = "~0.4"

src/PowerSystems.jl

@@ -101,7 +101,6 @@ export get_spillage_cost, set_spillage_cost!
 export Generator
 export HydroGen
 export HydroDispatch
-export HydroEnergyReservoir
 export HydroTurbine
 export HydroReservoir
 export HydroPumpTurbine
@@ -324,6 +323,7 @@ export StateTypes
 export ReservoirDataType
 export MotorLoadTechnology
 export HydroTurbineType
+export ReservoirLocation
 
 # from IS time_series_structs.jl, time_series_cache.jl
 export TimeSeriesAssociation
@@ -375,6 +375,7 @@ export has_service
 export remove_reservoir!
 export clear_reservoirs!
 export get_reservoirs
+export get_reservoir_location
 export has_reservoir
 export has_time_series
 export get_buses
@@ -837,6 +838,7 @@ include("models/dynamic_branch.jl")
 include("impedance_correction.jl")
 include("models/supplemental_constructors.jl")
 include("models/supplemental_accessors.jl")
+include("models/supplemental_setters.jl")
 
 # Supplemental attributes
 include("contingencies.jl")

src/base.jl

@@ -2682,6 +2682,9 @@ end
 function handle_component_removal!(sys::System, service::Service)
     _handle_component_removal_common!(service)
     for device in get_components(Device, sys)
+        if !supports_services(device)
+            continue
+        end
         _remove_service!(device, service)
     end
 end

src/definitions.jl

@@ -477,6 +477,22 @@ across different systems.
 - `OTHER`     : Placeholder for less common or custom turbine designs.
 " HydroTurbineType
 
+IS.@scoped_enum(
+    ReservoirLocation,
+    HEAD = 1,
+    TAIL = 2,
+)
+@doc"
+ReservoirLocation
+
+Enumeration representing the location of a hydro reservoir relative to its associated turbine.
+
+# Values
+- `HEAD`: The reservoir is located upstream of the turbine, typically at a higher elevation.
+- `TAIL`: The reservoir is located downstream of the turbine at a lower or same elevation.
+
+" ReservoirLocation
+
 const PS_MAX_LOG = parse(Int, get(ENV, "PS_MAX_LOG", "50"))
 const DEFAULT_BASE_MVA = 100.0
 

src/descriptors/power_system_inputs.json

@@ -818,7 +818,6 @@
             "name": "generator_category",
             "value_options": [
                 "HydroDispatch",
-                "HydroEnergyReservoir",
                 "RenewableNonDispatch",
                 "RenewableDispatch",
                 "ThermalStandard",