SwitchedAdmittance

mutable struct SwitchedAdmittance <: ElectricLoad
    name::String
    available::Bool
    bus::ACBus
    Y::Complex{Float64}
    number_of_steps::Int
    Y_increase::Complex{Float64}
    dynamic_injector::Union{Nothing, DynamicInjection}
    services::Vector{Service}
    ext::Dict{String, Any}
    internal::InfrastructureSystemsInternal
end

A switched admittance, with discrete steps to adjust the admittance.

Most often used in power flow studies, iterating over the steps to see impacts of admittance on the results. Total admittance is calculated as: Y + number_of_steps * Y_increase

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
• Y::Complex{Float64}: Initial admittance at N = 0
• number_of_steps::Int: (default: 0) Number of steps for adjustable shunt
• Y_increase::Complex{Float64}: (default: 0) Admittance increment for each of step increase
• dynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) corresponding dynamic injection model for admittance
• services::Vector{Service}: (default: Device[]) Services that this device contributes to
• 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::SwitchedAdmittance) -> String

Get SwitchedAdmittance name.

get_Y(value::SwitchedAdmittance) -> ComplexF64

Get SwitchedAdmittance Y.

get_Y_increase(value::SwitchedAdmittance) -> ComplexF64

Get SwitchedAdmittance Y_increase.

get_available(value::SwitchedAdmittance) -> Bool

Get SwitchedAdmittance available.

get_bus(value::SwitchedAdmittance) -> ACBus

Get SwitchedAdmittance bus.

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

Get SwitchedAdmittance dynamic_injector.

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

Get SwitchedAdmittance ext.

get_number_of_steps(value::SwitchedAdmittance) -> Int64

Get SwitchedAdmittance number_of_steps.

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

Get SwitchedAdmittance services.

set_Y!(value::SwitchedAdmittance, val) -> Any

Set SwitchedAdmittance Y.

set_Y_increase!(value::SwitchedAdmittance, val) -> Any

Set SwitchedAdmittance Y_increase.

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

Set SwitchedAdmittance available.

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

Set SwitchedAdmittance bus.

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

Set SwitchedAdmittance ext.

set_number_of_steps!(value::SwitchedAdmittance, val) -> Any

Set SwitchedAdmittance number_of_steps.

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

Set SwitchedAdmittance services.