HydroPumpedStorage

mutable struct HydroPumpedStorage <: HydroGen
    name::String
    available::Bool
    bus::ACBus
    active_power::Float64
    reactive_power::Float64
    rating::Float64
    base_power::Float64
    prime_mover_type::PrimeMovers
    active_power_limits::MinMax
    reactive_power_limits::Union{Nothing, MinMax}
    ramp_limits::Union{Nothing, UpDown}
    time_limits::Union{Nothing, UpDown}
    rating_pump::Float64
    active_power_limits_pump::MinMax
    reactive_power_limits_pump::Union{Nothing, MinMax}
    ramp_limits_pump::Union{Nothing, UpDown}
    time_limits_pump::Union{Nothing, UpDown}
    storage_capacity::UpDown
    inflow::Float64
    outflow::Float64
    initial_storage::UpDown
    storage_target::UpDown
    operation_cost::Union{HydroGenerationCost, StorageCost, MarketBidCost}
    pump_efficiency::Float64
    conversion_factor::Float64
    status::PumpHydroStatus
    time_at_status::Float64
    services::Vector{Service}
    dynamic_injector::Union{Nothing, DynamicInjection}
    ext::Dict{String, Any}
    internal::InfrastructureSystemsInternal
end

A hydropower generator with pumped storage and upper and lower reservoirs.

Arguments

• name::String: Name of the component. Components of the same type (e.g., PowerLoad) must have unique names, but components of different types (e.g., PowerLoad and ACBus) can have the same name
• available::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations
• bus::ACBus: Bus that this component is connected to
• active_power::Float64: Initial active power set point of the unit in MW. For power flow, this is the steady state operating point of the system. For production cost modeling, this may or may not be used as the initial starting point for the solver, depending on the solver used
• reactive_power::Float64: Initial reactive power set point of the unit (MVAR)
• rating::Float64: Maximum output power rating of the unit (MVA), validation range: (0, nothing)
• base_power::Float64: Base power of the unit (MVA) for per unitization, validation range: (0, nothing)
• prime_mover_type::PrimeMovers: Prime mover technology according to EIA 923. Options are listed here
• active_power_limits::MinMax: Minimum and maximum stable active power levels (MW), validation range: (0, nothing)
• reactive_power_limits::Union{Nothing, MinMax}: Minimum and maximum reactive power limits. Set to Nothing if not applicable
• ramp_limits::Union{Nothing, UpDown}: ramp up and ramp down limits in MW/min, validation range: (0, nothing)
• time_limits::Union{Nothing, UpDown}: Minimum up and Minimum down time limits in hours, validation range: (0, nothing)
• rating_pump::Float64: Maximum power withdrawal (MVA) of the pump, validation range: (0, nothing)
• active_power_limits_pump::MinMax:
• reactive_power_limits_pump::Union{Nothing, MinMax}:
• ramp_limits_pump::Union{Nothing, UpDown}: ramp up and ramp down limits in MW/min of pump, validation range: (0, nothing)
• time_limits_pump::Union{Nothing, UpDown}: Minimum up and Minimum down time limits of pump in hours, validation range: (0, nothing)
• storage_capacity::UpDown: Maximum storage capacity in the upper and lower reservoirs (units can be p.u-hr or m^3), validation range: (0, nothing)
• inflow::Float64: Baseline inflow into the upper reservoir (units can be p.u. or m^3/hr), validation range: (0, nothing)
• outflow::Float64: Baseline outflow from the lower reservoir (units can be p.u. or m^3/hr), validation range: (0, nothing)
• initial_storage::UpDown: Initial storage capacity in the upper and lower reservoir (units can be p.u-hr or m^3), validation range: (0, nothing)
• storage_target::UpDown: (default: (up=1.0, down=1.0)) Storage target of upper reservoir at the end of simulation as ratio of storage capacity
• operation_cost::Union{HydroGenerationCost, StorageCost, MarketBidCost}: (default: HydroGenerationCost(nothing)) OperationalCost of generation
• pump_efficiency::Float64: (default: 1.0) Pumping efficiency [0, 1.0], validation range: (0, 1)
• conversion_factor::Float64: (default: 1.0) Conversion factor from flow/volume to energy: m^3 -> p.u-hr
• status::PumpHydroStatus: (default: PumpHydroStatus.OFF) Initial commitment condition at the start of a simulation (PumpHydroStatus.PUMP, PumpHydroStatus.GEN, or PumpHydroStatus.OFF)
• time_at_status::Float64: (default: INFINITE_TIME) Time (e.g., Hours(6)) the generator has been generating, pumping, or off, as indicated by status
• services::Vector{Service}: (default: Device[]) Services that this device contributes to
• dynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection device
• ext::Dict{String, Any}: (default: Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude.
• internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference

get_name(value::HydroPumpedStorage) -> String

Get HydroPumpedStorage name.

get_active_power(value::HydroPumpedStorage) -> Any

Get HydroPumpedStorage active_power.

get_active_power_limits(
    value::HydroPumpedStorage
) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}

