powerio_tx/

network.rs

//! 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`](crate::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.

use std::collections::{BTreeMap, BTreeSet, HashMap, HashSet};

use powerio_core::ComponentId;
use serde::{Deserialize, Serialize};
use serde_json::Value;

use crate::geo::{GeoMeta, Location};
use crate::{Error, Result};

mod transformer_3w_serde;

/// Source format fields the neutral model does not name, kept for round trips
/// and cross format conversion. Keys are field names; values are JSON scalars.
pub type Extras = BTreeMap<String, Value>;

/// An alternate name for a component, with the optional source supplied alias type.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct ComponentAlias {
    pub value: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub alias_type: Option<String>,
}

/// An identifier assigned by another data system or authority.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct ExternalIdentifier {
    pub value: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub authority: Option<String>,
}

/// Source neutral metadata attached to one stable PowerIO component identity.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct ComponentMetadata {
    pub component: ComponentId,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// The equipment container that owns this component, when the source model
    /// identifies one.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub equipment_container: Option<ComponentId>,
    #[serde(default)]
    pub aliases: Vec<ComponentAlias>,
    #[serde(default)]
    pub external_identifiers: Vec<ExternalIdentifier>,
    #[serde(default)]
    pub properties: BTreeMap<String, String>,
    #[serde(default)]
    pub fictitious: bool,
}

/// A substation containing one or more voltage levels.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct Substation {
    pub component: ComponentId,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub country: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub operator: Option<String>,
    #[serde(default)]
    pub geographical_tags: Vec<String>,
}

/// The connectivity representation used inside a voltage level.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum TopologyKind {
    BusBreaker,
    NodeBreaker,
}

/// A voltage level and its voltage limits in kV.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct VoltageLevel {
    pub component: ComponentId,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub substation: Option<ComponentId>,
    pub nominal_kv: f64,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub low_voltage_limit_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub high_voltage_limit_kv: Option<f64>,
    pub topology_kind: TopologyKind,
    /// Buses in the balanced calculation view that belong to this voltage level.
    #[serde(default)]
    pub buses: Vec<BusId>,
}

/// One connectivity node in a node breaker voltage level.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct ConnectivityNode {
    pub component: ComponentId,
    pub voltage_level: ComponentId,
    /// Integer node number when the source uses node breaker numbering, as in
    /// XIIDM and RAWX. Identity based sources such as CGMES leave this unset.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub node_number: Option<i32>,
    /// The energized bus in the balanced calculation view, when one is known.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub calculated_bus: Option<BusId>,
}

/// One configured bus in a bus breaker voltage level and the energized bus
/// it contributes to in the balanced calculation view.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct BusBreakerBus {
    pub component: ComponentId,
    pub voltage_level: ComponentId,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub calculated_bus: Option<BusId>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub voltage_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub angle_degrees: Option<f64>,
}

/// One calculated bus explicitly recorded in node breaker topology.
///
/// XIIDM calls this record `CalculatedBus`. Its node list distinguishes a bus
/// present in the source from a connected component PowerIO calculated when
/// the source omitted the record.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct CalculatedBus {
    pub voltage_level: ComponentId,
    pub calculated_bus: BusId,
    pub nodes: Vec<ComponentId>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub voltage_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub angle_degrees: Option<f64>,
}

/// A busbar section attached to a node breaker connectivity node.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct BusbarSection {
    pub component: ComponentId,
    pub voltage_level: ComponentId,
    pub node: ComponentId,
}

/// A CIM junction and its conducting equipment identity.
///
/// Its electrical connection is recorded by the corresponding entries in
/// [`DetailedConnectivity::terminals`].
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct Junction {
    pub component: ComponentId,
}

/// One equipment terminal and its bus breaker or node breaker connection.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct Terminal {
    /// The terminal's own identity when the source assigns one.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub component: Option<ComponentId>,
    pub equipment: ComponentId,
    /// One for single terminal equipment, or the branch/transformer side number.
    pub terminal: u8,
    pub voltage_level: ComponentId,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub bus: Option<ComponentId>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub connectable_bus: Option<ComponentId>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub node: Option<ComponentId>,
    pub connected: bool,
    /// Active power injected at this AC terminal, in MW.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub active_power_mw: Option<f64>,
    /// Reactive power injected at this AC terminal, in MVAr.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub reactive_power_mvar: Option<f64>,
}

/// Physical kind of a breaker topology switch.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum SwitchKind {
    Breaker,
    Disconnector,
    LoadBreakSwitch,
}

/// One endpoint of a detailed topology switch.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(tag = "kind", content = "component", rename_all = "snake_case")]
#[non_exhaustive]
pub enum TopologyEndpoint {
    Bus(ComponentId),
    Node(ComponentId),
}

/// A switch in the authoritative bus breaker or node breaker topology.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct TopologySwitch {
    pub component: ComponentId,
    pub voltage_level: ComponentId,
    pub kind: SwitchKind,
    pub endpoint1: TopologyEndpoint,
    pub endpoint2: TopologyEndpoint,
    pub open: bool,
    #[serde(default)]
    pub retained: bool,
}

/// A permanent connection between two node breaker connectivity nodes.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct InternalConnection {
    pub voltage_level: ComponentId,
    pub node1: ComponentId,
    pub node2: ComponentId,
}

/// A reference to one numbered terminal of an equipment record.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct TerminalReference {
    pub equipment: ComponentId,
    pub terminal: u8,
}

/// The operating arrangement of one CGMES DC converter unit.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum DcConverterOperatingMode {
    Bipolar,
    MonopolarGroundReturn,
    MonopolarMetallicReturn,
}

/// A CGMES DC converter unit and its substation containment.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct DcConverterUnit {
    pub component: ComponentId,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub substation: Option<ComponentId>,
    pub operation_mode: DcConverterOperatingMode,
}

/// An energized connectivity node in a CGMES DC network.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct DcTopologicalNode {
    pub component: ComponentId,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dc_converter_unit: Option<ComponentId>,
}

/// Polarity assigned to an AC/DC converter DC terminal.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum DcPolarity {
    Positive,
    Middle,
    Negative,
}

/// One terminal of DC conducting equipment.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct DcTerminal {
    /// The terminal's own identity when the source assigns one.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub component: Option<ComponentId>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub sequence_number: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dc_node: Option<ComponentId>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dc_topological_node: Option<ComponentId>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub polarity: Option<DcPolarity>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub connected: Option<bool>,
    /// Active power injected at this terminal, in MW.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub active_power_mw: Option<f64>,
    /// Current injected at this terminal, in A.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub current_a: Option<f64>,
}

/// A physical node in a DC network.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct DcNode {
    pub component: ComponentId,
    /// XIIDM nominal voltage. CGMES DC nodes do not carry this quantity.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub nominal_voltage_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dc_converter_unit: Option<ComponentId>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dc_topological_node: Option<ComponentId>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub voltage_kv: Option<f64>,
}

/// A connection from one DC node to ground.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct DcGround {
    pub component: ComponentId,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub equipment_container: Option<ComponentId>,
    pub dc_terminal: DcTerminal,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub rated_dc_voltage_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub resistance_ohm: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub inductance_h: Option<f64>,
}

/// A CGMES DC busbar.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct DcBusbar {
    pub component: ComponentId,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub equipment_container: Option<ComponentId>,
    pub dc_terminal: DcTerminal,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub rated_dc_voltage_kv: Option<f64>,
}

/// A line segment between two DC nodes.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct DcLine {
    pub component: ComponentId,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub equipment_container: Option<ComponentId>,
    pub dc_terminal1: DcTerminal,
    pub dc_terminal2: DcTerminal,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub rated_dc_voltage_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub resistance_ohm: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub inductance_h: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub capacitance_f: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub length_km: Option<f64>,
}

/// A CGMES DC series device.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct DcSeriesDevice {
    pub component: ComponentId,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub equipment_container: Option<ComponentId>,
    pub dc_terminal1: DcTerminal,
    pub dc_terminal2: DcTerminal,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub rated_dc_voltage_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub resistance_ohm: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub inductance_h: Option<f64>,
}

/// Physical kind of a DC switch.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum DcSwitchKind {
    Switch,
    Breaker,
    Disconnector,
}

/// A switch between two DC nodes.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct DcSwitch {
    pub component: ComponentId,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub equipment_container: Option<ComponentId>,
    pub dc_terminal1: DcTerminal,
    pub dc_terminal2: DcTerminal,
    pub kind: DcSwitchKind,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub rated_dc_voltage_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub open: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub resistance_ohm: Option<f64>,
}

/// Control quantity assigned to an AC/DC converter.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum AcDcConverterControlMode {
    /// Maintain active power at the point of common coupling.
    ActivePowerAtPcc,
    /// Maintain DC voltage.
    DcVoltage,
    /// Maintain DC current.
    DcCurrent,
    /// XIIDM `P_PCC_DROOP`: active power at the point of common coupling
    /// follows a piecewise droop curve over DC voltage.
    ActivePowerAtPccAndDcVoltageDroopCurve,
    /// CGMES `VsPpccControlKind.pPccAndUdcDroop`.
    ActivePowerAtPccAndDcVoltageDroop,
    /// CGMES `VsPpccControlKind.pPccAndUdcDroopWithCompensation`.
    ActivePowerAtPccAndDcVoltageDroopWithCompensation,
    /// CGMES `VsPpccControlKind.pPccAndUdcDroopPilot`.
    ActivePowerAtPccAndDcVoltageDroopPilot,
}

/// One segment of an AC/DC converter's DC voltage droop curve.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct DroopCurveSegment {
    pub minimum_voltage_kv: f64,
    pub maximum_voltage_kv: f64,
    pub k: f64,
}

/// DC voltage droop segments for an AC/DC converter.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct DroopCurve {
    pub segments: Vec<DroopCurveSegment>,
}

/// One point of a reactive capability curve.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct ReactiveCapabilityCurvePoint {
    pub active_power_mw: f64,
    pub minimum_reactive_power_mvar: f64,
    pub maximum_reactive_power_mvar: f64,
    #[serde(default)]
    pub properties: BTreeMap<String, String>,
}

/// CIM `CurveStyle` for a reactive capability curve.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum CurveStyle {
    /// CIM `CurveStyle.constantYValue`.
    ConstantYValue,
    /// CIM `CurveStyle.straightLineYValues`.
    StraightLineYValues,
}

/// Reactive power limits that vary with active power.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct ReactiveCapabilityCurve {
    pub curve_style: CurveStyle,
    #[serde(default)]
    pub properties: BTreeMap<String, String>,
    pub points: Vec<ReactiveCapabilityCurvePoint>,
}

/// Reactive power limits that do not vary with active power.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct MinMaxReactiveLimits {
    pub minimum_reactive_power_mvar: f64,
    pub maximum_reactive_power_mvar: f64,
    #[serde(default)]
    pub properties: BTreeMap<String, String>,
}

/// The two reactive limit forms carried by XIIDM equipment.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(tag = "kind", content = "limits", rename_all = "snake_case")]
#[non_exhaustive]
pub enum ReactiveLimits {
    MinMax(MinMaxReactiveLimits),
    CapabilityCurve(ReactiveCapabilityCurve),
}

/// Evaluate reactive limits at one active power assignment. Format readers use
/// this shared calculation when projecting a capability curve onto the
/// balanced generator row.
#[allow(clippy::float_cmp, clippy::manual_midpoint)]
pub(crate) fn calc_reactive_limits_at_active_power(
    owner: &str,
    limits: &ReactiveLimits,
    active_power_mw: f64,
) -> std::result::Result<(f64, f64), String> {
    match limits {
        ReactiveLimits::MinMax(limits) => {
            if limits.minimum_reactive_power_mvar > limits.maximum_reactive_power_mvar {
                return Err(format!("{owner} has minQ greater than maxQ"));
            }
            Ok((
                limits.minimum_reactive_power_mvar,
                limits.maximum_reactive_power_mvar,
            ))
        }
        ReactiveLimits::CapabilityCurve(curve) => {
            if curve.points.len() < 2 {
                return Err(format!(
                    "{owner} reactiveCapabilityCurve has fewer than two points"
                ));
            }
            if !active_power_mw.is_finite() {
                return Err(format!(
                    "{owner} reactiveCapabilityCurve cannot be evaluated at a nonfinite active power"
                ));
            }
            let mut points = curve.points.iter().collect::<Vec<_>>();
            points
                .sort_by(|first, second| first.active_power_mw.total_cmp(&second.active_power_mw));
            for pair in points.windows(2) {
                if pair[0].active_power_mw == pair[1].active_power_mw {
                    return Err(format!(
                        "{owner} reactiveCapabilityCurve has duplicate active power points"
                    ));
                }
            }
            let (first, second) = if active_power_mw <= points[0].active_power_mw {
                (points[0], points[0])
            } else if active_power_mw >= points[points.len() - 1].active_power_mw {
                (points[points.len() - 1], points[points.len() - 1])
            } else {
                let upper = points.partition_point(|point| point.active_power_mw < active_power_mw);
                (points[upper - 1], points[upper])
            };
            let (minimum, maximum) = if std::ptr::eq(first, second) {
                (
                    first.minimum_reactive_power_mvar,
                    first.maximum_reactive_power_mvar,
                )
            } else {
                let fraction = (active_power_mw - first.active_power_mw)
                    / (second.active_power_mw - first.active_power_mw);
                (
                    first.minimum_reactive_power_mvar
                        + fraction
                            * (second.minimum_reactive_power_mvar
                                - first.minimum_reactive_power_mvar),
                    first.maximum_reactive_power_mvar
                        + fraction
                            * (second.maximum_reactive_power_mvar
                                - first.maximum_reactive_power_mvar),
                )
            };
            if minimum <= maximum {
                Ok((minimum, maximum))
            } else {
                let midpoint = (minimum + maximum) / 2.0;
                Ok((midpoint, midpoint))
            }
        }
    }
}

/// Reactive limits retained for equipment whose balanced calculation row
/// carries only the limits evaluated at its current active power assignment.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct EquipmentReactiveLimits {
    pub equipment: ComponentId,
    pub limits: ReactiveLimits,
}

/// Optional generation attached to a PowSybl boundary line.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct BoundaryLineGeneration {
    pub voltage_regulation_on: bool,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub minimum_active_power_mw: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub maximum_active_power_mw: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub target_active_power_mw: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub target_reactive_power_mvar: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub target_voltage_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub reactive_limits: Option<ReactiveLimits>,
}

/// One PowSybl boundary line retained beside the balanced calculation view.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct BoundaryLine {
    pub component: ComponentId,
    pub voltage_level: ComponentId,
    pub active_power_setpoint_mw: f64,
    pub reactive_power_setpoint_mvar: f64,
    pub resistance_ohm: f64,
    pub reactance_ohm: f64,
    pub conductance_siemens: f64,
    pub susceptance_siemens: f64,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub pairing_key: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub generation: Option<BoundaryLineGeneration>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub calculation_load: Option<ComponentId>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub calculation_generator: Option<ComponentId>,
}

/// A PowSybl tie line and the two boundary lines that define it.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct TieLine {
    pub component: ComponentId,
    pub boundary_line1: ComponentId,
    pub boundary_line2: ComponentId,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub calculation_branch: Option<ComponentId>,
}

/// A voltage source converter connected to an AC voltage level and two DC nodes.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct VoltageSourceConverter {
    pub component: ComponentId,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dc_converter_unit: Option<ComponentId>,
    pub dc_terminal1: DcTerminal,
    pub dc_terminal2: DcTerminal,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub base_apparent_power_mva: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub minimum_active_power_mw: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub maximum_active_power_mw: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub minimum_dc_voltage_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub maximum_dc_voltage_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub rated_dc_voltage_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub valve_u0_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub number_of_valves: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub idle_loss_mw: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub switching_loss_mw_per_ampere: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub resistive_loss_ohm: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub control_mode: Option<AcDcConverterControlMode>,
    /// Active power at the point of common coupling, using load sign convention.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub active_power_at_pcc_mw: Option<f64>,
    /// Reactive power at the point of common coupling, using load sign convention.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub reactive_power_at_pcc_mvar: Option<f64>,
    /// Active power target at the point of common coupling, using load sign convention.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub target_active_power_mw: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub target_dc_voltage_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub pcc_terminal: Option<TerminalReference>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub droop_curve: Option<DroopCurve>,
    /// CGMES scalar droop. This is not the XIIDM piecewise [`DroopCurve`].
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub droop: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub droop_compensation: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub q_share: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub maximum_modulation_index: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub maximum_valve_current_a: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub voltage_regulator_on: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub voltage_setpoint_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub reactive_power_setpoint_mvar: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub reactive_limits: Option<ReactiveLimits>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub pole_loss_active_power_mw: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dc_current_a: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ac_voltage_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dc_voltage_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub delta_degrees: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub uf_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub uv_kv: Option<f64>,
}

/// Reactive power model used by a line commutated converter.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum LineCommutatedConverterReactiveModel {
    FixedPowerFactor,
    CalculatedPowerFactor,
}

/// Rectifier or inverter operation assigned to a line commutated converter.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum LineCommutatedConverterOperatingMode {
    Rectifier,
    Inverter,
}

/// A line commutated converter connected to an AC voltage level and two DC nodes.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct LineCommutatedConverter {
    pub component: ComponentId,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dc_converter_unit: Option<ComponentId>,
    pub dc_terminal1: DcTerminal,
    pub dc_terminal2: DcTerminal,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub base_apparent_power_mva: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub minimum_active_power_mw: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub maximum_active_power_mw: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub minimum_dc_voltage_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub maximum_dc_voltage_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub rated_dc_voltage_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub valve_u0_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub number_of_valves: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub idle_loss_mw: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub switching_loss_mw_per_ampere: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub resistive_loss_ohm: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub control_mode: Option<AcDcConverterControlMode>,
    /// Active power at the point of common coupling, using load sign convention.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub active_power_at_pcc_mw: Option<f64>,
    /// Reactive power at the point of common coupling, using load sign convention.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub reactive_power_at_pcc_mvar: Option<f64>,
    /// Active power target at the point of common coupling, using load sign convention.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub target_active_power_mw: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub target_dc_voltage_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub pcc_terminal: Option<TerminalReference>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub droop_curve: Option<DroopCurve>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub reactive_model: Option<LineCommutatedConverterReactiveModel>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub power_factor: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub operating_mode: Option<LineCommutatedConverterOperatingMode>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub rated_dc_current_a: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub minimum_alpha_degrees: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub maximum_alpha_degrees: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub minimum_gamma_degrees: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub maximum_gamma_degrees: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub target_alpha_degrees: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub target_gamma_degrees: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub target_dc_current_a: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub pole_loss_active_power_mw: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dc_current_a: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ac_voltage_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dc_voltage_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub alpha_degrees: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub gamma_degrees: Option<f64>,
}

/// One temporary loading limit inside an [`OperationalLimitGroup`].
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct TemporaryLimit {
    pub name: String,
    pub value: f64,
    pub acceptable_duration_seconds: u64,
    #[serde(default)]
    pub fictitious: bool,
}

/// A permanent loading limit and its named temporary limits.
///
/// The unit is selected by the field that contains this record: amperes for
/// `current_limits`, MW for `active_power_limits`, and MVA for
/// `apparent_power_limits`.
#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct LoadingLimits {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub permanent_limit: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub permanent_limit_name: Option<String>,
    #[serde(default)]
    pub temporary_limits: Vec<TemporaryLimit>,
}

/// One named set of loading limits at an equipment terminal.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct OperationalLimitGroup {
    pub equipment: ComponentId,
    pub terminal: u8,
    pub id: String,
    #[serde(default)]
    pub properties: BTreeMap<String, String>,
    #[serde(default)]
    pub selected: bool,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub current_limits: Option<LoadingLimits>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub active_power_limits: Option<LoadingLimits>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub apparent_power_limits: Option<LoadingLimits>,
}

/// Whether a transformer tap changer controls voltage ratio or phase angle.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum TapChangerKind {
    Ratio,
    Phase,
}

/// The electrical quantity regulated by a transformer tap changer.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum TapChangerRegulationMode {
    Voltage,
    ReactivePower,
    ActivePower,
    Current,
}

/// One transformer tap changer step.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct TapChangerStep {
    pub position: i32,
    /// Voltage ratio in per unit.
    pub rho: f64,
    /// Phase angle difference in degrees.
    pub alpha_degrees: f64,
    /// Resistance deviation from the transformer's nominal value, in percent.
    pub resistance_deviation_percent: f64,
    /// Reactance deviation from the transformer's nominal value, in percent.
    pub reactance_deviation_percent: f64,
    /// Conductance deviation from the transformer's nominal value, in percent.
    pub conductance_deviation_percent: f64,
    /// Susceptance deviation from the transformer's nominal value, in percent.
    pub susceptance_deviation_percent: f64,
}

/// A ratio or phase tap changer attached to one transformer winding.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct TapChanger {
    /// The tap changer's own identity when the source assigns one.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub component: Option<ComponentId>,
    pub transformer: ComponentId,
    /// One for a two winding transformer, or one through three for a three
    /// winding transformer.
    pub winding: u8,
    pub kind: TapChangerKind,
    /// Assigned tap position. XIIDM permits this to be absent for cases whose
    /// minimum validation level is `EQUIPMENT`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub tap_position: Option<i32>,
    /// Solved tap position when a source records it separately from the
    /// assigned tap position.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub solved_tap_position: Option<i32>,
    pub low_tap_position: i32,
    /// Tap position at which the ratio or phase shift is neutral.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub neutral_tap_position: Option<i32>,
    /// Normal tap position declared by the equipment model.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub normal_tap_position: Option<i32>,
    /// Voltage increment per tap position, in percent, for ratio and
    /// nonlinear phase tap changers.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub voltage_step_increment_percent: Option<f64>,
    pub load_tap_changing_capabilities: bool,
    pub regulating: bool,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub regulation_mode: Option<TapChangerRegulationMode>,
    /// kV, MVAr, MW, or A according to `regulation_mode`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub regulation_value: Option<f64>,
    /// Deadband in the same unit as `regulation_value`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub target_deadband: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub regulation_terminal: Option<TerminalReference>,
    pub steps: Vec<TapChangerStep>,
}

/// Source neutral case metadata recorded by a grid exchange format.
#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct CaseMetadata {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub case_date: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub forecast_distance: Option<i32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub source_model_format: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub minimum_validation_level: Option<String>,
}

/// One PowSybl subnetwork contained directly by a balanced network.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct Subnetwork {
    pub component: ComponentId,
    pub parent: ComponentId,
    pub case_metadata: CaseMetadata,
    #[serde(default)]
    pub components: Vec<ComponentId>,
}

/// The name of a field omitted by a source representation.
///
/// The balanced calculation view keeps an ordinary numeric value for these
/// fields. This metadata lets an emitter preserve the distinction between a
/// field that was absent and one that was explicitly set to that value.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum OmittedFieldName {
    ActivePower,
    ReactivePower,
    VoltageSetpoint,
    RatedApparentPower,
    ShuntConductancePerSection,
}

/// A field that was absent from a source representation.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct OmittedField {
    pub component: ComponentId,
    pub field: OmittedFieldName,
}

impl OmittedField {
    #[must_use]
    pub fn new(component: ComponentId, field: OmittedFieldName) -> Self {
        Self { component, field }
    }
}

/// Source neutral hierarchy and detailed connectivity retained beside the
/// balanced calculation view.
#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct DetailedConnectivity {
    /// Source fields whose absence must remain distinct from an explicit
    /// numeric zero or default value during fresh emission.
    #[serde(default)]
    pub omitted_fields: Vec<OmittedField>,
    #[serde(default)]
    pub component_metadata: Vec<ComponentMetadata>,
    #[serde(default)]
    pub subnetworks: Vec<Subnetwork>,
    #[serde(default)]
    pub substations: Vec<Substation>,
    #[serde(default)]
    pub voltage_levels: Vec<VoltageLevel>,
    #[serde(default)]
    pub bus_breaker_buses: Vec<BusBreakerBus>,
    #[serde(default)]
    pub calculated_buses: Vec<CalculatedBus>,
    #[serde(default)]
    pub connectivity_nodes: Vec<ConnectivityNode>,
    #[serde(default)]
    pub busbar_sections: Vec<BusbarSection>,
    #[serde(default)]
    pub junctions: Vec<Junction>,
    #[serde(default)]
    pub terminals: Vec<Terminal>,
    #[serde(default)]
    pub switches: Vec<TopologySwitch>,
    #[serde(default)]
    pub internal_connections: Vec<InternalConnection>,
    #[serde(default)]
    pub operational_limit_groups: Vec<OperationalLimitGroup>,
    #[serde(default)]
    pub tap_changers: Vec<TapChanger>,
    #[serde(default)]
    pub equipment_reactive_limits: Vec<EquipmentReactiveLimits>,
    #[serde(default)]
    pub boundary_lines: Vec<BoundaryLine>,
    #[serde(default)]
    pub tie_lines: Vec<TieLine>,
    #[serde(default)]
    pub dc_converter_units: Vec<DcConverterUnit>,
    #[serde(default)]
    pub dc_topological_nodes: Vec<DcTopologicalNode>,
    #[serde(default)]
    pub dc_nodes: Vec<DcNode>,
    #[serde(default)]
    pub dc_grounds: Vec<DcGround>,
    #[serde(default)]
    pub dc_busbars: Vec<DcBusbar>,
    #[serde(default)]
    pub dc_lines: Vec<DcLine>,
    #[serde(default)]
    pub dc_series_devices: Vec<DcSeriesDevice>,
    #[serde(default)]
    pub dc_switches: Vec<DcSwitch>,
    #[serde(default)]
    pub voltage_source_converters: Vec<VoltageSourceConverter>,
    #[serde(default)]
    pub line_commutated_converters: Vec<LineCommutatedConverter>,
}

/// 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.
pub const DEFAULT_BASE_FREQUENCY: f64 = 60.0;

/// serde default for [`BalancedNetwork::base_frequency`], so JSON written before the
/// field existed still deserializes (the C ABI and Julia bridge ride on the JSON
/// transport).
fn default_base_frequency() -> f64 {
    DEFAULT_BASE_FREQUENCY
}

/// A source bus ID, preserved from the input format.
///
/// MATPOWER IDs are 1-based and can contain gaps. They are distinct from the
/// zero based dense indices produced by
/// [`IndexedNetwork::bus_index`](crate::IndexedNetwork::bus_index). JSON stores
/// this type as an integer.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(transparent)]
pub struct BusId(pub usize);

impl BusId {
    /// The largest id a network may carry. The C ABI reports bus ids as int64,
    /// so an id past this ceiling has no distinct value there;
    /// [`BalancedNetwork::validate`] refuses one.
    pub const MAX: Self = Self(i64::MAX as usize);

    #[must_use]
    pub const fn new(id: usize) -> Self {
        Self(id)
    }
}

impl std::fmt::Display for BusId {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        self.0.fmt(f)
    }
}

/// Bus type per MATPOWER convention: 1=PQ, 2=PV, 3=ref/slack, 4=isolated.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "UPPERCASE")]
#[repr(u8)]
#[non_exhaustive]
pub enum BusType {
    Pq = 1,
    Pv = 2,
    Ref = 3,
    Isolated = 4,
}

impl BusType {
    /// Map a MATPOWER bus-type code to the enum; unknown codes fall back to PQ.
    pub(crate) fn from_f64(v: f64) -> Self {
        match v as i32 {
            2 => Self::Pv,
            3 => Self::Ref,
            4 => Self::Isolated,
            _ => Self::Pq,
        }
    }

    /// The canonical short name (`"PQ"`, `"PV"`, `"REF"`, `"ISOLATED"`), shared
    /// by the bindings so their bus-type strings can't drift.
    #[must_use]
    pub fn as_str(self) -> &'static str {
        match self {
            Self::Pq => "PQ",
            Self::Pv => "PV",
            Self::Ref => "REF",
            Self::Isolated => "ISOLATED",
        }
    }
}

/// A generator cost curve (`mpc.gencost` row).
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct GenCost {
    /// 1 = piecewise linear, 2 = polynomial.
    pub model: u8,
    pub startup: f64,
    pub shutdown: f64,
    /// Number of cost coefficients (polynomial) or breakpoints (piecewise).
    pub ncost: usize,
    /// Raw coefficients, highest order first for the polynomial model:
    /// `[c_{k-1}, …, c1, c0]`.
    pub coeffs: Vec<f64>,
}

