OPF result dictionary

solve_opf returns a plain Dict{String,Any} in SI units (V, A, W, var). The structure mirrors the input network dict: top-level keys match the network's component types, and within each component the result is keyed by the component id, then by terminal name (or winding label for transformers).

result = solve_opf(net)

result["termination_status"]   # "LOCALLY_SOLVED", "INFEASIBLE", …
result["objective"]            # objective value; units depend on solve mode
result["solve_time"]           # wall-clock time in seconds

result["bus"]["b1"]["1"]["vm"] # phase-1 voltage magnitude at bus b1 (V)
result["line"]["l1"]["1"]["cr_fr"]  # real part of current at from-terminal "1" (A)
result["generator"]["g1"]["1"]["pg"]  # active power on phase "1" (W)

Because the result is a plain dict, it serialises straight to JSON. write_result writes it to a file or IO, and read_result reads it back to an identical dict:

write_result(result, "result.json")
result2 = read_result("result.json")   # result2 == result

To turn the SolutionReport from profile_solution into a Markdown file, pass a path to render_solution: render_solution(report, "report.md").

Infeasible solutions

Candidate availability is distinct from termination. primal_status and result_count describe whether values were returned. A TIME_LIMIT or ITERATION_LIMIT candidate is retained, including an INFEASIBLE_POINT for diagnostics; a dual/infeasibility certificate is not a primal operating point. When no candidate exists, variable-derived results are NaN. Solver-reported feasible means a feasible/nearly-feasible primal status, not independent validation.

profile_solution reports solver_claimed_feasible, verification_status (checks_passed, failed, or indeterminate), missing paths, and unassessed dimensions. Its compatibility feasible flag additionally requires complete assessed data and no failing checks. None of these flags certifies all network physics or optimality. Bus checks derive magnitude and angle from vr/vi; inconsistent supplied vm is an error. The default bound/phasor consistency tolerance remains 0.2%, with the documented absolute floors.

Top-level fields

bus — voltages

result["bus"][bus_id][terminal] => Dict

All voltages are phase-to-ground (i.e. referenced to the global ground at potential 0 V). The rectangular components vr/vi are the primary variables solved by the OPF; vm and va are derived for convenience.

Grounded terminals (listed in perfectly_grounded_terminals or fixed by the voltage source neutral) are present in the result with vr = vi = vm = 0, va = 0.

The neutral terminal voltage is an explicit variable. In a balanced network it is close to zero; in an unbalanced network it reflects the neutral shift.

line — terminal currents

result["line"][line_id][terminal_name] => Dict

Conductors are keyed by terminal name taken from terminal_map_from of the input line. A line with terminal_map_from = ["1","2","n"] produces result keys "1", "2", "n".

The reported quantities are the total per-end currents: the series current plus that end's π-model shunt half-section, expressed as the current flowing out of the bus into the branch. This is exactly the quantity the thermal magnitude limit is enforced on (see Lines).

KCL sign convention: current is positive flowing out of the bus into the branch. Internally the OPF solves a single series-current variable per conductor with c_to = −c_fr; the shunt currents are linear functions of the bus voltages and are added here to form the totals.

cm_fr ≠ cm_to when the linecode has a nonzero shunt admittance (π model), because the two ends draw different shunt currents. For purely series lines (no shunt) the totals reduce to the series current and cm_fr = cm_to.

Besides the per-conductor terminal keys, the line dict carries two reserved keys: "ground" — the device's net current into earth (cg_r, cg_i, cgm [A]), nonzero only with a phase-to-ground π-shunt — and "loss", the element's active/reactive losses (see losses).

switch — switch currents

result["switch"][switch_id][terminal_name] => Dict

Conductors are keyed by terminal name from terminal_map_from. Open switches have all currents fixed to zero; they appear in the result as cr = ci = cm = 0.

Switches are ideal (lossless and voltage-coupling): cr_from = -cr_to exactly. Only the from-side current is stored.

load — absorbed power

result["load"][load_id][phase_terminal] => Dict

Loads are keyed by phase terminal name (the neutral terminal, if present, carries no independent current variable and is absent from the result). For a WYE load with terminal_map = ["1","2","3","n"] the result has keys "1", "2", "3".

The power fields confirm that the constant-power constraints were satisfied at the solved operating point.

Δv = v_phase − v_neutral for WYE/SINGLEPHASE; `Δv = vpos − vnegacross the DELTA element (terminalkto terminalk mod n + 1). For a feasible solvepd ≈ pnom[k]andqd ≈ q_nom[k]`.

generator — produced power

result["generator"][gen_id][phase_terminal] => Dict

Same terminal indexing as load — phase terminals only, neutral absent.

When the optional s_max / i_max ratings are supplied the dispatch also respects the apparent-power circle pg² + qg² ≤ s_max² and the current-magnitude circle crg² + cig² ≤ i_max² (see Generators).

ibr — produced power

result["ibr"][ibr_id][phase_terminal] => Dict

IBRs are keyed by phase terminal name, following the IBR's topology:

• FOUR_LEG — keyed by each phase terminal in terminal_map (the neutral, the last terminal, carries the summed return current and is absent).
• THREE_LEG (delta) — keyed by the first terminal of each conductor pair (k, k mod n + 1); there is no neutral.
• SINGLE_PHASE — a single key, the phase terminal terminal_map[1] (referenced against terminal_map[2]).

