Skip to main content

Crate powerio_capi

Crate powerio_capi 

Source
Expand description

PowerIO C ABI.

The ABI exposes the same four representation operations as Rust: pio_parse, pio_emit, pio_module_serialize, and pio_module_deserialize. Files and memory enter through PioSource; files, directories, and memory output use PioDestination. Values are identified by canonical structural type names rather than an ordinal enum.

§Safety

Non-null handles must be live handles of the declared type from this library. Retain creates an independently releasable handle. Release consumes one owned handle and must not overlap any use of that same raw handle. Concurrent immutable access is permitted. Module mutation requires exclusive access, including exclusion of retain calls, until the call returns.

Every non-null input pointer must be aligned and readable for its stated length; output pointers must be aligned and writable for their declared type. Spans must fit within one allocation and at most isize::MAX bytes. Input memory must remain unchanged while read. Output memory must not alias inputs or other outputs. Null pointers are accepted only where the operation handles their absence; a reported pointer error does not validate arbitrary addresses.

Borrowed views remain valid while their owner remains alive and unchanged. Module mutation invalidates plain views; independently owned child handles retain their snapshots. Returned owned handles must use their matching release function. These requirements apply to direct Rust callers as well as C callers.

Modules§

diagnostics
The codes the language boundary itself emits, and the workspace gates.

Structs§

