dss.IYMatrix

Module Contents

Classes

IYMatrix

YMatrix provides access to some lower-level solution aspects.

API

class dss.IYMatrix.IYMatrix(api_util, prefer_lists=False)

Bases: dss._cffi_api_util.Base

YMatrix provides access to some lower-level solution aspects.

Part of this class is ported from the original OpenDSSDirect.DLL back in 2017, but part is new. Since this is not exposed in the official COM API, it is marked as an extension.

(API Extension)

AddInAuxCurrents(SType)

BuildYMatrixD(BuildOps: int, AllocateVI: bool)

CheckConvergence() → bool

GetCompressedYMatrix(factor: bool = True) → Tuple[dss._types.ComplexArray, dss._types.Int32Array, dss._types.Int32Array]

Return as (data, indices, indptr) that can fed into scipy.sparse.csc_matrix

GetIPointer()

Get access to the internal Current pointer

GetPCInjCurr()

GetSourceInjCurrents()

GetVPointer()

Get access to the internal Voltage pointer

property Iteration: int

property LoadsNeedUpdating: bool

SetGeneratordQdV()

property SolutionInitialized: bool

SolveSystem(NodeV=None) → int

property SolverOptions: int

Sparse solver options. See the enumeration SparseSolverOptions

property SystemYChanged: bool

property UseAuxCurrents: bool

ZeroInjCurr()

__init__(api_util, prefer_lists=False)

getI() → List[float]

Get the data from the internal Current pointer

getV() → List[float]

Get the data from the internal Voltage pointer

getYSparse

None