impl GenCost {
    /// Build a cost row from the values carried after `ncost`.
    ///
    /// Polynomial rows (`model == 2`) store `ncost` coefficients. Piecewise
    /// linear rows (`model == 1`) store flattened `(x, y)` breakpoint pairs, so
    /// `ncost` is half the coefficient count. Use [`GenCost::with_ncost`] for
    /// malformed source rows or callers that need to preserve an explicit
    /// `ncost`.
    #[must_use]
    pub fn new(model: u8, startup: f64, shutdown: f64, coeffs: Vec<f64>) -> Self {
        let ncost = if model == 1 {
            coeffs.len() / 2
        } else {
            coeffs.len()
        };
        Self {
            model,
            startup,
            shutdown,
            ncost,
            coeffs,
        }
    }

    #[must_use]
    pub fn with_ncost(
        model: u8,
        startup: f64,
        shutdown: f64,
        ncost: usize,
        coeffs: Vec<f64>,
    ) -> Self {
        Self {
            model,
            startup,
            shutdown,
            ncost,
            coeffs,
        }
    }

    /// `(q, c)` for the quadratic cost `½ q p² + c p` from a polynomial
    /// (model 2) row. MATPOWER stores `c2 p² + c1 p + c0`, so `q = 2·c2` and
    /// `c = c1`. Linear rows (`ncost == 2`) give `q = 0`. Piecewise (model 1)
    /// or cubic and higher return `None`.
    pub fn calc_quadratic(&self) -> Option<(f64, f64)> {
        self.calc_quadratic_with_constant().map(|(q, c, _)| (q, c))
    }

    /// `(q, c, c0)` for the quadratic cost `½ q p² + c p + c0` from a
    /// polynomial (model 2) row, keeping the constant term that
    /// [`calc_quadratic`](Self::calc_quadratic) drops. Linear rows (`ncost == 2`) give
    /// `q = 0`; constant rows (`ncost == 1`) give `q = c = 0`. Piecewise
    /// (model 1) or cubic and higher return `None`.
    pub fn calc_quadratic_with_constant(&self) -> Option<(f64, f64, f64)> {
        if self.model != 2 {
            return None;
        }
        // Reject a row whose coefficient slice is shorter than `ncost` claims,
        // rather than reading the wrong powers by position.
        if self.coeffs.len() < self.ncost {
            return None;
        }
        // Matches on the stated arity, so a cubic row is refused even when its
        // leading coefficient is zero. `quadratic_with_constant_tol` is the
        // reader that lowers the order first.
        match self.ncost {
            3 => Some((2.0 * self.coeffs[0], self.coeffs[1], self.coeffs[2])),
            2 => Some((0.0, self.coeffs[0], self.coeffs[1])),
            1 => Some((0.0, 0.0, self.coeffs[0])),
            _ => None,
        }
    }

    /// Largest leading polynomial coefficient that
    /// [`calc_quadratic_with_constant_tol`](Self::calc_quadratic_with_constant_tol)
    /// reads as a rounding artifact of the source, not as a term of the curve.
    pub const LEADING_COEFF_TOL: f64 = 1e-12;

    /// `(q, c, c0)` as [`calc_quadratic_with_constant`](Self::calc_quadratic_with_constant)
    /// gives it, after the leading coefficients at or below `tol` come off the
    /// row.
    ///
    /// A model 2 row often carries a leading coefficient near `1e-17`, which
    /// the source produced by rounding. Such a row states a linear curve and
    /// reads as a quadratic one. Pass
    /// [`LEADING_COEFF_TOL`](Self::LEADING_COEFF_TOL) to strip the artifact,
    /// or `0.0` to strip an exact zero alone.
    pub fn calc_quadratic_with_constant_tol(&self, tol: f64) -> Option<(f64, f64, f64)> {
        if self.model != 2 {
            return None;
        }
        if self.coeffs.len() < self.ncost {
            return None;
        }
        let row = &self.coeffs[..self.ncost];
        let mut first = 0;
        while first + 1 < row.len() && row[first].abs() <= tol {
            first += 1;
        }
        match row.len() - first {
            3 => Some((2.0 * row[first], row[first + 1], row[first + 2])),
            2 => Some((0.0, row[first], row[first + 1])),
            1 => Some((0.0, 0.0, row[first])),
            _ => None,
        }
    }
}

/// Which format a [`BalancedNetwork`] was read from. Drives the same format byte exact
/// echo on write.
///
/// Serializes as the same lowercase token [`name`](SourceFormat::name) reports
/// and every string entry point accepts.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub enum SourceFormat {
    #[serde(rename = "matpower")]
    Matpower,
    #[serde(rename = "powermodels-json")]
    PowerModelsJson,
    #[serde(rename = "egret-json")]
    EgretJson,
    #[serde(rename = "psse")]
    Psse,
    /// Read from the PSS/E revision 35 JSON grid exchange format.
    #[serde(rename = "psse-rawx")]
    PsseRawx,
    #[serde(rename = "powerworld")]
    PowerWorld,
    #[serde(rename = "pandapower-json")]
    PandapowerJson,
    /// Read from a GE PSLF `.epc` case. Same source text is retained, so a
    /// same-format write echoes it byte-for-byte; a cross-format or
    /// source-dropped write goes through the internal `.epc` serializer.
    #[serde(rename = "pslf")]
    Pslf,
    /// Read from a PowerWorld `.pwb` binary case. Read only: there is no
    /// `.pwb` writer and no retained source text, so writing goes through
    /// another format's writer.
    #[serde(rename = "powerworld-pwb")]
    PowerWorldBinary,
    /// Built in memory, for example from synth or an edited case; no source text.
    #[serde(rename = "in-memory")]
    InMemory,
    /// A normalized derived form ([`BalancedNetwork::to_normalized`]): per unit, radians,
    /// filtered, source bus ids preserved. Distinct from
    /// [`InMemory`](SourceFormat::InMemory) so consumers can tell a per unit
    /// product from a raw in memory network; it has no source text and a different
    /// unit basis than a parsed network.
    #[serde(rename = "normalized")]
    Normalized,
    /// Read from a GridFM data kit Parquet dataset. The balanced network follows
    /// the dataset's native dense bus indices, nodal demand and shunt totals,
    /// fixed quadratic costs, and branch terminal flows.
    #[serde(rename = "gridfm")]
    Gridfm,
    /// Read from a PyPSA CSV folder. This is a folder format rather than a
    /// single retained text document, so same-format writes are canonicalized.
    #[serde(rename = "pypsa-csv")]
    PypsaCsv,
    /// Read from a DOE GO Challenge 3 JSON input document. The source is a
    /// unit commitment data set; the neutral transmission model keeps a static
    /// first interval network and retains the source text for the full data.
    #[serde(rename = "goc3-json")]
    Goc3Json,
    /// Read from a Surge native JSON document.
    #[serde(rename = "surge-json")]
    SurgeJson,
    /// Read from one raw JSON document in a DeepMind OPFData release. The
    /// source carries both solver initial values and a solution. The balanced
    /// model represents the solved snapshot and retains the source for an
    /// exact write back to the same format.
    #[serde(rename = "opfdata-json")]
    DeepMindOpfDataJson,
    /// Read from PowSybl's XIIDM XML grid exchange format, versions 1.0 through 1.17.
    #[serde(rename = "xiidm")]
    Xiidm,
    /// Read from PowSybl's JIIDM JSON grid exchange format, versions 1.0 through 1.17.
    #[serde(rename = "jiidm")]
    Jiidm,
    /// Read from a CGMES profile set (2.4.15/CIM16 or 3.0/CIM100).
    #[serde(rename = "cgmes")]
    Cgmes,
    /// Read from an ENTSO-E UCTE-DEF `.uct` file (revision 2003.09.01 or
    /// 2007.05.01).
    #[serde(rename = "ucte")]
    Ucte,
    /// Read from an IEEE Common Data Format case. Read only: there is no
    /// writer, so writing goes through another format's writer.
    #[serde(rename = "ieee-cdf")]
    IeeeCdf,
    /// A SINCAL project read using the explicitly selected balanced profile.
    #[serde(rename = "sincal")]
    Sincal,
}

impl SourceFormat {
    /// Stable lowercase token for the source format in module records, CLI
    /// summaries, and language bindings. The match is exhaustive here so a new
    /// enum case fails compilation at the one mapping instead of silently
    /// reporting "unknown" from a downstream wildcard copy.
    #[must_use]
    pub fn name(self) -> &'static str {
        match self {
            SourceFormat::Sincal => "sincal",
            SourceFormat::Matpower => "matpower",
            SourceFormat::PowerModelsJson => "powermodels-json",
            SourceFormat::EgretJson => "egret-json",
            SourceFormat::Psse => "psse",
            SourceFormat::PsseRawx => "psse-rawx",
            SourceFormat::PowerWorld => "powerworld",
            SourceFormat::PandapowerJson => "pandapower-json",
            SourceFormat::Pslf => "pslf",
            SourceFormat::PowerWorldBinary => "powerworld-pwb",
            SourceFormat::InMemory => "in-memory",
            SourceFormat::Normalized => "normalized",
            SourceFormat::Gridfm => "gridfm",
            SourceFormat::PypsaCsv => "pypsa-csv",
            SourceFormat::Goc3Json => "goc3-json",
            SourceFormat::SurgeJson => "surge-json",
            SourceFormat::DeepMindOpfDataJson => "opfdata-json",
            SourceFormat::Xiidm => "xiidm",
            SourceFormat::Jiidm => "jiidm",
            SourceFormat::Cgmes => "cgmes",
            SourceFormat::Ucte => "ucte",
            SourceFormat::IeeeCdf => "ieee-cdf",
        }
    }
}

/// A balanced network with stable source bus IDs and separate element tables:
/// an immutable cheap to clone owning handle over private shared tables.
///
/// Cloning the handle bumps one reference count and clones no table
/// allocation. Reads go through the per field accessors; the `*_mut`
/// accessors copy the shared tables once on first write to a shared handle
/// (copy on write), so no other handle ever observes a mutation. The choice
/// of whole value sharing is private: clone stays zero allocation because
/// the handle wraps its tables in one `Arc`.
#[derive(Debug, Clone)]
pub struct BalancedNetwork {
    tables: std::sync::Arc<BalancedNetworkTables>,
}

impl BalancedNetwork {
    pub(crate) fn from_tables(tables: BalancedNetworkTables) -> Self {
        Self {
            tables: std::sync::Arc::new(tables),
        }
    }

    /// The one mutation door: copies the shared tables on first write to a
    /// shared handle, so no other handle observes the change.
    pub(crate) fn tables_mut(&mut self) -> &mut BalancedNetworkTables {
        std::sync::Arc::make_mut(&mut self.tables)
    }
}

/// A balanced network with stable source bus IDs and separate element tables.
///
/// `remote = "Self"` turns the derived serde impls into inherent functions;
/// the trait impls beneath the struct route them through PowerIO's shared
/// nonfinite JSON spelling.
// The one owned table store behind the `BalancedNetwork` handle.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[cfg_attr(feature = "schema", schemars(rename = "BalancedNetwork"))]
#[serde(remote = "Self")]
pub(crate) struct BalancedNetworkTables {
    pub name: String,
    pub base_mva: f64,
    /// System base frequency in hertz (50 or 60). Threaded through the formats
    /// that record it (PSS/E `BASFRQ`, pandapower `f_hz`) and defaulted to
    /// [`DEFAULT_BASE_FREQUENCY`] for the rest. Load-bearing for any
    /// reactance↔henry conversion (pandapower line charging) and reported as a
    /// fidelity loss when a non-default value writes to a format with no
    /// frequency field.
    #[serde(default = "default_base_frequency")]
    pub base_frequency: f64,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub geo: Option<GeoMeta>,
    /// Source neutral case metadata such as the case date and forecast horizon.
    #[serde(default)]
    pub case_metadata: CaseMetadata,
    /// Authoritative hierarchy and bus breaker or node breaker connectivity,
    /// when the source states more than the balanced calculation view.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub detailed_connectivity: Option<std::sync::Arc<DetailedConnectivity>>,
    /// Component identities generated by PowerIO rather than supplied by the
    /// source. The provenance keeps target diagnostics from treating an
    /// internal indexing requirement as source data.
    #[serde(default, skip_serializing_if = "generated_uids_is_empty")]
    pub generated_uids: std::sync::Arc<BTreeSet<String>>,
    pub buses: std::sync::Arc<Vec<Bus>>,
    pub loads: std::sync::Arc<Vec<Load>>,
    pub shunts: std::sync::Arc<Vec<Shunt>>,
    #[serde(default)]
    pub static_var_compensators: std::sync::Arc<Vec<StaticVarCompensator>>,
    pub branches: std::sync::Arc<Vec<Branch>>,
    #[serde(default)]
    pub switches: std::sync::Arc<Vec<Switch>>,
    pub generators: std::sync::Arc<Vec<Generator>>,
    pub storage: std::sync::Arc<Vec<Storage>>,
    pub hvdc: std::sync::Arc<Vec<Hvdc>>,
    /// Three-winding transformers, kept as typed records rather than folded into
    /// `branches`, so a star point and the per-winding data survive a round trip.
    /// `#[serde(default)]` so JSON written before the field existed still
    /// deserializes. [`IndexedNetwork`](crate::IndexedNetwork) lowers each
    /// in-service record into a star bus plus three branches (via
    /// [`Transformer3W::to_star_expansion`]) before building any matrix, so a
    /// 3-winding transformer does appear in `Y_bus`/connectivity; the canonical
    /// model keeps the typed record for round-trip fidelity.
    #[serde(default)]
    pub transformers_3w: std::sync::Arc<Vec<Transformer3W>>,
    /// Area records: scheduled interchange and per-area swing bus. Distinct from
    /// the bare `area` number on each [`Bus`]; this is the area's metadata, which
    /// every conversion dropped before. `#[serde(default)]` so older JSON still
    /// deserializes.
    #[serde(default)]
    pub areas: std::sync::Arc<Vec<Area>>,
    /// Solver / solution-control metadata when the source carries it, else `None`.
    /// `#[serde(default)]` so older JSON still deserializes.
    #[serde(default)]
    pub solver: Option<SolverParams>,
    pub source_format: SourceFormat,
}

impl Serialize for BalancedNetwork {
    fn serialize<S: serde::Serializer>(
        &self,
        serializer: S,
    ) -> std::result::Result<S::Ok, S::Error> {
        BalancedNetworkTables::serialize(
            &self.tables,
            powerio_core::__implementation::nonfinite::NonFiniteSer(serializer),
        )
    }
}

impl<'de> Deserialize<'de> for BalancedNetwork {
    fn deserialize<D: serde::Deserializer<'de>>(
        deserializer: D,
    ) -> std::result::Result<Self, D::Error> {
        BalancedNetworkTables::deserialize(powerio_core::__implementation::nonfinite::NonFiniteDe(
            deserializer,
        ))
        .map(BalancedNetwork::from_tables)
    }
}

#[cfg(feature = "schema")]
impl schemars::JsonSchema for BalancedNetwork {
    fn schema_name() -> std::borrow::Cow<'static, str> {
        <BalancedNetworkTables as schemars::JsonSchema>::schema_name()
    }

    fn schema_id() -> std::borrow::Cow<'static, str> {
        <BalancedNetworkTables as schemars::JsonSchema>::schema_id()
    }

    fn json_schema(generator: &mut schemars::SchemaGenerator) -> schemars::Schema {
        <BalancedNetworkTables as schemars::JsonSchema>::json_schema(generator)
    }
}

