GenericDER

mutable struct GenericDER <: DynamicInjection
    name::String
    Qref_Flag::Int
    PQ_Flag::Int
    Gen_Flag::Int
    PerOp_Flag::Int
    Recon_Flag::Int
    Trv::Float64
    VV_pnts::NamedTuple{(:V1, :V2, :V3, :V4), Tuple{Float64, Float64, Float64, Float64}}
    Q_lim::MinMax
    Tp::Float64
    e_lim::MinMax
    Kpq::Float64
    Kiq::Float64
    Iqr_lim::MinMax
    I_max::Float64
    Tg::Float64
    kWh_Cap::Float64
    SOC_ini::Float64
    SOC_lim::MinMax
    Trf::Float64
    fdbd_pnts::NamedTuple{(:fdbd1, :fdbd2), Tuple{Float64, Float64}}
    D_dn::Float64
    D_up::Float64
    fe_lim::MinMax
    Kpp::Float64
    Kip::Float64
    P_lim::MinMax
    dP_lim::MinMax
    T_pord::Float64
    rrpwr::Float64
    VRT_pnts::NamedTuple{(:vrt1, :vrt2, :vrt3, :vrt4, :vrt5), Tuple{Float64, Float64, Float64, Float64, Float64}}
    TVRT_pnts::NamedTuple{(:tvrt1, :tvrt2, :tvrt3), Tuple{Float64, Float64, Float64}}
    tV_delay::Float64
    VES_lim::MinMax
    FRT_pnts::NamedTuple{(:frt1, :frt2, :frt3, :frt4), Tuple{Float64, Float64, Float64, Float64}}
    TFRT_pnts::NamedTuple{(:tfrt1, :tfrt2), Tuple{Float64, Float64}}
    tF_delay::Float64
    FES_lim::MinMax
    Pfa_ref::Float64
    Q_ref::Float64
    P_ref::Float64
    base_power::Float64
    states::Vector{Symbol}
    n_states::Int
    ext::Dict{String, Any}
    internal::InfrastructureSystemsInternal
end

