TapTransformer
PowerSystems.TapTransformer — Typemutable struct TapTransformer <: TwoWindingTransformer
name::String
available::Bool
active_power_flow::Float64
reactive_power_flow::Float64
arc::Arc
r::Float64
x::Float64
primary_shunt::Complex{Float64}
tap::Float64
rating::Union{Nothing, Float64}
base_power::Float64
base_voltage_primary::Union{Nothing, Float64}
base_voltage_secondary::Union{Nothing, Float64}
rating_b::Union{Nothing, Float64}
rating_c::Union{Nothing, Float64}
winding_group_number::WindingGroupNumber
control_objective::TransformerControlObjective
tap_limits::MinMax
number_of_tap_positions::Int
regulated_bus_number::Int
voltage_setpoint::Float64
services::Vector{Service}
ext::Dict{String, Any}
internal::InfrastructureSystemsInternal
endA 2-winding transformer, with a tap changer for variable turns ratio.
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.,PowerLoadandACBus) can have the same nameavailable::Bool: Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulationsactive_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: AnArcdefining this transformerfroma bustoanother busr::Float64: Resistance in p.u. (SYSTEM_BASE), validation range:(-2, 2)x::Float64: Reactance in p.u. (SYSTEM_BASE), validation range:(-2, 4)primary_shunt::Complex{Float64}: Primary shunt admittance in pu (SYSTEM_BASE)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)rating::Union{Nothing, Float64}: Thermal rating (MVA). Flow through the transformer must be between -rating. When defining a transformer before it is attached to aSystem,ratingmust be in pu (SYSTEM_BASE) using the base power of theSystemit will be attached to, validation range:(0, nothing)base_power::Float64: Base power (MVA) for per unitization, validation range:(0.0001, nothing)base_voltage_primary::Union{Nothing, Float64}: (default:get_base_voltage(get_from(arc))) Primary base voltage in kV, validation range:(0, nothing)base_voltage_secondary::Union{Nothing, Float64}: (default:get_base_voltage(get_to(arc))) Secondary base voltage in kV, validation range:(0, nothing)rating_b::Union{Nothing, Float64}: (default:nothing) Second current rating; entered in MVA.rating_c::Union{Nothing, Float64}: (default:nothing) Third current rating; entered in MVA.winding_group_number::WindingGroupNumber: (default:WindingGroupNumber.UNDEFINED) Vector group number ('clock number') indicating fixed phase shift (radians) between thefromandtobuses due to the connection group configurationcontrol_objective::TransformerControlObjective: (default:TransformerControlObjective.UNDEFINED) Control objective for the tap changer for power flow calculations. SeeTransformerControlObjectivetap_limits::MinMax: (default:(min=0.9, max=1.1)) Minimum and maximum tap ratio (per-unit turns ratio) over which the tap changer may regulatenumber_of_tap_positions::Int: (default:33) Number of discrete tap positions spanningtap_limits(NTP in PSS/e); used to snap the tap to a realizable stepregulated_bus_number::Int: (default:0) ACBusnumberwhose voltage the tap changer regulates;0identifies thetobus of this transformer's arc (local control)voltage_setpoint::Float64: (default:1.0) Voltage setpoint at the regulated bus, in p.u. (SYSTEM_BASE)services::Vector{Service}: (default:Device[]) Services that this device contributes toext::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
InfrastructureSystems.get_available — Methodget_available(value::TapTransformer) -> Bool
Get TapTransformeravailable.
InfrastructureSystems.get_name — Methodget_name(value::TapTransformer) -> String
Get TapTransformername.
InfrastructureSystems.set_available! — Methodset_available!(value::TapTransformer, val) -> Any
Set TapTransformeravailable.
PowerSystems.get_active_power_flow — Methodget_active_power_flow(value::TapTransformer) -> Float64
Get TapTransformeractive_power_flow.
PowerSystems.get_arc — Methodget_arc(value::TapTransformer) -> Arc
Get TapTransformerarc.
PowerSystems.get_base_power — Methodget_base_power(value::TapTransformer) -> Float64
Get TapTransformerbase_power.
PowerSystems.get_base_voltage_primary — Methodget_base_voltage_primary(
value::TapTransformer
) -> Union{Nothing, Float64}
Get TapTransformerbase_voltage_primary.
PowerSystems.get_base_voltage_secondary — Methodget_base_voltage_secondary(
value::TapTransformer
) -> Union{Nothing, Float64}
Get TapTransformerbase_voltage_secondary.
PowerSystems.get_control_objective — Methodget_control_objective(
value::TapTransformer
) -> TransformerControlObjective
Get TapTransformercontrol_objective.
PowerSystems.get_ext — Methodget_ext(value::TapTransformer) -> Dict{String, Any}
Get TapTransformerext.
PowerSystems.get_number_of_tap_positions — Methodget_number_of_tap_positions(value::TapTransformer) -> Int64
Get TapTransformernumber_of_tap_positions.
PowerSystems.get_primary_shunt — Methodget_primary_shunt(value::TapTransformer) -> ComplexF64
Get TapTransformerprimary_shunt.
PowerSystems.get_r — Methodget_r(value::TapTransformer) -> Float64
Get TapTransformerr.
PowerSystems.get_rating — Methodget_rating(value::TapTransformer) -> Union{Nothing, Float64}
Get TapTransformerrating.
PowerSystems.get_rating_b — Methodget_rating_b(
value::TapTransformer
) -> Union{Nothing, Float64}
Get TapTransformerrating_b.
PowerSystems.get_rating_c — Methodget_rating_c(
value::TapTransformer
) -> Union{Nothing, Float64}
Get TapTransformerrating_c.
PowerSystems.get_reactive_power_flow — Methodget_reactive_power_flow(value::TapTransformer) -> Float64
Get TapTransformerreactive_power_flow.
PowerSystems.get_regulated_bus_number — Methodget_regulated_bus_number(value::TapTransformer) -> Int64
Get TapTransformerregulated_bus_number.
PowerSystems.get_services — Methodget_services(value::TapTransformer) -> Vector{Service}
Get TapTransformerservices.
PowerSystems.get_tap — Methodget_tap(value::TapTransformer) -> Float64
Get TapTransformertap.
PowerSystems.get_tap_limits — Methodget_tap_limits(
value::TapTransformer
) -> @NamedTuple{min::Float64, max::Float64}
Get TapTransformertap_limits.
PowerSystems.get_voltage_setpoint — Methodget_voltage_setpoint(value::TapTransformer) -> Float64
Get TapTransformervoltage_setpoint.
PowerSystems.get_winding_group_number — Methodget_winding_group_number(
value::TapTransformer
) -> WindingGroupNumber
Get TapTransformerwinding_group_number.
PowerSystems.get_x — Methodget_x(value::TapTransformer) -> Float64
Get TapTransformerx.
PowerSystems.set_active_power_flow! — Methodset_active_power_flow!(value::TapTransformer, val) -> Any
Set TapTransformeractive_power_flow.
PowerSystems.set_arc! — Methodset_arc!(value::TapTransformer, val) -> Any
Set TapTransformerarc.
PowerSystems.set_base_power! — Methodset_base_power!(value::TapTransformer, val) -> Any
Set TapTransformerbase_power.
PowerSystems.set_base_voltage_primary! — Methodset_base_voltage_primary!(value::TapTransformer, val) -> Any
Set TapTransformerbase_voltage_primary.
PowerSystems.set_base_voltage_secondary! — Methodset_base_voltage_secondary!(
value::TapTransformer,
val
) -> Any
Set TapTransformerbase_voltage_secondary.
PowerSystems.set_control_objective! — Methodset_control_objective!(value::TapTransformer, val) -> Any
Set TapTransformercontrol_objective.
PowerSystems.set_ext! — Methodset_ext!(value::TapTransformer, val) -> Any
Set TapTransformerext.
PowerSystems.set_number_of_tap_positions! — Methodset_number_of_tap_positions!(
value::TapTransformer,
val
) -> Any
Set TapTransformernumber_of_tap_positions.
PowerSystems.set_primary_shunt! — Methodset_primary_shunt!(value::TapTransformer, val) -> Any
Set TapTransformerprimary_shunt.
PowerSystems.set_r! — Methodset_r!(value::TapTransformer, val) -> Any
Set TapTransformerr.
PowerSystems.set_rating! — Methodset_rating!(value::TapTransformer, val) -> Any
Set TapTransformerrating.
PowerSystems.set_rating_b! — Methodset_rating_b!(value::TapTransformer, val) -> Any
Set TapTransformerrating_b.
PowerSystems.set_rating_c! — Methodset_rating_c!(value::TapTransformer, val) -> Any
Set TapTransformerrating_c.
PowerSystems.set_reactive_power_flow! — Methodset_reactive_power_flow!(value::TapTransformer, val) -> Any
Set TapTransformerreactive_power_flow.
PowerSystems.set_regulated_bus_number! — Methodset_regulated_bus_number!(value::TapTransformer, val) -> Any
Set TapTransformerregulated_bus_number.
PowerSystems.set_services! — Methodset_services!(value::TapTransformer, val) -> Any
Set TapTransformerservices.
PowerSystems.set_tap! — Methodset_tap!(value::TapTransformer, val) -> Any
Set TapTransformertap.
PowerSystems.set_tap_limits! — Methodset_tap_limits!(value::TapTransformer, val) -> Any
Set TapTransformertap_limits.
PowerSystems.set_voltage_setpoint! — Methodset_voltage_setpoint!(value::TapTransformer, val) -> Any
Set TapTransformervoltage_setpoint.
PowerSystems.set_winding_group_number! — Methodset_winding_group_number!(value::TapTransformer, val) -> Any
Set TapTransformerwinding_group_number.
PowerSystems.set_x! — Methodset_x!(value::TapTransformer, val) -> Any
Set TapTransformerx.