Distribution power flow#

class DssCircuit(objects=<factory>, settings=<factory>, solve_options=<factory>, ignored_reports=<factory>, files=<factory>, active_key=None, electrical_edit_order=0, solve_order=None)#

Represent one OpenDSS snapshot after command and include processing.

get(class_name, name)#

Return one object by its case-insensitive identity.

by_class(class_name)#

Return enabled objects in deterministic insertion order.

class PhaseControlAction(control_class, control_name, action, old_state, new_state)#

Describe one static-control action in execution order.

class PhaseSolvedCase(bus_indexes, bus_names, node_numbers, node_voltage, element_classes, element_names, terminal_offsets, terminal_currents, terminal_powers, element_losses, electrical_iterations, control_passes, control_actions, tap_positions, capacitor_states, converged, controls_settled, maximum_voltage_change, exit_reason, control_stop_reason, findings=())#

Store phase-node, element, convergence, and control results.

to_dict()#

Return the complete solution as JSON-compatible data.

Returns:

A versioned mapping with node, element, and control results.

class PhaseSolveOptions(max_iterations=100, tolerance=1e-08, damping=1.0, max_control_iterations=10, controls=True)#

Configure phase electrical and static-control iterations.

max_iterations#

Electrical iteration limit.

Type:

int

tolerance#

Maximum normalized Newton step.

Type:

float

damping#

Maximum Newton line-search step length.

Type:

float

max_control_iterations#

Static-control pass limit.

Type:

int

controls#

Enable static controls.

Type:

bool

to_ctypes()#

Validate and convert the options to the C ABI record.