Parameters of a Generic Distributed Energy Resource Model. Based on "Modeling Framework and Coordination of DER and Flexible Loads for Ancillary Service Provision."

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
• Qref_Flag::Int: Reactive Power Control Mode. 1 VoltVar Control, 2 Constant Q Control, 3 Constant PF Control, validation range: (1, 3)
• PQ_Flag::Int: Active and reactive power priority mode. 0 for Q priority, 1 for P priority, validation range: (0, 1)
• Gen_Flag::Int: Define generator or storage system. 0 unit is a storage device, 1 unit is a generator, validation range: (0, 1)
• PerOp_Flag::Int: Defines operation of permisible region in VRT characteristic. 0 for cease, 1 for continuous operation, validation range: (0, 1)
• Recon_Flag::Int: Defines if DER can reconnect after voltage ride-through disconnection, validation range: (0, 1)
• Trv::Float64: Voltage measurement transducer's time constant, in s, validation range: (0, nothing)
• VV_pnts::NamedTuple{(:V1, :V2, :V3, :V4), Tuple{Float64, Float64, Float64, Float64}}: Y-axis Volt-var curve points (V1,V2,V3,V4)
• Q_lim::MinMax: Reactive power limits in pu (Qmin, Qmax)
• Tp::Float64: Power measurement transducer's time constant, in s, validation range: (0, nothing)
• e_lim::MinMax: Error limit in PI controller for q control (emin, emax)
• Kpq::Float64: PI controller proportional gain for q control, validation range: (0, nothing)
• Kiq::Float64: PI controller integral gain for q control, validation range: (0, nothing)
• Iqr_lim::MinMax: Limit on rate of change for reactive current (pu/s) (Iqrmin, Iqrmax)
• I_max::Float64: Max. inverter's current, validation range: (0, nothing)
• Tg::Float64: Current control's time constant, in s, validation range: (0, nothing)
• kWh_Cap::Float64: BESS capacity in kWh, validation range: (0, nothing)
• SOC_ini::Float64: Initial state of charge (SOC) in pu, validation range: (0, 1)
• SOC_lim::MinMax: Battery's SOC limits (SOCmin, SOCmax)
• Trf::Float64: Time constant to estimate system frequency, in s, validation range: (0, nothing)
• fdbd_pnts::NamedTuple{(:fdbd1, :fdbd2), Tuple{Float64, Float64}}: Frequency error dead band thresholds (fdbd1, fdbd2)
• D_dn::Float64: reciprocal of droop for over-frequency conditions, in pu, validation range: (0, nothing)
• D_up::Float64: reciprocal of droop for under-frequency conditions, in pu, validation range: (0, nothing)
• fe_lim::MinMax: Frequency error limits in pu (femin, femax)
• Kpp::Float64: PI controller proportional gain for p control, validation range: (0, nothing)
• Kip::Float64: PI controller integral gain for p control, validation range: (0, nothing)
• P_lim::MinMax: Active power limits in pu (Pmin, Pmax)
• dP_lim::MinMax: Ramp rate limits for active power in pu/s (dPmin, dPmax)
• T_pord::Float64: Power filter time constant in s, validation range: (0, nothing)
• rrpwr::Float64: Ramp rate for real power increase following a fault, in pu/s, validation range: (0, nothing)
• VRT_pnts::NamedTuple{(:vrt1, :vrt2, :vrt3, :vrt4, :vrt5), Tuple{Float64, Float64, Float64, Float64, Float64}}: Voltage ride through v points (vrt1,vrt2,vrt3,vrt4,vrt5)
• TVRT_pnts::NamedTuple{(:tvrt1, :tvrt2, :tvrt3), Tuple{Float64, Float64, Float64}}: Voltage ride through time points (tvrt1,tvrt2,tvrt3)
• tV_delay::Float64: Time delay for reconnection after voltage ride-through disconnection, validation range: (0, nothing)
• VES_lim::MinMax: Min and max voltage for entering service (VESmin,VESmax)
• FRT_pnts::NamedTuple{(:frt1, :frt2, :frt3, :frt4), Tuple{Float64, Float64, Float64, Float64}}: Frequency ride through v points (frt1,frt2,frt3,frt4)
• TFRT_pnts::NamedTuple{(:tfrt1, :tfrt2), Tuple{Float64, Float64}}: Frequency ride through time points (tfrt1,tfrt2)
• tF_delay::Float64: Time delay for reconnection after frequency ride-through disconnection, validation range: (0, nothing)
• FES_lim::MinMax: Min and max frequency for entering service (FESmin,FESmax)
• Pfa_ref::Float64: (default: 0.0) Reference power factor, validation range: (0, nothing)
• Q_ref::Float64: (default: 0.0) Reference reactive power, in pu, validation range: (0, nothing)
• P_ref::Float64: (default: 1.0) Reference active power, in pu, validation range: (0, nothing)
• base_power::Float64: (default: 100.0) Base power of the unit (MVA) for per unitization
• states::Vector{Symbol}: (Do not modify.) The states of GenericDER depend on the Flags
• n_states::Int: (Do not modify.) The states of GenericDER depend on the Flags
• 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_name(value::GenericDER) -> String

Get GenericDER name.

get_D_dn(value::GenericDER) -> Float64

Get GenericDER D_dn.

get_D_up(value::GenericDER) -> Float64

Get GenericDER D_up.

get_FES_lim(
    value::GenericDER
) -> @NamedTuple{min::Float64, max::Float64}

Get GenericDER FES_lim.

get_FRT_pnts(
    value::GenericDER
) -> @NamedTuple{frt1::Float64, frt2::Float64, frt3::Float64, frt4::Float64}

Get GenericDER FRT_pnts.

get_Gen_Flag(value::GenericDER) -> Int64

Get GenericDER Gen_Flag.

get_I_max(value::GenericDER) -> Float64

Get GenericDER I_max.

get_Iqr_lim(
    value::GenericDER
) -> @NamedTuple{min::Float64, max::Float64}

Get GenericDER Iqr_lim.

