PhaseShiftingTransformer

mutable struct PhaseShiftingTransformer <: ACBranch
    name::String
    available::Bool
    active_power_flow::Float64
    reactive_power_flow::Float64
    arc::Arc
    r::Float64
    x::Float64
    primary_shunt::Float64
    tap::Float64
    α::Float64
    rating::Union{Nothing, Float64}
    phase_angle_limits::MinMax
    services::Vector{Service}
    ext::Dict{String, Any}
    internal::InfrastructureSystemsInternal
end

A phase-shifting transformer regulating the phase angle between two buses to control active power flow in the system.

The model uses an equivalent circuit assuming the impedance is on the High Voltage Side of the transformer. The model allocates the iron losses and magnetizing susceptance to the primary side

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
• active_power_flow::Float64: Initial condition of active power flow through the transformer (MW)
• reactive_power_flow::Float64: Initial condition of reactive power flow through the transformer (MVAR)
• arc::Arc: An Arc defining this transformer from a bus to another bus
• r::Float64: Resistance in pu (SYSTEM_BASE), validation range: (0, 4)
• x::Float64: Reactance in pu (SYSTEM_BASE), validation range: (-2, 4)
• primary_shunt::Float64:, validation range: (0, 2)
• tap::Float64: Normalized tap changer position for voltage control, varying between 0 and 2, with 1 centered at the nominal voltage, validation range: (0, 2)
• α::Float64: Initial condition of phase shift (radians) between the from and to buses , validation range: (-1.571, 1.571)
• rating::Union{Nothing, Float64}: Thermal rating (MVA). Flow through the transformer must be between -rating and rating. When defining a transformer before it is attached to a System, rating must be in pu (SYSTEM_BASE) using the base power of the System it will be attached to, validation range: (0, nothing)
• phase_angle_limits::MinMax: (default: (min=-1.571, max=1.571)) Minimum and maximum phase angle limits (radians), validation range: (-1.571, 1.571)
• 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::PhaseShiftingTransformer) -> String

Get PhaseShiftingTransformer name.

get_active_power_flow(
    value::PhaseShiftingTransformer
) -> Any

Get PhaseShiftingTransformer active_power_flow.

get_arc(value::PhaseShiftingTransformer) -> Arc

Get PhaseShiftingTransformer arc.

get_available(value::PhaseShiftingTransformer) -> Bool

Get PhaseShiftingTransformer available.

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

Get PhaseShiftingTransformer ext.

get_phase_angle_limits(
    value::PhaseShiftingTransformer
) -> @NamedTuple{min::Float64, max::Float64}

Get PhaseShiftingTransformer phase_angle_limits.

get_primary_shunt(
    value::PhaseShiftingTransformer
) -> Float64

Get PhaseShiftingTransformer primary_shunt.

get_r(value::PhaseShiftingTransformer) -> Float64

Get PhaseShiftingTransformer r.

get_rating(value::PhaseShiftingTransformer) -> Any

Get PhaseShiftingTransformer rating.

get_reactive_power_flow(
    value::PhaseShiftingTransformer
) -> Any

Get PhaseShiftingTransformer reactive_power_flow.

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

Get PhaseShiftingTransformer services.

get_tap(value::PhaseShiftingTransformer) -> Float64

Get PhaseShiftingTransformer tap.

get_x(value::PhaseShiftingTransformer) -> Float64

Get PhaseShiftingTransformer x.

get_α(value::PhaseShiftingTransformer) -> Float64

Get PhaseShiftingTransformer α.

set_active_power_flow!(
    value::PhaseShiftingTransformer,
    val
) -> Any

Set PhaseShiftingTransformer active_power_flow.

set_arc!(value::PhaseShiftingTransformer, val) -> Any

Set PhaseShiftingTransformer arc.

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

Set PhaseShiftingTransformer available.

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

Set PhaseShiftingTransformer ext.

set_phase_angle_limits!(
    value::PhaseShiftingTransformer,
    val
) -> Any

Set PhaseShiftingTransformer phase_angle_limits.

set_primary_shunt!(
    value::PhaseShiftingTransformer,
    val
) -> Any

Set PhaseShiftingTransformer primary_shunt.

set_r!(value::PhaseShiftingTransformer, val) -> Any

Set PhaseShiftingTransformer r.

set_rating!(value::PhaseShiftingTransformer, val) -> Any

Set PhaseShiftingTransformer rating.

set_reactive_power_flow!(
    value::PhaseShiftingTransformer,
    val
) -> Any

Set PhaseShiftingTransformer reactive_power_flow.

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

Set PhaseShiftingTransformer services.

set_tap!(value::PhaseShiftingTransformer, val) -> Any

Set PhaseShiftingTransformer tap.

set_x!(value::PhaseShiftingTransformer, val) -> Any

Set PhaseShiftingTransformer x.

set_α!(value::PhaseShiftingTransformer, val) -> Any

Set PhaseShiftingTransformer α.