Δv is the topology-appropriate voltage difference: phase-to-neutral for FOUR_LEG, phase-to-reference for SINGLE_PHASE, and across the conductor pair for THREE_LEG. Sign convention matches the generator: positive pg/qg is power injected into the network. See IBRs for the constraint model (box q_min/q_max bounds, constant-power-factor coupling, the s_max apparent-power circle, and the optional i_max current-magnitude limit cri² + cii² ≤ i_max²).

transformer — winding currents

result["transformer"][xfmr_id]["fr"|"to"][k] => Dict

Transformer results use winding-side keys "fr" and "to", each mapping to a positional index string ("1", "2", ...) rather than a terminal name. The two winding sides may have different terminal maps (e.g. a wye_delta transformer has a neutral terminal on the wye side but not on the delta side), so a shared terminal-name key is not well-defined.

To map position back to terminal: position k corresponds to terminal_map_from[k] (from-side) or terminal_map_to[k] (to-side) in the input network.

s/s_max appear only on the coil the nameplate cap is stamped on (see current vs. apparent-power limits); the opposite side carries currents only. profile_solution compares s against s_max and reports E.SOL.THERMAL_VIOLATION / W.SOL.THERMAL_ACTIVE.

For ideal transformers the apparent power S = V·I* is conserved across windings (up to the ideal turns ratio). Series winding impedances (r_series_from, x_series_from, etc.) cause a small difference.

Alongside the "fr"/"to" winding keys, the transformer dict carries a "ground" entry (net current into earth: cg_r, cg_i, cgm [A]) and a "loss" entry (see losses).

When the transformer's tap is a free decision variable (see continuous tap optimisation), the solved tap is also reported:

These keys are present only when the tap was free (tap_min < tap_max); a fixed-tap transformer reports neither.

losses — active/reactive losses

Losses are computed exactly from the terminal-power identity S_loss = 1ᵀ S_from + 1ᵀ S_to, summed over every conductor the element drives (phases and neutral, both winding sides), using the per-device ledger of terminal-current injections built during model construction. Because the injected currents sum to zero internally, the result is independent of the ground voltage reference.

The top-level losses dict holds the network totals over all lines and transformers:

The same identity is attached per element under each line and transformer as a "loss" sub-dict:

result["line"][line_id]["loss"]         => Dict
result["transformer"][xfmr_id]["loss"]  => Dict

Switches are ideal (lossless) and carry no "loss" entry. The per-element sub-dicts are present only when the result was produced with the loss ledger (i.e. by solve_opf); they may be absent in results from other solvers.

voltage_source — slack current and grid injection

result["voltage_source"][source_id][phase_terminal] => Dict

The voltage source is the network's current slack: it fixes terminal voltages and injects the slack current that closes KCL at the source bus (see Voltage source as current slack). Results are keyed by phase terminal (neutral excluded — it carries the summed return current).

Positive ps/qs is power flowing into the network from the source. To obtain the total active power drawn from the grid, sum ps over all phases:

src    = result["voltage_source"]["source"]   # your source id
p_grid = sum(v["ps"] for v in values(src))

initialisation — Ipopt start values

result["initialisation"][bus_id][terminal] => Dict

The start values set on the vr/vi JuMP variables before optimize! is called. These are captured immediately after the warm-start setup and before the solver overwrites them. The section is always present (even for infeasible results), so it can be read without checking termination_status first.

Grounded terminals are recorded as all-zero regardless of the start-value setting, because they are fixed in the JuMP model and the solver ignores their start value.

Convergence diagnostics. profile_solution reads this section and emits warnings when the start values differ substantially from the solved values:

• W.SOL.INIT_LEVEL_MISMATCH — a terminal where vm_init / vm_solved is outside [0.1, 10]. The most common cause is applying the source voltage magnitude to buses on a different voltage level (e.g. a 6.35 kV source voltage applied to a 230 V LV bus via flat initialisation). The solver may still converge but the path is longer and local-minimum risk is higher.
• W.SOL.INIT_LARGE_ERROR — a phase terminal where the init error exceeds 20 % of the solved voltage magnitude. The start was a poor approximation.
• I.SOL.INIT_NEUTRAL_NONZERO — a neutral terminal with vm_init > 0. Neutral start values should be zero; a non-zero value indicates an initialisation inconsistency.

To compare start and solved voltages manually:

init  = result["initialisation"]
buses = result["bus"]
for (bid, t_dict) in init
    for (t, ivals) in t_dict
        vm_s = buses[bid][t]["vm"]
        vm_i = ivals["vm_init"]
        vm_s > 0 && println("$bid.$t  ratio=$(round(vm_i/vm_s, digits=2))")
    end
end

Coordinate spaces and sign conventions

All phase-to-neutral voltage differences use the solved neutral voltage (explicit JuMP variable), not a forced-zero assumption. This is the correct reference for 4-wire networks where the neutral is not perfectly grounded.

Per-unit scaling

When solve_opf is called with per_unit=true the result is automatically converted back to SI before being returned. The caller always receives SI units regardless of the internal solver representation.