get_Kip(value::GenericDER) -> Float64

Get GenericDER Kip.

get_Kiq(value::GenericDER) -> Float64

Get GenericDER Kiq.

get_Kpp(value::GenericDER) -> Float64

Get GenericDER Kpp.

get_Kpq(value::GenericDER) -> Float64

Get GenericDER Kpq.

get_PQ_Flag(value::GenericDER) -> Int64

Get GenericDER PQ_Flag.

get_P_lim(
    value::GenericDER
) -> @NamedTuple{min::Float64, max::Float64}

Get GenericDER P_lim.

get_P_ref(value::GenericDER) -> Float64

Get GenericDER P_ref.

get_PerOp_Flag(value::GenericDER) -> Int64

Get GenericDER PerOp_Flag.

get_Pfa_ref(value::GenericDER) -> Float64

Get GenericDER Pfa_ref.

get_Q_lim(
    value::GenericDER
) -> @NamedTuple{min::Float64, max::Float64}

Get GenericDER Q_lim.

get_Q_ref(value::GenericDER) -> Float64

Get GenericDER Q_ref.

get_Qref_Flag(value::GenericDER) -> Int64

Get GenericDER Qref_Flag.

get_Recon_Flag(value::GenericDER) -> Int64

Get GenericDER Recon_Flag.

get_SOC_ini(value::GenericDER) -> Float64

Get GenericDER SOC_ini.

get_SOC_lim(
    value::GenericDER
) -> @NamedTuple{min::Float64, max::Float64}

Get GenericDER SOC_lim.

get_TFRT_pnts(
    value::GenericDER
) -> @NamedTuple{tfrt1::Float64, tfrt2::Float64}

Get GenericDER TFRT_pnts.

get_TVRT_pnts(
    value::GenericDER
) -> @NamedTuple{tvrt1::Float64, tvrt2::Float64, tvrt3::Float64}

Get GenericDER TVRT_pnts.

get_T_pord(value::GenericDER) -> Float64

Get GenericDER T_pord.

get_Tg(value::GenericDER) -> Float64

Get GenericDER Tg.

get_Tp(value::GenericDER) -> Float64

Get GenericDER Tp.

get_Trf(value::GenericDER) -> Float64

Get GenericDER Trf.

get_Trv(value::GenericDER) -> Float64

Get GenericDER Trv.

get_VES_lim(
    value::GenericDER
) -> @NamedTuple{min::Float64, max::Float64}

Get GenericDER VES_lim.

get_VRT_pnts(
    value::GenericDER
) -> @NamedTuple{vrt1::Float64, vrt2::Float64, vrt3::Float64, vrt4::Float64, vrt5::Float64}

Get GenericDER VRT_pnts.

get_VV_pnts(
    value::GenericDER
) -> @NamedTuple{V1::Float64, V2::Float64, V3::Float64, V4::Float64}

Get GenericDER VV_pnts.

get_base_power(value::GenericDER) -> Float64

Get GenericDER base_power.

get_dP_lim(
    value::GenericDER
) -> @NamedTuple{min::Float64, max::Float64}

Get GenericDER dP_lim.

get_e_lim(
    value::GenericDER
) -> @NamedTuple{min::Float64, max::Float64}

Get GenericDER e_lim.

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

Get GenericDER ext.

get_fdbd_pnts(
    value::GenericDER
) -> @NamedTuple{fdbd1::Float64, fdbd2::Float64}

Get GenericDER fdbd_pnts.

get_fe_lim(
    value::GenericDER
) -> @NamedTuple{min::Float64, max::Float64}

Get GenericDER fe_lim.

get_kWh_Cap(value::GenericDER) -> Float64

Get GenericDER kWh_Cap.

get_n_states(value::GenericDER) -> Int64

Get GenericDER n_states.

get_rrpwr(value::GenericDER) -> Float64

Get GenericDER rrpwr.

get_states(value::GenericDER) -> Vector{Symbol}

Get GenericDER states.

get_tF_delay(value::GenericDER) -> Float64

Get GenericDER tF_delay.