PioAcBusSpecificationView
One bus boundary specification in an AC power flow instance.
PioAcDcConverterView
One source neutral AC/DC converter.
PioAcOpfBranchView
One active branch row in an AC OPF preparation.
PioAcOpfBusView
One dense bus row in an AC OPF preparation.
PioAcOpfGeneratorView
One generator row in an AC OPF preparation.
PioAcOpfPreparation
Owned AC OPF preparation whose borrowed row views remain valid until release.
PioAcOpfPreparationView
Shape and conventions of one prepared AC OPF calculation.
PioAcOpfStorageView
One storage row in an AC OPF preparation.
PioAcOtsBranchView
One physical branch as an AC optimal transmission switching instance sees it: its identity, initial status, whether it may switch, its switching costs, its stated current limits, and the current limits that apply under the instance’s policy. Borrowed data lives with the owner.
PioAcOtsOptions
AC optimal transmission switching options. switchable is all, none, or only (then identities names the switchable branches); islanding is forbidden or allowed; current_limits is skip, stated, or derive_from_rate_a. Arrays carry their element counts and are read during the call only.
PioAcOtsOptionsView
The stated switching options of one AC optimal transmission switching instance, and its branch count. Per-branch settings are read with pio_ac_ots_instance_branch_at. The strings are static.
PioAcOtsSolutionView
The totals of one AC optimal transmission switching solution. The objective includes the switching cost when the instance’s objective states the switching cost term.
PioActiveConstraintView
One active constraint family and its element selection.
PioActiveControlView
One active multiconductor equipment control.
PioActivePower
Active power replacement with an explicit unit.
PioActivePowerControlView
Governor and distributed slack settings for a generator or storage element.
PioApparentPower
Apparent power replacement with an explicit unit.
PioArtifact
Owner-rooted emitted artifact.
PioBalancedAreaView
One balanced control area.
PioBalancedBranchView
One balanced branch or two winding transformer.
PioBalancedBusView
One balanced bus. String and coefficient spans borrow from the network.
PioBalancedGeneratorView
One balanced generator.
PioBalancedGeoView
Coordinate metadata for a balanced network.
PioBalancedHvdcConverterView
One AC terminal converter station of a balanced HVDC line.
PioBalancedHvdcView
One balanced two terminal HVDC line.
PioBalancedLoadView
One balanced load.
PioBalancedLoadVoltageModelView
Voltage dependence attached to one balanced load.
PioBalancedLocationView
One point in a balanced network coordinate space.
PioBalancedNetwork
Owner-rooted balanced network view.
PioBalancedShuntView
One balanced shunt.
PioBalancedStaticVarCompensatorView
One balanced static VAR compensator.
PioBalancedStorageView
One balanced storage element.
PioBalancedSwitchView
One balanced transmission switch.
PioBalancedThreeWindingTransformerView
One balanced three winding transformer.
PioBoundaryLineGenerationView
Optional generation attached to one PowSybl boundary line.
PioBoundaryLineView
One PowSybl boundary line retained beside the balanced calculation view.
PioBranchCurrentLimit
Explicit current magnitude limits at a branch’s two terminals, per unit on the system MVA base and each terminal bus’s nominal voltage. A side whose has_ flag is false is unbounded.
PioBranchRatingView
One named branch MVA rating beyond rating A, B, and C.
PioBranchSwitchingCost
One branch’s opening and closing cost in objective units, by branch identity. Only a change against the initial topology costs anything.
PioBusBreakerBusView
One configured bus in bus breaker topology.
PioBusbarSectionView
One source neutral busbar section.
PioByteView
Borrowed binary bytes.
PioCalculatedBusView
One calculated bus explicitly recorded in node breaker topology.
PioCalculationInstance
Owner-rooted calculation instance view.
PioCalculationSolution
Owner-rooted calculation solution view.
PioCalculationUpdate
Typed update to a calculation instance.
PioCaseMetadataView
Source neutral case metadata attached to one subnetwork.
PioCollection
Shared bounded file inventory; parsed modules own their selected source bytes.
PioComponentAliasView
One source neutral component alias.
PioComponentId
Stable, type-qualified component identity.
PioComponentIdView
Borrowed stable component identity.
PioComponentMetadataView
Source neutral metadata attached to one stable component identity.
PioConnectivityNodeView
One source neutral connectivity node.
PioContingencyComponentView
One network element a contingency case bound to. id.component_type names the table row indexes, and every element states it. id.local_id is the element’s own identity, and its len is 0 when the network states none for the row; read the len rather than the data pointer, which is unspecified at that length. in_service is the element’s own flag as the network states it before the case is applied.
PioContingencyResolution
What one contingency set bound to on one network.
PioContingencySet
PSS/E contingency description file: the cases, the automatic specifications, and the SKIP rules. A handle taken from a module value holds that module owner alive.
PioControlProfileView
One inverter control profile.
PioDcBusSpecificationView
One bus boundary specification in a DC power flow instance.
PioDcConverterUnitView
One source neutral DC converter unit.
PioDcEquipmentView
One source neutral DC conducting equipment record.
PioDcNodeView
One physical or energized node in source neutral DC connectivity.
PioDcOperators
DC operators built once from a balanced network: the incidence, susceptance, flow, and injection calculations share one bus axis and one branch axis, and the handle names both axes.
PioDcOpfBranchView
One active branch row in a DC OPF preparation.
PioDcOpfBusView
One dense bus row in a DC OPF preparation.
PioDcOpfGeneratorView
One generator row in a DC OPF preparation.
PioDcOpfPreparation
Owned DC OPF preparation whose borrowed row views remain valid until release.
PioDcOpfPreparationView
Shape and conventions of one prepared DC OPF calculation.
PioDcTerminalView
One terminal of source neutral DC conducting equipment.
PioDestination
File, directory, or memory output destination.
PioDetailedConnectivity
Owner-rooted source neutral hierarchy and detailed connectivity view.
PioDetailedConnectivityCountsView
Exact table lengths in source neutral detailed connectivity.
PioDetailedTerminalView
One source neutral AC terminal.
PioDiagnosticSpanView
One borrowed source byte range from a diagnostic.
PioDiagnostics
Immutable diagnostic list.
PioDistLoadVoltageModelView
Complete borrowed load voltage law, including piecewise transitions. Presence flags distinguish absent transition parameters from zero.
PioDroopCurveSegmentView
One segment of an AC/DC converter DC voltage droop curve.
PioEmitResult
Completed artifact inventory and emission diagnostics.
PioEquipmentReactiveLimitsView
Reactive limits retained for one equipment record.
PioError
Structured operation failure.
PioExternalIdentifierView
One source neutral external component identifier.
PioF64View
Borrowed double values.
PioGeneratorCapabilityView
One optional generator capability or ramp field.
PioGeneratorCostView
One generator cost curve.
PioGeoApplyReport
Counts and notes from applying one geographic layer.
PioGeoLayer
Parsed geographic sidecar.
PioInternalConnectionView
One permanent connection between two node breaker connectivity nodes.
PioInverterBasedResourceView
One inverter based resource.
PioIslandView
One AC island of a balanced network, read from a PioIslands handle. Every view is borrowed from the handle. Bus indices are zero based positions in the network’s bus table; bus ids are the source’s own. generator_rows and hvdc_rows are zero based positions in the generator and HVDC tables: the in service generators on the island’s buses and the in service HVDC lines that tie it to another island. supplied is true when an in service generator can supply the island.
PioIslands
The AC islands of a balanced network and its isolated buses, computed once. The handle owns its data and does not keep the network alive.
PioIsolatedTerminalView
One isolated multiconductor terminal.
PioJsonObjectEntryView
One key and value type in a structured JSON object.
PioJsonValue
Owner-rooted structured value from module history or extensions.
PioJsonValueView
One structured JSON value stored in module history or extensions.
PioJunctionView
One source neutral CIM junction.
PioLinDist3FlowConductorView
One line conductor in the solution’s physical row order. Positions are zero based. Positive power flows from parent to child.
PioLinDist3FlowNodeView
One voltage node and its fixed phasor, in volts and radians.
PioModule
PowerIO value with diagnostics, source mappings, and history.
PioModuleExtensionView
One namespaced structured module extension.
PioModuleHistoryEntryView
One operation recorded in module history.
PioModuleHistoryParameterView
One named structured parameter in a module history entry.
PioModuleProducerView
Program identity recorded with one module.
PioModuleSourceMapEntryView
One typed value target and its relation to source bytes.
PioModuleSourceView
One durable source descriptor recorded with a module.
PioMonitoredSet
PSS/E monitored element file: the monitor statements. A handle taken from a module value holds that module owner alive.
PioMulticonductorBusView
One multiconductor bus.
PioMulticonductorCapacitorView
One multiconductor capacitor.
PioMulticonductorCommandView
One retained source command.
PioMulticonductorGeneratorView
One multiconductor generator.
PioMulticonductorGeoView
Coordinate metadata for a multiconductor network.
PioMulticonductorLineCodeView
One multiconductor line code.
PioMulticonductorLineView
One multiconductor line.
PioMulticonductorLoadDetailsView
One multiconductor load with its complete voltage law. Existing load views retain their ABI layout and continue to reject laws they cannot describe.
PioMulticonductorLoadView
One multiconductor load.
PioMulticonductorLocationView
One point in a multiconductor network coordinate space.
PioMulticonductorNetwork
Owner-rooted multiconductor network view.
PioMulticonductorNetworkCountsView
Exact table lengths in a multiconductor network.
PioMulticonductorShuntView
One multiconductor shunt.
PioMulticonductorSwitchView
One multiconductor switch.
PioMulticonductorTransformerView
One multiconductor transformer.
PioMulticonductorTransformerWindingView
One winding of a multiconductor transformer.
PioMulticonductorUntypedObjectView
One source object retained without a typed PowerIO representation.
PioMulticonductorUntypedPropertyView
One property of an untyped source object.
PioNamedBufferView
One caller-owned companion for an in-memory source. Both views are copied during source construction; no filesystem acquisition is permitted.
PioNetworkUpdate
Typed update to physical network data.
PioObjectiveTermView
One typed objective term.
PioOmittedFieldView
One source field that was absent rather than explicitly assigned a value.
PioOperatingPoint
Owner-rooted operating point view.
PioOperatingPointUpdate
Typed update to an operating point.
PioOperationalLimitGroupView
One named source neutral loading limit set at an equipment terminal.
PioParseOptions
Borrowed parsing options. Zero initialization preserves pio_parse behavior. All nested pointers need remain valid only during the call. These layouts are fixed; a future incompatible layout requires a new ABI or input type.
PioPrescribedLoadDetailsView
Prescribed terminal powers and the full borrowed voltage law of one PF load.
PioPrescribedSourceVoltageView
One prescribed multiconductor source terminal voltage.
PioPrescribedTerminalPowerView
One prescribed multiconductor load terminal power.
PioReactiveCapabilityCurvePointView
One point of a reactive capability curve.
PioReactiveLimitsView
Min/max or active power dependent reactive limits.
PioReactivePower
Reactive power replacement with an explicit unit.
PioScenarioSetHandle
Owner-rooted scenario set view.
PioScucActiveReservePeriodView
One period of an active power reserve zone.
PioScucActiveReserveZoneView
One active power reserve zone.
PioScucBranchSwitchingCostView
Connection and disconnection costs for one switchable AC branch.
PioScucContingencyComponentView
One component removed by a SCUC contingency.
PioScucContingencyView
One named SCUC contingency.
PioScucDevicePeriodView
One SCUC device period.
PioScucDeviceView
One SCUC producer or consumer.
PioScucDimensionsView
Set sizes and time horizon of one AC SCUC instance.
PioScucEnergyCostBlockView
One piecewise linear active energy cost block.
PioScucEnergyRequirementView
One energy requirement over a time window, in per unit as defined by GOC3.
PioScucInitialCommitmentView
Initial commitment durations for one SCUC device.
PioScucRampLimitsView
Active power ramp limits for one SCUC device, in per unit per hour.
PioScucReactiveCapabilityView
Additional active and reactive power capability relation for one device.
PioScucReactiveReservePeriodView
One period of a reactive power reserve zone.
PioScucReactiveReserveZoneView
One reactive power reserve zone.
PioScucReserveCostsView
Reserve costs for one device and one interval, in $/(p.u. h).
PioScucReserveLimitsView
Reserve quantity limits for one SCUC device.
PioScucShuntView
Discrete step limits for one SCUC shunt.
PioScucStartupCostAdjustmentView
One downtime dependent startup cost adjustment.
PioScucStartupLimitView
One limit on the number of device startups during a time window.
PioScucTransformerControlView
Tap ratio and phase shift bounds for one transformer.
PioScucViolationCostView
Required SCUC violation costs.
PioSensitivities
Dense DC PTDF and LODF of a balanced network with the axes that name their rows and columns. The handle owns its data.
PioShuntBlockView
One switched shunt block.
PioSincalBalancedReadOptions
Explicit balanced SINCAL reader selection; presence flags preserve zero.
PioSincalReadOptions
Explicit conductor-resolved SINCAL reader selection. Zero initialization means no selected variant, no snapshot, and no acquired-table companion. The presence flags distinguish omission from an explicit zero.
PioSizeView
Borrowed size_t values.
PioSource
Acquired file, directory, or named memory bytes.
PioSourceSpanView
One borrowed source byte range from a source map entry.
PioSparseMatrix
Immutable CSR sparse matrix.
PioString
Owned UTF-8 text returned by report functions.
PioStringPropertyView
One source neutral string property.
PioStringView
Borrowed UTF-8 bytes. The bytes need not end in NUL.
PioSubnetworkView
One PowSybl subnetwork contained directly by the balanced network.
PioSubstationView
One source neutral substation.
PioSubsystemSet
PSS/E subsystem description file: the named bus groups. A handle taken from a module value holds that module owner alive.
PioTapChangerStepView
One source neutral transformer tap changer step.
PioTapChangerView
One source neutral transformer tap changer.
PioTemporaryLimitView
One temporary source neutral loading limit.
PioTerminalPowerView
One terminal of a prescribed multiconductor load.
PioTerminalReferenceView
Borrowed reference to one numbered equipment terminal.
PioTerminalVoltageView
One terminal of a prescribed multiconductor source.
PioThreeWindingTransformerImpedanceView
One pairwise impedance of a balanced three winding transformer.
PioThreeWindingTransformerWindingView
One winding of a balanced three winding transformer.
PioTieLineView
One PowSybl tie line and the two boundary lines that define it.
PioTimePointView
A borrowed time label and optional duration in seconds. The label remains valid while the time-series handle is live and unmodified.
PioTimeSeriesHandle
Owner-rooted time series view.
PioTopologySwitchView
One source neutral bus breaker or node breaker switch.
PioTransformerControlView
Automatic transformer tap or phase control.
PioUpdateChange
Owner-rooted view of one changed component field.
PioUpdateReport
Exact changes made by one atomic update batch.
PioValueHandle
Owner-rooted view of one module or collection value.
PioVector
Immutable dense vector.
PioVersionView
The three numbers of a PowerIO release, such as 0.12.0.
PioVoltageLevelView
One source neutral voltage level.
PioVoltageSourceBoundaryView
Complete source boundary without changing the legacy source-view layout. Source phasors specify V(terminal) - V(reference). A named reference is on source.bus and does not imply grounding; an absent reference means earth. Borrowed data lives with the owner.
PioVoltageSourceView
One multiconductor voltage source.

