SwitchedAdmittance

Package: PowerOperationsOpenAPIModels · Source: Operations/StaticInjection/SwitchedAdmittance.json

A switched admittance, with discrete steps to adjust the admittance.

Most often used in power flow studies, iterating over the steps to see impacts of admittance on the results. Total admittance is number_engaged * Y_increase, unless solved_admittance is set, in which case that value is the effective admittance. There is no fixed base admittance: a PSS/E SWITCHED SHUNT record carries only BINIT and the per-block increments.

Properties

Property	Type	Required	Unit	Description
id	integer	yes	—	Unique integer identifier for this component.
name	string	yes	—	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	boolean	yes	—	Indicator of whether the component is connected and online (true) or disconnected, offline, or down (false). Unavailable components are excluded during simulations.
bus	integer	yes	—	ID of the bus that this component is connected to.
admittance_units	string (ShuntAdmittanceUnitBasis)	—	—	Unit basis for the shunt admittance fields. COMPONENT_MVAR is PSS/E RAW native (Mvar/MW at unity voltage).
number_engaged	array of integer	—	—	Vector with the number of steps currently engaged (switched in) for each adjustable shunt block. For example, number_engaged[2] is the number of steps in service at block 2, and cannot exceed number_of_steps[2].
number_of_steps	array of integer	—	—	Vector with number of steps for each adjustable shunt block. For example, number_of_steps[2] are the number of available steps for admittance increment at block 2.
Y_increase	array of ComplexNumber	—	S / MVAr (by admittance_units)	Vector with admittance increment step for each adjustable shunt block. For example, Y_increase[2] is the complex admittance increment for each step at block 2. Units: per admittance_units — NATURAL_UNITS: S, COMPONENT_MVAR: MVAr .
solved_admittance	number or null	—	S / MVAr (by admittance_units)	Solved-case switched shunt admittance (PSS/E BINIT); when present it is the shunt’s effective admittance, used in place of number_engaged * Y_increase. Units: per admittance_units — NATURAL_UNITS: S, COMPONENT_MVAR: MVAr .
admittance_limits	MinMax	—	S / MVAr (by admittance_units)	Shunt admittance limits for switched shunt model. Units: per admittance_units — NATURAL_UNITS: S, COMPONENT_MVAR: MVAr .
control_mode	string (SwitchedAdmittanceControlMode)	—	—	Switched-shunt control mode.
regulated_bus_number	integer	—	1	Bus number whose voltage/quantity this shunt regulates; 0 means local bus (PSS/E SWREM/NREG). Units: 1.
dynamic_injector	integer or null	—	—	ID of the corresponding dynamic injection model for admittance, if any.