PowerSystems.OutputCurrentLimiter

mutable struct HybridOutputCurrentLimiter <: OutputCurrentLimiter
    I_max::Float64
    rv::Float64
    lv::Float64
    ext::Dict{String, Any}
end

Parameters of Hybrid Current Controller Limiter. Regulates the magnitude of the inverter output current, but with a closed loop feedback regulated by a virtual impedance which provides ant-windup. Described in: Novel Hybrid Current Limiter for Grid-Forming Inverter Control During Unbalanced Faults by Baeckland and Seo, 2023

Arguments

• I_max::Float64: Maximum limit on current controller input current (device base), validation range: (0, nothing)
• rv::Float64: Real part of the virtual impedance, validation range: (0, nothing)
• lv::Float64: Imaginary part of the virtual impedance, validation range: (0, nothing)
• ext::Dict{String, Any}: (default: Dict{String, Any}())

get_I_max(value::HybridOutputCurrentLimiter) -> Float64

Get HybridOutputCurrentLimiter I_max.

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

Get HybridOutputCurrentLimiter ext.

get_lv(value::HybridOutputCurrentLimiter) -> Float64

Get HybridOutputCurrentLimiter lv.

get_rv(value::HybridOutputCurrentLimiter) -> Float64

Get HybridOutputCurrentLimiter rv.

set_I_max!(value::HybridOutputCurrentLimiter, val) -> Any

Set HybridOutputCurrentLimiter I_max.

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

Set HybridOutputCurrentLimiter ext.

set_lv!(value::HybridOutputCurrentLimiter, val) -> Any

Set HybridOutputCurrentLimiter lv.

set_rv!(value::HybridOutputCurrentLimiter, val) -> Any

Set HybridOutputCurrentLimiter rv.

mutable struct InstantaneousOutputCurrentLimiter <: OutputCurrentLimiter
    Id_max::Float64
    Iq_max::Float64
    ext::Dict{String, Any}
end

Parameters of Instantaneous (Square) Current Controller Limiter. Regulates inverter output current on the d and q axis separately

Arguments

• Id_max::Float64: Maximum limit on d-axis current controller input current in pu (DEVICE_BASE), validation range: (0, nothing)
• Iq_max::Float64: Maximum limit on d-axis current controller input current in pu (DEVICE_BASE), validation range: (0, nothing)
• 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.

get_Id_max(
    value::InstantaneousOutputCurrentLimiter
) -> Float64

Get InstantaneousOutputCurrentLimiter Id_max.

get_Iq_max(
    value::InstantaneousOutputCurrentLimiter
) -> Float64

Get InstantaneousOutputCurrentLimiter Iq_max.

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

Get InstantaneousOutputCurrentLimiter ext.

set_Id_max!(
    value::InstantaneousOutputCurrentLimiter,
    val
) -> Any

Set InstantaneousOutputCurrentLimiter Id_max.

set_Iq_max!(
    value::InstantaneousOutputCurrentLimiter,
    val
) -> Any

Set InstantaneousOutputCurrentLimiter Iq_max.

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

Set InstantaneousOutputCurrentLimiter ext.

mutable struct MagnitudeOutputCurrentLimiter <: OutputCurrentLimiter
    I_max::Float64
    ext::Dict{String, Any}
end

Parameters of Magnitude (Circular) Current Controller Limiter. Regulates only the magnitude of the inverter output current

Arguments

• I_max::Float64: Maximum limit on current controller input current in pu (DEVICE_BASE), validation range: (0, nothing)
• 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.

get_I_max(value::MagnitudeOutputCurrentLimiter) -> Float64

Get MagnitudeOutputCurrentLimiter I_max.

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

Get MagnitudeOutputCurrentLimiter ext.

set_I_max!(value::MagnitudeOutputCurrentLimiter, val) -> Any

Set MagnitudeOutputCurrentLimiter I_max.

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

Set MagnitudeOutputCurrentLimiter ext.

mutable struct PriorityOutputCurrentLimiter <: OutputCurrentLimiter
    I_max::Float64
    ϕ_I::Float64
    ext::Dict{String, Any}
end

Parameters of Priority-Based Current Controller Limiter. Regulates the magnitude of the inverter output current and prioritizes a specific angle for the resultant current signal

Arguments

• I_max::Float64: Maximum limit on current controller input current in pu (DEVICE_BASE), validation range: (0, nothing)
• ϕ_I::Float64: Pre-defined angle (measured against the d-axis) for Iref once limit Imax is hit, validation range: (-1.571, 1.571)
• 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.

get_I_max(value::PriorityOutputCurrentLimiter) -> Float64

Get PriorityOutputCurrentLimiter I_max.

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

Get PriorityOutputCurrentLimiter ext.

get_ϕ_I(value::PriorityOutputCurrentLimiter) -> Float64

Get PriorityOutputCurrentLimiter ϕ_I.

set_I_max!(value::PriorityOutputCurrentLimiter, val) -> Any

Set PriorityOutputCurrentLimiter I_max.

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

Set PriorityOutputCurrentLimiter ext.

set_ϕ_I!(value::PriorityOutputCurrentLimiter, val) -> Any

Set PriorityOutputCurrentLimiter ϕ_I.

mutable struct SaturationOutputCurrentLimiter <: OutputCurrentLimiter
    I_max::Float64
    kw::Float64
    ext::Dict{String, Any}
end

Parameters of Saturation Current Controller Limiter. Regulates the magnitude of the inverter output current, and applies a closed loop feedback regulated by a static gain which provides ant-windup

Arguments

• I_max::Float64: Maximum limit on current controller input current (device base), validation range: (0, nothing)
• kw::Float64: Defined feedback gain, validation range: (0, nothing)
• ext::Dict{String, Any}: (default: Dict{String, Any}())

get_I_max(value::SaturationOutputCurrentLimiter) -> Float64

Get SaturationOutputCurrentLimiter I_max.

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

Get SaturationOutputCurrentLimiter ext.

get_kw(value::SaturationOutputCurrentLimiter) -> Float64

Get SaturationOutputCurrentLimiter kw.

set_I_max!(
    value::SaturationOutputCurrentLimiter,
    val
) -> Any

Set SaturationOutputCurrentLimiter I_max.

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

Set SaturationOutputCurrentLimiter ext.

set_kw!(value::SaturationOutputCurrentLimiter, val) -> Any

Set SaturationOutputCurrentLimiter kw.