macro_rules! table_accessors {
    ($($(#[$doc:meta])* $field:ident, $field_mut:ident: $ty:ty;)+) => {
        impl BalancedNetwork {
            $(
                $(#[$doc])*
                #[must_use]
                pub fn $field(&self) -> &$ty {
                    &self.tables.$field
                }

                /// Mutable access to the same table; a shared handle copies
                /// its tables once here, so no other handle observes the
                /// change.
                #[must_use]
                pub fn $field_mut(&mut self) -> &mut $ty {
                    &mut self.tables_mut().$field
                }
            )+
        }
    };
}

table_accessors! {
    /// The case name.
    name, name_mut: String;
    /// The geographic metadata when the source carries any.
    geo, geo_mut: Option<GeoMeta>;
    /// Source neutral case metadata when the source records it.
    case_metadata, case_metadata_mut: CaseMetadata;
    /// Solver / solution-control metadata when the source carries it.
    solver, solver_mut: Option<SolverParams>;
}

impl BalancedNetwork {
    /// Authoritative hierarchy and detailed connectivity when present.
    #[must_use]
    pub fn detailed_connectivity(&self) -> &Option<std::sync::Arc<DetailedConnectivity>> {
        &self.tables.detailed_connectivity
    }

    /// Mutable access to detailed connectivity. Taking mutable access clears
    /// source field omission records because a caller can change any of the
    /// corresponding values through this reference.
    #[must_use]
    pub fn detailed_connectivity_mut(
        &mut self,
    ) -> &mut Option<std::sync::Arc<DetailedConnectivity>> {
        let tables = self.tables_mut();
        if let Some(detailed) = tables.detailed_connectivity.as_mut()
            && !detailed.omitted_fields.is_empty()
        {
            std::sync::Arc::make_mut(detailed).omitted_fields.clear();
        }
        &mut tables.detailed_connectivity
    }

    fn clear_omitted_fields(&mut self, component_type: &str, fields: &[OmittedFieldName]) {
        let Some(detailed) = self.tables_mut().detailed_connectivity.as_mut() else {
            return;
        };
        let affected = |omitted: &OmittedField| {
            omitted.component.component_type() == component_type && fields.contains(&omitted.field)
        };
        // Copy a shared connectivity only when a marker actually goes.
        if detailed.omitted_fields.iter().any(affected) {
            std::sync::Arc::make_mut(detailed)
                .omitted_fields
                .retain(|omitted| !affected(omitted));
        }
    }

    fn clear_omitted_field(&mut self, component: &ComponentId, field: OmittedFieldName) {
        let Some(detailed) = self.tables_mut().detailed_connectivity.as_mut() else {
            return;
        };
        let affected =
            |omitted: &OmittedField| omitted.component == *component && omitted.field == field;
        if detailed.omitted_fields.iter().any(affected) {
            std::sync::Arc::make_mut(detailed)
                .omitted_fields
                .retain(|omitted| !affected(omitted));
        }
    }
}

/// The element tables sit behind their own shared allocation inside the
/// shared table set, so a time series of networks that varies one table
/// clones only that table per point while every untouched table stays one
/// allocation across the whole series.
macro_rules! shared_table_accessors {
    ($($(#[$doc:meta])* $field:ident, $field_mut:ident: $ty:ty;)+) => {
        impl BalancedNetwork {
            $(
                $(#[$doc])*
                #[must_use]
                pub fn $field(&self) -> &$ty {
                    &self.tables.$field
                }

                /// Mutable access to the same table. A shared handle copies
                /// the table set spine and this one table here, so no other
                /// handle observes the change and untouched tables stay
                /// shared.
                #[must_use]
                pub fn $field_mut(&mut self) -> &mut $ty {
                    std::sync::Arc::make_mut(&mut self.tables_mut().$field)
                }
            )+
        }
    };
}

impl BalancedNetwork {
    /// Replace each element table's allocation with `donor`'s wherever the
    /// contents are equal, so equal tables across derived networks (the
    /// scenarios of one dataset, the points of one series) are stored once.
    /// No value changes; a table that differs anywhere keeps its own
    /// allocation.
    pub fn share_equal_tables(&mut self, donor: &Self) {
        macro_rules! share {
            ($($field:ident),+) => {
                $(
                    if !std::sync::Arc::ptr_eq(&self.tables.$field, &donor.tables.$field)
                        && self.tables.$field == donor.tables.$field
                    {
                        self.tables_mut().$field = donor.tables.$field.clone();
                    }
                )+
            };
        }
        share!(
            buses,
            loads,
            shunts,
            static_var_compensators,
            branches,
            switches,
            generators,
            storage,
            hvdc,
            transformers_3w,
            areas
        );
    }
}

shared_table_accessors! {
    buses, buses_mut: Vec<Bus>;
    static_var_compensators, static_var_compensators_mut: Vec<StaticVarCompensator>;
    branches, branches_mut: Vec<Branch>;
    switches, switches_mut: Vec<Switch>;
    hvdc, hvdc_mut: Vec<Hvdc>;
    /// Three-winding transformers, kept as typed records.
    transformers_3w, transformers_3w_mut: Vec<Transformer3W>;
    /// Area records: scheduled interchange and per-area swing bus.
    areas, areas_mut: Vec<Area>;
}

impl BalancedNetwork {
    #[must_use]
    pub fn loads(&self) -> &Vec<Load> {
        &self.tables.loads
    }

    /// Mutable load access makes source omission metadata conservative: a
    /// subsequent emission writes the numeric active and reactive power values.
    #[must_use]
    pub fn loads_mut(&mut self) -> &mut Vec<Load> {
        self.clear_omitted_fields(
            "load",
            &[
                OmittedFieldName::ActivePower,
                OmittedFieldName::ReactivePower,
            ],
        );
        std::sync::Arc::make_mut(&mut self.tables_mut().loads)
    }

    /// Edit one load assignment while preserving omission metadata for every
    /// other source field. This internal primitive is used by typed updates
    /// after resolving a stable component identity to `index`.
    #[doc(hidden)]
    pub(crate) fn edit_load_assignment<R>(
        &mut self,
        index: usize,
        component: &ComponentId,
        field: OmittedFieldName,
        edit: impl FnOnce(&mut Load) -> R,
    ) -> R {
        debug_assert_eq!(component.component_type(), "load");
        debug_assert!(matches!(
            field,
            OmittedFieldName::ActivePower | OmittedFieldName::ReactivePower
        ));
        self.clear_omitted_field(component, field);
        edit(&mut std::sync::Arc::make_mut(&mut self.tables_mut().loads)[index])
    }

    #[must_use]
    pub fn generators(&self) -> &Vec<Generator> {
        &self.tables.generators
    }

    /// Mutable generator access makes source omission metadata conservative:
    /// a subsequent emission writes all numeric generator assignments.
    #[must_use]
    pub fn generators_mut(&mut self) -> &mut Vec<Generator> {
        self.clear_omitted_fields(
            "generator",
            &[
                OmittedFieldName::ActivePower,
                OmittedFieldName::ReactivePower,
                OmittedFieldName::VoltageSetpoint,
                OmittedFieldName::RatedApparentPower,
            ],
        );
        std::sync::Arc::make_mut(&mut self.tables_mut().generators)
    }

    /// Edit one generator assignment while preserving omission metadata for
    /// every other source field. This internal primitive is used by typed
    /// updates after resolving a stable component identity to `index`.
    #[doc(hidden)]
    pub(crate) fn edit_generator_assignment<R>(
        &mut self,
        index: usize,
        component: &ComponentId,
        field: OmittedFieldName,
        edit: impl FnOnce(&mut Generator) -> R,
    ) -> R {
        debug_assert_eq!(component.component_type(), "generator");
        debug_assert!(matches!(
            field,
            OmittedFieldName::ActivePower
                | OmittedFieldName::ReactivePower
                | OmittedFieldName::VoltageSetpoint
        ));
        self.clear_omitted_field(component, field);
        edit(&mut std::sync::Arc::make_mut(&mut self.tables_mut().generators)[index])
    }

    #[must_use]
    pub fn storage(&self) -> &Vec<Storage> {
        &self.tables.storage
    }

    /// Mutable storage access makes source omission metadata conservative: a
    /// subsequent emission writes both numeric power assignments.
    #[must_use]
    pub fn storage_mut(&mut self) -> &mut Vec<Storage> {
        self.clear_omitted_fields(
            "storage",
            &[
                OmittedFieldName::ActivePower,
                OmittedFieldName::ReactivePower,
            ],
        );
        std::sync::Arc::make_mut(&mut self.tables_mut().storage)
    }

    #[must_use]
    pub fn shunts(&self) -> &Vec<Shunt> {
        &self.tables.shunts
    }

    /// Mutable shunt access makes source omission metadata conservative: a
    /// subsequent emission writes conductance per section.
    #[must_use]
    pub fn shunts_mut(&mut self) -> &mut Vec<Shunt> {
        self.clear_omitted_fields("shunt", &[OmittedFieldName::ShuntConductancePerSection]);
        std::sync::Arc::make_mut(&mut self.tables_mut().shunts)
    }
}

impl BalancedNetwork {
    /// System MVA base.
    #[must_use]
    pub fn base_mva(&self) -> f64 {
        self.tables.base_mva
    }

    #[must_use]
    pub fn base_mva_mut(&mut self) -> &mut f64 {
        &mut self.tables_mut().base_mva
    }

    /// System base frequency in hertz (50 or 60).
    #[must_use]
    pub fn base_frequency(&self) -> f64 {
        self.tables.base_frequency
    }

    #[must_use]
    pub fn base_frequency_mut(&mut self) -> &mut f64 {
        &mut self.tables_mut().base_frequency
    }

    /// The format the case was parsed from.
    #[must_use]
    pub fn source_format(&self) -> SourceFormat {
        self.tables.source_format
    }

    #[must_use]
    pub fn source_format_mut(&mut self) -> &mut SourceFormat {
        &mut self.tables_mut().source_format
    }

    /// Assign persistent identities to records whose source format supplied
    /// none.
    ///
    /// Source supplied identities are preserved. Generated identities use
    /// electrical identifiers such as a bus number or branch terminals and
    /// are stored on the record, so later table reordering does not change
    /// them. A suffix distinguishes several records attached to the same bus
    /// or terminal pair.
    ///
    /// The identities are unique across the whole network, not only within one
    /// table: a load and a generator at bus 3 are two records, and formats that
    /// index every element by one identifier (XIIDM, CGMES) reject the same
    /// identifier twice. The first record to claim a stem keeps it and the next
    /// takes a numeric suffix.
    ///
    /// Callers that assemble a network by pushing records can call this once
    /// after construction. PowerIO parsers call it before returning a module.
    pub fn assign_missing_component_ids(&mut self) {
        let mut used = self.component_ids_in_use();
        let mut next_suffix = HashMap::new();
        macro_rules! assign {
            ($table:ident, $table_mut:ident, $set_uid:expr, $stem:expr) => {
                if self.$table().iter().any(|value| value.uid.is_none()) {
                    let generated = assign_missing_ids(
                        self.$table_mut(),
                        |value| value.uid.as_deref(),
                        $set_uid,
                        $stem,
                        &mut used,
                        &mut next_suffix,
                    );
                    std::sync::Arc::make_mut(&mut self.tables_mut().generated_uids)
                        .extend(generated);
                }
            };
        }

        assign!(
            buses,
            buses_mut,
            |bus: &mut Bus, uid| bus.uid = Some(uid),
            |bus: &Bus| bus.id.to_string()
        );
        assign!(
            loads,
            loads_mut,
            |load: &mut Load, uid| load.uid = Some(uid),
            |load: &Load| format!("bus-{}", load.bus)
        );
        assign!(
            shunts,
            shunts_mut,
            |shunt: &mut Shunt, uid| shunt.uid = Some(uid),
            |shunt: &Shunt| format!("bus-{}", shunt.bus)
        );
        assign!(
            static_var_compensators,
            static_var_compensators_mut,
            |svc: &mut StaticVarCompensator, uid| svc.uid = Some(uid),
            |svc: &StaticVarCompensator| format!("bus-{}", svc.bus)
        );
        assign!(
            branches,
            branches_mut,
            |branch: &mut Branch, uid| branch.uid = Some(uid),
            |branch: &Branch| format!("{}-{}", branch.from, branch.to)
        );
        assign!(
            switches,
            switches_mut,
            |switch: &mut Switch, uid| switch.uid = Some(uid),
            |switch: &Switch| format!("{}-{}", switch.from, switch.to)
        );
        assign!(
            generators,
            generators_mut,
            |generator: &mut Generator, uid| generator.uid = Some(uid),
            |generator: &Generator| format!("bus-{}", generator.bus)
        );
        assign!(
            storage,
            storage_mut,
            |storage: &mut Storage, uid| storage.uid = Some(uid),
            |storage: &Storage| format!("bus-{}", storage.bus)
        );
        assign!(
            hvdc,
            hvdc_mut,
            |line: &mut Hvdc, uid| line.uid = Some(uid),
            |line: &Hvdc| format!("{}-{}", line.from, line.to)
        );
        assign!(
            transformers_3w,
            transformers_3w_mut,
            |transformer: &mut Transformer3W, uid| transformer.uid = Some(uid),
            |transformer: &Transformer3W| {
                let [first, second, third] = &transformer.windings;
                format!("{}-{}-{}", first.bus, second.bus, third.bus)
            }
        );
    }

    /// True when PowerIO generated this identity to make records addressable.
    #[must_use]
    pub fn uid_is_generated(&self, uid: Option<&str>) -> bool {
        uid.is_some_and(|uid| self.tables.generated_uids.contains(uid))
    }

    pub(crate) fn generated_uids(&self) -> &std::sync::Arc<BTreeSet<String>> {
        &self.tables.generated_uids
    }

    /// Every identity the network's records already carry.
    pub(crate) fn component_ids_in_use(&self) -> HashSet<String> {
        let mut used = HashSet::new();
        macro_rules! collect {
            ($($table:ident),+) => {
                $(used.extend(
                    self.$table()
                        .iter()
                        .filter_map(|value| value.uid.as_deref().map(str::to_owned)),
                );)+
            };
        }
        collect!(
            buses,
            loads,
            shunts,
            static_var_compensators,
            branches,
            switches,
            generators,
            storage,
            hvdc,
            transformers_3w
        );
        used
    }
}

fn generated_uids_is_empty(uids: &std::sync::Arc<BTreeSet<String>>) -> bool {
    uids.is_empty()
}

fn assign_missing_ids<T>(
    values: &mut [T],
    uid: impl for<'a> Fn(&'a T) -> Option<&'a str>,
    mut set_uid: impl FnMut(&mut T, String),
    stem: impl Fn(&T) -> String,
    used: &mut HashSet<String>,
    next_suffix: &mut HashMap<String, usize>,
) -> Vec<String> {
    let mut generated = Vec::new();
    for value in values {
        if uid(value).is_some() {
            continue;
        }
        let stem = stem(value);
        let suffix = match next_suffix.get_mut(&stem) {
            Some(suffix) => suffix,
            None => next_suffix.entry(stem.clone()).or_insert(1),
        };
        loop {
            let candidate = if *suffix == 1 {
                stem.clone()
            } else {
                format!("{stem}-{suffix}")
            };
            *suffix += 1;
            if !used.contains(&candidate) {
                used.insert(candidate.clone());
                set_uid(value, candidate.clone());
                generated.push(candidate);
                break;
            }
        }
    }
    generated
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct Bus {
    /// Stable bus id (1-based in MATPOWER; preserved verbatim).
    pub id: BusId,
    pub kind: BusType,
    /// Voltage magnitude (p.u.).
    pub vm: f64,
    /// Voltage angle (degrees).
    pub va: f64,
    pub base_kv: f64,
    pub vmax: f64,
    pub vmin: f64,
    /// Emergency (short-term) voltage band, set only when the source states one
    /// distinct from the normal [`vmax`](Bus::vmax)/[`vmin`](Bus::vmin) band (PSS/E
    /// `EVHI`/`EVLO`). `None` means the emergency band equals the normal band, so
    /// read `evhi.unwrap_or(vmax)` / `evlo.unwrap_or(vmin)`. `#[serde(default)]` so
    /// JSON written before the fields existed still deserializes.
    #[serde(default)]
    pub evhi: Option<f64>,
    #[serde(default)]
    pub evlo: Option<f64>,
    pub area: usize,
    pub zone: usize,
    pub name: Option<String>,
    /// Stable row identity for `.pio.json` payloads and operating point updates:
    /// the source record uid where the format defines one (GOC3), synthesized at
    /// package build otherwise. `#[serde(default)]` so JSON written before the
    /// field existed still deserializes.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub uid: Option<String>,
    /// Optional bus coordinates in the network coordinate space.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub location: Option<Location>,
    pub extras: Extras,
}

impl Bus {
    #[must_use]
    pub fn new(id: BusId, kind: BusType, base_kv: f64) -> Self {
        Self {
            id,
            kind,
            vm: 1.0,
            va: 0.0,
            base_kv,
            vmax: 1.1,
            vmin: 0.9,
            evhi: None,
            evlo: None,
            area: 1,
            zone: 1,
            name: None,
            uid: None,
            location: None,
            extras: Extras::new(),
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct Load {
    pub bus: BusId,
    /// Active demand (MW).
    pub p: f64,
    /// Reactive demand (MVAr).
    pub q: f64,
    /// Voltage dependence, when the source states one. `None` is constant power.
    #[serde(default)]
    pub voltage_model: Option<LoadVoltageModel>,
    pub in_service: bool,
    /// Stable row identity; see [`Bus::uid`].
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub uid: Option<String>,
    pub extras: Extras,
}

impl Load {
    #[must_use]
    pub fn new(bus: BusId, p: f64, q: f64) -> Self {
        Self {
            bus,
            p,
            q,
            voltage_model: None,
            in_service: true,
            uid: None,
            extras: Extras::new(),
        }
    }
}

/// Voltage dependence for a transmission load.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(tag = "kind", rename_all = "snake_case")]
#[non_exhaustive]
pub enum LoadVoltageModel {
    /// Explicit constant power marker.
    ConstantPower,
    /// ZIP load split in source units. The three active parts sum to
    /// [`Load::p`], and the three reactive parts sum to [`Load::q`].
    Zip {
        p_constant_power: f64,
        q_constant_power: f64,
        p_constant_current: f64,
        q_constant_current: f64,
        p_constant_impedance: f64,
        q_constant_impedance: f64,
        #[serde(default)]
        v_nom: Option<f64>,
        /// Source load type code, when a format has one (PSS/E `ID`/`LOADTYPE`
        /// style metadata).
        #[serde(default)]
        load_type: Option<i32>,
        /// Source scaling factor, when a format has one.
        #[serde(default)]
        scaling: Option<f64>,
    },
    /// Exponential voltage model: `P = p * (V / v_nom)^gamma_p`,
    /// `Q = q * (V / v_nom)^gamma_q`.
    Exponential {
        p: f64,
        q: f64,
        #[serde(default)]
        v_nom: Option<f64>,
        gamma_p: f64,
        gamma_q: f64,
    },
}

impl LoadVoltageModel {
    #[must_use]
    pub fn has_non_matpower_fields(&self) -> bool {
        match self {
            Self::ConstantPower => false,
            Self::Zip {
                p_constant_current,
                q_constant_current,
                p_constant_impedance,
                q_constant_impedance,
                v_nom,
                load_type,
                scaling,
                ..
            } => {
                *p_constant_current != 0.0
                    || *q_constant_current != 0.0
                    || *p_constant_impedance != 0.0
                    || *q_constant_impedance != 0.0
                    || v_nom.is_some()
                    || load_type.is_some()
                    || scaling.is_some()
            }
            Self::Exponential { .. } => true,
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct Shunt {
    pub bus: BusId,
    /// Shunt conductance (MW at V = 1 p.u.).
    pub g: f64,
    /// Shunt susceptance (MVAr at V = 1 p.u.). For a switched shunt this is the
    /// initial steady state value within the [`control`](Shunt::control) blocks.
    pub b: f64,
    pub in_service: bool,
    /// Number of shunt sections assigned in service. `None` records that the
    /// source left the assignment unset.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub section_count: Option<u32>,
    /// Switching-control data when this is a switched (adjustable) shunt; `None`
    /// for a fixed shunt. `#[serde(default)]` so JSON written before the field
    /// existed still deserializes.
    #[serde(default)]
    pub control: Option<SwitchedShuntControl>,
    /// Stable row identity; see [`Bus::uid`].
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub uid: Option<String>,
    pub extras: Extras,
}

impl Shunt {
    #[must_use]
    pub fn new(bus: BusId, g: f64, b: f64) -> Self {
        Self {
            bus,
            g,
            b,
            in_service: true,
            section_count: None,
            control: None,
            uid: None,
            extras: Extras::new(),
        }
    }
}

/// How a switched shunt adjusts its susceptance. Maps to the PSS/E `MODSW` code.
//
// The IR 2 schema catalogs are published byte for byte, and
// `powerio/tests/frozen_schemas.rs` holds every record to its published text.
// The schema descriptions of the two adjusting variants therefore keep their
// 0.11 wording, which swaps `MODSW` 1 and 2, until a new catalog snapshot
// takes the code mapping the rustdoc states.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum SwitchedShuntMode {
    /// Fixed at its initial susceptance, no automatic switching (`MODSW` 0).
    Locked,
    /// Continuous adjustment within the block range to hold the voltage band
    /// (`MODSW` 2).
    #[cfg_attr(
        feature = "schema",
        schemars(description = "Continuous adjustment within the block range (`MODSW` 1).")
    )]
    Continuous,
    /// Discrete adjustment in fixed steps (`MODSW` 1, and 3 to 6).
    ///
    /// `MODSW` 1 holds the voltage band. `MODSW` 3 to 6 control a plant's
    /// reactive output, a VSC dc converter's reactive output, another switched
    /// shunt's admittance setting, or a FACTS device's reactive output; the
    /// PSS/E reader keeps that code in the shunt's `psse_modsw` extra.
    #[cfg_attr(
        feature = "schema",
        schemars(description = "Discrete adjustment in fixed steps (`MODSW` 2 and up).")
    )]
    Discrete,
}

/// One block of a switched shunt: `steps` equal admittance increments.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct ShuntBlock {
    pub steps: u32,
    /// Conductance increment per step (MW at V = 1 p.u.).
    pub g: f64,
    /// Susceptance increment per step (MVAr at V = 1 p.u.).
    pub b: f64,
}

impl ShuntBlock {
    #[must_use]
    pub const fn new(steps: u32, b: f64) -> Self {
        Self { steps, g: 0.0, b }
    }

    #[must_use]
    pub const fn with_admittance(steps: u32, g: f64, b: f64) -> Self {
        Self { steps, g, b }
    }
}

/// 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's [`b`](Shunt::b) is the initial
/// value within the blocks' total range.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct SwitchedShuntControl {
    pub mode: SwitchedShuntMode,
    /// Regulated voltage band (per unit).
    pub vhigh: f64,
    pub vlow: f64,
    /// The regulated bus; `None` means the shunt regulates its own bus.
    pub control_bus: Option<BusId>,
    /// The exact regulated equipment terminal when the source identifies one.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub regulating_terminal: Option<TerminalReference>,
    /// Percent of the controlled device's reactive range to apply (PSS/E `RMPCT`).
    pub rmpct: f64,
    pub blocks: Vec<ShuntBlock>,
}

impl SwitchedShuntControl {
    #[must_use]
    pub fn new(mode: SwitchedShuntMode, vhigh: f64, vlow: f64, blocks: Vec<ShuntBlock>) -> Self {
        Self {
            mode,
            vhigh,
            vlow,
            control_bus: None,
            regulating_terminal: None,
            rmpct: 100.0,
            blocks,
        }
    }
}

/// The controlled quantity of a static VAR compensator.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum StaticVarCompensatorRegulationMode {
    Voltage,
    ReactivePower,
}

/// A static VAR compensator connected to one balanced network bus.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct StaticVarCompensator {
    pub bus: BusId,
    /// Minimum and maximum susceptance in siemens.
    pub b_min_siemens: f64,
    pub b_max_siemens: f64,
    pub voltage_setpoint_kv: f64,
    pub reactive_power_setpoint_mvar: f64,
    pub regulation_mode: StaticVarCompensatorRegulationMode,
    pub regulating: bool,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub regulating_terminal: Option<TerminalReference>,
    /// Assigned active and reactive terminal power in MW and MVAr.
    pub p: f64,
    pub q: f64,
    pub in_service: bool,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub uid: Option<String>,
    pub extras: Extras,
}

impl StaticVarCompensator {
    #[must_use]
    pub fn new(bus: BusId, b_min_siemens: f64, b_max_siemens: f64) -> Self {
        Self {
            bus,
            b_min_siemens,
            b_max_siemens,
            voltage_setpoint_kv: 0.0,
            reactive_power_setpoint_mvar: 0.0,
            regulation_mode: StaticVarCompensatorRegulationMode::Voltage,
            regulating: false,
            regulating_terminal: None,
            p: 0.0,
            q: 0.0,
            in_service: true,
            uid: None,
            extras: Extras::new(),
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct Branch {
    /// Source supplied equipment name, when present.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    pub from: BusId,
    pub to: BusId,
    /// Series resistance (p.u.).
    pub r: f64,
    /// Series reactance (p.u.).
    pub x: f64,
    /// MATPOWER compatible total line charging susceptance (p.u.). This is the
    /// legacy total projection; when [`charging`](Branch::charging) is present,
    /// per terminal admittance is canonical and this field is compatibility data.
    pub b: f64,
    /// Per terminal shunt admittance (p.u.). If absent, derive symmetric
    /// susceptance from [`b`](Branch::b).
    #[serde(default)]
    pub charging: Option<BranchCharging>,
    pub rate_a: f64,
    pub rate_b: f64,
    pub rate_c: f64,
    /// Additional MVA rating sets beyond A/B/C. Matrix builders continue to use
    /// `rate_a` unless they opt into one of these named sets.
    #[serde(default)]
    pub rating_sets: Vec<BranchRatingSet>,
    /// Current ratings, when the source distinguishes them from MVA ratings.
    #[serde(default)]
    pub current_ratings: Option<BranchCurrentRatings>,
    /// Tap ratio, MATPOWER convention: 0 means "no tap" (a line), treated as 1.
    pub tap: f64,
    /// Phase shift (degrees).
    pub shift: f64,
    pub in_service: bool,
    pub angmin: f64,
    pub angmax: f64,
    /// Regulating-transformer control data, when this branch is a transformer
    /// under automatic tap or phase control. `None` for lines and for fixed-ratio
    /// transformers. `#[serde(default)]` so JSON written before the field existed
    /// still deserializes.
    #[serde(default)]
    pub control: Option<TransformerControl>,
    /// Solved branch flow values, when present in a case snapshot.
    #[serde(default)]
    pub solution: Option<BranchSolution>,
    /// Stable row identity; see [`Bus::uid`].
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub uid: Option<String>,
    /// Polyline route in the network's coordinate space (`BalancedNetwork.geo`),
    /// present only when a source provides intermediate geometry; endpoint
    /// only rendering derives from the bus locations. `#[serde(default)]` so
    /// JSON written before the field existed still deserializes.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub route: Option<Vec<Location>>,
    pub extras: Extras,
}

/// The [`Branch::extras`] and [`Transformer3W::extras`] key behind
/// [`Branch::impedance_correction`] and
/// [`Transformer3W::winding_impedance_correction`].
pub(crate) const IMPEDANCE_CORRECTION_EXTRA: &str = "impedance_correction";
/// The extras key where [`BalancedNetwork::apply_impedance_correction`]
/// records the nominal series impedance it scales.
pub(crate) const IMPEDANCE_CORRECTION_NOMINAL_EXTRA: &str = "impedance_correction_nominal";
/// The extras key where [`BalancedNetwork::apply_impedance_correction`]
/// records the corrected series impedance it wrote, so a later edit of that
/// impedance can be told apart from the correction's own result.
pub(crate) const IMPEDANCE_CORRECTION_APPLIED_EXTRA: &str = "impedance_correction_applied";

/// The nominal impedance an impedance correction recorded in `extras`, when
/// it still describes the present impedance `current`. `None` when no nominal
/// is recorded, or when `current` differs from the corrected impedance the
/// correction wrote: the impedance was edited since, and the edited value is
/// the nominal one. A nominal recorded without the corrected value (0.11.6
/// and earlier) is taken as is.
pub(crate) fn current_correction_nominal<T>(extras: &Extras, current: &T) -> Option<T>
where
    T: PartialEq + serde::de::DeserializeOwned,
{
    let nominal = T::deserialize(extras.get(IMPEDANCE_CORRECTION_NOMINAL_EXTRA)?).ok()?;
    let applied = extras
        .get(IMPEDANCE_CORRECTION_APPLIED_EXTRA)
        .and_then(|value| T::deserialize(value).ok());
    applied
        .is_none_or(|applied| applied == *current)
        .then_some(nominal)
}

/// Whether the impedance `current` was edited after an impedance correction
/// scaled it: a nominal is recorded, and `current` is not the corrected value.
pub(crate) fn correction_nominal_edited<T>(extras: &Extras, current: &T) -> bool
where
    T: PartialEq + serde::de::DeserializeOwned,
{
    extras.contains_key(IMPEDANCE_CORRECTION_NOMINAL_EXTRA)
        && current_correction_nominal(extras, current).is_none()
}

/// A transformer impedance correction table: the factors by which a winding's
/// nominal series impedance is multiplied, tabulated against the winding's
/// off-nominal turns ratio or its phase shift. PSS/E states these as
/// impedance correction tables that a transformer winding names through
/// `TAB`.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct ImpedanceCorrection {
    /// The source's table number (PSS/E `TAB`).
    pub table: u32,
    /// What the points are tabulated against.
    pub variable: ImpedanceCorrectionVariable,
    /// The points, in ascending order of [`value`](ImpedanceCorrectionPoint::value).
    pub points: Vec<ImpedanceCorrectionPoint>,
}

/// The winding quantity an [`ImpedanceCorrection`] is tabulated against.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum ImpedanceCorrectionVariable {
    /// The off-nominal turns ratio as the transformer's `tap` states it.
    Ratio,
    /// The phase shift, degrees.
    Angle,
}

/// One point of an [`ImpedanceCorrection`]: the complex factor
/// `factor_re + j·factor_im` that multiplies the nominal series impedance at
/// `value`.
#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct ImpedanceCorrectionPoint {
    /// Turns ratio (p.u.) or phase shift (degrees).
    pub value: f64,
    pub factor_re: f64,
    pub factor_im: f64,
}

impl ImpedanceCorrectionPoint {
    #[must_use]
    pub fn new(value: f64, factor_re: f64, factor_im: f64) -> Self {
        Self {
            value,
            factor_re,
            factor_im,
        }
    }
}

impl ImpedanceCorrection {
    #[must_use]
    pub fn new(
        table: u32,
        variable: ImpedanceCorrectionVariable,
        points: Vec<ImpedanceCorrectionPoint>,
    ) -> Self {
        Self {
            table,
            variable,
            points,
        }
    }

    /// The complex factor `(re, im)` at `value`, interpolated linearly
    /// between the two points around it. Outside the tabulated range the
    /// nearest end point applies, and one point applies everywhere. `None`
    /// for a table with no points.
    #[must_use]
    pub fn calc_factor(&self, value: f64) -> Option<(f64, f64)> {
        let mut points = self.points.clone();
        points.sort_by(|a, b| a.value.total_cmp(&b.value));
        let first = points.first()?;
        let last = points.last()?;
        if value <= first.value {
            return Some((first.factor_re, first.factor_im));
        }
        if value >= last.value {
            return Some((last.factor_re, last.factor_im));
        }
        let upper = points.iter().position(|point| point.value >= value)?;
        let (a, b) = (points[upper - 1], points[upper]);
        let weight = (value - a.value) / (b.value - a.value);
        let lerp = |x: f64, y: f64| x + weight * (y - x);
        Some((
            lerp(a.factor_re, b.factor_re),
            lerp(a.factor_im, b.factor_im),
        ))
    }
}

/// Extra branch MVA rating set beyond the canonical A/B/C columns.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct BranchRatingSet {
    pub name: String,
    pub rate_mva: f64,
}

impl BranchRatingSet {
    #[must_use]
    pub fn new(name: impl Into<String>, rate_mva: f64) -> Self {
        Self {
            name: name.into(),
            rate_mva,
        }
    }
}

/// Per terminal branch shunt admittance in p.u. This is the canonical
/// physical branch shunt model when present.
#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct BranchCharging {
    pub g_fr: f64,
    pub b_fr: f64,
    pub g_to: f64,
    pub b_to: f64,
}

impl BranchCharging {
    #[must_use]
    pub const fn new(g_fr: f64, b_fr: f64, g_to: f64, b_to: f64) -> Self {
        Self {
            g_fr,
            b_fr,
            g_to,
            b_to,
        }
    }

    #[must_use]
    pub fn from_total_b(b: f64) -> Self {
        Self {
            g_fr: 0.0,
            b_fr: b / 2.0,
            g_to: 0.0,
            b_to: b / 2.0,
        }
    }

    #[must_use]
    pub fn calc_total_b(self) -> f64 {
        self.b_fr + self.b_to
    }

    #[must_use]
    pub fn calc_total_g(self) -> f64 {
        self.g_fr + self.g_to
    }

    #[must_use]
    pub fn is_matpower_symmetric(self) -> bool {
        self.g_fr.abs() <= f64::EPSILON
            && self.g_to.abs() <= f64::EPSILON
            && (self.b_fr - self.b_to).abs() <= f64::EPSILON
    }
}

/// Current limits for a branch, in source units.
#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct BranchCurrentRatings {
    pub c_rating_a: f64,
    pub c_rating_b: f64,
    pub c_rating_c: f64,
}

impl BranchCurrentRatings {
    #[must_use]
    pub const fn new(c_rating_a: f64, c_rating_b: f64, c_rating_c: f64) -> Self {
        Self {
            c_rating_a,
            c_rating_b,
            c_rating_c,
        }
    }
}

/// Solved branch terminal flows in MW/MVAr.
#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct BranchSolution {
    pub pf: f64,
    pub qf: f64,
    pub pt: f64,
    pub qt: f64,
}

impl BranchSolution {
    #[must_use]
    pub const fn new(pf: f64, qf: f64, pt: f64, qt: f64) -> Self {
        Self { pf, qf, pt, qt }
    }
}

impl Branch {
    #[must_use]
    pub fn new(from: BusId, to: BusId, r: f64, x: f64) -> Self {
        Self {
            name: None,
            from,
            to,
            r,
            x,
            b: 0.0,
            charging: None,
            rate_a: 0.0,
            rate_b: 0.0,
            rate_c: 0.0,
            rating_sets: Vec::new(),
            current_ratings: None,
            tap: 0.0,
            shift: 0.0,
            in_service: true,
            angmin: -360.0,
            angmax: 360.0,
            control: None,
            solution: None,
            uid: None,
            route: None,
            extras: Extras::new(),
        }
    }

    /// Effective tap ratio (0 ⇒ 1).
    #[must_use]
    pub fn calc_effective_tap(&self) -> f64 {
        if self.tap == 0.0 { 1.0 } else { self.tap }
    }

    /// [`calc_effective_tap`](Self::calc_effective_tap) for a builder that divides by it,
    /// which the remap of an exact 0.0 does not make safe on its own.
    ///
    /// # Errors
    /// [`Error::DegenerateTap`] under
    /// [`MIN_DIVISIBLE_MAGNITUDE`](crate::dc::MIN_DIVISIBLE_MAGNITUDE), where a
    /// tap scales an admittance past anything a matrix can carry. `row` only
    /// labels the error.
    pub fn calc_divisible_tap(&self, row: usize) -> Result<f64> {
        let tap = self.calc_effective_tap();
        if !tap.is_finite() || tap.abs() < crate::dc::MIN_DIVISIBLE_MAGNITUDE {
            return Err(Error::DegenerateTap { row, tap });
        }
        Ok(tap)
    }

    /// Per terminal shunt admittance, deriving the legacy symmetric MATPOWER
    /// charging model when the richer field is absent.
    #[must_use]
    pub fn calc_terminal_charging(&self) -> BranchCharging {
        self.charging
            .unwrap_or_else(|| BranchCharging::from_total_b(self.b))
    }

    /// Series admittance `(g, b) = (r, −x) / (r² + x²)` of the branch pi
    /// model, the primitive beside [`calc_effective_tap`](Self::calc_effective_tap) and
    /// [`calc_terminal_charging`](Self::calc_terminal_charging). `Ok(None)` for a zero
    /// impedance branch — one whose impedance magnitude is under
    /// [`MIN_DIVISIBLE_MAGNITUDE`](crate::dc::MIN_DIVISIBLE_MAGNITUDE); the
    /// caller decides whether that is a skip or an error.
    ///
    /// # Errors
    /// [`Error::NonFiniteSusceptance`] when `r`/`x` are NaN/Inf, so a bad
    /// value cannot write NaN or a silent zero downstream. `row` only labels
    /// the error.
    pub fn calc_series_admittance(&self, row: usize) -> Result<Option<(f64, f64)>> {
        calc_series_admittance_of(self.r, self.x, row)
    }

    /// Apparent power bound, per unit, for a branch the source left unrated
    /// (`rate_a == 0`, which reads as unlimited). `angle_window_rad` is the
    /// widest angle difference the branch may hold, in radians. That window and
    /// the two terminal voltage bands give the widest voltage phasor difference
    /// the branch can hold. The difference over `|Z|` bounds the current, and
    /// the larger ceiling turns the current into power. Returns `0.0` for a zero
    /// impedance branch — one under
    /// [`MIN_DIVISIBLE_MAGNITUDE`](crate::dc::MIN_DIVISIBLE_MAGNITUDE), the
    /// bound the rest of the builders divide by — which stays unlimited.
    ///
    /// Both ends of each band are needed, not just the ceilings. `|V_f e^{jδ} −
    /// V_t|²` is convex in `(V_f, V_t)`, so its largest value over the voltage
    /// box sits at a corner — and below a window of roughly 10° that corner is
    /// the mixed one, one terminal high and the other low, not both high.
    /// Reading only the ceilings there understates the bound several fold and
    /// hands an OPF a limit tighter than the branch physically has.
    ///
    /// The caller supplies the window in radians, because
    /// [`angmin`](Self::angmin) and [`angmax`](Self::angmax) are degrees in
    /// the neutral model and radians in a normalized network, and a branch
    /// cannot tell which it holds. Convert them with
    /// [`IndexedNetwork::to_radians`](crate::IndexedNetwork::to_radians),
    /// which reads the convention of the network. The method takes the
    /// magnitude of the window and holds it at `π`, the widest phasor
    /// separation two terminals can have.
    #[must_use]
    pub fn synthesize_rate_a(
        &self,
        angle_window_rad: f64,
        (fr_vmin, fr_vmax): (f64, f64),
        (to_vmin, to_vmax): (f64, f64),
    ) -> f64 {
        // The same bound `calc_series_admittance_of` divides by, so the two agree on
        // which branch has no impedance to bound a current with.
        let zmag = self.r.hypot(self.x);
        if zmag < crate::dc::MIN_DIVISIBLE_MAGNITUDE {
            return 0.0;
        }
        let window = angle_window_rad.abs().min(std::f64::consts::PI);
        let cos_window = window.cos();
        // Clamped at zero before the root: the law of cosines is nonnegative in
        // exact arithmetic, and rounding on two nearly equal voltages can carry
        // it a few ulp under.
        let separation = |vf: f64, vt: f64| {
            (vf * vf + vt * vt - 2.0 * vf * vt * cos_window)
                .max(0.0)
                .sqrt()
        };
        let widest = separation(fr_vmax, to_vmax)
            .max(separation(fr_vmax, to_vmin))
            .max(separation(fr_vmin, to_vmax))
            .max(separation(fr_vmin, to_vmin));
        fr_vmax.max(to_vmax) * widest / zmag
    }

    /// Total susceptance projection for MATPOWER shaped formats that only carry
    /// one line charging value.
    #[must_use]
    pub fn calc_total_charging_b(&self) -> f64 {
        self.calc_terminal_charging().calc_total_b()
    }

    /// Whether this branch has charging that a MATPOWER branch row cannot carry.
    #[must_use]
    pub fn has_non_matpower_charging(&self) -> bool {
        self.charging
            .is_some_and(|charging| !charging.is_matpower_symmetric())
    }

    /// A transformer iff the raw tap field is nonzero (an explicit `1` counts) or
    /// there is a phase shift.
    #[must_use]
    pub fn is_transformer(&self) -> bool {
        self.tap != 0.0 || self.shift != 0.0
    }

    /// True when the branch constrains its angle difference, i.e. the limits
    /// deviate from the ±360° "unconstrained" default. Formats without angle
    /// limit fields (PSS/E, PowerWorld) use this to warn on what they drop.
    #[must_use]
    pub fn has_angle_limits(&self) -> bool {
        self.angmin > -360.0 || self.angmax < 360.0
    }

    /// The impedance correction table this transformer's series impedance
    /// follows. It is kept under `extras["impedance_correction"]`; an absent
    /// or malformed entry reads as none.
    /// [`BalancedNetwork::apply_impedance_correction`] applies it.
    #[must_use]
    pub fn impedance_correction(&self) -> Option<ImpedanceCorrection> {
        self.extras
            .get(IMPEDANCE_CORRECTION_EXTRA)
            .and_then(|value| ImpedanceCorrection::deserialize(value).ok())
    }

