SwitchedAdmittance

mutable struct SwitchedAdmittance <: ElectricLoad
    name::String
    available::Bool
    bus::ACBus
    Y::Complex{Float64}
    initial_status::Vector{Int}
    number_of_steps::Vector{Int}
    Y_increase::Vector{Complex{Float64}}
    admittance_limits::MinMax
    control_mode::SwitchedAdmittanceControlMode
    regulated_bus_number::Int
    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: The ACBus that this component is connected to
• Y::Complex{Float64}: Initial admittance at N = 0
• initial_status::Vector{Int}: (default: Int[]) Vector of initial switched shunt status, one for in-service and zero for out-of-service for block i (1 through 8)
• number_of_steps::Vector{Int}: (default: Int[]) Vector with number of steps for each adjustable shunt block. For example, number_of_steps[2] are the number of available steps for admittance increment at block 2.
• Y_increase::Vector{Complex{Float64}}: (default: Complex{Float64}[]) Vector with admittance increment step for each adjustable shunt block. For example, Y_increase[2] is the complex admittance increment for each step at block 2.
• admittance_limits::MinMax: (default: (min=1.0, max=1.0)) Shunt admittance limits for switched shunt model
• control_mode::SwitchedAdmittanceControlMode: (default: SwitchedAdmittanceControlMode.FIXED) Switched-shunt control mode (PSS/E MODSW).
• regulated_bus_number::Int: (default: 0) Bus number whose voltage/quantity this shunt regulates; 0 ⇒ local bus (PSS/E SWREM/NREG).
• 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.
• internal::InfrastructureSystemsInternal: (Do not modify.) PowerSystems.jl internal reference

get_available(value::SwitchedAdmittance) -> Bool

Get SwitchedAdmittanceavailable.

get_name(value::SwitchedAdmittance) -> String

Get SwitchedAdmittancename.

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

Set SwitchedAdmittanceavailable.

get_Y(value::SwitchedAdmittance) -> ComplexF64

Get SwitchedAdmittanceY.

get_Y_increase(
    value::SwitchedAdmittance
) -> Vector{ComplexF64}

Get SwitchedAdmittanceY_increase.

get_admittance_limits(
    value::SwitchedAdmittance
) -> @NamedTuple{min::Float64, max::Float64}

Get SwitchedAdmittanceadmittance_limits.

get_bus(value::SwitchedAdmittance) -> ACBus

Get SwitchedAdmittancebus.

get_control_mode(
    value::SwitchedAdmittance
) -> SwitchedAdmittanceControlMode

Get SwitchedAdmittancecontrol_mode.

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

Get SwitchedAdmittancedynamic_injector.

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

Get SwitchedAdmittanceext.

get_initial_status(
    value::SwitchedAdmittance
) -> Vector{Int64}

Get SwitchedAdmittanceinitial_status.

get_number_of_steps(
    value::SwitchedAdmittance
) -> Vector{Int64}

Get SwitchedAdmittancenumber_of_steps.

get_regulated_bus_number(value::SwitchedAdmittance) -> Int64

Get SwitchedAdmittanceregulated_bus_number.

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

Get SwitchedAdmittanceservices.

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

Set SwitchedAdmittanceY.

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

Set SwitchedAdmittanceY_increase.

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

Set SwitchedAdmittanceadmittance_limits.

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

Set SwitchedAdmittancebus.

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

Set SwitchedAdmittancecontrol_mode.

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

Set SwitchedAdmittanceext.

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

Set SwitchedAdmittanceinitial_status.

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

Set SwitchedAdmittancenumber_of_steps.

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

Set SwitchedAdmittanceregulated_bus_number.

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

Set SwitchedAdmittanceservices.