Click or drag to resize

Reactors Class

[This is preliminary documentation and is subject to change.]

[Missing <summary> documentation for "T:dss_sharp.Reactors"]

Inheritance Hierarchy

Namespace:  dss_sharp
Assembly:  dss_sharp (in dss_sharp.dll) Version: 1.0.0
Syntax
public class Reactors : ContextState

The Reactors type exposes the following members.

Constructors
  NameDescription
Public methodReactors
Initializes a new instance of the Reactors class
Top
Properties
  NameDescription
Public propertyAllNames
Array of strings with all Reactor names in the circuit.
Public propertyBus1
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.
Public propertyBus2
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
Public propertyCount
Number of Reactor objects in active circuit.
Public propertyFirst
Sets the first Reactor active. Returns 0 if no more.
Public propertyidx
Get/set active Reactor by index; index is 1-based: 1..count
Public propertyIsDelta
Delta connection or wye?
Public propertykV
For 2, 3-phase, kV phase-phase. Otherwise specify actual coil rating.
Public propertykvar
Total kvar, all phases. Evenly divided among phases. Only determines X. Specify R separately
Public propertyLCurve
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.
Public propertyLmH
Inductance, mH. Alternate way to define the reactance, X, property.
Public propertyName
Sets the active Reactor by Name.
Public propertyNext
Sets the next Reactor active. Returns 0 if no more.
Public propertyParallel
Indicates whether Rmatrix and Xmatrix are to be considered in parallel.
Public propertyPhases
Number of phases.
Public propertyR
Resistance (in series with reactance), each phase, ohms. This property applies to REACTOR specified by either kvar or X. See also help on Z.
Public propertyRCurve
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.
Public propertyRmatrix
Resistance matrix, ohms at base frequency. Order of the matrix is the number of phases. Mutually exclusive to specifying parameters by kvar or X.
Public propertyRp
Resistance in parallel with R and X (the entire branch). Assumed infinite if not specified.
Public propertySpecType
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.
Public propertyX
Reactance, each phase, ohms at base frequency. See also help on Z and LmH properties.
Public propertyXmatrix
Reactance matrix, ohms at base frequency. Order of the matrix is the number of phases. Mutually exclusive to specifying parameters by kvar or X.
Public propertyZ
Alternative way of defining R and X properties. Enter a 2-element array representing R +jX in ohms.
Public propertyZ0
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.
Public propertyZ1
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.
Public propertyZ2
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.
Top
Methods
  NameDescription
Protected methodCheckForError (Inherited from ContextState.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetContextHandle
Returns the low-level handle of the current OpenDSS/DSS-CAPI instance.
(Inherited from ContextState.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodToString (Inherited from Object.)
Top
Fields
  NameDescription
Protected fieldapiutil (Inherited from ContextState.)
Protected fieldctx (Inherited from ContextState.)
Top
See Also