Module dist 

Distribution types and facade format dispatch. Types whose names overlap with balanced network types stay grouped here.

Modules

bmopf

The BMOPF task force JSON schema (https://github.com/distribution-system-opt/dsopt-schema).

cim

Distribution CIM: IEC 61968 and 61970 CIM100 RDF/XML for unbalanced feeders, read into and written from the MulticonductorNetwork (format token cim-dist).

convert

Distribution format dispatch.

diagnostics

The codes this crate emits.

dss

OpenDSS .dss support: tokenizer, RPN, class tables, raw object layer.

error

geo

Typed coordinate metadata for the distribution model.

glm

GridLAB-D source syntax, bounded offline preprocessing and static import.

graph

Render ready bus and terminal graph projection.

kron

Explicit-neutral Kron projection for MulticonductorNetwork.

lindist3flow

Audited, format-neutral network preparation for LinDist3Flow.

model

The canonical multiconductor network model.

pmd

The PowerModelsDistribution ENGINEERING model as JSON (“PMD JSON”).

ravens

MG-RAVENS JSON import and export for the multiconductor MulticonductorNetwork.

readiness

Pre-solver structural readiness checks for distribution networks.

Structs

BmopfEmitOptions

Options for BMOPF JSON output.

Diagnostic

One coded user facing finding.

DiagnosticCode

Stable dotted identity of one diagnostic.

DistBus

DistCanvas

Diagram canvas metadata.

DistCapacitor

A rated capacitor bank (BMOPF schema 0.1.0 capacitor): q_rated vars delivered at v_nom volts across the element terminals, distinct from the raw admittance DistShunt. The DSS converter still lowers OpenDSS capacitors to shunt B matrices; this element carries capacitors that arrive as BMOPF input.

DistComponentLocation

A geographic point attached to one exact component identity. It is independent of bus drawing positions, line routes and electrical length.

DistControlProfile

DistGenerator

DistGeoMeta

Network level coordinate metadata.

DistGeographicPoint

Source or user supplied geographic coordinates, in decimal degrees. Neither axis is implied by the other; zero is a valid stated value. An absent datum is unknown, never an implicit WGS84 declaration.

DistGraph

A collapsed bus graph with terminal level attachments and conductor maps.

DistGraphAttachment

An element connected to a bus terminal.

DistGraphBus

One bus node in the collapsed graph.

DistGraphEdge

One edge in the collapsed graph.

DistIbr

DistLine

DistLineCode

DistLoad

DistLocation

A point attached to one model element.

DistShunt

DistSwitch

DistTransformer

DistWinding

DssEmitOptions

Options for canonical OpenDSS output.

DssLoadVoltageBounds

OpenDSS per unit load voltage validity band.

ElectricalReadiness

Result of audit_electrical_readiness.

EmitOptions

Format specific policies for distribution network emission.

LinDist3FlowPreparationAction

One source component and the prepared representation chosen for it.

LinDist3FlowPreparationReport

Complete provenance for a LinDist3Flow preparation pass.

LinDist3FlowPreparedNetwork

Independently owned prepared network and its audit report.

MulticonductorNetwork

A multiconductor distribution network: an immutable cheap to clone owning handle over private shared tables.

NeutralKronAction

One auditable non-matrix rewrite performed by the projection.

NeutralKronBus

One eliminated bus terminal.

NeutralKronOptions

Options controlling explicit-neutral identification and grounding.

NeutralKronRecovery

Neutral-current recovery for one reduced linecode.

NeutralKronReduction

The independently owned reduced network and its projection audit.

NeutralKronReport

Complete audit of one neutral-Kron projection.

PowerFactorControl

ReadinessFinding

A deterministic finding emitted by the readiness audit.

SincalReadOptions

Selection for the conductor-resolved SINCAL reader. No external tool runs during parsing. Native SQLite/archive and explicitly acquired Access tables are distinct input paths; both retain the original primary source bytes.

UntypedObject

An object the reader recognized but does not type: preserved by class, name, and raw property text so conversions can warn precisely.

VoltVarControl

VoltWattControl

VoltageSource

An ideal source prescribing terminal voltages relative to earth or one explicit terminal on the same bus. A reference terminal is a conductor, not an implicit grounding instruction.

Enums

ActivePowerReference

ActivePowerUnit

BmopfSchemaVersion

The BMOPF schema version a document is read as or written against.

Configuration

ControlVoltageReference

CoordinateSpace

Coordinate space for locations in a network.

DiagnosticSeverity

Severity of one user facing finding.

DiagnosticStage

Pipeline stage encoded by the first segment of a diagnostic code.

DistCoordsKind

Coordinate origin.

DistGraphAttachmentKind

Element family for terminal attachments.

DistGraphEdgeKind

Edge family in the collapsed graph.

DistLoadVoltageModel

DistLocationTarget

The typed table containing a located component. Names retain exact case.

DistSourceFormat

Where the network came from; fixes the echo tier target.

DistTargetFormat

A writable distribution format.

DistWindingConn

Error

IbrPrimeMover

IbrTopology

IbrVoltageAggregation

LinDist3FlowPreparationActionKind

One auditable preparation decision.

LinDist3FlowPreparationPolicy

How aggressively the distribution network may be prepared for the LinDist3Flow formulation.

NeutralKronGrounding

How the eliminated neutral was grounded in the source network.

ReactivePowerReference

ReactivePowerUnit

ReadinessSeverity

Severity of an electrical-readiness finding.

Constants

BMOPF_SCHEMA_ID

Canonical identity of the default schema. Fresh proposal output uses BmopfSchemaVersion::retrieval_url in meta.$schema.

BMOPF_SCHEMA_VERSION

The version of the schema the writer targets by default, and the value it stamps into meta.schema_version. It is BmopfSchemaVersion::default().version().

CIM_DIST_HEAD_BYTES

How much of a document the header checks read.

Functions

audit_electrical_readiness

Audit a multiconductor network before numerical lowering or solving.

classify_distribution_json

Distribution parser policy for a .json input.

emit

Emit a parsed module to format through a destination.

emit_with_options

emit with format specific policies.

find_unresolved_references

Push a warning for every dangling or empty cross-reference. Bus and linecode references are bare strings, a reader leaves an empty string where the field is missing, and the graph projection synthesizes a phantom bus for any unresolved id (the empty string included) — so a typo or an absent field would otherwise parse cleanly into a topologically wrong network. Comparison is ASCII case insensitive, matching MulticonductorNetwork::bus and MulticonductorNetwork::linecode. The unresolved bus and linecode references of a network, as one message per finding: the same walk the reader’s warning pass runs, exposed so a decoder can refuse a document whose network fails it.

looks_like_cim_dist

Whether a document reads as distribution CIM: its header passes looks_like_cim_dist_header, and it holds at least one per phase or distribution only class anywhere.

looks_like_cim_dist_header

Whether a document opens like distribution CIM: RDF/XML in a CIM namespace with no md:FullModel header (which marks a CGMES profile) in its first CIM_DIST_HEAD_BYTES. A caller holding only a file’s head can rule it out with this before reading the whole file for looks_like_cim_dist.

neutral_kron_reduce

Produce a neutral-reduced multiconductor network without mutating the input. Neutral roles come from options.neutral_terminals, retained BMOPF terminal conventions, or the model’s conservative n / four-wire 4 convention. Only perfectly grounded neutrals are accepted unless the explicit forced-ground option is enabled. Component points remain attached to retained components and are copied to derived line configurations. Removed devices’ points remain in the audit action’s details.source_location.

parse

parse_dist_target_format

Resolves common names and file extensions to a target format.

parse_sincal

Parse a declared conductor-resolved SINCAL profile. Balanced-looking powers do not change the network family, and unsupported modes reject atomically.

prepare_lindist3flow_network

Prepare an independently owned LinDist3Flow network according to policy.

require_electrical_readiness

Reject incomplete electrical data before numerical use.

source_looks_like_cim_dist

Whether a source holds distribution CIM: its own buffer reads as distribution CIM (looks_like_cim_dist), or, for a directory, one of the .xml documents at its top level does. The reads go through the source, so they count against its acquisition budget and are cached for the parse that follows.

Type Aliases

ConductorMatrix

A square matrix in conductor order, row major.

Extras

Result