    /// Set or clear [`impedance_correction`](Self::impedance_correction).
    pub fn set_impedance_correction(&mut self, correction: Option<ImpedanceCorrection>) {
        set_impedance_correction_extra(&mut self.extras, correction);
    }
}

fn set_impedance_correction_extra(extras: &mut Extras, correction: Option<ImpedanceCorrection>) {
    match correction {
        Some(correction) => {
            let value = serde_json::to_value(correction).expect("a correction serializes to JSON");
            extras.insert(IMPEDANCE_CORRECTION_EXTRA.to_owned(), value);
        }
        None => {
            extras.remove(IMPEDANCE_CORRECTION_EXTRA);
        }
    }
}

/// The series admittance `(g, b)` of an impedance, guarded.
///
/// `None` is an impedance too small to divide by, under
/// [`MIN_DIVISIBLE_MAGNITUDE`](crate::dc::MIN_DIVISIBLE_MAGNITUDE); the caller
/// decides whether that is a skip or an error. The bound is on the impedance
/// magnitude, not on `r² + x²`, which is its square: bounding the square would
/// refuse impedances the DC builders divide by.
///
/// Y_bus takes `r` already zeroed under the XB scheme, so it passes its own
/// pair rather than a branch's.
///
/// # Errors
/// [`Error::NonFiniteSusceptance`] when `r`/`x` are NaN/Inf, so a bad value
/// cannot write NaN or a silent zero downstream. NaN leaves `hypot` NaN, which
/// is not below the bound, so it arrives at that check rather than reading as
/// zero impedance. `row` only labels the error.
pub fn calc_series_admittance_of(r: f64, x: f64, row: usize) -> Result<Option<(f64, f64)>> {
    let magnitude = r.hypot(x);
    if magnitude < crate::dc::MIN_DIVISIBLE_MAGNITUDE {
        return Ok(None);
    }
    if !magnitude.is_finite() {
        return Err(Error::NonFiniteSusceptance { row });
    }
    Ok(Some(crate::dc::series_admittance_parts(r, x)))
}

/// A transmission switch. Closed switches are preserved as data; matrix builders
/// do not lower them into zero impedance branches.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct Switch {
    pub from: BusId,
    pub to: BusId,
    pub closed: bool,
    #[serde(default)]
    pub thermal_rating: Option<f64>,
    #[serde(default)]
    pub current_rating: Option<f64>,
    #[serde(default)]
    pub pf: Option<f64>,
    #[serde(default)]
    pub qf: Option<f64>,
    #[serde(default)]
    pub pt: Option<f64>,
    #[serde(default)]
    pub qt: Option<f64>,
    /// Stable row identity; see [`Bus::uid`].
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub uid: Option<String>,
    pub extras: Extras,
}

impl Switch {
    #[must_use]
    pub fn new(from: BusId, to: BusId, closed: bool) -> Self {
        Self {
            from,
            to,
            closed,
            thermal_rating: None,
            current_rating: None,
            pf: None,
            qf: None,
            pt: None,
            qt: None,
            uid: None,
            extras: Extras::new(),
        }
    }
}

/// What a regulating transformer's tap (or phase shift) automatically controls.
/// Maps to the PSS/E control code `COD` and the PSLF transformer `type`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum TransformerControlMode {
    /// Fixed ratio, no automatic adjustment (PSS/E `COD` 0, PSLF type 1).
    Fixed,
    /// Bus voltage control via tap (LTC; PSS/E `COD` ±1, PSLF type 2).
    Voltage,
    /// Reactive power flow control via tap (PSS/E `COD` ±2).
    ReactiveFlow,
    /// Active power flow control via phase shift (PSS/E `COD` ±3, PSLF type 4).
    ActiveFlow,
    /// Control of a DC line quantity (PSS/E `COD` ±4; two-winding transformers only).
    DcLineQuantity,
    /// Asymmetric active power flow control via phase shift (PSS/E `COD` ±5).
    AsymmetricActiveFlow,
}

/// Automatic-control data for a regulating transformer ([`Branch::control`]).
///
/// The limits carry whatever the [`mode`](TransformerControl::mode) regulates:
/// `tap_min`/`tap_max` bound the tap ratio (or the phase angle for active power
/// control), and `band_min`/`band_max` bound the controlled quantity (the
/// regulated voltage band or the scheduled MW/MVAr). `ntp` is the number of
/// discrete tap positions and `controlled_bus` is the regulated bus (`None` =
/// the transformer's own terminal). `mva_base` is the winding MVA base the
/// impedance is referred to.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct TransformerControl {
    pub mode: TransformerControlMode,
    /// Whether automatic regulation is enabled. PSS/E represents this with
    /// the sign of `COD` while its magnitude selects [`mode`](Self::mode).
    pub enabled: bool,
    pub controlled_bus: Option<BusId>,
    /// Whether the controlled bus lies on this winding's side of the
    /// transformer. PSS/E represents this with a negative `CONT` value.
    #[serde(default)]
    pub controlled_bus_on_winding_side: bool,
    /// Exact regulated terminal when the source identifies one.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub regulating_terminal: Option<TerminalReference>,
    pub tap_min: f64,
    pub tap_max: f64,
    pub band_min: f64,
    pub band_max: f64,
    pub ntp: u32,
    pub mva_base: f64,
    /// Winding connection angle for asymmetric active power flow control.
    /// It is in degrees in a source network and radians after normalization.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub winding_connection_angle: Option<f64>,
}

impl Default for TransformerControl {
    fn default() -> Self {
        // PSS/E's documented defaults for an unset winding-control block.
        TransformerControl {
            mode: TransformerControlMode::Fixed,
            enabled: false,
            controlled_bus: None,
            controlled_bus_on_winding_side: false,
            regulating_terminal: None,
            tap_min: 0.9,
            tap_max: 1.1,
            band_min: 0.9,
            band_max: 1.1,
            ntp: 33,
            mva_base: 0.0,
            winding_connection_angle: None,
        }
    }
}

impl TransformerControl {
    #[must_use]
    pub fn new(mode: TransformerControlMode) -> Self {
        Self {
            mode,
            enabled: mode != TransformerControlMode::Fixed,
            ..Self::default()
        }
    }
}

/// Active power control settings for a generator or storage device.
///
/// `droop_percent` is the governor speed changer droop: the negated change in
/// active power divided by the change in frequency, normalized by nominal
/// power and nominal frequency, and expressed as a percentage.
/// `participation_factor` is the nonnegative distributed slack participation
/// factor. The target limits, when present, override the equipment active power
/// limits for active power control operations only.
/// It is distinct from MATPOWER's area participation factor (`APF`) in [`Generator::caps`].
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct ActivePowerControl {
    pub participate: bool,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub droop_percent: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub participation_factor: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub minimum_target_active_power_mw: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub maximum_target_active_power_mw: Option<f64>,
}

impl ActivePowerControl {
    #[must_use]
    pub fn new(participate: bool) -> Self {
        Self {
            participate,
            droop_percent: None,
            participation_factor: None,
            minimum_target_active_power_mw: None,
            maximum_target_active_power_mw: None,
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct Generator {
    pub bus: BusId,
    /// Primary energy source used by the generating equipment.
    #[serde(default)]
    pub energy_source: GeneratorEnergySource,
    /// Real power set point (MW).
    pub pg: f64,
    /// Reactive power set point (MVAr).
    pub qg: f64,
    pub pmax: f64,
    pub pmin: f64,
    pub qmax: f64,
    pub qmin: f64,
    /// Voltage set point (p.u.).
    pub vg: f64,
    pub mbase: f64,
    pub in_service: bool,
    pub cost: Option<GenCost>,
    /// The MATPOWER gen capability / ramp columns past `PMIN`, aligned to
    /// `GEN_EXTRA_KEYS` by index (`None` for a column the source omitted).
    /// A fixed array, not an [`Extras`] map: a string-keyed map per generator
    /// costs 11 heap allocations each, which dominates the parse of a large
    /// generator-heavy case. Surfaced into formats that name them (PowerModels).
    /// On the JSON snapshot it is a name-keyed object (see `caps_serde`) so the
    /// schema stays additive when `GEN_EXTRA_KEYS` grows; `#[serde(default)]` so a
    /// snapshot that omits it deserializes to the empty set.
    #[serde(default = "default_caps", with = "caps_serde")]
    #[cfg_attr(feature = "schema", schemars(with = "BTreeMap<String, f64>"))]
    pub caps: GenCaps,
    /// Whether the generator's voltage regulation is enabled. Formats without
    /// an explicit enable field use `true`, matching the voltage set point
    /// carried by the balanced generator row.
    #[serde(default = "default_voltage_regulation_on")]
    pub voltage_regulation_on: bool,
    /// The exact equipment terminal whose voltage is regulated. `None` means
    /// the generator's own terminal, or that the source format names only a
    /// regulated bus.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub regulating_terminal: Option<TerminalReference>,
    /// The remote bus whose voltage this generator regulates, when that is not its
    /// own terminal bus (PSS/E `IREG`). `None` means it regulates its own bus.
    /// Part of the cross-element voltage-control graph: a format that names a
    /// remote regulated bus (PSS/E) keeps it across a round trip instead of
    /// collapsing every generator onto its own terminal. `#[serde(default)]` so
    /// JSON written before the field existed still deserializes.
    #[serde(default)]
    pub regulated_bus: Option<BusId>,
    /// Governor and distributed slack settings, when supplied by the source.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub active_power_control: Option<ActivePowerControl>,
    /// Stable row identity; see [`Bus::uid`].
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub uid: Option<String>,
}

impl Generator {
    #[must_use]
    pub fn new(bus: BusId) -> Self {
        Self {
            bus,
            energy_source: GeneratorEnergySource::Other,
            pg: 0.0,
            qg: 0.0,
            pmax: 0.0,
            pmin: 0.0,
            qmax: 0.0,
            qmin: 0.0,
            vg: 1.0,
            mbase: 0.0,
            in_service: true,
            cost: None,
            caps: default_caps(),
            voltage_regulation_on: true,
            regulating_terminal: None,
            regulated_bus: None,
            active_power_control: None,
            uid: None,
        }
    }

    /// True when any capability / ramp column is present. Formats without those
    /// fields (PSS/E, PowerWorld) use this to warn on what they drop.
    #[must_use]
    pub fn has_caps(&self) -> bool {
        self.caps.iter().any(Option::is_some)
    }
}

/// Primary energy source used by generating equipment.
#[derive(Debug, Clone, Copy, Default, Serialize, Deserialize, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum GeneratorEnergySource {
    Hydro,
    Nuclear,
    Wind,
    Thermal,
    Solar,
    #[default]
    Other,
}

const fn default_voltage_regulation_on() -> bool {
    true
}

/// A generator's capability / ramp columns, one slot per `GEN_EXTRA_KEYS` name.
pub type GenCaps = [Option<f64>; GEN_EXTRA_KEYS.len()];

/// The empty capability set, for a JSON snapshot that omits the field entirely.
fn default_caps() -> GenCaps {
    [None; GEN_EXTRA_KEYS.len()]
}

/// Serialize [`GenCaps`] as a name-keyed object (`{"ramp_30": 1.2, ...}`) keyed by
/// [`GEN_EXTRA_KEYS`], emitting only the present slots, instead of a length-exact
/// array. A fixed-length array round-trips through serde only at exactly its
/// current length: the day `GEN_EXTRA_KEYS` grows a column, every old snapshot
/// fails to deserialize and every new one fails on an old build, and the C ABI
/// ties the JSON snapshot schema to its version, so that is a forced ABI break.
/// The named map makes a new key purely additive: an old document simply lacks it
/// (deserializes to `None`), and an unknown key from a newer document is ignored.
/// In memory `caps` stays a fixed array, so the per-generator allocation cost the
/// array avoids is unchanged; only the serialized form is named.
mod caps_serde {
    use super::{GEN_EXTRA_KEYS, GenCaps};
    use serde::de::{Deserialize, Deserializer};
    use serde::ser::{SerializeMap, Serializer};
    use std::collections::BTreeMap;

    pub(super) fn serialize<S: Serializer>(caps: &GenCaps, s: S) -> Result<S::Ok, S::Error> {
        let present = caps.iter().filter(|v| v.is_some()).count();
        let mut map = s.serialize_map(Some(present))?;
        for (key, slot) in GEN_EXTRA_KEYS.iter().zip(caps.iter()) {
            if let Some(value) = slot {
                map.serialize_entry(key, value)?;
            }
        }
        map.end()
    }

    pub(super) fn deserialize<'de, D: Deserializer<'de>>(d: D) -> Result<GenCaps, D::Error> {
        // Accept an explicit `null` as the empty set (treated like an omitted
        // field), so a producer that encodes "no caps" as `null` round-trips the
        // same way `cost: Option<_>` does. `#[serde(default)]` only covers an
        // absent key, not a present `null`.
        let named = Option::<BTreeMap<String, f64>>::deserialize(d)?.unwrap_or_default();
        let mut caps: GenCaps = [None; GEN_EXTRA_KEYS.len()];
        for (slot, key) in caps.iter_mut().zip(GEN_EXTRA_KEYS.iter()) {
            *slot = named.get(*key).copied();
        }
        Ok(caps)
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct Storage {
    pub bus: BusId,
    pub ps: f64,
    pub qs: f64,
    pub energy: f64,
    pub energy_rating: f64,
    pub charge_rating: f64,
    pub discharge_rating: f64,
    pub charge_efficiency: f64,
    pub discharge_efficiency: f64,
    pub thermal_rating: f64,
    #[serde(default)]
    pub current_rating: Option<f64>,
    pub qmin: f64,
    pub qmax: f64,
    pub r: f64,
    pub x: f64,
    pub p_loss: f64,
    pub q_loss: f64,
    pub in_service: bool,
    /// Governor and distributed slack settings, when supplied by the source.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub active_power_control: Option<ActivePowerControl>,
    /// Stable row identity; see [`Bus::uid`].
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub uid: Option<String>,
    pub extras: Extras,
}

impl Storage {
    #[must_use]
    pub fn new(bus: BusId) -> Self {
        Self {
            bus,
            ps: 0.0,
            qs: 0.0,
            energy: 0.0,
            energy_rating: 0.0,
            charge_rating: 0.0,
            discharge_rating: 0.0,
            charge_efficiency: 1.0,
            discharge_efficiency: 1.0,
            thermal_rating: 0.0,
            current_rating: None,
            qmin: 0.0,
            qmax: 0.0,
            r: 0.0,
            x: 0.0,
            p_loss: 0.0,
            q_loss: 0.0,
            in_service: true,
            active_power_control: None,
            uid: None,
            extras: Extras::new(),
        }
    }
}

/// A two-terminal HVDC line (MATPOWER `dcline`).
///
/// `pf`/`pt`/`qf`/`qt` are stored in MATPOWER's sign convention regardless of
/// source: the PowerModels reader un-flips `pt`/`qf`/`qt` on the way in, and the
/// PowerModels writer re-flips them on the way out (PowerModels.jl uses the
/// opposite sign). The flip is a format-boundary translation, so a derived view
/// like `to_normalized` keeps the MATPOWER convention and only scales to per unit.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum HvdcConvertersMode {
    Side1RectifierSide2Inverter,
    Side1InverterSide2Rectifier,
}

/// Converter technology used at both ends of one HVDC line.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum HvdcConverterKind {
    Vsc,
    Lcc,
}

/// One AC terminal converter station of an HVDC line.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct HvdcConverter {
    pub component: ComponentId,
    pub kind: HvdcConverterKind,
    /// Converter losses as a percentage of active power.
    pub loss_factor_percent: f64,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub voltage_regulator_on: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub voltage_setpoint_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub reactive_power_setpoint_mvar: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub power_factor: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub regulating_terminal: Option<TerminalReference>,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct Hvdc {
    pub from: BusId,
    pub to: BusId,
    pub in_service: bool,
    pub pf: f64,
    pub pt: f64,
    pub qf: f64,
    pub qt: f64,
    pub vf: f64,
    pub vt: f64,
    pub pmin: f64,
    pub pmax: f64,
    pub qminf: f64,
    pub qmaxf: f64,
    pub qmint: f64,
    pub qmaxt: f64,
    pub loss0: f64,
    pub loss1: f64,
    /// Physical line resistance and nominal DC voltage when the source states
    /// an explicit converter station model.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub resistance_ohm: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub nominal_voltage_kv: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub converters_mode: Option<HvdcConvertersMode>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub converter1: Option<HvdcConverter>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub converter2: Option<HvdcConverter>,
    #[serde(default)]
    pub cost: Option<GenCost>,
    /// Stable row identity; see [`Bus::uid`].
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub uid: Option<String>,
    pub extras: Extras,
}

impl Hvdc {
    /// The power arriving at the `to` end for a sending end setpoint, under the
    /// MATPOWER dcline loss model `Pt = Pf - loss0 - loss1·Pf`.
    ///
    /// [`pf`](Self::pf), [`pt`](Self::pt), and [`loss0`](Self::loss0) are one
    /// relation, not three independent fields, and a format that states only
    /// the sending end reconstructs the far end from it. Stated here so every
    /// reader spells the same rule: `loss0` and `pf` scale together, so this
    /// holds in per unit as in MW.
    #[must_use]
    pub fn calc_delivered_power(pf: f64, loss0: f64, loss1: f64) -> f64 {
        pf - loss0 - loss1 * pf
    }

    /// Whether [`pt`](Self::pt) agrees with this line's own loss model to
    /// `tol`. A writer whose format states no received power reports the lines
    /// that fail this, because those are the ones it cannot reproduce.
    #[must_use]
    pub fn pt_matches_loss_model(&self, tol: f64) -> bool {
        (self.pt - Self::calc_delivered_power(self.pf, self.loss0, self.loss1)).abs() <= tol
    }

    #[must_use]
    pub fn new(from: BusId, to: BusId) -> Self {
        Self {
            from,
            to,
            in_service: true,
            pf: 0.0,
            pt: 0.0,
            qf: 0.0,
            qt: 0.0,
            vf: 1.0,
            vt: 1.0,
            pmin: 0.0,
            pmax: 0.0,
            qminf: 0.0,
            qmaxf: 0.0,
            qmint: 0.0,
            qmaxt: 0.0,
            loss0: 0.0,
            loss1: 0.0,
            resistance_ohm: None,
            nominal_voltage_kv: None,
            converters_mode: None,
            converter1: None,
            converter2: None,
            cost: None,
            uid: None,
            extras: Extras::new(),
        }
    }
}

/// An area record: the area's scheduled net interchange and its swing bus.
///
/// The [`number`](Area::number) matches the `area` field carried on each
/// [`Bus`]; this table holds the per-area metadata (the interchange target and
/// the area slack) that the bus number alone can't. Maps to the PSS/E area record
/// (`I, ISW, PDES, PTOL, ARNAME`).
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct Area {
    pub number: usize,
    /// The area swing (slack) bus, or `None` when unset.
    pub slack_bus: Option<BusId>,
    /// Scheduled net interchange (MW); positive is export out of the area.
    pub net_interchange: f64,
    /// Interchange tolerance bandwidth (MW).
    pub tolerance: f64,
    pub name: Option<String>,
    /// Stable source identity when the source uses a named area rather than a
    /// numeric area table.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub uid: Option<String>,
    /// Area classification used by formats that distinguish control areas,
    /// bidding zones, and other area kinds.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub area_type: Option<String>,
}

impl Area {
    #[must_use]
    pub fn new(number: usize) -> Self {
        Self {
            number,
            slack_bus: None,
            net_interchange: 0.0,
            tolerance: 0.0,
            name: None,
            uid: None,
            area_type: None,
        }
    }
}

/// Solver / solution-control metadata: the Newton tolerance and iteration cap,
/// the zero-impedance threshold, and the per-quantity adjustment-enable flags.
///
/// Each field is optional because a source states only the ones it carries. No
/// power flow physics, but it determines whether a downstream solver reproduces
/// the source tool's converged answer. Maps to the PSS/E v34+ system-wide block
/// (`GENERAL THRSHZ`, `NEWTON TOLN`/`ITMXN`, `SOLVER ACTAPS`/`AREAIN`/`PHSHFT`/
/// `DCTAPS`/`SWSHNT`).
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct SolverParams {
    /// Newton power flow mismatch tolerance (`NEWTON TOLN`).
    pub newton_tolerance: Option<f64>,
    /// Newton iteration cap (`NEWTON ITMXN`).
    pub max_iterations: Option<u32>,
    /// Branches with `|x|` below this are treated as zero impedance (`GENERAL THRSHZ`).
    pub zero_impedance_threshold: Option<f64>,
    /// Whether the solver adjusts transformer taps (`SOLVER ACTAPS`).
    pub adjust_taps: Option<bool>,
    /// Whether the solver adjusts area interchange (`SOLVER AREAIN`).
    pub adjust_area_interchange: Option<bool>,
    /// Whether the solver adjusts phase-shift angles (`SOLVER PHSHFT`).
    pub adjust_phase_shift: Option<bool>,
    /// Whether the solver adjusts DC line taps (`SOLVER DCTAPS`).
    pub adjust_dc_taps: Option<bool>,
    /// Whether the solver adjusts switched shunts (`SOLVER SWSHNT`).
    pub adjust_switched_shunt: Option<bool>,
}

impl SolverParams {
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    /// True when no field is set (so readers can avoid attaching an empty record).
    #[must_use]
    pub fn is_empty(&self) -> bool {
        *self == SolverParams::default()
    }
}

/// 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.
///
/// `r`/`x` are per unit on the *system* base (the same `CZ = 1` convention as
/// [`Branch::r`]/[`Branch::x`], so the matrix math needs no rebasing); `base_mva`
/// records the winding-pair MVA base the source file declared (PSS/E `SBASE1-2`
/// and friends), kept so a write-back reproduces it and so a future `CZ = 2`
/// reader has somewhere to put the winding base it must rebase from. Room to grow
/// (winding voltage base, turns-ratio units) as the transformer control work
/// lands without reshaping the [`Transformer3W::z`] array.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct Impedance {
    pub r: f64,
    pub x: f64,
    pub base_mva: f64,
}

impl Impedance {
    #[must_use]
    pub const fn new(r: f64, x: f64, base_mva: f64) -> Self {
        Self { r, x, base_mva }
    }
}

/// The [`Transformer3W::extras`] key behind
/// [`Transformer3W::winding_in_service`].
pub(crate) const WINDING_IN_SERVICE_EXTRA: &str = "winding_in_service";
/// The [`Transformer3W::extras`] key behind
/// [`Transformer3W::winding_rating_sets`].
pub(crate) const WINDING_RATING_SETS_EXTRA: &str = "winding_rating_sets";

/// One winding of a [`Transformer3W`]: its terminal bus, off-nominal ratio, phase
/// shift, nominal voltage, and thermal ratings.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[non_exhaustive]
pub struct Winding {
    pub bus: BusId,
    /// Off-nominal turns ratio (1.0 = nominal); the PSS/E `WINDV`, `CW = 1`.
    pub tap: f64,
    /// Phase shift (degrees).
    pub shift: f64,
    /// Winding nominal voltage (kV); 0 defers to the terminal bus base kV.
    pub nominal_kv: f64,
    pub rate_a: f64,
    pub rate_b: f64,
    pub rate_c: f64,
    /// Automatic tap or phase control for this winding.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub control: Option<TransformerControl>,
}

impl Winding {
    #[must_use]
    pub fn new(bus: BusId) -> Self {
        Self {
            bus,
            tap: 1.0,
            shift: 0.0,
            nominal_kv: 0.0,
            rate_a: 0.0,
            rate_b: 0.0,
            rate_c: 0.0,
            control: None,
        }
    }
}

/// A three winding transformer with three terminal buses joined at a star point.
///
/// Series impedance is stored for winding pairs 1-2, 2-3, and 3-1. The record
/// also retains star point voltage and per winding control data. PSS/E three
/// winding records and PSLF tertiary winding records map to this type.
/// [`to_star_expansion`](Transformer3W::to_star_expansion) turns it into the synthetic
/// star bus plus three branches for a consumer that works in the bus-branch model;
/// [`IndexedNetwork`](crate::IndexedNetwork) applies it before building any matrix,
/// so a 3-winding transformer contributes to `Y_bus` and connectivity.
#[derive(Debug, Clone, PartialEq)]
#[non_exhaustive]
pub struct Transformer3W {
    /// The three windings, in order (primary, secondary, tertiary).
    pub windings: [Winding; 3],
    /// Pairwise series impedance `[z12, z23, z31]` (primary-secondary,
    /// secondary-tertiary, tertiary-primary), each per unit on the system base
    /// with its declared MVA base.
    pub z: [Impedance; 3],
    /// Star-point voltage magnitude (p.u.) and angle (degrees), as solved.
    pub star_vm: f64,
    pub star_va: f64,
    /// Magnetizing shunt referred to the star point (p.u. on the system base).
    pub mag_g: f64,
    pub mag_b: f64,
    pub in_service: bool,
    pub name: Option<String>,
    /// Stable row identity; see [`Bus::uid`].
    pub uid: Option<String>,
    pub extras: Extras,
}

impl Transformer3W {
    #[must_use]
    pub fn new(windings: [Winding; 3], z: [Impedance; 3]) -> Self {
        Self {
            windings,
            z,
            star_vm: 1.0,
            star_va: 0.0,
            mag_g: 0.0,
            mag_b: 0.0,
            in_service: true,
            name: None,
            uid: None,
            extras: Extras::new(),
        }
    }

    /// The per-winding star impedances `(r, x)` — winding *k* to the star point —
    /// from the pairwise values, per unit on the system base.
    ///
    /// Standard pairwise→star conversion: `z1 = (z12 + z31 - z23) / 2`, and so on.
    /// Because the impedances are already on a common base, the split is linear in
    /// `r` and `x` separately.
    #[must_use]
    pub fn calc_star_impedances(&self) -> [(f64, f64); 3] {
        let [z12, z23, z31] = self.z;
        let half = |a: f64, b: f64, c: f64| (a + b - c) / 2.0;
        [
            (half(z12.r, z31.r, z23.r), half(z12.x, z31.x, z23.x)),
            (half(z12.r, z23.r, z31.r), half(z12.x, z23.x, z31.x)),
            (half(z23.r, z31.r, z12.r), half(z23.x, z31.x, z12.x)),
        ]
    }

    /// Whether each winding is connected while the transformer is in service,
    /// in winding order. [`in_service`](Self::in_service) takes the whole
    /// transformer out; a winding that is out leaves the other two coupled
    /// through the star point.
    ///
    /// The status is kept as three booleans under
    /// `extras["winding_in_service"]`, absent while every winding is in
    /// service. An absent or malformed entry reads as every winding in service.
    #[must_use]
    pub fn winding_in_service(&self) -> [bool; 3] {
        self.extras
            .get(WINDING_IN_SERVICE_EXTRA)
            .and_then(|value| <[bool; 3]>::deserialize(value).ok())
            .unwrap_or([true; 3])
    }

    /// Set [`winding_in_service`](Self::winding_in_service).
    pub fn set_winding_in_service(&mut self, in_service: [bool; 3]) {
        if in_service == [true; 3] {
            self.extras.remove(WINDING_IN_SERVICE_EXTRA);
        } else {
            self.extras.insert(
                WINDING_IN_SERVICE_EXTRA.to_owned(),
                Value::from(in_service.to_vec()),
            );
        }
    }

    /// The MVA rating sets of winding `winding` (0, 1, or 2) beyond `rate_a`,
    /// `rate_b`, and `rate_c`, named as on [`Branch::rating_sets`]: PSS/E
    /// states `RATE4` to `RATE12`.
    ///
    /// The sets are kept under `extras["winding_rating_sets"]` as three arrays
    /// of `{name, rate_mva}` objects in winding order, absent while no winding
    /// has one. An absent or malformed entry reads as no sets.
    ///
    /// # Panics
    /// If `winding` is 3 or more.
    #[must_use]
    pub fn winding_rating_sets(&self, winding: usize) -> Vec<BranchRatingSet> {
        let mut sets = self.stored_winding_rating_sets();
        std::mem::take(&mut sets[winding])
    }

    /// Set [`winding_rating_sets`](Self::winding_rating_sets) for one winding.
    ///
    /// # Panics
    /// If `winding` is 3 or more.
    pub fn set_winding_rating_sets(&mut self, winding: usize, rating_sets: Vec<BranchRatingSet>) {
        let mut sets = self.stored_winding_rating_sets();
        sets[winding] = rating_sets;
        if sets.iter().all(Vec::is_empty) {
            self.extras.remove(WINDING_RATING_SETS_EXTRA);
        } else {
            let value = serde_json::to_value(sets).expect("rating sets serialize to JSON");
            self.extras
                .insert(WINDING_RATING_SETS_EXTRA.to_owned(), value);
        }
    }