Get HydroPumpedStorage active_power_limits.

get_active_power_limits_pump(
    value::HydroPumpedStorage
) -> NamedTuple{(:min, :max), <:Tuple{Any, Any}}

Get HydroPumpedStorage active_power_limits_pump.

get_available(value::HydroPumpedStorage) -> Bool

Get HydroPumpedStorage available.

get_base_power(value::HydroPumpedStorage) -> Float64

Get HydroPumpedStorage base_power.

get_bus(value::HydroPumpedStorage) -> ACBus

Get HydroPumpedStorage bus.

get_conversion_factor(value::HydroPumpedStorage) -> Float64

Get HydroPumpedStorage conversion_factor.

get_dynamic_injector(
    value::HydroPumpedStorage
) -> Union{Nothing, DynamicInjection}

Get HydroPumpedStorage dynamic_injector.

get_ext(value::HydroPumpedStorage) -> Dict{String, Any}

Get HydroPumpedStorage ext.

get_inflow(value::HydroPumpedStorage) -> Any

Get HydroPumpedStorage inflow.

get_initial_storage(
    value::HydroPumpedStorage
) -> NamedTuple{(:up, :down), <:Tuple{Any, Any}}

Get HydroPumpedStorage initial_storage.

get_operation_cost(
    value::HydroPumpedStorage
) -> Union{HydroGenerationCost, MarketBidCost, StorageCost}

Get HydroPumpedStorage operation_cost.

get_outflow(value::HydroPumpedStorage) -> Float64

Get HydroPumpedStorage outflow.

get_prime_mover_type(
    value::HydroPumpedStorage
) -> PrimeMovers

Get HydroPumpedStorage prime_mover_type.

get_pump_efficiency(value::HydroPumpedStorage) -> Float64

Get HydroPumpedStorage pump_efficiency.

get_ramp_limits(
    value::HydroPumpedStorage
) -> Union{Nothing, NamedTuple{(:up, :down), <:Tuple{Any, Any}}}

Get HydroPumpedStorage ramp_limits.

get_ramp_limits_pump(
    value::HydroPumpedStorage
) -> Union{Nothing, NamedTuple{(:up, :down), <:Tuple{Any, Any}}}

Get HydroPumpedStorage ramp_limits_pump.

get_rating(value::HydroPumpedStorage) -> Any

Get HydroPumpedStorage rating.

get_rating_pump(value::HydroPumpedStorage) -> Any

Get HydroPumpedStorage rating_pump.

get_reactive_power(value::HydroPumpedStorage) -> Any

Get HydroPumpedStorage reactive_power.

get_reactive_power_limits(
    value::HydroPumpedStorage
) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}

Get HydroPumpedStorage reactive_power_limits.

get_reactive_power_limits_pump(
    value::HydroPumpedStorage
) -> Union{Nothing, NamedTuple{(:min, :max), <:Tuple{Any, Any}}}

Get HydroPumpedStorage reactive_power_limits_pump.

get_services(value::HydroPumpedStorage) -> Vector{Service}

Get HydroPumpedStorage services.

get_status(
    value::HydroPumpedStorage
) -> PowerSystems.PumpHydroStatusModule.PumpHydroStatus

Get HydroPumpedStorage status.

get_storage_capacity(
    value::HydroPumpedStorage
) -> NamedTuple{(:up, :down), <:Tuple{Any, Any}}