get_tV_delay(value::GenericDER) -> Float64

Get GenericDER tV_delay.

set_D_dn!(value::GenericDER, val) -> Any

Set GenericDER D_dn.

set_D_up!(value::GenericDER, val) -> Any

Set GenericDER D_up.

set_FES_lim!(value::GenericDER, val) -> Any

Set GenericDER FES_lim.

set_FRT_pnts!(value::GenericDER, val) -> Any

Set GenericDER FRT_pnts.

set_Gen_Flag!(value::GenericDER, val) -> Any

Set GenericDER Gen_Flag.

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

Set GenericDER I_max.

set_Iqr_lim!(value::GenericDER, val) -> Any

Set GenericDER Iqr_lim.

set_Kip!(value::GenericDER, val) -> Any

Set GenericDER Kip.

set_Kiq!(value::GenericDER, val) -> Any

Set GenericDER Kiq.

set_Kpp!(value::GenericDER, val) -> Any

Set GenericDER Kpp.

set_Kpq!(value::GenericDER, val) -> Any

Set GenericDER Kpq.

set_PQ_Flag!(value::GenericDER, val) -> Any

Set GenericDER PQ_Flag.

set_P_lim!(value::GenericDER, val) -> Any

Set GenericDER P_lim.

set_P_ref!(value::GenericDER, val) -> Any

Set GenericDER P_ref.

set_PerOp_Flag!(value::GenericDER, val) -> Any

Set GenericDER PerOp_Flag.

set_Pfa_ref!(value::GenericDER, val) -> Any

Set GenericDER Pfa_ref.

set_Q_lim!(value::GenericDER, val) -> Any

Set GenericDER Q_lim.

set_Q_ref!(value::GenericDER, val) -> Any

Set GenericDER Q_ref.

set_Qref_Flag!(value::GenericDER, val) -> Any

Set GenericDER Qref_Flag.

set_Recon_Flag!(value::GenericDER, val) -> Any

Set GenericDER Recon_Flag.

set_SOC_ini!(value::GenericDER, val) -> Any

Set GenericDER SOC_ini.

set_SOC_lim!(value::GenericDER, val) -> Any

Set GenericDER SOC_lim.

set_TFRT_pnts!(value::GenericDER, val) -> Any

Set GenericDER TFRT_pnts.

set_TVRT_pnts!(value::GenericDER, val) -> Any

Set GenericDER TVRT_pnts.

set_T_pord!(value::GenericDER, val) -> Any

Set GenericDER T_pord.

set_Tg!(value::GenericDER, val) -> Any

Set GenericDER Tg.

set_Tp!(value::GenericDER, val) -> Any

Set GenericDER Tp.

set_Trf!(value::GenericDER, val) -> Any

Set GenericDER Trf.

set_Trv!(value::GenericDER, val) -> Any

Set GenericDER Trv.

set_VES_lim!(value::GenericDER, val) -> Any

Set GenericDER VES_lim.

set_VRT_pnts!(value::GenericDER, val) -> Any

Set GenericDER VRT_pnts.

set_VV_pnts!(value::GenericDER, val) -> Any

Set GenericDER VV_pnts.

set_base_power!(value::GenericDER, val) -> Any

Set GenericDER base_power.

set_dP_lim!(value::GenericDER, val) -> Any

Set GenericDER dP_lim.

set_e_lim!(value::GenericDER, val) -> Any

Set GenericDER e_lim.

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

Set GenericDER ext.

set_fdbd_pnts!(value::GenericDER, val) -> Any

Set GenericDER fdbd_pnts.

set_fe_lim!(value::GenericDER, val) -> Any

Set GenericDER fe_lim.

set_kWh_Cap!(value::GenericDER, val) -> Any

Set GenericDER kWh_Cap.

set_rrpwr!(value::GenericDER, val) -> Any

Set GenericDER rrpwr.

set_tF_delay!(value::GenericDER, val) -> Any

Set GenericDER tF_delay.

set_tV_delay!(value::GenericDER, val) -> Any

Set GenericDER tV_delay.