    fn stored_winding_rating_sets(&self) -> [Vec<BranchRatingSet>; 3] {
        self.extras
            .get(WINDING_RATING_SETS_EXTRA)
            .and_then(|value| <[Vec<BranchRatingSet>; 3]>::deserialize(value).ok())
            .unwrap_or_default()
    }

    /// The sole adjustable winding for PSS/E bus-to-bus correction. The
    /// sign of COD enables regulation but does not change which winding the
    /// tables describe: a disabled nonzero control remains adjustable.
    pub(crate) fn impedance_correction_control_winding(&self) -> Option<usize> {
        let mut adjustable = self
            .windings
            .iter()
            .enumerate()
            .filter(|(_, winding)| {
                winding
                    .control
                    .as_ref()
                    .is_some_and(|control| control.mode != TransformerControlMode::Fixed)
            })
            .map(|(index, _)| index);
        let winding = adjustable.next()?;
        adjustable.next().is_none().then_some(winding)
    }

    /// The impedance correction table winding `winding` (0, 1, or 2) follows:
    /// it scales that winding's star impedance, except with PSS/E `ZCOD=1`,
    /// where entries 0/1/2 scale Z12/Z23/Z31 at the sole adjustable winding.
    /// The tables are kept under
    /// `extras["impedance_correction"]` as three entries in winding order, each
    /// a table or `null`; an absent or malformed entry reads as none.
    ///
    /// # Panics
    /// If `winding` is 3 or more.
    #[must_use]
    pub fn winding_impedance_correction(&self, winding: usize) -> Option<ImpedanceCorrection> {
        let mut corrections = self.stored_winding_impedance_corrections();
        corrections[winding].take()
    }

    /// Set or clear [`winding_impedance_correction`](Self::winding_impedance_correction)
    /// for one winding.
    ///
    /// # Panics
    /// If `winding` is 3 or more.
    pub fn set_winding_impedance_correction(
        &mut self,
        winding: usize,
        correction: Option<ImpedanceCorrection>,
    ) {
        let mut corrections = self.stored_winding_impedance_corrections();
        corrections[winding] = correction;
        if corrections.iter().all(Option::is_none) {
            self.extras.remove(IMPEDANCE_CORRECTION_EXTRA);
        } else {
            let value = serde_json::to_value(corrections).expect("corrections serialize to JSON");
            self.extras
                .insert(IMPEDANCE_CORRECTION_EXTRA.to_owned(), value);
        }
    }

    fn stored_winding_impedance_corrections(&self) -> [Option<ImpedanceCorrection>; 3] {
        self.extras
            .get(IMPEDANCE_CORRECTION_EXTRA)
            .and_then(|value| <[Option<ImpedanceCorrection>; 3]>::deserialize(value).ok())
            .unwrap_or_default()
    }

    /// Expand into a synthetic star [`Bus`] (id `star_id`) plus three [`Branch`]es,
    /// one per winding, for a consumer that works in the bus-branch model.
    /// [`IndexedNetwork`](crate::IndexedNetwork) calls this via
    /// `BalancedNetwork::expand_transformers_3w` when assembling matrix inputs. The star
    /// bus carries the stored star voltage and the magnetizing shunt is left to the
    /// caller; each branch takes its winding's tap, phase shift, ratings, and
    /// status, so a winding out of service gives an out of service branch.
    #[must_use]
    pub fn to_star_expansion(&self, star_id: BusId) -> (Bus, [Branch; 3]) {
        let star = Bus {
            id: star_id,
            kind: BusType::Pq,
            vm: self.star_vm,
            va: self.star_va,
            base_kv: self.windings[0].nominal_kv,
            vmax: 1.1,
            vmin: 0.9,
            evhi: None,
            evlo: None,
            area: 0,
            zone: 0,
            name: self.name.clone(),
            uid: self.uid.clone(),
            location: None,
            extras: Extras::new(),
        };
        let zs = self.calc_star_impedances();
        let branch = |w: &Winding, (r, x): (f64, f64)| Branch {
            name: None,
            from: w.bus,
            to: star_id,
            r,
            x,
            b: 0.0,
            charging: None,
            rate_a: w.rate_a,
            rate_b: w.rate_b,
            rate_c: w.rate_c,
            rating_sets: Vec::new(),
            current_ratings: None,
            tap: w.tap,
            shift: w.shift,
            in_service: self.in_service,
            angmin: -360.0,
            angmax: 360.0,
            control: w.control.clone(),
            solution: None,
            uid: None,
            route: None,
            extras: Extras::new(),
        };
        let mut branches = [
            branch(&self.windings[0], zs[0]),
            branch(&self.windings[1], zs[1]),
            branch(&self.windings[2], zs[2]),
        ];
        let windings_in_service = self.winding_in_service();
        for (k, branch) in branches.iter_mut().enumerate() {
            branch.in_service &= windings_in_service[k];
            branch.rating_sets = self.winding_rating_sets(k);
        }
        (star, branches)
    }
}

/// The MATPOWER gen capability / ramp columns past `PMIN`, in order. The index
/// into this array is the slot index into a [`GenCaps`].
pub const GEN_EXTRA_KEYS: [&str; 11] = [
    "pc1", "pc2", "qc1min", "qc1max", "qc2min", "qc2max", "ramp_agc", "ramp_10", "ramp_30",
    "ramp_q", "apf",
];

/// One value-domain scan finding, internal to the diagnostic and repair
/// passes: an element field whose value falls outside its physical range,
/// paired with the value the repair sets in its place. The public shapes are
/// the coded [`Diagnostic`](crate::Diagnostic) records
/// [`BalancedNetwork::validate_values`] returns and the history entry
/// [`repair_values`] appends.
#[derive(Debug, Clone, PartialEq)]
pub(crate) struct ValueFinding {
    /// Human-readable element locator, e.g. `"bus 3"` or `"generator at bus 5"`.
    pub element: String,
    /// The top level JSON field the element serializes under, e.g.
    /// `"buses"`. Paired with `index`, this names the finding's RFC 6901
    /// target, so it must match [`BalancedNetwork`]'s own field name (the
    /// stored module writes this network under `value.data`, unchanged).
    pub table: &'static str,
    /// The element's position in `table`, for the target — the array index,
    /// never the element's id, since an id can differ from its position.
    pub index: usize,
    pub field: &'static str,
    pub old: f64,
    pub new: f64,
    pub reason: &'static str,
}

impl ValueFinding {
    /// The finding as the coded record: target is an RFC 6901 pointer to the
    /// field within the stored document's `value.data`, details carry the
    /// other machine readable pieces, and the message stays prose.
    pub(crate) fn into_diagnostic(self) -> crate::Diagnostic {
        let mut details = serde_json::Map::new();
        details.insert("element".to_owned(), serde_json::json!(self.element));
        details.insert("field".to_owned(), serde_json::json!(self.field));
        details.insert("value".to_owned(), serde_json::json!(self.old));
        details.insert("repaired_value".to_owned(), serde_json::json!(self.new));
        details.insert("reason".to_owned(), serde_json::json!(self.reason));
        crate::Diagnostic::of(
            &crate::diagnostics::codes::VALIDATE_BALANCED_VALUE_DOMAIN,
            format!(
                "{}: `{}` is {} ({}); the repair sets {}",
                self.element, self.field, self.old, self.reason, self.new
            ),
        )
        .with_target(format!("/{}/{}/{}", self.table, self.index, self.field))
        .expect("scan-built targets are nonempty and bounded")
        .with_details(details)
        .expect("scan-built details stay within the record bounds")
    }
}

/// Clamp every out-of-domain value of a parsed module to its repaired value
/// and record the pass: one `Repair` history entry naming each change in its
/// parameters, and one `VALIDATE.BALANCED.VALUE_DOMAIN` finding 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.
///
/// # Errors
/// Never on scan output: the record constructors refuse only unbounded
/// caller data, and the scan is bounded by the model.
pub fn repair_values(
    module: powerio_core::PioModule<BalancedNetwork>,
) -> std::result::Result<powerio_core::PioModule<BalancedNetwork>, powerio_core::Error> {
    let repair_ordinal = module
        .history()
        .iter()
        .filter(|entry| entry.kind() == powerio_core::HistoryKind::Repair)
        .count();
    let mut network_findings = Vec::new();
    let mut module = module.map_value(|mut network| {
        network_findings = network.repair_in_place();
        network
    });
    if network_findings.is_empty() {
        return Ok(module);
    }
    let mut parameters = std::collections::BTreeMap::new();
    parameters.insert(
        "repairs".to_owned(),
        serde_json::json!(
            network_findings
                .iter()
                .map(|finding| {
                    serde_json::json!({
                        "element": finding.element,
                        "field": finding.field,
                        "value": finding.old,
                        "repaired_value": finding.new,
                    })
                })
                .collect::<Vec<_>>()
        ),
    );
    let entry = powerio_core::HistoryEntry::new(
        powerio_core::HistoryId::new(format!("repair{repair_ordinal}"))?,
        powerio_core::HistoryKind::Repair,
        "value_domain_repair",
    )?
    .with_parameters(parameters)?;
    module.add_history_entry(entry)?;
    for finding in network_findings {
        module.add_diagnostic(finding.into_diagnostic())?;
    }
    module = module.sever_source();
    Ok(module)
}

/// Voltage magnitude (p.u.) repair: non-positive or above 2 (or non-finite) → 1.0.
/// A zero magnitude is treated as out of domain (a de-energized placeholder), not
/// a valid 0 p.u.
fn repair_vm(vm: f64) -> Option<f64> {
    (!vm.is_finite() || vm <= 0.0 || vm > 2.0).then_some(1.0)
}

/// Voltage angle (degrees) repair: `|va| > 2000` (or non-finite) → 0.0.
fn repair_va(va: f64) -> Option<f64> {
    (!va.is_finite() || va.abs() > 2000.0).then_some(0.0)
}

/// Generator MVA base repair: non-positive (or non-finite) → the system base.
fn repair_mbase(mbase: f64, sbase: f64) -> Option<f64> {
    (!mbase.is_finite() || mbase <= 0.0).then_some(sbase)
}

/// Generator voltage setpoint (p.u.) repair: non-positive (or non-finite) → 1.0.
fn repair_vg(vg: f64) -> Option<f64> {
    (!vg.is_finite() || vg <= 0.0).then_some(1.0)
}

/// The three element counts the star lowering changes, from
/// [`BalancedNetwork::lowered_lengths`]. Every other family keeps its length, since the
/// lowering only appends a star bus, its winding branches, and a magnetizing
/// shunt.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) struct LoweredLengths {
    pub(crate) buses: usize,
    pub(crate) branches: usize,
    pub(crate) shunts: usize,
}

impl BalancedNetwork {
    #[must_use]
    pub fn new(name: impl Into<String>, base_mva: f64) -> BalancedNetwork {
        BalancedNetwork::from_tables(BalancedNetworkTables {
            name: name.into(),
            base_mva,
            base_frequency: DEFAULT_BASE_FREQUENCY,
            geo: None,
            case_metadata: CaseMetadata::default(),
            detailed_connectivity: None,
            generated_uids: std::sync::Arc::default(),
            buses: Vec::new().into(),
            loads: Vec::new().into(),
            shunts: Vec::new().into(),
            static_var_compensators: Vec::new().into(),
            branches: Vec::new().into(),
            switches: Vec::new().into(),
            generators: Vec::new().into(),
            storage: Vec::new().into(),
            hvdc: Vec::new().into(),
            transformers_3w: Vec::new().into(),
            areas: Vec::new().into(),
            solver: None,
            source_format: SourceFormat::InMemory,
        })
    }

    /// A network assembled in memory from buses and branches, with no loads,
    /// shunts, generators, storage, HVDC, or retained source document. Synthetic
    /// topology generators and tests use it instead of repeating the struct
    /// literal. The caller owns reference integrity (run `check_references` if
    /// the ids might be inconsistent).
    #[must_use]
    pub fn in_memory(
        name: impl Into<String>,
        base_mva: f64,
        buses: Vec<Bus>,
        branches: Vec<Branch>,
    ) -> BalancedNetwork {
        let mut net = Self::new(name, base_mva);
        *net.buses_mut() = buses;
        *net.branches_mut() = branches;
        net.assign_missing_component_ids();
        net
    }

    /// Whether this is a normalized (per-unit, radian, filtered)
    /// derived product from [`to_normalized`](BalancedNetwork::to_normalized), rather
    /// than a raw network at the file's unit basis. Unit-sensitive code that
    /// takes a `&BalancedNetwork` can check this instead of silently assuming MW.
    #[must_use]
    pub fn is_normalized(&self) -> bool {
        self.source_format() == SourceFormat::Normalized
    }

    /// Error unless `base_mva` is a positive, finite number. It is every
    /// per-unit divisor, so a malformed base would otherwise silently poison
    /// downstream values with `NaN`/`Inf` or flipped signs. The per-unit
    /// consumers ([`to_normalized`](BalancedNetwork::to_normalized), the gridfm
    /// export) call this; any other unit-sensitive consumer should too.
    pub fn check_base_mva(&self) -> crate::Result<()> {
        if self.base_mva().is_finite() && self.base_mva() > 0.0 {
            Ok(())
        } else {
            Err(crate::Error::InvalidBaseMva {
                base: self.base_mva(),
            })
        }
    }

    /// Report element fields whose values fall outside their physical domain,
    /// without changing anything, as coded `VALIDATE.BALANCED.VALUE_DOMAIN`
    /// findings. Each record targets the element and carries the field, the
    /// current value, the value a repair would set, and why in details.
    ///
    /// This generalizes the per-reader value clamps (a bus voltage magnitude
    /// outside `[0, 2]`, an angle past `±2000°`, a zero generator MVA base or
    /// voltage setpoint) into one pass any consumer can run, separate from the
    /// structural [`validate`](BalancedNetwork::validate) (which only checks
    /// ids and references). It is non-mutating; [`repair_values`] applies the
    /// fixes to a parsed module and records them.
    #[must_use]
    pub fn validate_values(&self) -> Vec<crate::Diagnostic> {
        self.value_findings()
            .into_iter()
            .map(ValueFinding::into_diagnostic)
            .collect()
    }

    pub(crate) fn value_findings(&self) -> Vec<ValueFinding> {
        let mut out = Vec::new();
        for (index, b) in self.buses().iter().enumerate() {
            if let Some(new) = repair_vm(b.vm) {
                out.push(ValueFinding {
                    element: format!("bus {}", b.id),
                    table: "buses",
                    index,
                    field: "vm",
                    old: b.vm,
                    new,
                    reason: "voltage magnitude outside [0, 2] p.u.",
                });
            }
            if let Some(new) = repair_va(b.va) {
                out.push(ValueFinding {
                    element: format!("bus {}", b.id),
                    table: "buses",
                    index,
                    field: "va",
                    old: b.va,
                    new,
                    reason: "voltage angle outside ±2000°",
                });
            }
        }
        for (index, g) in self.generators().iter().enumerate() {
            if let Some(new) = repair_mbase(g.mbase, self.base_mva()) {
                out.push(ValueFinding {
                    element: format!("generator at bus {}", g.bus),
                    table: "generators",
                    index,
                    field: "mbase",
                    old: g.mbase,
                    new,
                    reason: "non-positive generator MVA base",
                });
            }
            if let Some(new) = repair_vg(g.vg) {
                out.push(ValueFinding {
                    element: format!("generator at bus {}", g.bus),
                    table: "generators",
                    index,
                    field: "vg",
                    old: g.vg,
                    new,
                    reason: "non-positive voltage setpoint",
                });
            }
        }
        out
    }

    /// Clamp every out-of-domain value to its repaired value (the same rules
    /// [`validate_values`](BalancedNetwork::validate_values) reports), returning the list
    /// of changes made. A second call returns an empty list (the values are now
    /// in domain). Crate private: the recorded public path is
    /// [`repair_values`], which appends the history entry and severs the
    /// retained source echo the mutation invalidates.
    pub(crate) fn repair_in_place(&mut self) -> Vec<ValueFinding> {
        let findings = self.value_findings();
        let sbase = self.base_mva();
        for b in self.buses_mut() {
            if let Some(new) = repair_vm(b.vm) {
                b.vm = new;
            }
            if let Some(new) = repair_va(b.va) {
                b.va = new;
            }
        }
        for g in self.generators_mut() {
            if let Some(new) = repair_mbase(g.mbase, sbase) {
                g.mbase = new;
            }
            if let Some(new) = repair_vg(g.vg) {
                g.vg = new;
            }
        }
        findings
    }

    /// The element counts [`Self::expand_transformers_3w`] would produce, read off
    /// the transformer records instead of building the lowering. A caller that
    /// only needs the lowered lengths — sizing a per-row map, say — would
    /// otherwise pay a whole `BalancedNetwork` clone for three `len()` calls.
    /// `lowered_lengths_match_the_expansion` pins the two against each other.
    pub(crate) fn lowered_lengths(&self) -> LoweredLengths {
        let mut lengths = LoweredLengths {
            buses: self.buses().len(),
            branches: self.branches().len(),
            shunts: self.shunts().len(),
        };
        for t in self.transformers_3w().iter().filter(|t| t.in_service) {
            lengths.buses += 1;
            lengths.branches += 3;
            if t.mag_g != 0.0 || t.mag_b != 0.0 {
                lengths.shunts += 1;
            }
        }
        lengths
    }

