dss.IReactors

`dss.IReactors`#

Module Contents#

Classes#

IReactors

Reactor objects

API#

class dss.IReactors.IReactors(api_util)#

Bases: dss._cffi_api_util.Iterable

Reactor objects

(API Extension)

property AllNames: List[str]#: Array of all names of this object type

property Bus1: str#: Name of first bus. Bus2 property will default to this bus, node 0, unless previously specified. Only Bus1 need be specified for a Yg shunt reactor.

property Bus2: str#: Name of 2nd bus. Defaults to all phases connected to first bus, node 0, (Shunt Wye Connection) except when Bus2 is specifically defined. Not necessary to specify for delta (LL) connection

property Count: int#: Number of objects of this type

property First: int#: Sets the first object of this type active. Returns 0 if none.

property IsDelta: bool#: Delta connection or wye?

property LCurve: str#: Name of XYCurve object, previously defined, describing per-unit variation of phase inductance, L=X/w, vs. frequency. Applies to reactance specified by X, LmH, Z, or kvar property. L generally decreases somewhat with frequency above the base frequency, approaching a limit at a few kHz.

property LmH: float#: Inductance, mH. Alternate way to define the reactance, X, property.

property Name: str#: Gets the current name or sets the active object of this type by name

property Next: int#: Sets next object of this type active. Returns 0 if no more.

property Parallel: bool#: Indicates whether Rmatrix and Xmatrix are to be considered in parallel.

property Phases: int#: Number of phases.

property R: float#: Resistance (in series with reactance), each phase, ohms. This property applies to REACTOR specified by either kvar or X. See also help on Z.

property RCurve: str#: Name of XYCurve object, previously defined, describing per-unit variation of phase resistance, R, vs. frequency. Applies to resistance specified by R or Z property. If actual values are not known, R often increases by approximately the square root of frequency.

property Rmatrix: dss._types.Float64Array#: Resistance matrix, ohms at base frequency. Order of the matrix is the number of phases. Mutually exclusive to specifying parameters by kvar or X.

property Rp: float#: Resistance in parallel with R and X (the entire branch). Assumed infinite if not specified.

property SpecType: int#: How the reactor data was provided: 1=kvar, 2=R+jX, 3=R and X matrices, 4=sym components. Depending on this value, only some properties are filled or make sense in the context.

property X: float#: Reactance, each phase, ohms at base frequency. See also help on Z and LmH properties.

property Xmatrix: dss._types.Float64Array#: Reactance matrix, ohms at base frequency. Order of the matrix is the number of phases. Mutually exclusive to specifying parameters by kvar or X.

property Z: dss._types.Float64ArrayOrSimpleComplex#: Alternative way of defining R and X properties. Enter a 2-element array representing R +jX in ohms.

property Z0: dss._types.Float64ArrayOrSimpleComplex#

Zero-sequence impedance, ohms, as a 2-element array representing a complex number.

Used to define the impedance matrix of the REACTOR if Z1 is also specified.

Note: Z0 defaults to Z1 if it is not specifically defined.

property Z1: dss._types.Float64ArrayOrSimpleComplex#

Positive-sequence impedance, ohms, as a 2-element array representing a complex number.

If defined, Z1, Z2, and Z0 are used to define the impedance matrix of the REACTOR.

Z1 MUST BE DEFINED TO USE THIS OPTION FOR DEFINING THE MATRIX.

Side Effect: Sets Z2 and Z0 to same values unless they were previously defined.

property Z2: dss._types.Float64ArrayOrSimpleComplex#

Negative-sequence impedance, ohms, as a 2-element array representing a complex number.

Used to define the impedance matrix of the REACTOR if Z1 is also specified.

Note: Z2 defaults to Z1 if it is not specifically defined. If Z2 is not equal to Z1, the impedance matrix is asymmetrical.

__init__(api_util)#

__iter__() → Iterator[dss._cffi_api_util.Iterable]#

Get an iterator of the object collection.

Note that OpenDSS, via the classic APIs, only allow a single object of a specific type to be activated. That is, you cannot use references of distinct objects and interact with both at the same time, or keep a reference to use later. You need to reactivate the target object or ensure it is the active one.

For an alternative, consider using our AltDSS-Python package.

(API Extension)

__len__() → int#

property idx: int#

Gets the current index or sets the active object of this type by index

While the official API included this for some classes, this is an API Extension for:

Capacitors
CapControls
ISources
LineCodes
Lines
LoadShapes
Meters
Monitors
RegControls
Sensors
SwtControls
Transformers
Vsources
XYCurves