Circuit Properties |
[This is preliminary documentation and is subject to change.]
The Circuit type exposes the following members.
| Name | Description | |
|---|---|---|
| AllBusDistances |
Returns distance from each bus to parent EnergyMeter. Corresponds to sequence in AllBusNames.
| |
| AllBusNames |
Array of strings containing names of all buses in circuit (see AllNodeNames).
| |
| AllBusVmag |
Array of magnitudes (doubles) of voltages at all buses
| |
| AllBusVmagPu |
Double Array of all bus voltages (each node) magnitudes in Per unit
| |
| AllBusVolts |
Complex array of all bus, node voltages from most recent solution
| |
| AllElementLosses |
Array of total losses (complex) in each circuit element
| |
| AllElementNames |
Array of strings containing Full Name of all elements.
| |
| AllNodeDistances |
Returns an array of distances from parent EnergyMeter for each Node. Corresponds to AllBusVMag sequence.
| |
| AllNodeNames |
Array of strings containing full name of each node in system in same order as returned by AllBusVolts, etc.
| |
| LineLosses |
Complex total line losses in the circuit
| |
| Losses |
Total losses in active circuit, complex number (two-element array of double).
| |
| Name |
Name of the active circuit.
| |
| NumBuses |
Total number of Buses in the circuit.
| |
| NumCktElements |
Number of CktElements in the circuit.
| |
| NumNodes |
Total number of nodes in the circuit.
| |
| ParentPDElement |
Sets Parent PD element, if any, to be the active circuit element and returns index>0; Returns 0 if it fails or not applicable.
| |
| SubstationLosses |
Complex losses in all transformers designated to substations.
| |
| SystemY |
System Y matrix (after a solution has been performed).
This is deprecated as it returns a dense matrix. Only use it for small systems.
For large scale systems, prefer YMatrix.GetCompressedYMatrix.
| |
| TotalPower |
Total power, kW delivered to the circuit
| |
| YCurrents |
Array of doubles containing complex injection currents for the present solution. Is is the "I" vector of I=YV
| |
| YNodeOrder |
Array of strings containing the names of the nodes in the same order as the Y matrix
| |
| YNodeVarray |
Complex array of actual node voltages in same order as SystemY matrix.
|