    /// A bus-branch lowering of the network for analysis: each in-service
    /// 3-winding transformer becomes a synthetic star bus, its three winding
    /// branches, and (when present) its magnetizing shunt, so the matrix builders
    /// and connectivity see it. Returns the network unchanged (borrowed) when
    /// no 3-winding transformer is in service, so a network without one, or
    /// with only out-of-service units, allocates nothing.
    ///
    /// The canonical `BalancedNetwork` keeps the typed [`Transformer3W`] records; this is
    /// the derived analysis form that [`IndexedNetwork`](crate::IndexedNetwork)
    /// builds behind the scenes, so callers never see the synthetic buses in the
    /// model they read or write.
    pub(crate) fn expand_transformers_3w(&self) -> std::borrow::Cow<'_, BalancedNetwork> {
        if !self.transformers_3w().iter().any(|t| t.in_service) {
            return std::borrow::Cow::Borrowed(self);
        }
        let mut net = self.clone();
        // The star branches carry per-unit impedance (CZ = 1), the same convention
        // the matrix builders read straight off a branch, so no rebasing. The
        // magnetizing shunt is an admittance, so it scales like every other shunt:
        // by the per-unit base for a raw network, by 1 for a normalized one.
        let scale = if net.is_normalized() {
            1.0
        } else {
            net.base_mva()
        };
        // check_references refuses bus ids without headroom for these
        // synthetic ids on every parse path; the checked arithmetic turns a
        // programmatic caller's overflow into a loud panic instead of a
        // wrapped id aliasing an existing bus.
        let base_id = net
            .buses()
            .iter()
            .map(|b| b.id.0)
            .max()
            .unwrap_or(0)
            .checked_add(1)
            .expect("bus id space exhausted for star expansion");
        for (k, (source_row, t)) in self
            .transformers_3w()
            .iter()
            .enumerate()
            .filter(|(_, t)| t.in_service)
            .enumerate()
        {
            let star_id = BusId(
                base_id
                    .checked_add(k)
                    .expect("bus id space exhausted for star expansion"),
            );
            let (star, mut branches) = t.to_star_expansion(star_id);
            let transformer_identity = t
                .uid
                .clone()
                .unwrap_or_else(|| format!("transformers_3w:{source_row}"));
            for (winding, branch) in branches.iter_mut().enumerate() {
                branch.uid = Some(format!("{transformer_identity}/winding:{}", winding + 1));
            }
            net.buses_mut().push(star);
            net.branches_mut().extend(branches);
            if t.mag_g != 0.0 || t.mag_b != 0.0 {
                net.shunts_mut().push(Shunt {
                    bus: star_id,
                    g: t.mag_g * scale,
                    b: t.mag_b * scale,
                    in_service: true,
                    section_count: None,
                    control: None,
                    uid: None,
                    extras: Extras::new(),
                });
            }
        }
        net.transformers_3w_mut().clear();
        std::borrow::Cow::Owned(net)
    }

    /// Check structural integrity: bus ids are unique and every element
    /// references an existing bus. File readers run this; a `BalancedNetwork`
    /// built by hand (or mutated, e.g. by a scenario generator) should call it
    /// before handing the network to
    /// [`IndexedNetwork`](crate::IndexedNetwork), whose dense indexing assumes it.
    pub fn validate(&self) -> crate::Result<()> {
        self.check_references("network")
    }

    /// Error if two buses share an id, or if any element references a bus that
    /// doesn't exist. Readers call this after parsing so a missing/garbled id
    /// (which would otherwise default to a placeholder and silently re-wire the
    /// network) fails loudly instead.
    #[allow(clippy::too_many_lines)]
    pub(crate) fn check_references(&self, format: &'static str) -> crate::Result<()> {
        // HashSet, not BTreeSet: building the id set and probing it once per branch
        // endpoint / load / shunt / gen is the dominant cost of a large parse, and
        // a BTreeSet pays a log-n pointer-chasing probe each time. Pre-size to skip
        // rehashing.
        let mut ids = std::collections::HashSet::with_capacity(self.buses().len());
        for b in self.buses() {
            // The readers parse ids through `as usize`, which saturates rather
            // than failing, and the C ABI reports them as int64. Two distinct
            // ids above the ceiling would read as one value there, so a
            // branch endpoint would match two bus rows.
            if b.id > BusId::MAX {
                return Err(Error::FormatRead {
                    format,
                    message: format!("bus id {} is outside the int64 id space", b.id),
                });
            }
            if !ids.insert(b.id) {
                return Err(Error::FormatRead {
                    format,
                    message: format!("duplicate bus id {}", b.id),
                });
            }
        }
        let check = |bus: BusId, what: &str| -> crate::Result<()> {
            if ids.contains(&bus) {
                Ok(())
            } else {
                Err(Error::FormatRead {
                    format,
                    message: format!("{what} references unknown bus {bus}"),
                })
            }
        };
        // Format the context only on the error path, not once per branch.
        for (i, br) in self.branches().iter().enumerate() {
            for bus in [br.from, br.to] {
                if !ids.contains(&bus) {
                    return Err(Error::FormatRead {
                        format,
                        message: format!("branch {i} references unknown bus {bus}"),
                    });
                }
            }
            if let Some(control) = br.control.as_ref() {
                if control.controlled_bus_on_winding_side
                    && control.controlled_bus.is_none_or(|bus| bus.0 == 0)
                {
                    return Err(Error::FormatRead {
                        format,
                        message: format!(
                            "transformer control on branch {i} marks its controlled bus as lying on the winding side but has no nonzero controlled bus"
                        ),
                    });
                }
                if let Some(bus) = control.controlled_bus {
                    check(bus, "transformer control")?;
                }
            }
        }
        for (i, sw) in self.switches().iter().enumerate() {
            for bus in [sw.from, sw.to] {
                if !ids.contains(&bus) {
                    return Err(Error::FormatRead {
                        format,
                        message: format!("switch {i} references unknown bus {bus}"),
                    });
                }
            }
        }
        for l in self.loads() {
            check(l.bus, "load")?;
        }
        for s in self.shunts() {
            check(s.bus, "shunt")?;
            if let Some(bus) = s.control.as_ref().and_then(|c| c.control_bus) {
                check(bus, "switched-shunt control")?;
            }
        }
        for svc in self.static_var_compensators() {
            check(svc.bus, "static VAR compensator")?;
        }
        for g in self.generators() {
            check(g.bus, "generator")?;
            if let Some(bus) = g.regulated_bus {
                check(bus, "generator voltage control")?;
            }
        }
        for d in self.hvdc() {
            check(d.from, "dcline")?;
            check(d.to, "dcline")?;
        }
        for s in self.storage() {
            check(s.bus, "storage")?;
        }
        for a in self.areas() {
            if let Some(slack) = a.slack_bus {
                check(slack, "area swing")?;
            }
        }
        for t in self.transformers_3w() {
            for w in &t.windings {
                check(w.bus, "3-winding transformer")?;
                if let Some(control) = w.control.as_ref() {
                    if control.controlled_bus_on_winding_side
                        && control.controlled_bus.is_none_or(|bus| bus.0 == 0)
                    {
                        return Err(Error::FormatRead {
                            format,
                            message: format!(
                                "3-winding transformer control at bus {} marks its controlled bus as lying on the winding side but has no nonzero controlled bus",
                                w.bus
                            ),
                        });
                    }
                    if let Some(bus) = control.controlled_bus {
                        check(bus, "3-winding transformer control")?;
                    }
                }
            }
        }
        if let Some(detailed) = self.detailed_connectivity().as_ref() {
            let nodes = detailed
                .connectivity_nodes
                .iter()
                .map(|node| &node.component)
                .collect::<std::collections::HashSet<_>>();
            for calculated in &detailed.calculated_buses {
                check(calculated.calculated_bus, "calculated bus")?;
                if calculated.nodes.is_empty() {
                    return Err(Error::FormatRead {
                        format,
                        message: "calculated bus has no connectivity nodes".into(),
                    });
                }
                for node in &calculated.nodes {
                    if !nodes.contains(node) {
                        return Err(Error::FormatRead {
                            format,
                            message: format!(
                                "calculated bus references unknown connectivity node `{}`",
                                node.local_id()
                            ),
                        });
                    }
                }
            }
            let declared_components = detailed
                .component_metadata
                .iter()
                .map(|metadata| &metadata.component)
                .chain(
                    detailed
                        .substations
                        .iter()
                        .map(|substation| &substation.component),
                )
                .chain(detailed.voltage_levels.iter().map(|level| &level.component))
                .chain(
                    detailed
                        .dc_converter_units
                        .iter()
                        .map(|unit| &unit.component),
                )
                .collect::<std::collections::HashSet<_>>();
            for metadata in &detailed.component_metadata {
                if let Some(container) = metadata.equipment_container.as_ref()
                    && !declared_components.contains(container)
                {
                    return Err(Error::FormatRead {
                        format,
                        message: format!(
                            "component `{}` references unknown equipment container `{container}`",
                            metadata.component
                        ),
                    });
                }
            }
            let mut junctions = std::collections::HashSet::new();
            let terminal_equipment: std::collections::HashSet<&ComponentId> = detailed
                .terminals
                .iter()
                .map(|terminal| &terminal.equipment)
                .collect();
            for junction in &detailed.junctions {
                if !junctions.insert(&junction.component) {
                    return Err(Error::FormatRead {
                        format,
                        message: format!("duplicate Junction `{}`", junction.component.local_id()),
                    });
                }
                if !declared_components.contains(&junction.component) {
                    return Err(Error::FormatRead {
                        format,
                        message: format!(
                            "Junction `{}` has no component metadata",
                            junction.component.local_id()
                        ),
                    });
                }
                if !terminal_equipment.contains(&junction.component) {
                    return Err(Error::FormatRead {
                        format,
                        message: format!(
                            "Junction `{}` has no terminal",
                            junction.component.local_id()
                        ),
                    });
                }
            }
        }
        self.check_detailed_ac_references(format, &ids)?;
        self.check_detailed_dc_references(format)?;
        self.check_star_expansion_headroom(format)
    }

    #[allow(clippy::too_many_lines)]
    fn check_detailed_ac_references(
        &self,
        format: &'static str,
        balanced_buses: &std::collections::HashSet<BusId>,
    ) -> crate::Result<()> {
        let Some(detailed) = self.detailed_connectivity().as_ref() else {
            return Ok(());
        };
        let error = |message: String| Error::FormatRead { format, message };

        let mut metadata_components = std::collections::HashSet::new();
        for metadata in &detailed.component_metadata {
            if !metadata_components.insert(metadata.component.clone()) {
                return Err(error(format!(
                    "duplicate component metadata `{}`",
                    metadata.component
                )));
            }
        }

        let mut substations = std::collections::HashSet::new();
        for substation in &detailed.substations {
            if !substations.insert(substation.component.clone()) {
                return Err(error(format!(
                    "duplicate substation `{}`",
                    substation.component
                )));
            }
        }

        let mut voltage_levels = std::collections::HashSet::new();
        let mut voltage_level_topology = std::collections::HashMap::new();
        let mut calculated_bus_levels = std::collections::HashMap::new();
        for level in &detailed.voltage_levels {
            if !voltage_levels.insert(level.component.clone()) {
                return Err(error(format!(
                    "duplicate voltage level `{}`",
                    level.component
                )));
            }
            voltage_level_topology.insert(level.component.clone(), level.topology_kind);
            if let Some(substation) = &level.substation
                && !substations.contains(substation)
            {
                return Err(error(format!(
                    "voltage level `{}` references unknown substation `{substation}`",
                    level.component
                )));
            }
            let mut level_buses = std::collections::HashSet::new();
            for bus in &level.buses {
                if !balanced_buses.contains(bus) {
                    return Err(error(format!(
                        "voltage level `{}` references unknown calculated bus {bus}",
                        level.component
                    )));
                }
                if !level_buses.insert(*bus) {
                    return Err(error(format!(
                        "voltage level `{}` repeats calculated bus {bus}",
                        level.component
                    )));
                }
                if let Some(first_level) =
                    calculated_bus_levels.insert(*bus, level.component.clone())
                    && first_level != level.component
                {
                    return Err(error(format!(
                        "calculated bus {bus} belongs to both voltage levels `{first_level}` and `{}`",
                        level.component
                    )));
                }
            }
        }
        let known_container = |container: &ComponentId| {
            voltage_levels.contains(container) || metadata_components.contains(container)
        };

        let mut configured_buses = std::collections::HashSet::new();
        let mut configured_bus_levels = std::collections::HashMap::new();
        for bus in &detailed.bus_breaker_buses {
            if !configured_buses.insert(bus.component.clone()) {
                return Err(error(format!(
                    "duplicate bus breaker bus `{}`",
                    bus.component
                )));
            }
            if !known_container(&bus.voltage_level) {
                let detail = if bus.calculated_bus.is_none() {
                    " has no calculated bus and"
                } else {
                    ""
                };
                return Err(error(format!(
                    "TopologicalNode `{}`{detail} references unknown voltage level or connectivity container `{}`",
                    bus.component, bus.voltage_level
                )));
            }
            configured_bus_levels.insert(bus.component.clone(), bus.voltage_level.clone());
            if let Some(calculated) = bus.calculated_bus
                && !balanced_buses.contains(&calculated)
            {
                return Err(error(format!(
                    "bus breaker bus `{}` references unknown calculated bus {calculated}",
                    bus.component
                )));
            }
            if voltage_levels.contains(&bus.voltage_level)
                && let Some(calculated) = bus.calculated_bus
                && let Some(first_level) =
                    calculated_bus_levels.insert(calculated, bus.voltage_level.clone())
                && first_level != bus.voltage_level
            {
                return Err(error(format!(
                    "calculated bus {calculated} belongs to both connectivity containers `{first_level}` and `{}`",
                    bus.voltage_level
                )));
            }
        }

        let mut connectivity_nodes = std::collections::HashSet::new();
        let mut connectivity_node_levels = std::collections::HashMap::new();
        let mut connectivity_node_calculated_buses = std::collections::HashMap::new();
        for node in &detailed.connectivity_nodes {
            if !connectivity_nodes.insert(node.component.clone()) {
                return Err(error(format!(
                    "duplicate connectivity node `{}`",
                    node.component
                )));
            }
            if !known_container(&node.voltage_level) {
                let detail = if node.calculated_bus.is_none() {
                    " has no calculated bus and"
                } else {
                    ""
                };
                return Err(error(format!(
                    "ConnectivityNode `{}`{detail} references unknown voltage level or connectivity container `{}`",
                    node.component, node.voltage_level
                )));
            }
            connectivity_node_levels.insert(node.component.clone(), node.voltage_level.clone());
            connectivity_node_calculated_buses.insert(node.component.clone(), node.calculated_bus);
            if let Some(calculated) = node.calculated_bus
                && !balanced_buses.contains(&calculated)
            {
                return Err(error(format!(
                    "connectivity node `{}` references unknown calculated bus {calculated}",
                    node.component
                )));
            }
            if voltage_levels.contains(&node.voltage_level)
                && let Some(calculated) = node.calculated_bus
                && let Some(first_level) =
                    calculated_bus_levels.insert(calculated, node.voltage_level.clone())
                && first_level != node.voltage_level
            {
                return Err(error(format!(
                    "calculated bus {calculated} belongs to both connectivity containers `{first_level}` and `{}`",
                    node.voltage_level
                )));
            }
        }

        let mut calculated_buses = std::collections::HashSet::new();
        let mut calculated_bus_nodes = std::collections::HashMap::new();
        for calculated in &detailed.calculated_buses {
            if !calculated_buses.insert(calculated.calculated_bus) {
                return Err(error(format!(
                    "duplicate calculated bus {} in detailed connectivity",
                    calculated.calculated_bus
                )));
            }
            if !balanced_buses.contains(&calculated.calculated_bus) {
                return Err(error(format!(
                    "detailed connectivity references unknown calculated bus {}",
                    calculated.calculated_bus
                )));
            }
            if !known_container(&calculated.voltage_level) {
                return Err(error(format!(
                    "calculated bus {} references unknown voltage level or connectivity container `{}`",
                    calculated.calculated_bus, calculated.voltage_level
                )));
            }
            if voltage_levels.contains(&calculated.voltage_level)
                && let Some(first_level) = calculated_bus_levels
                    .insert(calculated.calculated_bus, calculated.voltage_level.clone())
                && first_level != calculated.voltage_level
            {
                return Err(error(format!(
                    "calculated bus {} belongs to both connectivity containers `{first_level}` and `{}`",
                    calculated.calculated_bus, calculated.voltage_level
                )));
            }
            for node in &calculated.nodes {
                let Some(node_level) = connectivity_node_levels.get(node) else {
                    return Err(error(format!(
                        "calculated bus {} references unknown connectivity node `{node}`",
                        calculated.calculated_bus
                    )));
                };
                if node_level != &calculated.voltage_level {
                    return Err(error(format!(
                        "calculated bus {} in `{}` contains connectivity node `{node}` from `{node_level}`",
                        calculated.calculated_bus, calculated.voltage_level
                    )));
                }
                if let Some(Some(node_bus)) = connectivity_node_calculated_buses.get(node)
                    && *node_bus != calculated.calculated_bus
                {
                    return Err(error(format!(
                        "connectivity node `{node}` names calculated bus {node_bus}, but calculated bus {} also claims that node",
                        calculated.calculated_bus
                    )));
                }
                if let Some(first_bus) =
                    calculated_bus_nodes.insert(node.clone(), calculated.calculated_bus)
                {
                    return Err(error(format!(
                        "connectivity node `{node}` is listed by calculated buses {first_bus} and {}",
                        calculated.calculated_bus
                    )));
                }
            }
        }

        let mut busbars = std::collections::HashSet::new();
        for busbar in &detailed.busbar_sections {
            if !busbars.insert(busbar.component.clone()) {
                return Err(error(format!(
                    "duplicate busbar section `{}`",
                    busbar.component
                )));
            }
            if !known_container(&busbar.voltage_level) {
                return Err(error(format!(
                    "busbar section `{}` references unknown voltage level or connectivity container `{}`",
                    busbar.component, busbar.voltage_level
                )));
            }
            let Some(node_level) = connectivity_node_levels.get(&busbar.node) else {
                return Err(error(format!(
                    "busbar section `{}` references unknown connectivity node `{}`",
                    busbar.component, busbar.node
                )));
            };
            if voltage_levels.contains(&busbar.voltage_level)
                && voltage_levels.contains(node_level)
                && node_level != &busbar.voltage_level
            {
                return Err(error(format!(
                    "busbar section `{}` in `{}` references connectivity node `{}` from `{node_level}`",
                    busbar.component, busbar.voltage_level, busbar.node
                )));
            }
        }

        let mut terminal_components = std::collections::HashSet::new();
        let mut terminal_keys = std::collections::HashSet::new();
        for terminal in &detailed.terminals {
            if terminal.terminal == 0 {
                return Err(error(format!(
                    "equipment `{}` has terminal 0",
                    terminal.equipment
                )));
            }
            if !terminal_keys.insert((terminal.equipment.clone(), terminal.terminal)) {
                return Err(error(format!(
                    "equipment `{}` repeats terminal {}",
                    terminal.equipment, terminal.terminal
                )));
            }
            if let Some(component) = &terminal.component
                && !terminal_components.insert(component.clone())
            {
                return Err(error(format!("duplicate terminal identity `{component}`")));
            }
            if !known_container(&terminal.voltage_level) {
                return Err(error(format!(
                    "equipment `{}` terminal {} references unknown voltage level or connectivity container `{}`",
                    terminal.equipment, terminal.terminal, terminal.voltage_level
                )));
            }
            for bus in [terminal.bus.as_ref(), terminal.connectable_bus.as_ref()]
                .into_iter()
                .flatten()
            {
                let Some(bus_level) = configured_bus_levels.get(bus) else {
                    return Err(error(format!(
                        "equipment `{}` terminal {} references unknown bus breaker bus `{bus}`",
                        terminal.equipment, terminal.terminal
                    )));
                };
                if bus_level != &terminal.voltage_level {
                    return Err(error(format!(
                        "equipment `{}` terminal {} in `{}` references bus `{bus}` from `{bus_level}`",
                        terminal.equipment, terminal.terminal, terminal.voltage_level
                    )));
                }
            }
            if let Some(node) = &terminal.node {
                let Some(node_level) = connectivity_node_levels.get(node) else {
                    return Err(error(format!(
                        "equipment `{}` terminal {} references unknown connectivity node `{node}`",
                        terminal.equipment, terminal.terminal
                    )));
                };
                if node_level != &terminal.voltage_level {
                    return Err(error(format!(
                        "equipment `{}` terminal {} in `{}` references connectivity node `{node}` from `{node_level}`",
                        terminal.equipment, terminal.terminal, terminal.voltage_level
                    )));
                }
            }
        }

        let mut switches = std::collections::HashSet::new();
        for switch in &detailed.switches {
            if !switches.insert(switch.component.clone()) {
                return Err(error(format!(
                    "duplicate topology switch `{}`",
                    switch.component
                )));
            }
            if !voltage_levels.contains(&switch.voltage_level)
                && !metadata_components.contains(&switch.voltage_level)
            {
                return Err(error(format!(
                    "topology switch `{}` references unknown voltage level or connectivity container `{}`",
                    switch.component, switch.voltage_level
                )));
            }
            for endpoint in [&switch.endpoint1, &switch.endpoint2] {
                match endpoint {
                    TopologyEndpoint::Bus(bus) => {
                        if !configured_bus_levels.contains_key(bus) {
                            return Err(error(format!(
                                "topology switch `{}` references unknown bus breaker bus `{bus}`",
                                switch.component
                            )));
                        }
                        if voltage_level_topology.get(&switch.voltage_level)
                            == Some(&TopologyKind::NodeBreaker)
                        {
                            return Err(error(format!(
                                "topology switch `{}` uses a bus endpoint in node breaker voltage level `{}`",
                                switch.component, switch.voltage_level
                            )));
                        }
                    }
                    TopologyEndpoint::Node(node) => {
                        if !connectivity_node_levels.contains_key(node) {
                            return Err(error(format!(
                                "topology switch `{}` references unknown connectivity node `{node}`",
                                switch.component
                            )));
                        }
                        if voltage_level_topology.get(&switch.voltage_level)
                            == Some(&TopologyKind::BusBreaker)
                        {
                            return Err(error(format!(
                                "topology switch `{}` uses a node endpoint in bus breaker voltage level `{}`",
                                switch.component, switch.voltage_level
                            )));
                        }
                    }
                }
            }
        }

        for connection in &detailed.internal_connections {
            if !voltage_levels.contains(&connection.voltage_level) {
                return Err(error(format!(
                    "internal connection references unknown voltage level `{}`",
                    connection.voltage_level
                )));
            }
            for node in [&connection.node1, &connection.node2] {
                let Some(node_level) = connectivity_node_levels.get(node) else {
                    return Err(error(format!(
                        "internal connection references unknown connectivity node `{node}`"
                    )));
                };
                if node_level != &connection.voltage_level {
                    return Err(error(format!(
                        "internal connection in `{}` references connectivity node `{node}` from `{node_level}`",
                        connection.voltage_level
                    )));
                }
            }
        }

        let mut tap_components = std::collections::HashSet::new();
        let mut tap_keys = std::collections::HashSet::new();
        for tap in &detailed.tap_changers {
            if tap.winding == 0 {
                return Err(error(format!(
                    "transformer `{}` has a tap changer on winding 0",
                    tap.transformer
                )));
            }
            let kind = match tap.kind {
                TapChangerKind::Ratio => 0_u8,
                TapChangerKind::Phase => 1_u8,
            };
            if !tap_keys.insert((tap.transformer.clone(), tap.winding, kind)) {
                return Err(error(format!(
                    "transformer `{}` repeats its {:?} tap changer on winding {}",
                    tap.transformer, tap.kind, tap.winding
                )));
            }
            if let Some(component) = &tap.component
                && !tap_components.insert(component.clone())
            {
                return Err(error(format!(
                    "duplicate tap changer identity `{component}`"
                )));
            }
            let mut positions = std::collections::HashSet::new();
            for step in &tap.steps {
                if !positions.insert(step.position) {
                    return Err(error(format!(
                        "transformer `{}` winding {} repeats tap position {}",
                        tap.transformer, tap.winding, step.position
                    )));
                }
            }
            if let Some(reference) = &tap.regulation_terminal
                && !terminal_keys.contains(&(reference.equipment.clone(), reference.terminal))
            {
                return Err(error(format!(
                    "transformer `{}` winding {} regulates unknown equipment terminal `{}` terminal {}",
                    tap.transformer, tap.winding, reference.equipment, reference.terminal
                )));
            }
        }

        Ok(())
    }

    #[allow(clippy::too_many_lines)]
    fn check_detailed_dc_references(&self, format: &'static str) -> crate::Result<()> {
        let Some(detailed) = self.detailed_connectivity().as_ref() else {
            return Ok(());
        };

        let substations = detailed
            .substations
            .iter()
            .map(|substation| &substation.component)
            .collect::<std::collections::HashSet<_>>();
        let mut converter_units =
            std::collections::HashSet::with_capacity(detailed.dc_converter_units.len());
        for unit in &detailed.dc_converter_units {
            if !converter_units.insert(&unit.component) {
                return Err(Error::FormatRead {
                    format,
                    message: format!("duplicate DCConverterUnit `{}`", unit.component.local_id()),
                });
            }
            if let Some(substation) = unit.substation.as_ref()
                && !substations.contains(substation)
            {
                return Err(Error::FormatRead {
                    format,
                    message: format!(
                        "DCConverterUnit `{}` references unknown Substation `{}`",
                        unit.component.local_id(),
                        substation.local_id()
                    ),
                });
            }
        }
        let known_components = detailed
            .component_metadata
            .iter()
            .map(|metadata| &metadata.component)
            .chain(converter_units.iter().copied())
            .collect::<std::collections::HashSet<_>>();

        let mut nodes = std::collections::HashSet::with_capacity(detailed.dc_nodes.len());
        for node in &detailed.dc_nodes {
            if !nodes.insert(&node.component) {
                return Err(Error::FormatRead {
                    format,
                    message: format!("duplicate DCNode `{}`", node.component.local_id()),
                });
            }
        }
        let mut topological_nodes =
            std::collections::HashSet::with_capacity(detailed.dc_topological_nodes.len());
        for node in &detailed.dc_topological_nodes {
            if !topological_nodes.insert(&node.component) {
                return Err(Error::FormatRead {
                    format,
                    message: format!(
                        "duplicate DCTopologicalNode `{}`",
                        node.component.local_id()
                    ),
                });
            }
        }

        let check_unit = |class: &str,
                          component: &ComponentId,
                          unit: Option<&ComponentId>|
         -> crate::Result<()> {
            if let Some(unit) = unit
                && !converter_units.contains(unit)
            {
                return Err(Error::FormatRead {
                    format,
                    message: format!(
                        "{class} `{}` references unknown DCConverterUnit `{}`",
                        component.local_id(),
                        unit.local_id()
                    ),
                });
            }
            Ok(())
        };
        let check_container = |class: &str,
                               component: &ComponentId,
                               container: Option<&ComponentId>|
         -> crate::Result<()> {
            if let Some(container) = container
                && !known_components.contains(container)
            {
                return Err(Error::FormatRead {
                    format,
                    message: format!(
                        "{class} `{}` references unknown equipment container `{}`",
                        component.local_id(),
                        container.local_id()
                    ),
                });
            }
            Ok(())
        };
        for node in &detailed.dc_topological_nodes {
            check_unit(
                "DCTopologicalNode",
                &node.component,
                node.dc_converter_unit.as_ref(),
            )?;
        }
        for node in &detailed.dc_nodes {
            check_unit("DCNode", &node.component, node.dc_converter_unit.as_ref())?;
            if let Some(topological_node) = node.dc_topological_node.as_ref()
                && !topological_nodes.contains(topological_node)
            {
                return Err(Error::FormatRead {
                    format,
                    message: format!(
                        "DCNode `{}` references unknown DCTopologicalNode `{}`",
                        node.component.local_id(),
                        topological_node.local_id()
                    ),
                });
            }
        }

        let mut terminal_ids = std::collections::HashSet::<ComponentId>::new();
        let mut check_terminal = |class: &str,
                                  equipment: &ComponentId,
                                  terminal: &DcTerminal|
         -> crate::Result<()> {
            if let Some(terminal_id) = terminal.component.as_ref()
                && !terminal_ids.insert(terminal_id.clone())
            {
                return Err(Error::FormatRead {
                    format,
                    message: format!("duplicate DCTerminal `{}`", terminal_id.local_id()),
                });
            }
            if terminal.dc_node.is_none() && terminal.dc_topological_node.is_none() {
                return Err(Error::FormatRead {
                    format,
                    message: format!(
                        "DCTerminal on {class} `{}` references neither a DCNode nor a DCTopologicalNode",
                        equipment.local_id()
                    ),
                });
            }
            if let Some(node) = terminal.dc_node.as_ref()
                && !nodes.contains(node)
            {
                return Err(Error::FormatRead {
                    format,
                    message: format!(
                        "DCTerminal on {class} `{}` references unknown DCNode `{}`",
                        equipment.local_id(),
                        node.local_id()
                    ),
                });
            }
            if let Some(node) = terminal.dc_topological_node.as_ref()
                && !topological_nodes.contains(node)
            {
                return Err(Error::FormatRead {
                    format,
                    message: format!(
                        "DCTerminal on {class} `{}` references unknown DCTopologicalNode `{}`",
                        equipment.local_id(),
                        node.local_id()
                    ),
                });
            }
            Ok(())
        };

        for ground in &detailed.dc_grounds {
            check_container(
                "DCGround",
                &ground.component,
                ground.equipment_container.as_ref(),
            )?;
            check_terminal("DCGround", &ground.component, &ground.dc_terminal)?;
        }
        for busbar in &detailed.dc_busbars {
            check_container(
                "DCBusbar",
                &busbar.component,
                busbar.equipment_container.as_ref(),
            )?;
            check_terminal("DCBusbar", &busbar.component, &busbar.dc_terminal)?;
        }
        for line in &detailed.dc_lines {
            check_container(
                "DCLineSegment",
                &line.component,
                line.equipment_container.as_ref(),
            )?;
            check_terminal("DCLineSegment", &line.component, &line.dc_terminal1)?;
            check_terminal("DCLineSegment", &line.component, &line.dc_terminal2)?;
        }
        for device in &detailed.dc_series_devices {
            check_container(
                "DCSeriesDevice",
                &device.component,
                device.equipment_container.as_ref(),
            )?;
            check_terminal("DCSeriesDevice", &device.component, &device.dc_terminal1)?;
            check_terminal("DCSeriesDevice", &device.component, &device.dc_terminal2)?;
        }
        for switch in &detailed.dc_switches {
            check_container(
                "DCSwitch",
                &switch.component,
                switch.equipment_container.as_ref(),
            )?;
            check_terminal("DCSwitch", &switch.component, &switch.dc_terminal1)?;
            check_terminal("DCSwitch", &switch.component, &switch.dc_terminal2)?;
        }
        for converter in &detailed.voltage_source_converters {
            check_unit(
                "VsConverter",
                &converter.component,
                converter.dc_converter_unit.as_ref(),
            )?;
            check_terminal("VsConverter", &converter.component, &converter.dc_terminal1)?;
            check_terminal("VsConverter", &converter.component, &converter.dc_terminal2)?;
        }
        for converter in &detailed.line_commutated_converters {
            check_unit(
                "CsConverter",
                &converter.component,
                converter.dc_converter_unit.as_ref(),
            )?;
            check_terminal("CsConverter", &converter.component, &converter.dc_terminal1)?;
            check_terminal("CsConverter", &converter.component, &converter.dc_terminal2)?;
        }

        let ac_terminals = detailed
            .terminals
            .iter()
            .map(|terminal| (&terminal.equipment, terminal.terminal))
            .collect::<std::collections::HashSet<_>>();
        let check_regulating_terminal =
            |what: &str, reference: Option<&TerminalReference>| -> crate::Result<()> {
                if let Some(reference) = reference
                    && !ac_terminals.contains(&(&reference.equipment, reference.terminal))
                {
                    return Err(Error::FormatRead {
                        format,
                        message: format!(
                            "{what} references undeclared regulating Terminal `{}` number {}",
                            reference.equipment.local_id(),
                            reference.terminal
                        ),
                    });
                }
                Ok(())
            };
        for (index, generator) in self.generators().iter().enumerate() {
            check_regulating_terminal(
                &format!("generator {index}"),
                generator.regulating_terminal.as_ref(),
            )?;
        }
        for (index, branch) in self.branches().iter().enumerate() {
            if let Some(control) = &branch.control {
                check_regulating_terminal(
                    &format!("transformer branch {index}"),
                    control.regulating_terminal.as_ref(),
                )?;
            }
        }
        for (index, shunt) in self.shunts().iter().enumerate() {
            if let Some(control) = &shunt.control {
                check_regulating_terminal(
                    &format!("switched shunt {index}"),
                    control.regulating_terminal.as_ref(),
                )?;
            }
        }
        for (transformer_index, transformer) in self.transformers_3w().iter().enumerate() {
            for (winding_index, winding) in transformer.windings.iter().enumerate() {
                if let Some(control) = &winding.control {
                    check_regulating_terminal(
                        &format!(
                            "three winding transformer {transformer_index} winding {winding_index}"
                        ),
                        control.regulating_terminal.as_ref(),
                    )?;
                }
            }
        }
        let check_pcc_terminal = |class: &str,
                                  component: &ComponentId,
                                  pcc: Option<&TerminalReference>|
         -> crate::Result<()> {
            if let Some(pcc) = pcc
                && !ac_terminals.contains(&(&pcc.equipment, pcc.terminal))
            {
                return Err(Error::FormatRead {
                    format,
                    message: format!(
                        "{class} `{}` references undeclared PCC Terminal `{}` number {}",
                        component.local_id(),
                        pcc.equipment.local_id(),
                        pcc.terminal
                    ),
                });
            }
            Ok(())
        };
        for converter in &detailed.voltage_source_converters {
            check_pcc_terminal(
                "VoltageSourceConverter",
                &converter.component,
                converter.pcc_terminal.as_ref(),
            )?;
        }
        for converter in &detailed.line_commutated_converters {
            check_pcc_terminal(
                "LineCommutatedConverter",
                &converter.component,
                converter.pcc_terminal.as_ref(),
            )?;
        }
        Ok(())
    }

    /// Star expansion allocates synthetic bus ids `max_bus_id + 1 + k`, one per
    /// in-service 3-winding transformer; a bus id near [`BusId::MAX`] would
    /// push those past the ceiling the C ABI reports ids in. The base id
    /// `max + 1` is computed whenever any 3-winding transformer is present,
    /// even if none is in service, so the headroom is
    /// `max(1, in-service count)`. No real case sits there, so refuse it at the
    /// boundary like any other malformed reference.
    fn check_star_expansion_headroom(&self, format: &'static str) -> crate::Result<()> {
        if self.transformers_3w().is_empty() {
            return Ok(());
        }
        let Some(max_id) = self.buses().iter().map(|b| b.id.0).max() else {
            return Ok(());
        };
        let needed = self
            .transformers_3w()
            .iter()
            .filter(|t| t.in_service)
            .count()
            .max(1);
        if max_id
            .checked_add(needed)
            .is_none_or(|top| top > BusId::MAX.0)
        {
            return Err(Error::FormatRead {
                format,
                message: format!(
                    "bus id {max_id} leaves no room to allocate synthetic star bus ids \
                     for 3-winding transformers"
                ),
            });
        }
        Ok(())
    }
}

/// A network as it comes back from its own serde representation, the form
/// PowerIO IR nests as `value.data`. Shared by the unit tests of every module
/// that checks a field survives that trip.
#[cfg(test)]
pub(crate) fn serde_round_trip(network: &BalancedNetwork) -> BalancedNetwork {
    serde_json::from_str(&serde_json::to_string(network).unwrap()).unwrap()
}

#[cfg(test)]
mod tests {
    use super::*;

    fn close(actual: f64, expected: f64) {
        assert!((actual - expected).abs() < 1e-12, "{actual} != {expected}");
    }

    fn component(component_type: &str, local_id: &str) -> ComponentId {
        ComponentId::new(component_type, local_id).unwrap()
    }

    fn reference_test_dc_terminal(local_id: &str, node: &ComponentId) -> DcTerminal {
        DcTerminal {
            component: Some(component("dc_terminal", local_id)),
            sequence_number: None,
            dc_node: Some(node.clone()),
            dc_topological_node: None,
            polarity: None,
            connected: None,
            active_power_mw: None,
            current_a: None,
        }
    }

    #[allow(clippy::too_many_lines)]
    fn detailed_dc_reference_test_network() -> BalancedNetwork {
        let substation = component("substation", "S");
        let converter_unit = component("dc_converter_unit", "U");
        let topological_node = component("dc_topological_node", "T");
        let node = component("dc_node", "N");
        let pcc_equipment = component("ac_equipment", "PCC");
        let voltage_level = component("voltage_level", "VL");

        let voltage_source_converter: VoltageSourceConverter =
            serde_json::from_value(serde_json::json!({
                "component": component("voltage_source_converter", "VSC"),
                "dc_converter_unit": converter_unit.clone(),
                "dc_terminal1": reference_test_dc_terminal("VSC-1", &node),
                "dc_terminal2": reference_test_dc_terminal("VSC-2", &node),
                "pcc_terminal": {
                    "equipment": pcc_equipment.clone(),
                    "terminal": 1
                }
            }))
            .unwrap();
        let line_commutated_converter: LineCommutatedConverter =
            serde_json::from_value(serde_json::json!({
                "component": component("line_commutated_converter", "LCC"),
                "dc_converter_unit": converter_unit.clone(),
                "dc_terminal1": reference_test_dc_terminal("LCC-1", &node),
                "dc_terminal2": reference_test_dc_terminal("LCC-2", &node),
                "pcc_terminal": {
                    "equipment": pcc_equipment.clone(),
                    "terminal": 1
                }
            }))
            .unwrap();

        let detailed = DetailedConnectivity {
            substations: vec![Substation {
                component: substation.clone(),
                country: None,
                operator: None,
                geographical_tags: Vec::new(),
            }],
            voltage_levels: vec![VoltageLevel {
                component: voltage_level.clone(),
                substation: Some(substation.clone()),
                nominal_kv: 230.0,
                low_voltage_limit_kv: None,
                high_voltage_limit_kv: None,
                topology_kind: TopologyKind::BusBreaker,
                buses: Vec::new(),
            }],
            terminals: vec![Terminal {
                component: None,
                equipment: pcc_equipment,
                terminal: 1,
                voltage_level,
                bus: None,
                connectable_bus: None,
                node: None,
                connected: true,
                active_power_mw: None,
                reactive_power_mvar: None,
            }],
            dc_converter_units: vec![DcConverterUnit {
                component: converter_unit.clone(),
                substation: Some(substation),
                operation_mode: DcConverterOperatingMode::Bipolar,
            }],
            dc_topological_nodes: vec![DcTopologicalNode {
                component: topological_node.clone(),
                dc_converter_unit: Some(converter_unit.clone()),
            }],
            dc_nodes: vec![DcNode {
                component: node.clone(),
                nominal_voltage_kv: None,
                dc_converter_unit: Some(converter_unit.clone()),
                dc_topological_node: Some(topological_node),
                voltage_kv: None,
            }],
            dc_grounds: vec![DcGround {
                component: component("dc_ground", "G"),
                equipment_container: Some(converter_unit.clone()),
                dc_terminal: reference_test_dc_terminal("G-1", &node),
                rated_dc_voltage_kv: None,
                resistance_ohm: None,
                inductance_h: None,
            }],
            dc_lines: vec![DcLine {
                component: component("dc_line", "L"),
                equipment_container: Some(converter_unit.clone()),
                dc_terminal1: reference_test_dc_terminal("L-1", &node),
                dc_terminal2: reference_test_dc_terminal("L-2", &node),
                rated_dc_voltage_kv: None,
                resistance_ohm: None,
                inductance_h: None,
                capacitance_f: None,
                length_km: None,
            }],
            dc_switches: vec![DcSwitch {
                component: component("dc_switch", "SW"),
                equipment_container: Some(converter_unit),
                dc_terminal1: reference_test_dc_terminal("SW-1", &node),
                dc_terminal2: reference_test_dc_terminal("SW-2", &node),
                kind: DcSwitchKind::Switch,
                rated_dc_voltage_kv: None,
                open: None,
                resistance_ohm: None,
            }],
            voltage_source_converters: vec![voltage_source_converter],
            line_commutated_converters: vec![line_commutated_converter],
            ..DetailedConnectivity::default()
        };
        let mut network = BalancedNetwork::new("dc-reference-test", 100.0);
        *network.detailed_connectivity_mut() = Some(std::sync::Arc::new(detailed));
        network
    }

