HydroDispatch
PowerSystems.HydroDispatch — Typemutable struct HydroDispatch <: HydroGen
name::String
available::Bool
bus::ACBus
active_power::Float64
reactive_power::Float64
rating::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}
base_power::Float64
status::Bool
time_at_status::Float64
operation_cost::Union{HydroGenerationCost, MarketBidCost}
services::Vector{Service}
dynamic_injector::Union{Nothing, DynamicInjection}
ext::Dict{String, Any}
internal::InfrastructureSystemsInternal
endA hydropower generator without a reservoir, suitable for modeling run-of-river hydropower.
For hydro generators with an upper reservoir, see HydroReservoir
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.,PowerLoadandACBus) can have the same nameavailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulationsbus::ACBus: TheACBusthat this component is connected toactive_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 usedreactive_power::Float64: Initial reactive power set point of the unit (MVAR), validation range:reactive_power_limitsrating::Float64: Maximum AC side output power rating of the unit. Stored in per unit of the device and not to be confused with base_power, validation range:(0, nothing)prime_mover_type::PrimeMovers: Prime mover technology according to EIA 923. SeePrimeMovers.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 toNothingif not applicableramp_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)base_power::Float64: Base power of the unit (MVA) for per unitization, validation range:(0.0001, nothing)status::Bool: (default:false) Initial commitment condition at the start of a simulation (true= on orfalse= off)time_at_status::Float64: (default:INFINITE_TIME) Time (e.g.,Hours(6)) the generator has been on or off, as indicated bystatusoperation_cost::Union{HydroGenerationCost, MarketBidCost}: (default:HydroGenerationCost(nothing))OperationalCostof generationservices::Vector{Service}: (default:Device[]) Services that this device contributes todynamic_injector::Union{Nothing, DynamicInjection}: (default:nothing) corresponding dynamic injection deviceext::Dict{String, Any}: (default:Dict{String, Any}()) An extra dictionary for users to add metadata that are not used in simulation.internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference
InfrastructureSystems.get_available — Methodget_available(value::HydroDispatch) -> Bool
Get HydroDispatchavailable.
InfrastructureSystems.get_name — Methodget_name(value::HydroDispatch) -> String
Get HydroDispatchname.
InfrastructureSystems.set_available! — Methodset_available!(value::HydroDispatch, val) -> Any
Set HydroDispatchavailable.
PowerSystems.get_active_power — Methodget_active_power(value::HydroDispatch) -> Float64
Get HydroDispatchactive_power.
PowerSystems.get_active_power_limits — Methodget_active_power_limits(
value::HydroDispatch
) -> @NamedTuple{min::Float64, max::Float64}
Get HydroDispatchactive_power_limits.
PowerSystems.get_base_power — Methodget_base_power(value::HydroDispatch) -> Float64
Get HydroDispatchbase_power.
PowerSystems.get_bus — Methodget_bus(value::HydroDispatch) -> ACBus
Get HydroDispatchbus.
PowerSystems.get_dynamic_injector — Methodget_dynamic_injector(
value::HydroDispatch
) -> Union{Nothing, DynamicInjection}
Get HydroDispatchdynamic_injector.
PowerSystems.get_ext — Methodget_ext(value::HydroDispatch) -> Dict{String, Any}
Get HydroDispatchext.
PowerSystems.get_operation_cost — Methodget_operation_cost(
value::HydroDispatch
) -> Union{HydroGenerationCost, MarketBidCost}
Get HydroDispatchoperation_cost.
PowerSystems.get_prime_mover_type — Methodget_prime_mover_type(value::HydroDispatch) -> PrimeMovers
Get HydroDispatchprime_mover_type.
PowerSystems.get_ramp_limits — Methodget_ramp_limits(
value::HydroDispatch
) -> Union{Nothing, @NamedTuple{up::Float64, down::Float64}}
Get HydroDispatchramp_limits.
PowerSystems.get_rating — Methodget_rating(value::HydroDispatch) -> Float64
Get HydroDispatchrating.
PowerSystems.get_reactive_power — Methodget_reactive_power(value::HydroDispatch) -> Float64
Get HydroDispatchreactive_power.
PowerSystems.get_reactive_power_limits — Methodget_reactive_power_limits(
value::HydroDispatch
) -> Union{Nothing, @NamedTuple{min::Float64, max::Float64}}
Get HydroDispatchreactive_power_limits.
PowerSystems.get_services — Methodget_services(value::HydroDispatch) -> Vector{Service}
Get HydroDispatchservices.
PowerSystems.get_status — Methodget_status(value::HydroDispatch) -> Bool
Get HydroDispatchstatus.
PowerSystems.get_time_at_status — Methodget_time_at_status(value::HydroDispatch) -> Float64
Get HydroDispatchtime_at_status.
PowerSystems.get_time_limits — Methodget_time_limits(
value::HydroDispatch
) -> Union{Nothing, @NamedTuple{up::Float64, down::Float64}}
Get HydroDispatchtime_limits.
PowerSystems.set_active_power! — Methodset_active_power!(value::HydroDispatch, val) -> Any
Set HydroDispatchactive_power.
PowerSystems.set_active_power_limits! — Methodset_active_power_limits!(value::HydroDispatch, val) -> Any
Set HydroDispatchactive_power_limits.
PowerSystems.set_base_power! — Methodset_base_power!(value::HydroDispatch, val) -> Any
Set HydroDispatchbase_power.
PowerSystems.set_bus! — Methodset_bus!(value::HydroDispatch, val) -> Any
Set HydroDispatchbus.
PowerSystems.set_ext! — Methodset_ext!(value::HydroDispatch, val) -> Any
Set HydroDispatchext.
PowerSystems.set_operation_cost! — Methodset_operation_cost!(value::HydroDispatch, val) -> Any
Set HydroDispatchoperation_cost.
PowerSystems.set_prime_mover_type! — Methodset_prime_mover_type!(value::HydroDispatch, val) -> Any
Set HydroDispatchprime_mover_type.
PowerSystems.set_ramp_limits! — Methodset_ramp_limits!(value::HydroDispatch, val) -> Any
Set HydroDispatchramp_limits.
PowerSystems.set_rating! — Methodset_rating!(value::HydroDispatch, val) -> Any
Set HydroDispatchrating.
PowerSystems.set_reactive_power! — Methodset_reactive_power!(value::HydroDispatch, val) -> Any
Set HydroDispatchreactive_power.
PowerSystems.set_reactive_power_limits! — Methodset_reactive_power_limits!(value::HydroDispatch, val) -> Any
Set HydroDispatchreactive_power_limits.
PowerSystems.set_services! — Methodset_services!(value::HydroDispatch, val) -> Any
Set HydroDispatchservices.
PowerSystems.set_status! — Methodset_status!(value::HydroDispatch, val) -> Any
Set HydroDispatchstatus.
PowerSystems.set_time_at_status! — Methodset_time_at_status!(value::HydroDispatch, val) -> Any
Set HydroDispatchtime_at_status.
PowerSystems.set_time_limits! — Methodset_time_limits!(value::HydroDispatch, val) -> Any
Set HydroDispatchtime_limits.