Expand description
Balanced network records and the public network and geographic submodules.
Derived indexes, normalization data, solver tables, and component error
types remain available from powerio-tx rather than being duplicated at
the facade root.
Format neutral balanced network model.
Readers map source formats into a BalancedNetwork, and writers map a network to
target formats. Loads and shunts have separate tables, so formats can retain
several elements at one bus. MATPOWER demand and shunt fields become those
records during parsing. IndexedNetwork provides
the dense analysis view used by matrix builders.
A network can retain its source bytes and SourceFormat for same format
writing. Each element also has an Extras map for source fields not named
by the typed model.
Formats represent different data. Cross format writers report unsupported fields rather than claiming an exact conversion.
Structs§
- Active
Power Control - Active power control settings for a generator or storage device.
- Area
- An area record: the area’s scheduled net interchange and its swing bus.
- Balanced
Network - A balanced network with stable source bus IDs and separate element tables: an immutable cheap to clone owning handle over private shared tables.
- Boundary
Line - One PowSybl boundary line retained beside the balanced calculation view.
- Boundary
Line Generation - Optional generation attached to a PowSybl boundary line.
- Branch
- Branch
Charging - Per terminal branch shunt admittance in p.u. This is the canonical physical branch shunt model when present.
- Branch
Current Ratings - Current limits for a branch, in source units.
- Branch
Rating Set - Extra branch MVA rating set beyond the canonical A/B/C columns.
- Branch
Solution - Solved branch terminal flows in MW/MVAr.
- Bus
- BusBreaker
Bus - One configured bus in a bus breaker voltage level and the energized bus it contributes to in the balanced calculation view.
- BusId
- A source bus ID, preserved from the input format.
- Busbar
Section - A busbar section attached to a node breaker connectivity node.
- Calculated
Bus - One calculated bus explicitly recorded in node breaker topology.
- Case
Metadata - Source neutral case metadata recorded by a grid exchange format.
- Component
Alias - An alternate name for a component, with the optional source supplied alias type.
- Component
Metadata - Source neutral metadata attached to one stable PowerIO component identity.
- Connectivity
Node - One connectivity node in a node breaker voltage level.
- DcBusbar
- A CGMES DC busbar.
- DcConverter
Unit - A CGMES DC converter unit and its substation containment.
- DcGround
- A connection from one DC node to ground.
- DcLine
- A line segment between two DC nodes.
- DcNode
- A physical node in a DC network.
- DcSeries
Device - A CGMES DC series device.
- DcSwitch
- A switch between two DC nodes.
- DcTerminal
- One terminal of DC conducting equipment.
- DcTopological
Node - An energized connectivity node in a CGMES DC network.
- Detailed
Connectivity - Source neutral hierarchy and detailed connectivity retained beside the balanced calculation view.
- Droop
Curve - DC voltage droop segments for an AC/DC converter.
- Droop
Curve Segment - One segment of an AC/DC converter’s DC voltage droop curve.
- Equipment
Reactive Limits - Reactive limits retained for equipment whose balanced calculation row carries only the limits evaluated at its current active power assignment.
- External
Identifier - An identifier assigned by another data system or authority.
- GenCost
- A generator cost curve (
mpc.gencostrow). - Generator
- Hvdc
- Hvdc
Converter - One AC terminal converter station of an HVDC line.
- Impedance
- A series impedance with the MVA base it is expressed on. Used pairwise by
Transformer3W; a self-contained unit so the base travels with the value instead of being implied by position. - Internal
Connection - A permanent connection between two node breaker connectivity nodes.
- Junction
- A CIM junction and its conducting equipment identity.
- Line
Commutated Converter - A line commutated converter connected to an AC voltage level and two DC nodes.
- Load
- Loading
Limits - A permanent loading limit and its named temporary limits.
- MinMax
Reactive Limits - Reactive power limits that do not vary with active power.
- Omitted
Field - A field that was absent from a source representation.
- Operational
Limit Group - One named set of loading limits at an equipment terminal.
- Reactive
Capability Curve - Reactive power limits that vary with active power.
- Reactive
Capability Curve Point - One point of a reactive capability curve.
- Shunt
- Shunt
Block - One block of a switched shunt:
stepsequal admittance increments. - Solver
Params - Solver / solution-control metadata: the Newton tolerance and iteration cap, the zero-impedance threshold, and the per-quantity adjustment-enable flags.
- Static
VarCompensator - A static VAR compensator connected to one balanced network bus.
- Storage
- Subnetwork
- One PowSybl subnetwork contained directly by a balanced network.
- Substation
- A substation containing one or more voltage levels.
- Switch
- A transmission switch. Closed switches are preserved as data; matrix builders do not lower them into zero impedance branches.
- Switched
Shunt Control - Switching-control data for a switched shunt (
Shunt::control): the mode, the regulated voltage band and bus, the reactive-range percentage, and the adjustable susceptance blocks. The shunt’sbis the initial value within the blocks’ total range. - TapChanger
- A ratio or phase tap changer attached to one transformer winding.
- TapChanger
Step - One transformer tap changer step.
- Temporary
Limit - One temporary loading limit inside an
OperationalLimitGroup. - Terminal
- One equipment terminal and its bus breaker or node breaker connection.
- Terminal
Reference - A reference to one numbered terminal of an equipment record.
- TieLine
- A PowSybl tie line and the two boundary lines that define it.
- Topology
Switch - A switch in the authoritative bus breaker or node breaker topology.
- Transformer3W
- A three winding transformer with three terminal buses joined at a star point.
- Transformer
Control - Automatic-control data for a regulating transformer (
Branch::control). - Voltage
Level - A voltage level and its voltage limits in kV.
- Voltage
Source Converter - A voltage source converter connected to an AC voltage level and two DC nodes.
- Winding
- One winding of a
Transformer3W: its terminal bus, off-nominal ratio, phase shift, nominal voltage, and thermal ratings.
Enums§
- AcDc
Converter Control Mode - Control quantity assigned to an AC/DC converter.
- BusType
- Bus type per MATPOWER convention: 1=PQ, 2=PV, 3=ref/slack, 4=isolated.
- Curve
Style - CIM
CurveStylefor a reactive capability curve. - DcConverter
Operating Mode - The operating arrangement of one CGMES DC converter unit.
- DcPolarity
- Polarity assigned to an AC/DC converter DC terminal.
- DcSwitch
Kind - Physical kind of a DC switch.
- Generator
Energy Source - Primary energy source used by generating equipment.
- Hvdc
Converter Kind - Converter technology used at both ends of one HVDC line.
- Hvdc
Converters Mode - A two-terminal HVDC line (MATPOWER
dcline). - Line
Commutated Converter Operating Mode - Rectifier or inverter operation assigned to a line commutated converter.
- Line
Commutated Converter Reactive Model - Reactive power model used by a line commutated converter.
- Load
Voltage Model - Voltage dependence for a transmission load.
- Omitted
Field Name - The name of a field omitted by a source representation.
- Reactive
Limits - The two reactive limit forms carried by XIIDM equipment.
- Source
Format - Which format a
BalancedNetworkwas read from. Drives the same format byte exact echo on write. - Static
VarCompensator Regulation Mode - The controlled quantity of a static VAR compensator.
- Switch
Kind - Physical kind of a breaker topology switch.
- Switched
Shunt Mode - How a switched shunt adjusts its susceptance. Maps to the PSS/E
MODSWcode. - TapChanger
Kind - Whether a transformer tap changer controls voltage ratio or phase angle.
- TapChanger
Regulation Mode - The electrical quantity regulated by a transformer tap changer.
- Topology
Endpoint - One endpoint of a detailed topology switch.
- Topology
Kind - The connectivity representation used inside a voltage level.
- Transformer
Control Mode - What a regulating transformer’s tap (or phase shift) automatically controls.
Maps to the PSS/E control code
CODand the PSLF transformertype.
Constants§
- DEFAULT_
BASE_ FREQUENCY - System base frequency in hertz when a format records none. Power networks run at 50 or 60 Hz; 60 is the default for the formats (MATPOWER, PowerModels, egret) that carry no frequency field.
Functions§
- calc_
series_ admittance_ of - The series admittance
(g, b)of an impedance, guarded. - repair_
values - Clamp every out-of-domain value of a parsed module to its repaired value
and record the pass: one
Repairhistory entry naming each change in its parameters, and oneVALIDATE.BALANCED.VALUE_DOMAINfinding per repaired field. The retained source is severed — the value no longer matches the bytes, so a same format write serializes the repaired network rather than echoing the input. A module already in domain comes back unchanged.