    fn reference_test_detailed_mut(network: &mut BalancedNetwork) -> &mut DetailedConnectivity {
        std::sync::Arc::make_mut(
            network
                .detailed_connectivity_mut()
                .as_mut()
                .expect("reference test has detailed connectivity"),
        )
    }

    fn assert_invalid(network: &BalancedNetwork, expected: &str) {
        let error = network.validate().unwrap_err().to_string();
        assert!(
            error.contains(expected),
            "expected `{expected}` in `{error}`"
        );
    }

    fn assert_duplicate_dc_converter_unit_rejected(valid: &BalancedNetwork) {
        let mut network = valid.clone();
        let unit = reference_test_detailed_mut(&mut network).dc_converter_units[0].clone();
        reference_test_detailed_mut(&mut network)
            .dc_converter_units
            .push(unit);
        assert_invalid(&network, "duplicate DCConverterUnit");
    }

    #[test]
    fn detailed_dc_references_are_complete_and_checked() {
        let valid = detailed_dc_reference_test_network();
        valid.validate().unwrap();

        assert_duplicate_dc_converter_unit_rejected(&valid);

        let mut missing_substation = valid.clone();
        reference_test_detailed_mut(&mut missing_substation).dc_converter_units[0].substation =
            Some(component("substation", "missing"));
        assert_invalid(&missing_substation, "references unknown Substation");

        let mut duplicate_topological_node = valid.clone();
        let node = reference_test_detailed_mut(&mut duplicate_topological_node)
            .dc_topological_nodes[0]
            .clone();
        reference_test_detailed_mut(&mut duplicate_topological_node)
            .dc_topological_nodes
            .push(node);
        assert_invalid(&duplicate_topological_node, "duplicate DCTopologicalNode");

        let mut missing_topological_unit = valid.clone();
        reference_test_detailed_mut(&mut missing_topological_unit).dc_topological_nodes[0]
            .dc_converter_unit = Some(component("dc_converter_unit", "missing"));
        assert_invalid(
            &missing_topological_unit,
            "DCTopologicalNode `T` references unknown DCConverterUnit",
        );

        let mut missing_node_unit = valid.clone();
        reference_test_detailed_mut(&mut missing_node_unit).dc_nodes[0].dc_converter_unit =
            Some(component("dc_converter_unit", "missing"));
        assert_invalid(
            &missing_node_unit,
            "DCNode `N` references unknown DCConverterUnit",
        );

        let mut missing_node_topology = valid.clone();
        reference_test_detailed_mut(&mut missing_node_topology).dc_nodes[0].dc_topological_node =
            Some(component("dc_topological_node", "missing"));
        assert_invalid(
            &missing_node_topology,
            "DCNode `N` references unknown DCTopologicalNode",
        );

        let mut missing_container = valid.clone();
        reference_test_detailed_mut(&mut missing_container).dc_lines[0].equipment_container =
            Some(component("dc_converter_unit", "missing"));
        assert_invalid(
            &missing_container,
            "DCLineSegment `L` references unknown equipment container",
        );

        let mut missing_converter_unit = valid.clone();
        reference_test_detailed_mut(&mut missing_converter_unit).voltage_source_converters[0]
            .dc_converter_unit = Some(component("dc_converter_unit", "missing"));
        assert_invalid(
            &missing_converter_unit,
            "VsConverter `VSC` references unknown DCConverterUnit",
        );

        let mut terminal_without_node = valid.clone();
        let terminal =
            &mut reference_test_detailed_mut(&mut terminal_without_node).dc_grounds[0].dc_terminal;
        terminal.dc_node = None;
        terminal.dc_topological_node = None;
        assert_invalid(
            &terminal_without_node,
            "references neither a DCNode nor a DCTopologicalNode",
        );

        let mut missing_physical_node = valid.clone();
        reference_test_detailed_mut(&mut missing_physical_node).dc_grounds[0]
            .dc_terminal
            .dc_node = Some(component("dc_node", "missing"));
        assert_invalid(&missing_physical_node, "references unknown DCNode");

        let mut missing_terminal_topology = valid.clone();
        let terminal = &mut reference_test_detailed_mut(&mut missing_terminal_topology).dc_grounds
            [0]
        .dc_terminal;
        terminal.dc_node = None;
        terminal.dc_topological_node = Some(component("dc_topological_node", "missing"));
        assert_invalid(
            &missing_terminal_topology,
            "references unknown DCTopologicalNode",
        );

        let mut duplicate_terminal = valid.clone();
        let terminal_id = reference_test_detailed_mut(&mut duplicate_terminal).dc_grounds[0]
            .dc_terminal
            .component
            .clone();
        reference_test_detailed_mut(&mut duplicate_terminal).dc_lines[0]
            .dc_terminal1
            .component = terminal_id;
        assert_invalid(&duplicate_terminal, "duplicate DCTerminal");

        let mut missing_pcc_terminal = valid;
        reference_test_detailed_mut(&mut missing_pcc_terminal).voltage_source_converters[0]
            .pcc_terminal
            .as_mut()
            .unwrap()
            .terminal = 2;
        assert_invalid(&missing_pcc_terminal, "references undeclared PCC Terminal");
    }

    #[test]
    #[allow(clippy::too_many_lines)] // the fixture names every physical DC equipment record
    fn detailed_connectivity_dc_equipment_round_trips_and_defaults() {
        let empty: DetailedConnectivity = serde_json::from_str("{}").unwrap();
        assert_eq!(empty, DetailedConnectivity::default());

        let node1 = component("dc_node", "dc-1");
        let node2 = component("dc_node", "dc-2");
        let terminal = |dc_node: ComponentId, connected: bool, power| DcTerminal {
            component: None,
            sequence_number: None,
            dc_node: Some(dc_node),
            dc_topological_node: None,
            polarity: None,
            connected: Some(connected),
            active_power_mw: power,
            current_a: power.map(|value| value / 320.0),
        };
        let unit = component("dc_converter_unit", "unit");
        let topological_node = component("dc_topological_node", "dc-topology");
        let pcc_terminal = TerminalReference {
            equipment: component("branch", "pcc"),
            terminal: 2,
        };
        let droop_curve = DroopCurve {
            segments: vec![DroopCurveSegment {
                minimum_voltage_kv: 300.0,
                maximum_voltage_kv: 340.0,
                k: 0.4,
            }],
        };
        let mut curve_properties = BTreeMap::new();
        curve_properties.insert("source".into(), "test".into());
        let reactive_limits = ReactiveLimits::CapabilityCurve(ReactiveCapabilityCurve {
            curve_style: CurveStyle::StraightLineYValues,
            properties: curve_properties,
            points: vec![
                ReactiveCapabilityCurvePoint {
                    active_power_mw: -100.0,
                    minimum_reactive_power_mvar: -50.0,
                    maximum_reactive_power_mvar: 40.0,
                    properties: BTreeMap::new(),
                },
                ReactiveCapabilityCurvePoint {
                    active_power_mw: 100.0,
                    minimum_reactive_power_mvar: -40.0,
                    maximum_reactive_power_mvar: 50.0,
                    properties: BTreeMap::new(),
                },
            ],
        });
        let detailed = DetailedConnectivity {
            terminals: vec![Terminal {
                component: None,
                equipment: component("voltage_source_converter", "vsc"),
                terminal: 1,
                voltage_level: component("voltage_level", "vl"),
                bus: None,
                connectable_bus: None,
                node: Some(component("connectivity_node", "n1")),
                connected: true,
                active_power_mw: Some(-95.0),
                reactive_power_mvar: Some(12.0),
            }],
            dc_converter_units: vec![DcConverterUnit {
                component: unit.clone(),
                substation: Some(component("substation", "station")),
                operation_mode: DcConverterOperatingMode::Bipolar,
            }],
            dc_topological_nodes: vec![DcTopologicalNode {
                component: topological_node.clone(),
                dc_converter_unit: Some(unit.clone()),
            }],
            dc_nodes: vec![
                DcNode {
                    component: node1.clone(),
                    nominal_voltage_kv: Some(320.0),
                    dc_converter_unit: Some(unit.clone()),
                    dc_topological_node: Some(topological_node.clone()),
                    voltage_kv: Some(318.0),
                },
                DcNode {
                    component: node2.clone(),
                    nominal_voltage_kv: Some(320.0),
                    dc_converter_unit: Some(unit.clone()),
                    dc_topological_node: Some(topological_node),
                    voltage_kv: None,
                },
            ],
            dc_grounds: vec![DcGround {
                component: component("dc_ground", "ground"),
                equipment_container: Some(unit.clone()),
                dc_terminal: terminal(node1.clone(), true, Some(0.5)),
                rated_dc_voltage_kv: Some(320.0),
                resistance_ohm: Some(2.0),
                inductance_h: Some(0.01),
            }],
            dc_lines: vec![DcLine {
                component: component("dc_line", "line"),
                equipment_container: Some(unit.clone()),
                dc_terminal1: terminal(node1.clone(), true, Some(100.0)),
                dc_terminal2: terminal(node2.clone(), false, Some(-99.0)),
                rated_dc_voltage_kv: Some(320.0),
                resistance_ohm: Some(1.5),
                inductance_h: Some(0.02),
                capacitance_f: Some(0.001),
                length_km: Some(20.0),
            }],
            dc_switches: vec![DcSwitch {
                component: component("dc_switch", "breaker"),
                equipment_container: Some(unit.clone()),
                dc_terminal1: terminal(node1.clone(), true, None),
                dc_terminal2: terminal(node2.clone(), true, None),
                kind: DcSwitchKind::Breaker,
                rated_dc_voltage_kv: Some(320.0),
                open: Some(false),
                resistance_ohm: Some(0.01),
            }],
            voltage_source_converters: vec![VoltageSourceConverter {
                component: component("voltage_source_converter", "vsc"),
                dc_converter_unit: Some(unit.clone()),
                dc_terminal1: terminal(node1.clone(), true, Some(-100.0)),
                dc_terminal2: terminal(node2.clone(), true, Some(100.0)),
                base_apparent_power_mva: Some(200.0),
                minimum_active_power_mw: Some(-150.0),
                maximum_active_power_mw: Some(150.0),
                minimum_dc_voltage_kv: Some(300.0),
                maximum_dc_voltage_kv: Some(340.0),
                rated_dc_voltage_kv: Some(320.0),
                valve_u0_kv: Some(0.1),
                number_of_valves: Some(4),
                idle_loss_mw: Some(1.0),
                switching_loss_mw_per_ampere: Some(0.002),
                resistive_loss_ohm: Some(0.1),
                control_mode: Some(
                    AcDcConverterControlMode::ActivePowerAtPccAndDcVoltageDroopCurve,
                ),
                active_power_at_pcc_mw: Some(95.0),
                reactive_power_at_pcc_mvar: Some(12.0),
                target_active_power_mw: Some(95.0),
                target_dc_voltage_kv: Some(320.0),
                pcc_terminal: Some(pcc_terminal.clone()),
                droop_curve: Some(droop_curve.clone()),
                droop: Some(2.0),
                droop_compensation: Some(0.1),
                q_share: Some(0.5),
                maximum_modulation_index: Some(0.9),
                maximum_valve_current_a: Some(800.0),
                voltage_regulator_on: Some(true),
                voltage_setpoint_kv: Some(230.0),
                reactive_power_setpoint_mvar: None,
                reactive_limits: Some(reactive_limits),
                pole_loss_active_power_mw: Some(1.2),
                dc_current_a: Some(300.0),
                ac_voltage_kv: Some(230.0),
                dc_voltage_kv: Some(318.0),
                delta_degrees: Some(1.0),
                uf_kv: Some(229.0),
                uv_kv: Some(231.0),
            }],
            line_commutated_converters: vec![LineCommutatedConverter {
                component: component("line_commutated_converter", "lcc"),
                dc_converter_unit: Some(unit),
                dc_terminal1: terminal(node1, true, Some(-75.0)),
                dc_terminal2: terminal(node2, true, Some(75.0)),
                base_apparent_power_mva: Some(160.0),
                minimum_active_power_mw: Some(-120.0),
                maximum_active_power_mw: Some(120.0),
                minimum_dc_voltage_kv: Some(300.0),
                maximum_dc_voltage_kv: Some(340.0),
                rated_dc_voltage_kv: Some(320.0),
                valve_u0_kv: Some(0.2),
                number_of_valves: Some(6),
                idle_loss_mw: Some(0.5),
                switching_loss_mw_per_ampere: Some(0.001),
                resistive_loss_ohm: Some(0.2),
                control_mode: Some(AcDcConverterControlMode::DcVoltage),
                active_power_at_pcc_mw: Some(-75.0),
                reactive_power_at_pcc_mvar: Some(-20.0),
                target_active_power_mw: None,
                target_dc_voltage_kv: Some(320.0),
                pcc_terminal: Some(pcc_terminal),
                droop_curve: Some(droop_curve),
                reactive_model: Some(LineCommutatedConverterReactiveModel::FixedPowerFactor),
                power_factor: Some(0.95),
                operating_mode: Some(LineCommutatedConverterOperatingMode::Rectifier),
                rated_dc_current_a: Some(500.0),
                minimum_alpha_degrees: Some(5.0),
                maximum_alpha_degrees: Some(30.0),
                minimum_gamma_degrees: Some(10.0),
                maximum_gamma_degrees: Some(35.0),
                target_alpha_degrees: Some(15.0),
                target_gamma_degrees: Some(20.0),
                target_dc_current_a: Some(250.0),
                pole_loss_active_power_mw: Some(0.8),
                dc_current_a: Some(250.0),
                ac_voltage_kv: Some(230.0),
                dc_voltage_kv: Some(319.0),
                alpha_degrees: Some(14.0),
                gamma_degrees: Some(19.0),
            }],
            ..DetailedConnectivity::default()
        };

        let json = serde_json::to_string(&detailed).unwrap();
        let restored: DetailedConnectivity = serde_json::from_str(&json).unwrap();
        assert_eq!(restored, detailed);

        let mut older_terminal = serde_json::to_value(&detailed.terminals[0]).unwrap();
        let older_terminal = older_terminal.as_object_mut().unwrap();
        older_terminal.remove("active_power_mw");
        older_terminal.remove("reactive_power_mvar");
        let older_terminal: Terminal =
            serde_json::from_value(serde_json::Value::Object(older_terminal.clone())).unwrap();
        assert_eq!(older_terminal.active_power_mw, None);
        assert_eq!(older_terminal.reactive_power_mvar, None);

        let min_max = ReactiveLimits::MinMax(MinMaxReactiveLimits {
            minimum_reactive_power_mvar: -25.0,
            maximum_reactive_power_mvar: 30.0,
            properties: BTreeMap::new(),
        });
        let json = serde_json::to_string(&min_max).unwrap();
        assert_eq!(
            serde_json::from_str::<ReactiveLimits>(&json).unwrap(),
            min_max
        );
    }

    #[test]
    fn converter_droop_control_modes_have_distinct_serialized_names() {
        for (mode, name) in [
            (
                AcDcConverterControlMode::ActivePowerAtPccAndDcVoltageDroopCurve,
                "active_power_at_pcc_and_dc_voltage_droop_curve",
            ),
            (
                AcDcConverterControlMode::ActivePowerAtPccAndDcVoltageDroop,
                "active_power_at_pcc_and_dc_voltage_droop",
            ),
            (
                AcDcConverterControlMode::ActivePowerAtPccAndDcVoltageDroopWithCompensation,
                "active_power_at_pcc_and_dc_voltage_droop_with_compensation",
            ),
            (
                AcDcConverterControlMode::ActivePowerAtPccAndDcVoltageDroopPilot,
                "active_power_at_pcc_and_dc_voltage_droop_pilot",
            ),
        ] {
            let value = serde_json::to_value(mode).unwrap();
            assert_eq!(value, serde_json::Value::String(name.to_owned()));
            assert_eq!(
                serde_json::from_value::<AcDcConverterControlMode>(value).unwrap(),
                mode
            );
        }
    }

    #[test]
    fn assigned_component_ids_follow_records_after_reordering() {
        let mut network = BalancedNetwork::in_memory(
            "ids",
            100.0,
            vec![
                Bus::new(BusId(10), BusType::Ref, 230.0),
                Bus::new(BusId(20), BusType::Pq, 230.0),
            ],
            vec![
                Branch::new(BusId(10), BusId(20), 0.0, 0.1),
                Branch::new(BusId(10), BusId(20), 0.0, 0.2),
            ],
        );
        network.loads_mut().extend([
            Load::new(BusId(20), 10.0, 1.0),
            Load::new(BusId(20), 20.0, 2.0),
        ]);
        network.assign_missing_component_ids();

        assert_eq!(network.buses()[0].uid.as_deref(), Some("10"));
        assert_eq!(network.branches()[0].uid.as_deref(), Some("10-20"));
        assert_eq!(network.branches()[1].uid.as_deref(), Some("10-20-2"));
        assert_eq!(network.loads()[0].uid.as_deref(), Some("bus-20"));
        assert_eq!(network.loads()[1].uid.as_deref(), Some("bus-20-2"));
        assert!(network.uid_is_generated(network.loads()[0].uid.as_deref()));

        network.loads_mut().swap(0, 1);
        network.branches_mut().swap(0, 1);
        network.assign_missing_component_ids();
        assert_eq!(network.loads()[0].uid.as_deref(), Some("bus-20-2"));
        assert_eq!(network.loads()[1].uid.as_deref(), Some("bus-20"));
        assert_eq!(network.branches()[0].uid.as_deref(), Some("10-20-2"));
        assert_eq!(network.branches()[1].uid.as_deref(), Some("10-20"));

        let restored = serde_round_trip(&network);
        assert_eq!(restored.loads()[0].uid, network.loads()[0].uid);
        assert_eq!(restored.branches()[0].uid, network.branches()[0].uid);
        assert!(restored.uid_is_generated(restored.loads()[0].uid.as_deref()));
    }

    #[test]
    fn source_and_generated_component_identities_remain_distinct() {
        let mut explicit = Bus::new(BusId(10), BusType::Ref, 230.0);
        explicit.uid = Some("source-bus".to_owned());
        let mut network = BalancedNetwork::new("identity provenance", 100.0);
        network
            .buses_mut()
            .extend([explicit, Bus::new(BusId(20), BusType::Pq, 230.0)]);
        network.assign_missing_component_ids();

        assert!(!network.uid_is_generated(network.buses()[0].uid.as_deref()));
        assert!(network.uid_is_generated(network.buses()[1].uid.as_deref()));
    }

    /// XIIDM and CGMES index every element by one identifier, so a load and a
    /// generator at the same bus cannot both be `bus-20`.
    #[test]
    fn generated_identities_are_unique_across_tables() {
        let mut network = BalancedNetwork::in_memory(
            "cross table ids",
            100.0,
            vec![
                Bus::new(BusId(10), BusType::Ref, 230.0),
                Bus::new(BusId(20), BusType::Pq, 230.0),
            ],
            vec![Branch::new(BusId(10), BusId(20), 0.0, 0.1)],
        );
        network.loads_mut().push(Load::new(BusId(20), 10.0, 1.0));
        network.shunts_mut().push(Shunt::new(BusId(20), 0.0, 0.5));
        network.generators_mut().push(Generator::new(BusId(20)));
        network.assign_missing_component_ids();

        let mut identities = vec![
            network.loads()[0].uid.clone().unwrap(),
            network.shunts()[0].uid.clone().unwrap(),
            network.generators()[0].uid.clone().unwrap(),
        ];
        identities.sort();
        assert_eq!(identities, ["bus-20", "bus-20-2", "bus-20-3"]);

        // Assigning again leaves every identity alone, so an identity stays
        // stable across a reload.
        let before = identities.clone();
        network.assign_missing_component_ids();
        let mut after = vec![
            network.loads()[0].uid.clone().unwrap(),
            network.shunts()[0].uid.clone().unwrap(),
            network.generators()[0].uid.clone().unwrap(),
        ];
        after.sort();
        assert_eq!(after, before);
    }

    #[test]
    fn source_format_serializes_as_its_name_token() {
        // The exhaustive match keeps a new enum case from shipping with a serde
        // spelling that differs from name().
        let all = [
            SourceFormat::Sincal,
            SourceFormat::Matpower,
            SourceFormat::PowerModelsJson,
            SourceFormat::EgretJson,
            SourceFormat::Psse,
            SourceFormat::PsseRawx,
            SourceFormat::PowerWorld,
            SourceFormat::PandapowerJson,
            SourceFormat::Pslf,
            SourceFormat::PowerWorldBinary,
            SourceFormat::InMemory,
            SourceFormat::Normalized,
            SourceFormat::Gridfm,
            SourceFormat::PypsaCsv,
            SourceFormat::Goc3Json,
            SourceFormat::SurgeJson,
            SourceFormat::DeepMindOpfDataJson,
            SourceFormat::Xiidm,
            SourceFormat::Jiidm,
            SourceFormat::Cgmes,
            SourceFormat::Ucte,
            SourceFormat::IeeeCdf,
        ];
        for f in all {
            match f {
                SourceFormat::Matpower
                | SourceFormat::PowerModelsJson
                | SourceFormat::EgretJson
                | SourceFormat::Psse
                | SourceFormat::PsseRawx
                | SourceFormat::PowerWorld
                | SourceFormat::PandapowerJson
                | SourceFormat::Pslf
                | SourceFormat::PowerWorldBinary
                | SourceFormat::InMemory
                | SourceFormat::Normalized
                | SourceFormat::Gridfm
                | SourceFormat::PypsaCsv
                | SourceFormat::Goc3Json
                | SourceFormat::SurgeJson
                | SourceFormat::DeepMindOpfDataJson
                | SourceFormat::Xiidm
                | SourceFormat::Jiidm
                | SourceFormat::Cgmes
                | SourceFormat::Ucte
                | SourceFormat::IeeeCdf
                | SourceFormat::Sincal => {}
            }
            let token = serde_json::to_value(f).unwrap();
            assert_eq!(token, serde_json::Value::String(f.name().to_owned()));
            let back: SourceFormat = serde_json::from_value(token).unwrap();
            assert_eq!(back, f);
        }
    }

    #[test]
    fn quadratic_with_constant_keeps_c0_across_ncost() {
        let full = GenCost::new(2, 0.0, 0.0, vec![1.5, 2.0, 5.0]);
        assert_eq!(full.calc_quadratic_with_constant(), Some((3.0, 2.0, 5.0)));
        assert_eq!(full.calc_quadratic(), Some((3.0, 2.0)));
        assert_eq!(
            full.calc_quadratic_with_constant(),
            full.calc_quadratic_with_constant()
        );
        assert_eq!(full.calc_quadratic(), full.calc_quadratic());

        let linear = GenCost::new(2, 0.0, 0.0, vec![2.0, 5.0]);
        assert_eq!(linear.calc_quadratic_with_constant(), Some((0.0, 2.0, 5.0)));

        let constant = GenCost::new(2, 0.0, 0.0, vec![5.0]);
        assert_eq!(
            constant.calc_quadratic_with_constant(),
            Some((0.0, 0.0, 5.0))
        );

        let piecewise = GenCost::new(1, 0.0, 0.0, vec![0.0, 0.0, 1.0, 1.0]);
        assert_eq!(piecewise.calc_quadratic_with_constant(), None);

        let cubic = GenCost::new(2, 0.0, 0.0, vec![1.0, 1.0, 1.0, 1.0]);
        assert_eq!(cubic.calc_quadratic_with_constant(), None);

        let truncated = GenCost::with_ncost(2, 0.0, 0.0, 3, vec![1.0]);
        assert_eq!(truncated.calc_quadratic_with_constant(), None);
    }

    #[test]
    fn a_leading_coefficient_below_the_tolerance_comes_off_the_row() {
        let artifact = GenCost::new(2, 0.0, 0.0, vec![1e-17, 2.0, 5.0]);
        assert_eq!(
            artifact.calc_quadratic_with_constant(),
            Some((2e-17, 2.0, 5.0)),
            "the untouched reader keeps the artifact"
        );
        assert_eq!(
            artifact.calc_quadratic_with_constant_tol(GenCost::LEADING_COEFF_TOL),
            Some((0.0, 2.0, 5.0))
        );
        assert_eq!(
            artifact.calc_quadratic_with_constant_tol(0.0),
            Some((2e-17, 2.0, 5.0)),
            "a zero tolerance strips an exact zero alone"
        );

        // A row states a curve of a lower order once the leading zeros are off,
        // so a cubic row the untouched reader refuses reads as a quadratic one.
        let padded = GenCost::new(2, 0.0, 0.0, vec![0.0, 1.5, 2.0, 5.0]);
        assert_eq!(padded.calc_quadratic_with_constant(), None);
        assert_eq!(
            padded.calc_quadratic_with_constant_tol(0.0),
            Some((3.0, 2.0, 5.0))
        );

        let flat = GenCost::new(2, 0.0, 0.0, vec![1e-17, 1e-17, 1e-17]);
        assert_eq!(
            flat.calc_quadratic_with_constant_tol(GenCost::LEADING_COEFF_TOL),
            Some((0.0, 0.0, 1e-17)),
            "the last coefficient stays, whatever its magnitude"
        );

        let piecewise = GenCost::new(1, 0.0, 0.0, vec![0.0, 0.0, 1.0, 1.0]);
        assert_eq!(
            piecewise.calc_quadratic_with_constant_tol(GenCost::LEADING_COEFF_TOL),
            None
        );

        let truncated = GenCost::with_ncost(2, 0.0, 0.0, 3, vec![1.0]);
        assert_eq!(
            truncated.calc_quadratic_with_constant_tol(GenCost::LEADING_COEFF_TOL),
            None
        );

        let quartic = GenCost::new(2, 0.0, 0.0, vec![1.0, 1.0, 1.0, 1.0, 1.0]);
        assert_eq!(
            quartic.calc_quadratic_with_constant_tol(GenCost::LEADING_COEFF_TOL),
            None
        );
    }

    /// The bound at one corner of the voltage box: the law of cosines over the
    /// angle window, scaled by the larger terminal ceiling and the impedance.
    fn expected_rate(window: f64, fr: f64, to: f64, zmag: f64) -> f64 {
        let separation = (fr * fr + to * to - 2.0 * fr * to * window.cos()).sqrt();
        fr.max(to) * separation / zmag
    }

    #[test]
    fn synthesized_rate_follows_the_angle_window_and_the_voltage_bands() {
        let br = Branch::new(BusId(1), BusId(2), 0.03, 0.04);
        let expected = |window: f64, fr: f64, to: f64| expected_rate(window, fr, to, 0.05);
        // A band pinned to one value, so the four corners collapse to one and
        // the bound is the plain law of cosines.
        let at = |v: f64| (v, v);
        close(
            br.synthesize_rate_a(0.5, at(1.1), at(1.06)),
            expected(0.5, 1.1, 1.06),
        );

        // A wider window gives a looser bound.
        assert!(
            br.synthesize_rate_a(0.8, at(1.1), at(1.06))
                > br.synthesize_rate_a(0.5, at(1.1), at(1.06))
        );

        // The magnitude of the window is what counts, and it holds at π.
        close(
            br.synthesize_rate_a(-0.5, at(1.1), at(1.06)),
            expected(0.5, 1.1, 1.06),
        );
        for window in [6.0, 2.0 * std::f64::consts::PI, -360.0] {
            close(
                br.synthesize_rate_a(window, at(1.1), at(1.06)),
                expected(std::f64::consts::PI, 1.1, 1.06),
            );
        }

        let ideal = Branch::new(BusId(1), BusId(2), 0.0, 0.0);
        close(ideal.synthesize_rate_a(0.5, at(1.1), at(1.1)), 0.0);
    }