Constants§

PIO_VERSION_MAJOR
Major number of the PowerIO release this header was generated from.
PIO_VERSION_MINOR
Minor number of the PowerIO release this header was generated from.
PIO_VERSION_PATCH
Patch number of the PowerIO release this header was generated from.

Functions§

pio_ac_opf_preparation_branch_at⚠
Read one active branch row of an AC OPF preparation.
pio_ac_opf_preparation_bus_at⚠
Read one dense bus row of an AC OPF preparation.
pio_ac_opf_preparation_generator_at⚠
Read one generator row of an AC OPF preparation.
pio_ac_opf_preparation_reference_buses⚠
Borrow the dense reference bus indices of an AC OPF preparation.
pio_ac_opf_preparation_release⚠
Safety
pio_ac_opf_preparation_retain⚠
Safety
pio_ac_opf_preparation_skipped_zero_impedance⚠
Borrow the analysis rows skipped for zero impedance.
pio_ac_opf_preparation_storage_at⚠
Read one storage row of an AC OPF preparation.
pio_ac_opf_preparation_summary⚠
Read the dimensions and conventions of an AC OPF preparation.
pio_ac_ots_instance_branch_at⚠
Read one physical branch of an AC optimal transmission switching instance by zero based branch table position.
pio_ac_ots_instance_create⚠
Combine an AC OPF instance with explicit switching options, keeping its objective exactly, as a new module that carries the base module’s records. NULL options are the defaults: every branch may switch.
pio_ac_ots_instance_fix_topology⚠
The AC OPF calculation module over a validated final topology: every branch row with its final status, and the switching data the AC OPF cannot carry reported as module diagnostics.
pio_ac_ots_instance_options⚠
Read an AC optimal transmission switching instance’s stated options and branch count.
pio_ac_ots_instance_validate_topology⚠
Check a complete final branch status vector (one byte per branch in table order, 0 open and 1 closed) against the fixed branches, the budgets, and the islanding policy, and write its switching cost. This does not certify AC feasibility.
pio_ac_ots_solution_branch_closed_at⚠
Read one final branch status by zero based branch table position.
pio_ac_ots_solution_create⚠
Attach the AC OPF solution computed on the instance’s fixed topology for branch_closed, as a new AC OTS solution module that carries the instance module’s records. Construction checks the topology, the exact fixed-problem correspondence, finite values, and zero flow on open branches; it does not check residuals or optimality.
pio_ac_ots_solution_materialize⚠
The balanced network module an AC optimal transmission switching solution states: final branch statuses with the solved bus voltages, generator dispatch, and branch flows applied, ready for pio_emit.
pio_ac_ots_solution_summary⚠
Read an AC optimal transmission switching solution’s totals.
pio_ac_pf_instance_bus_specification_at⚠
Read one AC power flow bus specification by zero based bus table position.
pio_ac_pf_instance_bus_specification_count⚠
Safety
pio_ac_scuc_instance_active_reserve_zone_at⚠
Safety
pio_ac_scuc_instance_active_reserve_zone_bus_at⚠
Safety
pio_ac_scuc_instance_active_reserve_zone_count⚠
Safety
pio_ac_scuc_instance_active_reserve_zone_period_at⚠
Safety
pio_ac_scuc_instance_branch_switching_cost_at⚠
Safety
pio_ac_scuc_instance_branch_switching_cost_count⚠
Safety
pio_ac_scuc_instance_contingency_at⚠
Read one named contingency in source order.
pio_ac_scuc_instance_contingency_component_at⚠
Read one stable component identity from a named contingency.
pio_ac_scuc_instance_contingency_count⚠
Return the number of named contingencies.
pio_ac_scuc_instance_contingency_get⚠
Read one named contingency by its exact source UID.
pio_ac_scuc_instance_device_at⚠
Safety
pio_ac_scuc_instance_device_count⚠
Safety
pio_ac_scuc_instance_device_energy_cost_block_at⚠
Safety
pio_ac_scuc_instance_device_energy_cost_block_count⚠
Safety
pio_ac_scuc_instance_device_energy_lower_bound_at⚠
Safety
pio_ac_scuc_instance_device_energy_lower_bound_count⚠
Safety
pio_ac_scuc_instance_device_energy_upper_bound_at⚠
Safety
pio_ac_scuc_instance_device_energy_upper_bound_count⚠
Safety
pio_ac_scuc_instance_device_get⚠
Read one device by its exact source UID.
pio_ac_scuc_instance_device_period_at⚠
Safety
pio_ac_scuc_instance_device_startup_cost_adjustment_at⚠
Safety
pio_ac_scuc_instance_device_startup_cost_adjustment_count⚠
Safety
pio_ac_scuc_instance_device_startup_limit_at⚠
Safety
pio_ac_scuc_instance_device_startup_limit_count⚠
Safety
pio_ac_scuc_instance_dimensions⚠
Read semantic collection sizes for one AC SCUC instance.
pio_ac_scuc_instance_interval_durations⚠
Borrow interval durations in hours, in chronological order.
pio_ac_scuc_instance_reactive_reserve_zone_at⚠
Safety
pio_ac_scuc_instance_reactive_reserve_zone_bus_at⚠
Safety
pio_ac_scuc_instance_reactive_reserve_zone_count⚠
Safety
pio_ac_scuc_instance_reactive_reserve_zone_period_at⚠
Safety
pio_ac_scuc_instance_shunt_at⚠
Safety
pio_ac_scuc_instance_shunt_count⚠
Safety
pio_ac_scuc_instance_shunt_get⚠
Read one shunt by its exact source UID.
pio_ac_scuc_instance_transformer_control_at⚠
Safety
pio_ac_scuc_instance_transformer_control_count⚠
Safety
pio_ac_scuc_instance_violation_costs⚠
Read the four required violation costs.
pio_ac_scuc_solution_get_values_at⚠
Copy one AC SCUC output row for one time position into an owned vector.
pio_ac_scuc_solution_time_count⚠
Safety
pio_active_power_from_megawatts
pio_active_power_from_watts
pio_active_power_release⚠
Safety
pio_active_power_retain⚠
Safety
pio_active_power_unit⚠
Safety
pio_active_power_value⚠
Safety
pio_apparent_power_from_megavolt_amperes
pio_apparent_power_from_volt_amperes
pio_apparent_power_release⚠
Safety
pio_apparent_power_retain⚠
Safety
pio_apparent_power_unit⚠
Safety
pio_apparent_power_value⚠
Safety
pio_apply_bus_load_active_power⚠
Replace aggregate active demand at one bus using the named allocation rule.
pio_apply_updates⚠
Apply a complete typed update batch atomically.
pio_artifact_bytes⚠
Return emitted memory bytes. A path destination has no memory bytes and returns an empty view.
pio_artifact_name⚠
Safety
pio_artifact_release⚠
Safety
pio_artifact_retain⚠
Safety
pio_balanced_network_area_at⚠
Read one control area by zero based table position.
pio_balanced_network_area_count⚠
Safety
pio_balanced_network_base_frequency_hz⚠
Safety
pio_balanced_network_base_mva⚠
Safety
pio_balanced_network_branch_at⚠
Read one branch by zero based table position.
pio_balanced_network_branch_count⚠
Safety
pio_balanced_network_branch_rating_at⚠
Read one additional named branch MVA rating.
pio_balanced_network_branch_route_point_at⚠
Read one point from an explicitly stored balanced branch route.
pio_balanced_network_bus_at⚠
Read one bus by zero based table position.
pio_balanced_network_bus_count⚠
Safety
pio_balanced_network_detailed_connectivity⚠
Return the optional owner-rooted detailed connectivity view.
pio_balanced_network_generator_at⚠
Read one generator by zero based table position.
pio_balanced_network_generator_capability_at⚠
Read one named generator capability or ramp field.
pio_balanced_network_generator_count⚠
Safety
pio_balanced_network_geo⚠
Read the optional coordinate space metadata for a balanced network.
pio_balanced_network_has_detailed_connectivity⚠
Safety
pio_balanced_network_hvdc_at⚠
Read one HVDC line by zero based table position.
pio_balanced_network_hvdc_count⚠
Safety
pio_balanced_network_islands⚠
Partition a balanced network into AC islands, as the Rust BalancedNetwork::calc_islands does. Two buses share an island when a path of in service branches, closed switches, and in service three winding transformer windings joins them; HVDC lines do not join islands. Buses typed isolated belong to no island and are listed by pio_islands_isolated_bus_ids. Islands come largest first, ties in ascending order of their smallest bus id; buses within an island in ascending id order. Release with pio_islands_release.
pio_balanced_network_load_at⚠
Read one load by zero based table position.
pio_balanced_network_load_count⚠
Safety
pio_balanced_network_name⚠
Safety
pio_balanced_network_release⚠
Safety
pio_balanced_network_retain⚠
Safety
pio_balanced_network_select_subsystem_buses⚠
The buses of one balanced network that a named subsystem selects, in ascending bus number order.
pio_balanced_network_shunt_at⚠
Read one shunt by zero based table position.
pio_balanced_network_shunt_block_at⚠
Read one switched shunt block by zero based position.
pio_balanced_network_shunt_count⚠
Safety
pio_balanced_network_static_var_compensator_at⚠
Read one static VAR compensator by zero based table position.
pio_balanced_network_static_var_compensator_count⚠
Safety
pio_balanced_network_storage_at⚠
Read one storage element by zero based table position.
pio_balanced_network_storage_count⚠
Safety
pio_balanced_network_switch_at⚠
Read one transmission switch by zero based table position.
pio_balanced_network_switch_count⚠
Safety
pio_balanced_network_three_winding_transformer_at⚠
Read one three winding transformer by zero based table position.
pio_balanced_network_three_winding_transformer_count⚠
Safety
pio_balanced_network_three_winding_transformer_impedance_at⚠
Read one pairwise impedance of a three winding transformer.
pio_balanced_network_three_winding_transformer_winding_at⚠
Read one winding of a three winding transformer.
pio_build_ac_opf_preparation⚠
Build the matrix free AC OPF inputs from one typed instance.
pio_build_dc_opf_preparation⚠
Build the matrix free DC OPF inputs from one typed instance.
pio_calc_branch_flow_dc⚠
Safety
pio_calc_branch_flow_matrix⚠
Safety
pio_calc_branch_phase_shift_injection⚠
Safety
pio_calc_branch_susceptances⚠
Safety
pio_calc_bus_injection_dc⚠
Safety
pio_calc_bus_phase_shift_injection⚠
Safety
pio_calc_bus_susceptance_matrix⚠
Safety
pio_calc_dc_operators⚠
Build the DC operators of a balanced network once. formula selects the branch susceptance as in pio_calc_incidence_matrix; NULL means series_susceptance. With skip_zero_impedance false a zero impedance branch fails the build with BUILD.OPERATOR.ZERO_IMPEDANCE; with it true the branch is dropped from the branch axis and reported by pio_dc_operators_skipped_branch_rows. The bus axis is every bus in table order; the branch axis is every in service, non self loop branch in table order, followed by three winding transformer windings, less any skipped branch. Release with pio_dc_operators_release.
pio_calc_incidence_matrix⚠
Signed branch by bus incidence matrix of a balanced network. formula names the branch susceptance formula, which decides the zero impedance guard: series_susceptance (the default when formula is NULL), series_susceptance_no_phase_shift, tap_adjusted_reactance, tap_adjusted_series_susceptance, or reactance_only. Any other token fails with REQUEST.CAPI.UNKNOWN_FORMULA.
pio_calc_sensitivities⚠
DC power transfer and line outage distribution factors of a balanced network, through the same Rust routine the Python binding calls (calc_ptdf_lodf_with_options). formula selects the branch susceptance as in pio_calc_incidence_matrix; NULL means series_susceptance. solver is auto, dense, or sparse; NULL means auto, which takes the dense factorization on small cases and the sparse one on large cases.
pio_calculation_instance_active_constraint_at⚠
Read one active constraint family by zero based position.
pio_calculation_instance_active_constraint_count⚠
Safety
pio_calculation_instance_active_constraint_identity_at⚠
Read one selected component identity from an only constraint selection.
pio_calculation_instance_balanced_network⚠
Safety
pio_calculation_instance_has_initial_point⚠
Safety
pio_calculation_instance_initial_point⚠
Return the optional owner-rooted initial operating point. A calculation instance with no initial point returns NULL without setting an error.
pio_calculation_instance_multiconductor_network⚠
Safety
pio_calculation_instance_objective_term_at⚠
Read one typed objective term by zero based position.
pio_calculation_instance_objective_term_count⚠
Safety
pio_calculation_instance_release⚠
Safety
pio_calculation_instance_retain⚠
Safety
pio_calculation_instance_type_name⚠
Safety
pio_calculation_solution_balanced_network⚠
Safety
pio_calculation_solution_get_objective⚠
Return an OPF or SCUC objective. SOCWR reports a lower bound through pio_socwr_opf_solution_get_objective_lower_bound instead.
pio_calculation_solution_get_values⚠
Copy one named solution quantity into an independently owned vector.
pio_calculation_solution_instance⚠
Return an owner-rooted view of the exact calculation instance retained by a calculation solution.
pio_calculation_solution_multiconductor_network⚠
Safety
pio_calculation_solution_release⚠
Safety
pio_calculation_solution_retain⚠
Safety
pio_calculation_solution_termination⚠
Safety
pio_calculation_solution_type_name⚠
Safety
pio_calculation_update_from_network⚠
Safety
pio_calculation_update_from_operating_point⚠
Safety
pio_calculation_update_release⚠
Safety
pio_calculation_update_retain⚠
Safety
pio_collection_from_files⚠
Copy named buffers once into a shared immutable inventory. Checks count and cumulative bytes before copying payloads. No host fallback is possible.
pio_collection_from_zip⚠
Copy and verify a ZIP, bounding compressed input before copying.
pio_collection_inspect⚠
Inspect metadata and suggested selections as JSON, without electrical parsing. Release the returned owned string with pio_string_release.
pio_collection_open⚠
Acquire a folder or ZIP with explicit total byte and file limits.
pio_collection_parse⚠
Parse one JSON selection (at most 1 MiB) into an owned typed module. Optional options have the same semantics as pio_parse_with_options, but cannot acquire host files. If report is non-NULL, success also returns an owned JSON string containing observed dependencies and the incomplete flag. Release it with pio_string_release. False incomplete is not a completeness certificate.
pio_collection_release⚠
Release one owned collection handle. Parsed modules retain their own source.
pio_collection_retain⚠
Retain an independently releasable collection handle.
pio_component_id_local_id⚠
Safety
pio_component_id_new⚠
Construct a stable component identity.
pio_component_id_release⚠
Safety
pio_component_id_retain⚠
Safety
pio_component_id_type⚠
Safety
pio_contingency_resolution_case_component⚠
Read one element one case bound to, by zero based case and element position, in action order.
pio_contingency_resolution_case_component_count⚠
The number of elements one case’s actions bound to.
pio_contingency_resolution_case_count⚠
Safety
pio_contingency_resolution_case_is_resolved⚠
Whether every action of one case bound. A NULL handle or an index out of range reads as false; pio_contingency_resolution_case_unresolved_count tells the two apart.
pio_contingency_resolution_case_name⚠
Read one case name by zero based position, in the set’s own order.
pio_contingency_resolution_case_unresolved_action⚠
Read the statement of one action of one case that bound to nothing, by zero based case and action position. The text is the .con line pio_contingency_set_to_con writes for that action, without its line ending, and the view borrows the resolution handle.
pio_contingency_resolution_case_unresolved_count⚠
The number of one case’s actions that bound to nothing.
pio_contingency_resolution_case_unresolved_reason⚠
Read why one action of one case bound to nothing, as a fixed snake case name: no_such_bus, no_such_branch, ambiguous_branch, ambiguous_transformer_3w, no_such_machine, no_such_shunt, no_such_load, no_such_transformer_3w, unrecognized, no_such_bus_name, ambiguous_bus_name, no_such_branch_name, or ambiguous_branch_name. Python reports the same names.
pio_contingency_resolution_release⚠
Safety
pio_contingency_resolution_resolved_count⚠
The number of cases whose every action bound.
pio_contingency_resolution_retain⚠
Safety
pio_contingency_resolution_unrecognized_statement_count⚠
The number of actions the reader kept as text, counted over every case.
pio_contingency_resolution_unresolved_count⚠
The number of cases holding at least one action that did not bind.
pio_contingency_set_case_count⚠
Safety
pio_contingency_set_case_name⚠
Read one case name by zero based position, in the set’s own order.
pio_contingency_set_diagnostics⚠
Return the notes the contingency reader produced, which are empty for a set taken from a module value and for an expanded set.
pio_contingency_set_expand⚠
Expand every automatic specification of the set against one network and one subsystem set, producing a set whose cases are all explicit.
pio_contingency_set_parse⚠
Read text from an acquired source as a PSS/E contingency description file.
pio_contingency_set_release⚠
Safety
pio_contingency_set_resolve⚠
Bind every case of the set to the elements of one balanced network.
pio_contingency_set_retain⚠
Safety
pio_contingency_set_to_con⚠
Write the set back as .con text, so an expanded set reaches a file. The text is owned by the returned handle and read with pio_string_view; release it with pio_string_release.
pio_dc_operators_branch_flow_dc⚠
DC branch flows for bus voltage angles in radians over the bus axis.
pio_dc_operators_branch_flow_matrix⚠
The branch flow matrix Bf = diag(b) A, branches by buses.
pio_dc_operators_branch_identity⚠
The stable identity of branch axis row index: the source uid when one exists, else branches:<row>. An index past the branch axis returns an empty view. Borrowed from the handle.
pio_dc_operators_branch_phase_shift_injection⚠
The per branch phase shift injection b .* shift.
pio_dc_operators_branch_rows⚠
Branch axis row to the analysis branch row it represents: the position in the network’s branch table, with three winding transformer windings after the branches. Borrowed from the handle.
pio_dc_operators_branch_susceptances⚠
The per branch susceptances b over the branch axis.
pio_dc_operators_bus_ids⚠
Bus axis row to source bus id. Borrowed from the handle.
pio_dc_operators_bus_injection_dc⚠
DC bus injections for bus voltage angles in radians over the bus axis.
pio_dc_operators_bus_phase_shift_injection⚠
The per bus phase shift injection A' (b .* shift).
pio_dc_operators_bus_susceptance_matrix⚠
The bus susceptance matrix B = A' diag(b) A, buses by buses.
pio_dc_operators_incidence_matrix⚠
The incidence matrix A, branches by buses, over the handle’s axes.
pio_dc_operators_n_branches⚠
The length of the branch axis.
pio_dc_operators_n_buses⚠
The length of the bus axis.
pio_dc_operators_release⚠
Safety
pio_dc_operators_retain⚠
Safety
pio_dc_operators_skipped_branch_rows⚠
Analysis branch rows dropped under skip_zero_impedance, in table order. Borrowed from the handle.
pio_dc_opf_instance_branch_susceptance_formula⚠
Safety
pio_dc_opf_preparation_branch_at⚠
Read one active branch row of a DC OPF preparation.
pio_dc_opf_preparation_bus_at⚠
Read one dense bus row of a DC OPF preparation.
pio_dc_opf_preparation_generator_at⚠
Read one generator row of a DC OPF preparation.
pio_dc_opf_preparation_reference_buses⚠
Borrow the dense reference bus indices of a DC OPF preparation.
pio_dc_opf_preparation_release⚠
Safety
pio_dc_opf_preparation_retain⚠
Safety
pio_dc_opf_preparation_skipped_zero_impedance⚠
Borrow the analysis rows skipped for zero impedance.
pio_dc_opf_preparation_summary⚠
Read the dimensions and conventions of a DC OPF preparation.
pio_dc_pf_instance_branch_susceptance_formula⚠
Safety
pio_dc_pf_instance_bus_specification_at⚠
Read one DC power flow bus specification by zero based bus table position.
pio_dc_pf_instance_bus_specification_count⚠
Safety
pio_destination_memory⚠
Select memory output and prefix returned artifact names with root.
pio_destination_path⚠
Select a filesystem output path.
pio_destination_release⚠
Safety
pio_destination_retain⚠
Safety
pio_detailed_connectivity_boundary_line_at⚠
Read one PowSybl boundary line by zero based table position.
pio_detailed_connectivity_boundary_line_reactive_capability_point_at⚠
Read one point from a boundary line generation reactive capability curve.
pio_detailed_connectivity_boundary_line_reactive_capability_point_property_at⚠
Read one property from one boundary line reactive capability curve point.
pio_detailed_connectivity_boundary_line_reactive_limit_property_at⚠
Read one property on a boundary line generation reactive limit record.
pio_detailed_connectivity_bus_breaker_bus_at⚠
Read one configured bus breaker bus by zero based table position.
pio_detailed_connectivity_busbar_section_at⚠
Read one busbar section by zero based table position.
pio_detailed_connectivity_calculated_bus_at⚠
Read one calculated bus by zero based table position.
pio_detailed_connectivity_calculated_bus_node_at⚠
Read one node identity from a calculated bus.
pio_detailed_connectivity_component_alias_at⚠
Read one alias from a component metadata record.
pio_detailed_connectivity_component_metadata_at⚠
Read one component metadata record by zero based table position.
pio_detailed_connectivity_component_property_at⚠
Read one string property from a component metadata record.
pio_detailed_connectivity_counts⚠
Read every detailed connectivity table length.
pio_detailed_connectivity_dc_busbar_at⚠
Read one DC busbar by zero based table position.
pio_detailed_connectivity_dc_converter_unit_at⚠
Read one DC converter unit by zero based table position.
pio_detailed_connectivity_dc_ground_at⚠
Read one DC ground by zero based table position.
pio_detailed_connectivity_dc_line_at⚠
Read one DC line by zero based table position.
pio_detailed_connectivity_dc_node_at⚠
Read one physical DC node by zero based table position.
pio_detailed_connectivity_dc_series_device_at⚠
Read one DC series device by zero based table position.
pio_detailed_connectivity_dc_switch_at⚠
Read one DC switch by zero based table position.
pio_detailed_connectivity_dc_topological_node_at⚠
Read one DC topological node by zero based table position.
pio_detailed_connectivity_equipment_reactive_capability_point_at⚠
Read one point from an equipment reactive capability curve.
pio_detailed_connectivity_equipment_reactive_capability_point_property_at⚠
Read one property from an equipment reactive capability curve point.
pio_detailed_connectivity_equipment_reactive_limit_property_at⚠
Read one property from an equipment reactive limit record.
pio_detailed_connectivity_equipment_reactive_limits_at⚠
Read reactive limits retained for one equipment record.
pio_detailed_connectivity_external_identifier_at⚠
Read one external identifier from a component metadata record.
pio_detailed_connectivity_internal_connection_at⚠
Read one node breaker internal connection by zero based table position.
pio_detailed_connectivity_junction_at⚠
Read one CIM junction by zero based table position.
pio_detailed_connectivity_line_commutated_converter_at⚠
Read one line commutated converter by zero based table position.
pio_detailed_connectivity_line_commutated_converter_droop_curve_segment_at⚠
Read one DC voltage droop curve segment from a line commutated converter.
pio_detailed_connectivity_node_at⚠
Read one connectivity node by zero based table position.
pio_detailed_connectivity_omitted_field_at⚠
Read one field that was absent from the source representation.
pio_detailed_connectivity_operational_limit_group_at⚠
Read one operational limit group by zero based table position.
pio_detailed_connectivity_operational_limit_group_property_at⚠
Read one string property from an operational limit group.
pio_detailed_connectivity_release⚠
Safety
pio_detailed_connectivity_retain⚠
Safety
pio_detailed_connectivity_subnetwork_at⚠
Read one PowSybl subnetwork by zero based table position.
pio_detailed_connectivity_subnetwork_component_at⚠
Read one component identity contained by a PowSybl subnetwork.
pio_detailed_connectivity_substation_at⚠
Read one substation by zero based table position.
pio_detailed_connectivity_substation_geographical_tag_at⚠
Read one geographical tag of a substation.
pio_detailed_connectivity_switch_at⚠
Read one detailed topology switch by zero based table position.
pio_detailed_connectivity_tap_changer_at⚠
Read one transformer tap changer by zero based table position.
pio_detailed_connectivity_tap_changer_step_at⚠
Read one transformer tap changer step by zero based position.
pio_detailed_connectivity_temporary_limit_at⚠
Read one temporary current, active power, or apparent power limit.
pio_detailed_connectivity_terminal_at⚠
Read one AC terminal by zero based table position.
pio_detailed_connectivity_tie_line_at⚠
Read one PowSybl tie line by zero based table position.
pio_detailed_connectivity_voltage_level_at⚠
Read one voltage level by zero based table position.
pio_detailed_connectivity_voltage_level_bus_at⚠
Read one balanced bus ID assigned to a voltage level.
pio_detailed_connectivity_voltage_source_converter_at⚠
Read one voltage source converter by zero based table position.
pio_detailed_connectivity_voltage_source_converter_droop_curve_segment_at⚠
Read one DC voltage droop curve segment from a voltage source converter.
pio_detailed_connectivity_voltage_source_converter_reactive_capability_point_at⚠
Read one point from a voltage source converter reactive capability curve.
pio_detailed_connectivity_voltage_source_converter_reactive_capability_point_property_at⚠
Read one property from a voltage source converter reactive capability point.
pio_detailed_connectivity_voltage_source_converter_reactive_limit_property_at⚠
Read one property from a voltage source converter reactive limit record.
pio_diagnostic_code⚠
Safety
pio_diagnostic_details_json⚠
Serialize this diagnostic’s structured details as an owned JSON object.
pio_diagnostic_has_id⚠
Whether this diagnostic has a durable identity.
pio_diagnostic_has_suggested_action⚠
Whether this diagnostic carries a suggested action.
pio_diagnostic_has_target⚠
Whether this diagnostic names a value element.
pio_diagnostic_id⚠
Borrow this diagnostic’s durable identity, or an empty view when absent.
pio_diagnostic_message⚠
Safety
pio_diagnostic_n_related⚠
Number of other diagnostic identities referenced by this diagnostic.
pio_diagnostic_n_spans⚠
Number of source byte ranges attached to this diagnostic.
pio_diagnostic_related⚠
Borrow one related diagnostic identity, or an empty view when out of range.
pio_diagnostic_severity⚠
Safety
pio_diagnostic_span⚠
Read one source byte range. The source string borrows from diagnostics.
pio_diagnostic_suggested_action⚠
Borrow this diagnostic’s suggested action, or an empty view when absent.
pio_diagnostic_target⚠
Borrow this diagnostic’s value element locator, or an empty view when absent.
pio_diagnostics_len⚠
Safety
pio_diagnostics_release⚠
Safety
pio_diagnostics_retain⚠
Safety
pio_emit⚠
Emit one module as a grid exchange format.
pio_emit_result_artifact⚠
Safety
pio_emit_result_artifact_count⚠
Safety
pio_emit_result_diagnostics⚠
Safety
pio_emit_result_fidelity⚠
Safety
pio_emit_result_layout⚠
Safety
pio_emit_result_release⚠
Safety
pio_emit_result_retain⚠
Safety
pio_error_code⚠
The failure’s stable diagnostic code.
pio_error_diagnostics⚠
The structured diagnostics that caused the failure.
pio_error_message⚠
The rendered failure message.
pio_error_release⚠
Safety
pio_error_retain⚠
Safety
pio_geo_apply_report_matched_branches⚠
Safety
pio_geo_apply_report_matched_buses⚠
Safety
pio_geo_apply_report_note_at⚠
Safety
pio_geo_apply_report_note_count⚠
Safety
pio_geo_apply_report_release⚠
Safety
pio_geo_apply_report_retain⚠
Safety
pio_geo_apply_report_unlocated_branches⚠
Safety
pio_geo_apply_report_unlocated_buses⚠
Safety
pio_geo_apply_report_unmatched_features⚠
Safety
pio_geo_layer_diagnostics⚠
Return diagnostics produced while parsing a geographic sidecar.
pio_geo_layer_parse⚠
Parse one geographic sidecar from an acquired source.
pio_geo_layer_release⚠
Safety
pio_geo_layer_retain⚠
Safety
pio_geo_layer_to_geojson⚠
Write the layer as the canonical .geo.json document: a GeoJSON FeatureCollection whose powerio_geo member states the coordinate space and the writer’s version. The text is owned by the returned handle and read with pio_string_view; release it with pio_string_release.
pio_islands_at⚠
Read island index, zero based in the order pio_balanced_network_islands documents. The views stay valid while the handle is alive.
pio_islands_count⚠
The number of islands. A NULL handle has none.
pio_islands_isolated_bus_ids⚠
Source bus ids of the buses typed isolated, in ascending order. Borrowed from the handle.
pio_islands_isolated_bus_indices⚠
Zero based bus table positions of the buses typed isolated, in ascending bus id order. Borrowed from the handle.
pio_islands_release⚠
Safety
pio_islands_retain⚠
Safety
pio_json_value_array_at⚠
Return one owner-rooted element from a structured JSON array.
pio_json_value_get⚠
Read the type and scalar or collection data for a structured value.
pio_json_value_object_entry_at⚠
Read one key and value type from a structured JSON object.
pio_json_value_object_value_at⚠
Return one owner-rooted value from a structured JSON object by position.
pio_json_value_release⚠
Safety
pio_json_value_retain⚠
Safety
pio_lindist3flow_opf_instance_conductor_at⚠
Read a conductor by zero based position. Strings borrow the instance handle.
pio_lindist3flow_opf_instance_conductor_count⚠
Safety
pio_lindist3flow_opf_instance_node_at⚠
Read a node by zero based position. Strings borrow the instance handle.
pio_lindist3flow_opf_instance_node_count⚠
Safety
pio_mc_ac_pf_instance_active_control_at⚠
Safety
pio_mc_ac_pf_instance_active_control_count⚠
Safety
pio_mc_ac_pf_instance_isolated_terminal_at⚠
Safety
pio_mc_ac_pf_instance_isolated_terminal_count⚠
Safety
pio_mc_ac_pf_instance_load_at⚠
Safety
pio_mc_ac_pf_instance_load_count⚠
Safety
pio_mc_ac_pf_instance_load_details_at⚠
Borrow prescribed powers and their full voltage law from a PF instance.
pio_mc_ac_pf_instance_load_terminal_at⚠
Safety
pio_mc_ac_pf_instance_load_terminal_name_at⚠
Borrow one prescribed load terminal name, including for bounded laws.
pio_mc_ac_pf_instance_source_at⚠
Legacy source parameters. Referenced sources fail with a type mismatch; use pio_mc_ac_pf_instance_source_boundary_at for both voltage endpoints.
pio_mc_ac_pf_instance_source_boundary_at⚠
Read a complete prescribed PF source boundary. The source index and terminal order match the instance’s network; use its voltage-source terminal accessor to read terminal names. Borrowed arrays and strings remain valid while their calculation-instance owner is retained.
pio_mc_ac_pf_instance_source_count⚠
Safety
pio_mc_ac_pf_instance_source_terminal_at⚠
Legacy earth-referenced terminal voltage. Referenced sources fail with a type mismatch; use pio_mc_ac_pf_instance_source_boundary_at instead.
pio_module_apply_geo_layer⚠
Apply one geographic layer to a balanced or multiconductor network module. The input module is unchanged. When out_report is not NULL, it receives an independently owned report handle.
pio_module_deserialize⚠
Deserialize one PowerIO IR source.
pio_module_diagnostics⚠
Return the module’s stored diagnostics.
pio_module_extension_at⚠
Read one namespaced structured module extension by zero based position.
pio_module_extension_count⚠
Safety
pio_module_extension_value_at⚠
Return an owner-rooted structured module extension value.
pio_module_history_assumption_at⚠
Read one assumption attached to a history entry.
pio_module_history_at⚠
Read one operation from module history by zero based position.
pio_module_history_count⚠
Safety
pio_module_history_loss_at⚠
Read one declared loss attached to a history entry.
pio_module_history_parameter_at⚠
Read one named structured history parameter by zero based position.
pio_module_history_parameter_value_at⚠
Return an owner-rooted structured history parameter value.
pio_module_producer⚠
Read the program identity recorded with a module.
pio_module_release⚠
Safety
pio_module_retain⚠
Safety
pio_module_serialize⚠
Serialize one module as PowerIO IR.
pio_module_source_at⚠
Read one durable source descriptor by zero based position.
pio_module_source_count⚠
Safety
pio_module_source_map_at⚠
Read one source map entry by zero based position.
pio_module_source_map_count⚠
Safety
pio_module_source_map_span_at⚠
Read one byte range from a source map entry.
pio_module_to_ac_opf_instance⚠
Construct an AC optimal power flow calculation module from a balanced network module.
pio_module_to_ac_ots_instance⚠
Construct an AC optimal transmission switching calculation module with the default options from a balanced network or AC OPF module: every initially in-service branch may switch, at zero cost, and the objective gains the switching cost term. An AC OTS module comes back unchanged.
pio_module_to_ac_ots_instance_with_options⚠
Construct an AC optimal transmission switching calculation module with explicit options from a balanced network, AC OPF, or AC OTS module. An AC OTS module keeps its base problem and objective and takes the new options; the objective gains the switching cost term once. NULL options give exactly what pio_module_to_ac_ots_instance gives: only the initially in-service branches may switch, and an AC OTS module comes back unchanged.
pio_module_to_ac_pf_instance⚠
Construct an AC power flow calculation module from a balanced network module.
pio_module_to_dc_opf_instance⚠
Construct a DC optimal power flow calculation module from a balanced network module.
pio_module_to_dc_pf_instance⚠
Construct a DC power flow calculation module from a balanced network module.
pio_module_to_lindist3flow_opf_instance⚠
Safety
pio_module_to_mc_ac_opf_instance⚠
Construct a multiconductor AC optimal power flow calculation module from a multiconductor network module.
pio_module_to_mc_ac_pf_instance⚠
Construct a multiconductor AC power flow calculation module from a multiconductor network module.
pio_module_value⚠
Return an owner-rooted view of the module’s value.
pio_monitored_set_release⚠
Safety
pio_monitored_set_retain⚠
Safety
pio_monitored_set_statement_count⚠
Safety
pio_monitored_set_to_mon⚠
Write the set back as .mon text. The text is owned by the returned handle and read with pio_string_view; release it with pio_string_release.
pio_multiconductor_network_base_frequency_hz⚠
Safety
pio_multiconductor_network_bus_at⚠
Read one multiconductor bus by zero based table position. Borrowed strings and numeric spans remain valid while the network handle is alive.
pio_multiconductor_network_bus_count⚠
Safety
pio_multiconductor_network_bus_grounded_terminal_at⚠
Safety
pio_multiconductor_network_bus_terminal_at⚠
Safety
pio_multiconductor_network_capacitor_at⚠
Safety
pio_multiconductor_network_capacitor_terminal_at⚠
Safety
pio_multiconductor_network_command_at⚠
Safety
pio_multiconductor_network_control_profile_at⚠
Safety
pio_multiconductor_network_counts⚠
Read exact table lengths. Defaulted source fields and arbitrary extension maps are retained internally and are not separate domain tables.
pio_multiconductor_network_generator_at⚠
Safety
pio_multiconductor_network_generator_count⚠
Safety
pio_multiconductor_network_generator_terminal_at⚠
Safety
pio_multiconductor_network_geo⚠
Read the network coordinate metadata, including absence through has_geo.
pio_multiconductor_network_has_name⚠
Safety
pio_multiconductor_network_has_source_format⚠
Safety
pio_multiconductor_network_inverter_based_resource_at⚠
Safety
pio_multiconductor_network_inverter_based_resource_terminal_at⚠
Safety
pio_multiconductor_network_line_at⚠
Safety
pio_multiconductor_network_line_code_at⚠
Safety
pio_multiconductor_network_line_code_conductance_from_matrix_row_at⚠
Safety
pio_multiconductor_network_line_code_conductance_to_matrix_row_at⚠
Safety
pio_multiconductor_network_line_code_reactance_matrix_row_at⚠
Safety
pio_multiconductor_network_line_code_resistance_matrix_row_at⚠
Safety
pio_multiconductor_network_line_code_susceptance_from_matrix_row_at⚠
Safety
pio_multiconductor_network_line_code_susceptance_to_matrix_row_at⚠
Safety
pio_multiconductor_network_line_count⚠
Safety
pio_multiconductor_network_line_route_point_at⚠
Safety
pio_multiconductor_network_line_terminal_from_at⚠
Safety
pio_multiconductor_network_line_terminal_to_at⚠
Safety
pio_multiconductor_network_load_at⚠
Safety
pio_multiconductor_network_load_count⚠
Safety
pio_multiconductor_network_load_details_at⚠
Borrow a load and its complete voltage law, without cloning or serializing its network.
pio_multiconductor_network_load_terminal_at⚠
Safety
pio_multiconductor_network_name⚠
Safety
pio_multiconductor_network_option_at⚠
Safety
pio_multiconductor_network_release⚠
Safety
pio_multiconductor_network_retain⚠
Safety
pio_multiconductor_network_shunt_at⚠
Safety
pio_multiconductor_network_shunt_conductance_matrix_row_at⚠
Safety
pio_multiconductor_network_shunt_susceptance_matrix_row_at⚠
Safety
pio_multiconductor_network_shunt_terminal_at⚠
Safety
pio_multiconductor_network_source_format⚠
Safety
pio_multiconductor_network_switch_at⚠
Safety
pio_multiconductor_network_switch_terminal_from_at⚠
Safety
pio_multiconductor_network_switch_terminal_to_at⚠
Safety
pio_multiconductor_network_transformer_at⚠
Safety
pio_multiconductor_network_transformer_winding_at⚠
Safety
pio_multiconductor_network_transformer_winding_terminal_at⚠
Safety
pio_multiconductor_network_untyped_object_at⚠
Safety
pio_multiconductor_network_untyped_object_property_at⚠
Safety
pio_multiconductor_network_voltage_source_at⚠
Safety
pio_multiconductor_network_voltage_source_boundary_at⚠
Read all source parameters and the explicit voltage reference. None is indicated by has_reference_terminal=false. Terminal names use the existing network voltage-source terminal accessor at the same source index.
pio_multiconductor_network_voltage_source_terminal_at⚠
Safety
pio_network_update_release⚠
Safety
pio_network_update_retain⚠
Safety
pio_network_update_set_branch_thermal_rating⚠
Safety
pio_operating_point_balanced_network⚠
Safety
pio_operating_point_get_value⚠
Read one operating point quantity by its PowerIO quantity name and stable component identity. Multiconductor terminal identities use component/terminal. Returns false when the point does not contain the quantity or identity.
pio_operating_point_multiconductor_network⚠
Safety
pio_operating_point_release⚠
Safety
pio_operating_point_retain⚠
Safety
pio_operating_point_type_name⚠
Safety
pio_operating_point_update_release⚠
Safety
pio_operating_point_update_retain⚠
Safety
pio_operating_point_update_set_branch_in_service⚠
Safety
pio_operating_point_update_set_generator_active_power⚠
Safety
pio_operating_point_update_set_generator_in_service⚠
Safety
pio_operating_point_update_set_generator_reactive_power⚠
Safety
pio_operating_point_update_set_generator_voltage_magnitude⚠
Safety
pio_operating_point_update_set_load_active_power⚠
Safety
pio_operating_point_update_set_load_reactive_power⚠
Safety
pio_operating_point_update_set_switch_closed⚠
Safety
pio_operating_point_update_set_transformer_phase_shift_degrees⚠
Safety
pio_operating_point_update_set_transformer_tap_ratio⚠
Safety
pio_parse⚠
Parse one acquired grid exchange source.
pio_parse_with_options⚠
Parse with optional typed reader and acquisition selections. NULL options is identical to pio_parse. Explicit SINCAL options require the matching format token and never select or balance a network family implicitly.
pio_reactive_power_from_megavars
pio_reactive_power_from_vars
pio_reactive_power_release⚠
Safety
pio_reactive_power_retain⚠
Safety
pio_reactive_power_unit⚠
Safety
pio_reactive_power_value⚠
Safety
pio_scenario_set_element_type⚠
Safety
pio_scenario_set_get⚠
Return an owner-rooted scenario value by exact scenario ID.
pio_scenario_set_get_at⚠
Return an owner-rooted scenario value by zero-based position.
pio_scenario_set_id_at⚠
Safety
pio_scenario_set_len⚠
Safety
pio_scenario_set_release⚠
Safety
pio_scenario_set_retain⚠
Safety
pio_schema_report⚠
Return version information for this library and the PowerIO IR serializer/deserializer.
pio_sensitivities_branch_identity⚠
The stable identity of branch axis position index: the source uid when one exists, else branches:<row>. An index past the branch axis returns an empty view. Borrowed from the handle.
pio_sensitivities_branch_rows⚠
Branch axis position to the branch table row it represents, with three winding transformer windings after the branches. Borrowed from the handle.
pio_sensitivities_bus_ids⚠
Bus axis position to source bus id. Borrowed from the handle.
pio_sensitivities_lodf⚠
The LODF, branches by branches, row major: entry (l, k) sits at l * n_branches + k and is the share of branch k’s pre-outage flow that moves onto branch l when k goes out. The diagonal is -1; a branch whose outage splits an island has a zero column. Borrowed from the handle.
pio_sensitivities_n_branches⚠
The length of the branch axis: the PTDF row count and the LODF order.
pio_sensitivities_n_buses⚠
The length of the bus axis: the PTDF column count.
pio_sensitivities_ptdf⚠
The PTDF, branches by buses, row major: entry (l, k) sits at l * n_buses + k and is the flow on branch l per unit injected at bus k and withdrawn at the reference bus of its island. Borrowed from the handle.
pio_sensitivities_reduced_dimension⚠
The order of the grounded system the build factored: the bus count less the reference count.
pio_sensitivities_reference_bus_indices⚠
Bus axis positions of the reference buses the build grounded, in ascending order: every reference bus of the network. Borrowed from the handle.
pio_sensitivities_release⚠
Safety
pio_sensitivities_retain⚠
Safety
pio_sensitivities_solver_path⚠
The factorization the build used: dense_cholesky, dense_inverse, sparse_cholesky, sparse_ldlt, sparse_lu, or sparse_empty.
pio_socwr_opf_solution_get_objective_lower_bound⚠
Safety
pio_source_from_memory⚠
Retain named bytes as an in-memory source. Binary content is supported.
pio_source_from_memory_with_buffers⚠
Construct a memory source with explicitly supplied relative companions. Copies the primary and companion bytes before returning an owned handle. This source never reads referenced files from the filesystem.
pio_source_open⚠
Acquire a file or directory path.
pio_source_release⚠
Safety
pio_source_retain⚠
Safety
pio_sparse_matrix_column_indices⚠
Safety
pio_sparse_matrix_columns⚠
Safety
pio_sparse_matrix_release⚠
Safety
pio_sparse_matrix_retain⚠
Safety
pio_sparse_matrix_row_offsets⚠
Safety
pio_sparse_matrix_rows⚠
Safety
pio_sparse_matrix_values⚠
Safety
pio_string_release⚠
Safety
pio_string_retain⚠
Safety
pio_string_view⚠
Safety
pio_subsystem_set_count⚠
Safety
pio_subsystem_set_name⚠
Read one subsystem name by zero based position, in the file’s own order.
pio_subsystem_set_release⚠
Safety
pio_subsystem_set_retain⚠
Safety
pio_subsystem_set_to_sub⚠
Write the set back as .sub text. The text is owned by the returned handle and read with pio_string_view; release it with pio_string_release.
pio_time_series_element_type⚠
Safety
pio_time_series_get⚠
Return an owner-rooted entry by zero-based position.
pio_time_series_len⚠
Safety
pio_time_series_release⚠
Safety
pio_time_series_retain⚠
Safety
pio_time_series_time_point⚠
Read time metadata at a zero-based position without serializing the value. Returns false and reports an error for an invalid handle, index or output.
pio_update_change_component_id⚠
Safety
pio_update_change_field⚠
Safety
pio_update_change_release⚠
Safety
pio_update_change_retain⚠
Safety
pio_update_change_terminal⚠
Safety
pio_update_report_change⚠
Safety
pio_update_report_connectivity_changed⚠
Safety
pio_update_report_len⚠
Safety
pio_update_report_release⚠
Safety
pio_update_report_retain⚠
Safety
pio_value_ac_opf_instance⚠
Safety
pio_value_ac_opf_solution⚠
Safety
pio_value_ac_ots_instance⚠
Return an owner-rooted AC optimal transmission switching instance view.
pio_value_ac_ots_solution⚠
Return an owner-rooted AC optimal transmission switching solution view.
pio_value_ac_pf_instance⚠
Safety
pio_value_ac_pf_solution⚠
Safety
pio_value_ac_scuc_instance⚠
Safety
pio_value_ac_scuc_solution⚠
Safety
pio_value_balanced_network⚠
Borrow the value as a balanced network without serialization or copying.
pio_value_balanced_operating_point⚠
Safety
pio_value_contingency_set⚠
Borrow the value as a PSS/E contingency description file without copying. The handle holds the module owner alive, so it stays readable after the module handle is released. A set taken this way carries no reader notes.
pio_value_dc_opf_instance⚠
Safety
pio_value_dc_opf_solution⚠
Safety
pio_value_dc_pf_instance⚠
Safety
pio_value_dc_pf_solution⚠
Safety
pio_value_geo_layer⚠
Take the value as a geographic layer handle. The layer is copied out of the value, so the handle outlives the module the way pio_geo_layer_parse produces one.
pio_value_is_type⚠
Exact structural type predicate.
pio_value_lindist3flow_opf_instance⚠
Safety
pio_value_lindist3flow_opf_solution⚠
Safety
pio_value_mc_ac_opf_instance⚠
Safety
pio_value_mc_ac_opf_solution⚠
Safety
pio_value_mc_ac_pf_instance⚠
Safety
pio_value_mc_ac_pf_solution⚠
Safety
pio_value_monitored_set⚠
Borrow the value as a PSS/E monitored element file without copying. The handle holds the module owner alive, so it stays readable after the module handle is released.
pio_value_multiconductor_network⚠
Borrow the value as a multiconductor network without serialization or copying.
pio_value_multiconductor_operating_point⚠
Safety
pio_value_release⚠
Safety
pio_value_retain⚠
Safety
pio_value_scenario_set⚠
Borrow the value as a scenario set.
pio_value_socwr_opf_solution⚠
Safety
pio_value_subsystem_set⚠
Borrow the value as a PSS/E subsystem description file without copying. The handle holds the module owner alive, so it stays readable after the module handle is released.
pio_value_time_series⚠
Borrow the value as a time series.
pio_value_type_name⚠
Canonical structural type name, such as powerio.BalancedNetwork.
pio_vector_release⚠
Safety
pio_vector_retain⚠
Safety
pio_vector_values⚠
Safety
pio_version
Return the PowerIO crate version.
pio_version_numbers
Return the release of this library as numbers.