InterruptiblePowerLoad
PowerSystems.InterruptiblePowerLoad
— Typemutable struct InterruptiblePowerLoad <: ControllableLoad
name::String
available::Bool
bus::ACBus
active_power::Float64
reactive_power::Float64
max_active_power::Float64
max_reactive_power::Float64
base_power::Float64
operation_cost::Union{LoadCost, MarketBidCost}
services::Vector{Service}
dynamic_injector::Union{Nothing, DynamicInjection}
ext::Dict{String, Any}
internal::InfrastructureSystemsInternal
end
A static power load that can be compensated for temporary or continuous interruptions to its requested demand.
These loads are most commonly used for operational optimizations and can be used to model, for example, large commercial and industrial customers enrolled in demand response programs. This load has a target demand profile (set by a max_active_power
time series for an operational simulation) that can be reduced to satisfy other system needs. For simpler loads without an operating cost for demand response, see PowerLoad
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
andACBus
) 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
: Bus that this component is connected toactive_power::Float64
: Initial steady state active power demand (MW)reactive_power::Float64
: Initial steady state reactive power demand (MVAR)max_active_power::Float64
: Maximum active power (MW) that this load can demandmax_reactive_power::Float64
: Maximum reactive power (MVAR) that this load can demandbase_power::Float64
: Base power (MVA) for per unitization, validation range:(0, nothing)
operation_cost::Union{LoadCost, MarketBidCost}
:OperationalCost
of interrupting loadservices::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, such as latitude and longitude.internal::InfrastructureSystemsInternal
: (Do not modify.) PowerSystems.jl internal reference
InfrastructureSystems.get_name
— Methodget_name(value::InterruptiblePowerLoad) -> String
Get InterruptiblePowerLoad
name
.
PowerSystems.get_active_power
— Methodget_active_power(value::InterruptiblePowerLoad) -> Any
Get InterruptiblePowerLoad
active_power
.
PowerSystems.get_available
— Methodget_available(value::InterruptiblePowerLoad) -> Bool
Get InterruptiblePowerLoad
available
.
PowerSystems.get_base_power
— Methodget_base_power(value::InterruptiblePowerLoad) -> Float64
Get InterruptiblePowerLoad
base_power
.
PowerSystems.get_bus
— Methodget_bus(value::InterruptiblePowerLoad) -> ACBus
Get InterruptiblePowerLoad
bus
.
PowerSystems.get_dynamic_injector
— Methodget_dynamic_injector(
value::InterruptiblePowerLoad
) -> Union{Nothing, DynamicInjection}
Get InterruptiblePowerLoad
dynamic_injector
.
PowerSystems.get_ext
— Methodget_ext(value::InterruptiblePowerLoad) -> Dict{String, Any}
Get InterruptiblePowerLoad
ext
.
PowerSystems.get_max_active_power
— Methodget_max_active_power(value::InterruptiblePowerLoad) -> Any
Get InterruptiblePowerLoad
max_active_power
.
PowerSystems.get_max_reactive_power
— Methodget_max_reactive_power(value::InterruptiblePowerLoad) -> Any
Get InterruptiblePowerLoad
max_reactive_power
.
PowerSystems.get_operation_cost
— Methodget_operation_cost(
value::InterruptiblePowerLoad
) -> Union{LoadCost, MarketBidCost}
Get InterruptiblePowerLoad
operation_cost
.
PowerSystems.get_reactive_power
— Methodget_reactive_power(value::InterruptiblePowerLoad) -> Any
Get InterruptiblePowerLoad
reactive_power
.
PowerSystems.get_services
— Methodget_services(
value::InterruptiblePowerLoad
) -> Vector{Service}
Get InterruptiblePowerLoad
services
.
PowerSystems.set_active_power!
— Methodset_active_power!(value::InterruptiblePowerLoad, val) -> Any
Set InterruptiblePowerLoad
active_power
.
PowerSystems.set_available!
— Methodset_available!(value::InterruptiblePowerLoad, val) -> Any
Set InterruptiblePowerLoad
available
.
PowerSystems.set_base_power!
— Methodset_base_power!(value::InterruptiblePowerLoad, val) -> Any
Set InterruptiblePowerLoad
base_power
.
PowerSystems.set_bus!
— Methodset_bus!(value::InterruptiblePowerLoad, val) -> Any
Set InterruptiblePowerLoad
bus
.
PowerSystems.set_ext!
— Methodset_ext!(value::InterruptiblePowerLoad, val) -> Any
Set InterruptiblePowerLoad
ext
.
PowerSystems.set_max_active_power!
— Methodset_max_active_power!(
value::InterruptiblePowerLoad,
val
) -> Any
Set InterruptiblePowerLoad
max_active_power
.
PowerSystems.set_max_reactive_power!
— Methodset_max_reactive_power!(
value::InterruptiblePowerLoad,
val
) -> Any
Set InterruptiblePowerLoad
max_reactive_power
.
PowerSystems.set_operation_cost!
— Methodset_operation_cost!(
value::InterruptiblePowerLoad,
val
) -> Any
Set InterruptiblePowerLoad
operation_cost
.
PowerSystems.set_reactive_power!
— Methodset_reactive_power!(
value::InterruptiblePowerLoad,
val
) -> Any
Set InterruptiblePowerLoad
reactive_power
.
PowerSystems.set_services!
— Methodset_services!(value::InterruptiblePowerLoad, val) -> Any
Set InterruptiblePowerLoad
services
.