    #[test]
    fn a_narrow_window_bounds_at_the_mixed_voltage_corner() {
        // The phasor difference is convex in the two voltages, so its largest
        // value over the band box is at a corner. Below roughly 10° that corner
        // is one terminal at its ceiling and the other at its floor, not both at
        // their ceilings. Reading only the ceilings there returns a bound
        // several times tighter than the branch physically has, and an OPF
        // enforces it.
        let br = Branch::new(BusId(1), BusId(2), 0.0, 0.01);
        let (vmin, vmax) = (0.9, 1.1);
        let corner = |window: f64, fr: f64, to: f64| expected_rate(window, fr, to, 0.01);

        let narrow = 2.0_f64.to_radians();
        let bound = br.synthesize_rate_a(narrow, (vmin, vmax), (vmin, vmax));
        close(bound, corner(narrow, vmax, vmin));
        assert!(
            bound > 5.0 * corner(narrow, vmax, vmax),
            "the mixed corner dominates here: {bound} vs {}",
            corner(narrow, vmax, vmax)
        );

        // Past the crossover both ceilings win again, and the bound follows.
        let wide = 30.0_f64.to_radians();
        close(
            br.synthesize_rate_a(wide, (vmin, vmax), (vmin, vmax)),
            corner(wide, vmax, vmax),
        );
    }

    fn bus(id: usize) -> Bus {
        Bus {
            id: BusId(id),
            kind: BusType::Pq,
            vm: 1.0,
            va: 0.0,
            base_kv: 230.0,
            vmax: 1.1,
            vmin: 0.9,
            evhi: None,
            evlo: None,
            area: 1,
            zone: 1,
            name: None,
            uid: None,
            location: None,
            extras: Extras::new(),
        }
    }

    fn winding(b: usize) -> Winding {
        Winding {
            bus: BusId(b),
            tap: 1.0,
            shift: 0.0,
            nominal_kv: 230.0,
            rate_a: 100.0,
            rate_b: 0.0,
            rate_c: 0.0,
            control: None,
        }
    }

    fn transformer_3w() -> Transformer3W {
        let z = |r, x| Impedance {
            r,
            x,
            base_mva: 100.0,
        };
        Transformer3W {
            windings: [winding(1), winding(2), winding(3)],
            z: [z(0.01, 0.10), z(0.02, 0.20), z(0.03, 0.30)],
            star_vm: 0.98,
            star_va: -1.5,
            mag_g: 0.0,
            mag_b: 0.0,
            in_service: true,
            name: Some("T1".into()),
            uid: None,
            extras: Extras::new(),
        }
    }

    #[test]
    fn star_impedances_split_the_pairwise_values() {
        // z1 = (z12 + z31 - z23)/2, z2 = (z12 + z23 - z31)/2, z3 = (z23 + z31 - z12)/2.
        let [(r1, x1), (r2, x2), (r3, x3)] = transformer_3w().calc_star_impedances();
        close(r1, 0.01);
        close(x1, 0.10);
        close(r2, 0.0);
        close(x2, 0.0);
        close(r3, 0.02);
        close(x3, 0.20);
    }

    #[test]
    fn star_expansion_builds_a_star_bus_and_three_branches() {
        let t = transformer_3w();
        let (star, branches) = t.to_star_expansion(BusId(99));

        assert_eq!(star.id, BusId(99));
        close(star.vm, 0.98);
        close(star.va, -1.5);
        // Each branch runs from its winding bus to the star, carrying the
        // winding tap and ratings and the split impedance.
        for (i, br) in branches.iter().enumerate() {
            assert_eq!(br.from, t.windings[i].bus);
            assert_eq!(br.to, BusId(99));
            close(br.tap, 1.0);
            close(br.rate_a, 100.0);
        }
        close(branches[2].r, 0.02);
        close(branches[2].x, 0.20);
    }

    #[test]
    fn star_expansion_carries_winding_status_and_rating_sets() {
        let mut t = transformer_3w();
        t.set_winding_in_service([true, false, true]);
        t.set_winding_rating_sets(2, vec![BranchRatingSet::new("RATE4", 75.0)]);
        let (_, branches) = t.to_star_expansion(BusId(99));
        assert_eq!(
            branches.each_ref().map(|br| br.in_service),
            [true, false, true]
        );
        assert_eq!(
            branches[2].rating_sets,
            [BranchRatingSet::new("RATE4", 75.0)]
        );
        assert_eq!(branches[0].rating_sets, []);

        // The transformer status still takes every winding out.
        t.in_service = false;
        let (_, branches) = t.to_star_expansion(BusId(99));
        assert!(branches.iter().all(|br| !br.in_service));

        // The lowering keeps all three branches of a partly in service
        // transformer, so analysis rows still map to windings one for one.
        t.in_service = true;
        let mut net =
            BalancedNetwork::in_memory("t", 100.0, vec![bus(1), bus(2), bus(3)], Vec::new());
        net.transformers_3w_mut().push(t);
        let lowered = net.expand_transformers_3w();
        assert_eq!(
            lowered
                .branches()
                .iter()
                .map(|br| (br.from, br.in_service))
                .collect::<Vec<_>>(),
            [(BusId(1), true), (BusId(2), false), (BusId(3), true)]
        );
        assert_eq!(net.lowered_lengths().branches, lowered.branches().len());
    }

    #[test]
    fn winding_status_and_rating_sets_live_in_extras_only_when_stated() {
        let mut t = transformer_3w();
        assert_eq!(t.winding_in_service(), [true; 3]);
        assert_eq!(t.winding_rating_sets(1), []);

        t.set_winding_in_service([false, true, true]);
        t.set_winding_rating_sets(1, vec![BranchRatingSet::new("RATE4", 75.0)]);
        assert_eq!(
            t.extras["winding_in_service"],
            serde_json::json!([false, true, true])
        );
        assert_eq!(
            t.extras["winding_rating_sets"],
            serde_json::json!([[], [{"name": "RATE4", "rate_mva": 75.0}], []])
        );
        let mut net =
            BalancedNetwork::in_memory("t", 100.0, vec![bus(1), bus(2), bus(3)], Vec::new());
        net.transformers_3w_mut().push(t.clone());
        let back = serde_round_trip(&net);
        assert_eq!(
            back.transformers_3w()[0].winding_in_service(),
            [false, true, true]
        );
        assert_eq!(
            back.transformers_3w()[0].winding_rating_sets(1),
            [BranchRatingSet::new("RATE4", 75.0)]
        );

        // Restating the defaults removes both entries.
        t.set_winding_in_service([true; 3]);
        t.set_winding_rating_sets(1, Vec::new());
        assert!(t.extras.is_empty(), "{:?}", t.extras);

        // A malformed entry reads as the default rather than failing.
        t.extras
            .insert("winding_in_service".to_owned(), Value::from("open"));
        assert_eq!(t.winding_in_service(), [true; 3]);
    }

    #[test]
    fn three_winding_transformer_survives_serde_round_trip() {
        let mut net =
            BalancedNetwork::in_memory("t", 100.0, vec![bus(1), bus(2), bus(3)], Vec::new());
        net.transformers_3w_mut().push(transformer_3w());
        net.validate().unwrap();

        let back = serde_round_trip(&net);
        assert_eq!(back.transformers_3w().len(), 1);
        close(back.transformers_3w()[0].z[1].x, 0.20);
        assert_eq!(back.transformers_3w()[0].windings[2].bus, BusId(3));
    }

    #[test]
    fn a_network_with_only_out_of_service_three_winding_units_is_not_copied() {
        let mut out_of_service = transformer_3w();
        out_of_service.in_service = false;
        let mut net =
            BalancedNetwork::in_memory("t", 100.0, vec![bus(1), bus(2), bus(3)], Vec::new());
        net.transformers_3w_mut().push(out_of_service);
        assert!(matches!(
            net.expand_transformers_3w(),
            std::borrow::Cow::Borrowed(_)
        ));
        // A cached core serves the view as is.
        let core = crate::IndexCore::build(&net);
        let view = crate::IndexedNetwork::with_core(&net, &core);
        assert!(std::ptr::eq(view.network(), std::ptr::from_ref(&net)));
        net.transformers_3w_mut()[0].in_service = true;
        assert!(matches!(
            net.expand_transformers_3w(),
            std::borrow::Cow::Owned(_)
        ));
    }

    #[test]
    fn lowered_lengths_match_the_expansion() {
        // `lowered_lengths` counts what `expand_transformers_3w` would append
        // instead of building it. The two must agree on every mix: an
        // out-of-service unit appends nothing, and only a unit with magnetizing
        // admittance appends a shunt.
        let mut magnetizing = transformer_3w();
        magnetizing.mag_b = 0.02;
        let mut out_of_service = transformer_3w();
        out_of_service.in_service = false;
        out_of_service.mag_g = 0.01;

        for units in [
            vec![],
            vec![transformer_3w()],
            vec![magnetizing.clone()],
            vec![out_of_service.clone()],
            vec![transformer_3w(), magnetizing, out_of_service],
        ] {
            let mut net =
                BalancedNetwork::in_memory("t", 100.0, vec![bus(1), bus(2), bus(3)], Vec::new());
            net.shunts_mut().push(Shunt::new(BusId(1), 0.0, 0.5));
            *net.transformers_3w_mut() = units;
            let counted = net.lowered_lengths();
            let built = net.expand_transformers_3w();
            assert_eq!(counted.buses, built.buses().len());
            assert_eq!(counted.branches, built.branches().len());
            assert_eq!(counted.shunts, built.shunts().len());
        }
    }

    #[test]
    fn check_references_rejects_bus_ids_without_star_expansion_headroom() {
        // A bus id at the top of the id space would make the synthetic star id
        // `max_bus_id + 1 + k` run past it during indexed analysis; the parse
        // boundary refuses it like any other malformed reference.
        let mut net = BalancedNetwork::in_memory(
            "t",
            100.0,
            vec![bus(1), bus(2), bus(3), bus(i64::MAX as usize)],
            Vec::new(),
        );
        net.transformers_3w_mut().push(transformer_3w());
        let err = net.validate().unwrap_err().to_string();
        assert!(
            err.contains("no room to allocate synthetic star bus ids"),
            "got {err}"
        );
    }

    #[test]
    fn star_expansion_headroom_counts_only_in_service_transformers() {
        // The headroom needed is the in-service transformer count (plus the
        // base id), not the total: an out-of-service unit allocates no star
        // bus, so a network that only fits the in-service count must not be
        // rejected. A max bus id one under the ceiling fits one in-service
        // star id (max + 1) but not two.
        let mut net = BalancedNetwork::in_memory(
            "t",
            100.0,
            vec![bus(1), bus(2), bus(3), bus(i64::MAX as usize - 1)],
            Vec::new(),
        );
        net.transformers_3w_mut().push(transformer_3w());
        let mut out_of_service = transformer_3w();
        out_of_service.in_service = false;
        net.transformers_3w_mut().push(out_of_service);
        net.validate()
            .expect("in-service count fits; must not be rejected");
    }

    #[test]
    fn check_references_rejects_a_bus_id_past_the_int64_ceiling() {
        // The C ABI reports bus ids as int64, so two distinct usize ids above
        // the ceiling both surface as the same value and a branch endpoint
        // matches two bus rows. Refuse them where every other malformed
        // reference is refused.
        let mut net = BalancedNetwork::in_memory(
            "t",
            100.0,
            vec![bus(1), bus(i64::MAX as usize + 1)],
            Vec::new(),
        );
        let err = net.validate().unwrap_err().to_string();
        assert!(err.contains("outside the int64 id space"), "got {err}");

        // The ceiling itself is a valid id.
        net.buses_mut()[1].id = BusId(i64::MAX as usize);
        net.validate().expect("the ceiling itself is representable");
    }

    #[test]
    fn check_references_rejects_a_dangling_winding_bus() {
        let mut net = BalancedNetwork::in_memory("t", 100.0, vec![bus(1), bus(2)], Vec::new());
        net.transformers_3w_mut().push(transformer_3w()); // winding 3 references bus 3
        let err = net.validate().unwrap_err().to_string();
        assert!(
            err.contains("3-winding transformer references unknown bus 3"),
            "got {err}"
        );
    }

    #[test]
    fn check_references_rejects_a_dangling_winding_control_bus() {
        let mut net =
            BalancedNetwork::in_memory("t", 100.0, vec![bus(1), bus(2), bus(3)], Vec::new());
        let mut transformer = transformer_3w();
        let mut control = TransformerControl::new(TransformerControlMode::Voltage);
        control.controlled_bus = Some(BusId(4));
        transformer.windings[2].control = Some(control);
        net.transformers_3w_mut().push(transformer);
        let err = net.validate().unwrap_err().to_string();
        assert!(
            err.contains("3-winding transformer control references unknown bus 4"),
            "got {err}"
        );
    }

    /// A regulating transformer (bus 1→2) controlling the voltage at bus `reg`.
    fn regulating_branch(reg: usize) -> Branch {
        Branch {
            name: None,
            from: BusId(1),
            to: BusId(2),
            r: 0.0,
            x: 0.1,
            b: 0.0,
            charging: None,
            rate_a: 0.0,
            rate_b: 0.0,
            rate_c: 0.0,
            rating_sets: Vec::new(),
            current_ratings: None,
            tap: 1.0,
            shift: 0.0,
            in_service: true,
            angmin: -360.0,
            angmax: 360.0,
            control: Some(TransformerControl {
                mode: TransformerControlMode::Voltage,
                enabled: true,
                controlled_bus: Some(BusId(reg)),
                controlled_bus_on_winding_side: false,
                regulating_terminal: None,
                tap_min: 0.95,
                tap_max: 1.05,
                band_min: 1.0,
                band_max: 1.02,
                ntp: 17,
                mva_base: 100.0,
                winding_connection_angle: None,
            }),
            solution: None,
            uid: None,
            route: None,
            extras: Extras::new(),
        }
    }

    #[test]
    fn transformer_control_survives_serde_round_trip() {
        let mut net =
            BalancedNetwork::in_memory("t", 100.0, vec![bus(1), bus(2), bus(3)], Vec::new());
        net.branches_mut().push(regulating_branch(3));
        net.validate().unwrap();

        let back = serde_round_trip(&net);
        let c = back.branches()[0].control.as_ref().unwrap();
        assert_eq!(c.mode, TransformerControlMode::Voltage);
        assert_eq!(c.controlled_bus, Some(BusId(3)));
        close(c.tap_max, 1.05);
        assert_eq!(c.ntp, 17);
    }

    #[test]
    fn gen_caps_serialize_as_a_named_map_that_grows_additively() {
        let mut caps: GenCaps = [None; GEN_EXTRA_KEYS.len()];
        caps[8] = Some(1.5); // ramp_30
        caps[10] = Some(0.5); // apf
        let g = Generator {
            bus: BusId(1),
            energy_source: GeneratorEnergySource::default(),
            pg: 10.0,
            qg: 0.0,
            pmax: 100.0,
            pmin: 0.0,
            qmax: 50.0,
            qmin: -50.0,
            vg: 1.0,
            mbase: 100.0,
            in_service: true,
            cost: None,
            caps,
            voltage_regulation_on: false,
            regulating_terminal: Some(TerminalReference {
                equipment: ComponentId::new("load", "L1").unwrap(),
                terminal: 1,
            }),
            regulated_bus: Some(BusId(2)),
            active_power_control: None,
            uid: None,
        };

        // caps is a name-keyed object emitting only the present slots, not a
        // length-exact array.
        let json = serde_json::to_string(&g).unwrap();
        assert!(json.contains(r#""caps":{"#), "caps is an object: {json}");
        assert!(json.contains(r#""ramp_30":1.5"#) && json.contains(r#""apf":0.5"#));
        let back: Generator = serde_json::from_str(&json).unwrap();
        assert_eq!(back.caps, g.caps);
        assert!(!back.voltage_regulation_on);
        assert_eq!(back.regulating_terminal, g.regulating_terminal);
        assert_eq!(back.regulated_bus, Some(BusId(2)));

        // Growing GEN_EXTRA_KEYS stays additive: an unknown future key is ignored,
        // a missing key reads as None, and an omitted field is the empty set.
        let with_future = r#"{"bus":1,"pg":10,"qg":0,"pmax":100,"pmin":0,"qmax":50,"qmin":-50,
            "vg":1,"mbase":100,"in_service":true,"cost":null,
            "caps":{"ramp_30":1.5,"future_ramp":9.9}}"#;
        let g2: Generator = serde_json::from_str(with_future).unwrap();
        assert_eq!(g2.caps[8], Some(1.5));
        assert_eq!(g2.caps.iter().filter(|v| v.is_some()).count(), 1);
        let no_caps = r#"{"bus":1,"pg":10,"qg":0,"pmax":100,"pmin":0,"qmax":50,"qmin":-50,
            "vg":1,"mbase":100,"in_service":true,"cost":null}"#;
        let g3: Generator = serde_json::from_str(no_caps).unwrap();
        assert!(!g3.has_caps());
        assert!(g3.voltage_regulation_on);
        assert_eq!(g3.regulating_terminal, None);

        // An explicit `"caps":null` is the empty set too, the same as omitting it.
        let null_caps = r#"{"bus":1,"pg":10,"qg":0,"pmax":100,"pmin":0,"qmax":50,"qmin":-50,
            "vg":1,"mbase":100,"in_service":true,"cost":null,"caps":null}"#;
        let g4: Generator = serde_json::from_str(null_caps).unwrap();
        assert!(!g4.has_caps());
    }

    #[test]
    #[allow(clippy::float_cmp)]
    fn nonfinite_values_round_trip_through_serde() {
        let bus = |id, vm| Bus {
            id: BusId(id),
            kind: BusType::Pq,
            vm,
            va: 0.0,
            base_kv: 230.0,
            vmax: 1.1,
            vmin: 0.9,
            evhi: None,
            evlo: None,
            area: 1,
            zone: 1,
            name: None,
            uid: None,
            location: None,
            extras: Extras::new(),
        };
        let branch = Branch {
            name: None,
            from: BusId(1),
            to: BusId(2),
            r: 0.0,
            x: f64::INFINITY,
            b: 0.0,
            charging: None,
            rate_a: 0.0,
            rate_b: 0.0,
            rate_c: 0.0,
            rating_sets: Vec::new(),
            current_ratings: None,
            tap: 0.0,
            shift: 0.0,
            in_service: true,
            angmin: -360.0,
            angmax: 360.0,
            control: None,
            solution: None,
            uid: None,
            route: None,
            extras: Extras::new(),
        };
        // A non-finite generator capability reports at its exact key path
        // (caps serializes as a name-keyed object), not the parent `caps`.
        let mut g = Generator {
            bus: BusId(1),
            energy_source: GeneratorEnergySource::default(),
            pg: 0.0,
            qg: 0.0,
            pmax: 0.0,
            pmin: 0.0,
            qmax: 0.0,
            qmin: 0.0,
            vg: 1.0,
            mbase: 100.0,
            in_service: true,
            cost: None,
            caps: GenCaps::default(),
            voltage_regulation_on: true,
            regulating_terminal: None,
            regulated_bus: None,
            active_power_control: None,
            uid: None,
        };
        g.caps[8] = Some(f64::INFINITY); // ramp_30
        // Three nonfinite values at three nesting depths: a bus vm (NaN, a
        // struct field in a table), a branch x (Inf), and a generator ramp_30
        // cap (Inf, inside the name-keyed caps object).
        let mut net = BalancedNetwork::in_memory(
            "nf",
            100.0,
            vec![bus(1, f64::NAN), bus(2, 1.0)],
            vec![branch],
        );
        net.generators_mut().push(g);

        let text = serde_json::to_string(&net).unwrap();
        assert!(text.contains(r#""vm":"NaN""#), "{text}");
        assert!(text.contains(r#""x":"Infinity""#), "{text}");
        assert!(text.contains(r#""ramp_30":"Infinity""#), "{text}");

        let back: BalancedNetwork = serde_json::from_str(&text).unwrap();
        assert!(back.buses()[0].vm.is_nan());
        assert_eq!(back.branches()[0].x, f64::INFINITY);
        assert_eq!(back.generators()[0].caps[8], Some(f64::INFINITY));

        // A second serialization is byte stable.
        assert_eq!(serde_json::to_string(&back).unwrap(), text);
    }

    #[test]
    fn a_null_at_a_float_position_is_rejected() {
        let net = BalancedNetwork::in_memory("nf", 100.0, vec![bus(1), bus(2)], Vec::new());
        let text = serde_json::to_string(&net)
            .unwrap()
            .replacen("\"vm\":1.0", "\"vm\":null", 1);
        assert!(text.contains("\"vm\":null"), "fixture edit failed: {text}");
        let err = serde_json::from_str::<BalancedNetwork>(&text)
            .unwrap_err()
            .to_string();
        assert!(err.contains("cannot be null"), "{err}");
    }

    #[test]
    fn check_references_rejects_a_dangling_controlled_bus() {
        let mut net = BalancedNetwork::in_memory("t", 100.0, vec![bus(1), bus(2)], Vec::new());
        net.branches_mut().push(regulating_branch(9)); // controls a bus that doesn't exist
        let err = net.validate().unwrap_err().to_string();
        assert!(
            err.contains("transformer control references unknown bus 9"),
            "got {err}"
        );
    }

    #[test]
    fn check_references_rejects_winding_side_without_a_controlled_bus() {
        let mut net = BalancedNetwork::in_memory("t", 100.0, vec![bus(1), bus(2)], Vec::new());
        let mut branch = regulating_branch(2);
        let control = branch.control.as_mut().unwrap();
        control.controlled_bus = None;
        control.controlled_bus_on_winding_side = true;
        net.branches_mut().push(branch);

        let err = net.validate().unwrap_err().to_string();
        assert!(
            err.contains("winding side but has no nonzero controlled bus"),
            "got {err}"
        );
    }

    /// A discrete switched shunt on bus 1 regulating the voltage at bus `reg`.
    fn switched_shunt(reg: usize) -> Shunt {
        Shunt {
            bus: BusId(1),
            g: 0.0,
            b: 19.0,
            in_service: true,
            section_count: None,
            control: Some(SwitchedShuntControl {
                mode: SwitchedShuntMode::Discrete,
                vhigh: 1.05,
                vlow: 0.95,
                control_bus: Some(BusId(reg)),
                regulating_terminal: None,
                rmpct: 100.0,
                blocks: vec![ShuntBlock::new(2, 25.0), ShuntBlock::new(1, 50.0)],
            }),
            uid: None,
            extras: Extras::new(),
        }
    }

    #[test]
    fn switched_shunt_control_survives_serde_round_trip() {
        let mut net =
            BalancedNetwork::in_memory("t", 100.0, vec![bus(1), bus(2), bus(3)], Vec::new());
        net.shunts_mut().push(switched_shunt(3));
        net.validate().unwrap();

        let back = serde_round_trip(&net);
        let c = back.shunts()[0].control.as_ref().unwrap();
        assert_eq!(c.mode, SwitchedShuntMode::Discrete);
        assert_eq!(c.control_bus, Some(BusId(3)));
        assert_eq!(c.blocks.len(), 2);
        close(c.blocks[1].b, 50.0);
    }

    #[test]
    fn check_references_rejects_a_dangling_switched_shunt_control_bus() {
        let mut net = BalancedNetwork::in_memory("t", 100.0, vec![bus(1), bus(2)], Vec::new());
        net.shunts_mut().push(switched_shunt(9)); // controls a bus that doesn't exist
        let err = net.validate().unwrap_err().to_string();
        assert!(
            err.contains("switched-shunt control references unknown bus 9"),
            "got {err}"
        );
    }

    #[test]
    fn validate_values_flags_and_repair_clamps_out_of_domain_values() {
        let mut net = BalancedNetwork::in_memory("t", 100.0, vec![bus(1), bus(2)], Vec::new());
        net.buses_mut()[0].vm = 0.0; // outside [0, 2]
        net.buses_mut()[1].va = 9000.0; // past ±2000°
        net.generators_mut().push(Generator {
            bus: BusId(1),
            energy_source: GeneratorEnergySource::default(),
            pg: 10.0,
            qg: 0.0,
            pmax: 100.0,
            pmin: 0.0,
            qmax: 50.0,
            qmin: -50.0,
            vg: 0.0,    // non-positive setpoint
            mbase: 0.0, // non-positive base
            in_service: true,
            cost: None,
            voltage_regulation_on: true,
            regulating_terminal: None,
            caps: Default::default(),
            regulated_bus: None,
            active_power_control: None,
            uid: None,
        });

        let diags = net.validate_values();
        let fields: std::collections::BTreeSet<_> = diags
            .iter()
            .map(|d| d.details()["field"].as_str().unwrap().to_owned())
            .collect();
        assert_eq!(
            fields,
            ["mbase", "va", "vg", "vm"]
                .into_iter()
                .map(str::to_owned)
                .collect(),
            "all four out-of-domain fields reported"
        );
        assert!(
            diags
                .iter()
                .all(|d| d.code() == "VALIDATE.BALANCED.VALUE_DOMAIN" && d.target().is_some())
        );
        // Non-mutating: the network still holds the bad values.
        close(net.buses()[0].vm, 0.0);

        // The recorded path: repair the module, read the history entry.
        let module = powerio_core::PioModule::new(net);
        let module = repair_values(module).unwrap();
        let net = &module.value();
        close(net.buses()[0].vm, 1.0);
        close(net.buses()[1].va, 0.0);
        close(net.generators()[0].mbase, 100.0); // → base_mva
        close(net.generators()[0].vg, 1.0);
        // Idempotent: nothing left to repair, and a second pass appends
        // nothing.
        assert_eq!(net.validate_values().as_slice(), []);
        let entries = module.history();
        assert_eq!(entries.len(), 1);
        assert_eq!(entries[0].kind(), powerio_core::HistoryKind::Repair);
        assert_eq!(
            entries[0].parameters()["repairs"].as_array().unwrap().len(),
            diags.len()
        );
        assert_eq!(module.diagnostics().len(), diags.len());
        let module = repair_values(module).unwrap();
        assert_eq!(module.history().len(), 1);
    }

    #[test]
    fn validate_values_is_empty_for_a_clean_network() {
        let net = BalancedNetwork::in_memory("t", 100.0, vec![bus(1), bus(2)], Vec::new());
        assert_eq!(net.validate_values().as_slice(), []);
    }

    #[test]
    fn capability_curve_rejects_a_nonfinite_active_power() {
        let limits = ReactiveLimits::CapabilityCurve(ReactiveCapabilityCurve {
            curve_style: CurveStyle::StraightLineYValues,
            properties: BTreeMap::new(),
            points: vec![
                ReactiveCapabilityCurvePoint {
                    active_power_mw: 0.0,
                    minimum_reactive_power_mvar: -10.0,
                    maximum_reactive_power_mvar: 10.0,
                    properties: BTreeMap::new(),
                },
                ReactiveCapabilityCurvePoint {
                    active_power_mw: 100.0,
                    minimum_reactive_power_mvar: -5.0,
                    maximum_reactive_power_mvar: 5.0,
                    properties: BTreeMap::new(),
                },
            ],
        });

        let error = calc_reactive_limits_at_active_power("generator 1", &limits, f64::NAN)
            .expect_err("NaN must not be used to index a capability curve");
        assert!(error.contains("nonfinite active power"), "{error}");
    }
    #[test]
    fn impedance_correction_factor_interpolates_and_holds_the_end_points() {
        let point = ImpedanceCorrectionPoint::new;
        let table = ImpedanceCorrection::new(
            1,
            ImpedanceCorrectionVariable::Angle,
            vec![
                point(30.0, 1.2, -0.2),
                point(-30.0, 1.2, 0.2),
                point(0.0, 1.0, 0.0),
            ],
        );
        assert_eq!(table.calc_factor(-45.0), Some((1.2, 0.2)));
        assert_eq!(table.calc_factor(45.0), Some((1.2, -0.2)));
        let (re, im) = table.calc_factor(15.0).unwrap();
        close(re, 1.1);
        close(im, -0.1);
        let single = ImpedanceCorrection::new(
            2,
            ImpedanceCorrectionVariable::Ratio,
            vec![point(1.0, 0.9, 0.0)],
        );
        assert_eq!(single.calc_factor(1.1), Some((0.9, 0.0)));
        let empty = ImpedanceCorrection::new(3, ImpedanceCorrectionVariable::Ratio, Vec::new());
        assert_eq!(empty.calc_factor(1.0), None);
    }
}