Get HydroPumpedStorage storage_capacity.

get_storage_target(
    value::HydroPumpedStorage
) -> @NamedTuple{up::Float64, down::Float64}

Get HydroPumpedStorage storage_target.

get_time_at_status(value::HydroPumpedStorage) -> Float64

Get HydroPumpedStorage time_at_status.

get_time_limits(
    value::HydroPumpedStorage
) -> Union{Nothing, @NamedTuple{up::Float64, down::Float64}}

Get HydroPumpedStorage time_limits.

get_time_limits_pump(
    value::HydroPumpedStorage
) -> Union{Nothing, @NamedTuple{up::Float64, down::Float64}}

Get HydroPumpedStorage time_limits_pump.

set_active_power!(value::HydroPumpedStorage, val) -> Any

Set HydroPumpedStorage active_power.

set_active_power_limits!(
    value::HydroPumpedStorage,
    val
) -> Any

Set HydroPumpedStorage active_power_limits.

set_active_power_limits_pump!(
    value::HydroPumpedStorage,
    val
) -> Any

Set HydroPumpedStorage active_power_limits_pump.

set_available!(value::HydroPumpedStorage, val) -> Any

Set HydroPumpedStorage available.

set_base_power!(value::HydroPumpedStorage, val) -> Any

Set HydroPumpedStorage base_power.

set_bus!(value::HydroPumpedStorage, val) -> Any

Set HydroPumpedStorage bus.

set_conversion_factor!(
    value::HydroPumpedStorage,
    val
) -> Any

Set HydroPumpedStorage conversion_factor.

set_ext!(value::HydroPumpedStorage, val) -> Any

Set HydroPumpedStorage ext.

set_inflow!(value::HydroPumpedStorage, val) -> Any

Set HydroPumpedStorage inflow.

set_initial_storage!(value::HydroPumpedStorage, val) -> Any

Set HydroPumpedStorage initial_storage.

set_operation_cost!(value::HydroPumpedStorage, val) -> Any

Set HydroPumpedStorage operation_cost.

set_outflow!(value::HydroPumpedStorage, val) -> Any

Set HydroPumpedStorage outflow.

set_prime_mover_type!(value::HydroPumpedStorage, val) -> Any

Set HydroPumpedStorage prime_mover_type.

set_pump_efficiency!(value::HydroPumpedStorage, val) -> Any

Set HydroPumpedStorage pump_efficiency.

set_ramp_limits!(value::HydroPumpedStorage, val) -> Any

Set HydroPumpedStorage ramp_limits.

set_ramp_limits_pump!(value::HydroPumpedStorage, val) -> Any

Set HydroPumpedStorage ramp_limits_pump.

set_rating!(value::HydroPumpedStorage, val) -> Any

Set HydroPumpedStorage rating.

set_rating_pump!(value::HydroPumpedStorage, val) -> Any

Set HydroPumpedStorage rating_pump.

set_reactive_power!(value::HydroPumpedStorage, val) -> Any

Set HydroPumpedStorage reactive_power.

set_reactive_power_limits!(
    value::HydroPumpedStorage,
    val
) -> Any

Set HydroPumpedStorage reactive_power_limits.

set_reactive_power_limits_pump!(
    value::HydroPumpedStorage,
    val
) -> Any

Set HydroPumpedStorage reactive_power_limits_pump.

set_services!(value::HydroPumpedStorage, val) -> Any

Set HydroPumpedStorage services.

set_status!(value::HydroPumpedStorage, val) -> Any

Set HydroPumpedStorage status.

set_storage_capacity!(value::HydroPumpedStorage, val) -> Any

Set HydroPumpedStorage storage_capacity.

set_storage_target!(value::HydroPumpedStorage, val) -> Any

Set HydroPumpedStorage storage_target.

set_time_at_status!(value::HydroPumpedStorage, val) -> Any

Set HydroPumpedStorage time_at_status.

set_time_limits!(value::HydroPumpedStorage, val) -> Any

Set HydroPumpedStorage time_limits.

set_time_limits_pump!(value::HydroPumpedStorage, val) -> Any

Set HydroPumpedStorage time_limits_pump.