FACTSControlDevice

mutable struct FACTSControlDevice <: StaticInjection
    name::String
    available::Bool
    bus::ACBus
    control_mode::Union{Nothing, FACTSOperationModes}
    voltage_setpoint::Float64
    max_shunt_current::Float64
    max_reactive_power::Float64
    shunt_control_type::FACTSShuntControlType
    regulated_bus_number::Int
    reactive_power_required::Float64
    services::Vector{Service}
    dynamic_injector::Union{Nothing, DynamicInjection}
    ext::Dict{String, Any}
    internal::InfrastructureSystemsInternal
end

Facts control devices.

Most often used in AC power flow studies as a control of voltage and, active and reactive power.

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 sending-end ACBus
• control_mode::Union{Nothing, FACTSOperationModes}: Control mode. Used to describe the behavior of the control device. See FACTSOperationModes.
• voltage_setpoint::Float64: (default: 1.0) Voltage setpoint at the sending end bus, it has to be a PV bus, in p.u. (SYSTEM_BASE).
• max_shunt_current::Float64: (default: 9999.0) Maximum shunt current at unity voltage (PSS/E SHMX), MVA; the STATCOM current limit and SVC susceptance base.
• max_reactive_power::Float64: (default: 9999.0) Independent maximum reactive power ceiling (MVA); the device reactive limit is min(the current/susceptance law on maxshuntcurrent, this value). Non-binding at the 9999.0 default.
• shunt_control_type::FACTSShuntControlType: (default: FACTSShuntControlType.STATCOM) Device class selecting the reactive-limit law (SVC vs STATCOM)
• regulated_bus_number::Int: (default: 0) Bus whose voltage this device regulates; 0 ⇒ local (sending) bus (PSS/E FCREG)
• reactive_power_required::Float64: (default: 0.0) Solver-populated: delivered reactive power after solve (output; not parsed from input)
• services::Vector{Service}: (default: Device[]) Services that this device contributes to
• dynamic_injector::Union{Nothing, DynamicInjection}: (default: nothing) Corresponding dynamic injection model for FACTS control device
• 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::FACTSControlDevice) -> Bool

Get FACTSControlDevice available.

get_name(value::FACTSControlDevice) -> String

Get FACTSControlDevice name.

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

Set FACTSControlDevice available.

get_bus(value::FACTSControlDevice) -> ACBus

Get FACTSControlDevice bus.

get_control_mode(
    value::FACTSControlDevice
) -> Union{Nothing, FACTSOperationModes}

Get FACTSControlDevice control_mode.

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

Get FACTSControlDevice dynamic_injector.

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

Get FACTSControlDevice ext.

get_max_reactive_power(value::FACTSControlDevice) -> Float64

Get FACTSControlDevice max_reactive_power.

get_max_shunt_current(value::FACTSControlDevice) -> Float64

Get FACTSControlDevice max_shunt_current.

get_reactive_power_required(
    value::FACTSControlDevice
) -> Float64

Get FACTSControlDevice reactive_power_required.

get_regulated_bus_number(value::FACTSControlDevice) -> Int64

Get FACTSControlDevice regulated_bus_number.

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

Get FACTSControlDevice services.

get_shunt_control_type(
    value::FACTSControlDevice
) -> FACTSShuntControlType

Get FACTSControlDevice shunt_control_type.

get_voltage_setpoint(value::FACTSControlDevice) -> Float64

Get FACTSControlDevice voltage_setpoint.

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

Set FACTSControlDevice bus.

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

Set FACTSControlDevice control_mode.

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

Set FACTSControlDevice ext.

set_max_reactive_power!(
    value::FACTSControlDevice,
    val
) -> Any

Set FACTSControlDevice max_reactive_power.

set_max_shunt_current!(
    value::FACTSControlDevice,
    val
) -> Any

Set FACTSControlDevice max_shunt_current.

set_reactive_power_required!(
    value::FACTSControlDevice,
    val
) -> Any

Set FACTSControlDevice reactive_power_required.

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

Set FACTSControlDevice regulated_bus_number.

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

Set FACTSControlDevice services.

set_shunt_control_type!(
    value::FACTSControlDevice,
    val
) -> Any

Set FACTSControlDevice shunt_control_type.

set_voltage_setpoint!(value::FACTSControlDevice, val) -> Any

Set FACTSControlDevice voltage_setpoint.