IscEquivalentRadial

The IscEquivalentRadial class provides access to an IPSA equivalent radial (generated by network reduction), to set and get data values and to retrieve load flow results.

Field Values

**IscEquivalentRadial Field Values**
Type	Field Name	Description
Integer	FromUID	Gets the unique ID for busbar.
String	BusName	Gets the busbar name.
String	Name	Gets the equivalent radial name.
Integer	Status	Status: 0 = Switched in -1 = Switched out
Float	RealPowerMW	Gets and sets the active power output.
Float	ReactivePowerMVAr	Gets and sets the reactive power output.
Float	ResistancePU	Gets the resistance from the shunt equivalent in per unit.
Float	ReactancePU	Gets the reactance from the shunt equivalent in per unit.
Float	ExtResistancePU	Gets the resistance in per unit from the diagonal shunt component generated in the Extended Ward method.
Float	ExtReactancePU	Gets the reactance in per unit from the diagonal shunt component generated in the Extended Ward method.
Float	TargetVoltagePU	Gets and sets the target voltage in per unit.
Boolean	IncludesReducedSlack	Gets whether the equivalent radial includes a reduced slack busbar.
List[Int]	CatalogTypes	Gets a list of the type of objects in the catalog (generator, load, motor).
List[Int]	CatalogTechs	Gets a list of the technology for the objects in the catalog.
List[Int]	CatalogStagings	Gets a list of the development stage for the objects in the catalog.
List[Float]	CatalogPowersMW	Gets a list of the real power in MW for the objects in the catalog.
String	Comment	Gets and sets the comments.

IscEquivalentRadial Class

class ipsa.IscEquivalentRadial

Provides access to an IPSA equivalent radial.

SetName(strName: str) → bool

Sets the name as a string.

Parameters:: strName (str) – The selected string name.
Returns:: True if successful.
Return type:: bool

GetIValue(nFieldIndex: int) → int

Returns an integer value for the enumerated field.

Parameters:: nFieldIndex (int) – The field index.
Returns:: The integer value.
Return type:: int

GetDValue(nFieldIndex: int) → float

Returns a double value for the enumerated field.

Parameters:: nFieldIndex (int) – The field index.
Returns:: The double value.
Return type:: float

GetSValue(nFieldIndex: int) → str

Returns a string value for the enumerated field.

Parameters:: nFieldIndex (int) – The field index.
Returns:: The string value.
Return type:: str

GetBValue(nFieldIndex: int) → bool

Returns a boolean value for the enumerated field.

Parameters:: nFieldIndex (int) – The field index.
Returns:: The boolean value.
Return type:: bool

GetListIValue(nFieldIndex: int) → List[int]

Returns a list of integer values for the enumerated field.

Parameters:: nFieldIndex (int) – The field index.
Returns:: The list of values.
Return type:: list[int]

GetListDValue(nFieldIndex: int) → List[float]

Returns a list of double values for the enumerated field.

Parameters:: nFieldIndex (int) – The field index.
Returns:: The list of values.
Return type:: list[float]

SetIValue(nFieldIndex: int, nValue: int) → bool

Sets the value for the enumerated field from an integer.

Parameters:

nFieldIndex (int) – The field index.
nValue (int) – The given integer value.

Returns:

True if successful.

Return type:

bool

SetDValue(nFieldIndex: int, dValue: float) → bool

Sets the value for the enumerated field from a double.

Parameters:

nFieldIndex (int) – The field index.
dValue (float) – The given double value.

Returns:

True if successful.

Return type:

bool

SetSValue(nFieldIndex: int, strValue: int) → bool

Sets the value for the enumerated field from a string.

Parameters:

nFieldIndex (int) – The field index.
strValue (str) – The given string value.

Returns:

True if successful.

Return type:

bool

SetBValue(nFieldIndex: int, bValue: bool) → bool

Sets the value for the enumerated field from boolean.

Parameters:

nFieldIndex (int) – The field index.
bValue (bool) – The given boolean value.

Returns:

True if successful.

Return type:

bool

SetListIValue(nFieldIndex: int, lIValue: List[int]) → bool

Sets the value for the enumerated field from a list of integers.

Parameters:

nFieldIndex (int) – The field index.
lIValue (list[int]) – The given list of values.

Returns:

True if successful.

Return type:

bool

SetListDValue(nFieldIndex: int, lDValue: List[float]) → bool

Sets the value for the enumerated field from a list of doubles.

Parameters:

nFieldIndex (int) – The field index.
lDValue (list[float]) – The given list of double values.

Returns:

True if successful.

Return type:

bool

GetVoltageMagnitudePU() → float

Returns the equivalent radial voltage magnitude in per unit.

Returns:: The equivalent radial voltage magnitude in per unit.
Return type:: float

GetVoltageAngleRad() → float

Returns the voltage angle in radians.

Returns:: The voltage angle.
Return type:: float

GetVoltageAngleDeg() → float

Returns the voltage angle in degrees.

Returns:: The voltage angle.
Return type:: float

GetInjectionRealPowerMW() → float

Returns the current injection real power output in MW.

Returns:: The current injection real power output in MW.
Return type:: float

GetInjectionReactivePowerMVAr() → float

Returns the current injection reactive power output in MVAr.

Returns:: The current injection reactive power output in MVAr.
Return type:: float

GetInjectionRealPowerkW() → float

Returns the current injection real power output in kW.

Returns:: The current injection real power output in kW.
Return type:: float

GetInjectionReactivePowerkVAr() → float

Returns the current injection reactive power output in kVAr.

Returns:: The current injection reactive power output in kVAr.
Return type:: float

GetShuntRealPowerMW() → float

Returns the real shunt power in MW.

Returns:: The real shunt power in MW.
Return type:: float

GetShuntReactivePowerMVAr() → float

Returns the reactive shunt power in MVAr.

Returns:: The reactive shunt power in MVAr.
Return type:: float

GetShuntRealPowerkW() → float

Returns the real shunt power in kW.

Returns:: The real shunt power in kW.
Return type:: float

GetShuntReactivePowerkVAr() → float

Returns the reactive shunt power in kVAr.

Returns:: The reactive shunt power in kVAr.
Return type:: float

GetFictBranchRealPowerMW() → float

Returns the real power injection from the fictitious branch component of the Extended Ward in MW.

Returns:: The real power injection from the fictitious branch component of the Extended Ward in MW.
Return type:: float

GetFictBranchReactivePowerMVAr() → float

Returns the reactive power injection from the fictitious branch component of the Extended Ward in MVAr.

Returns:: The reactive power injection from the fictitious branch component of the Extended Ward in MVAr.
Return type:: float

GetFictBranchRealPowerkW() → float

Returns the real power injection from the fictitious branch component of the Extended Ward in kW.

Returns:: The real power injection from the fictitious branch component of the Extended Ward in kW.
Return type:: float

GetFictBranchReactivePowerkVAr() → float

Returns the reactive power injection from the fictitious branch component of the Extended Ward in kVAr.

Returns:: The reactive power injection from the fictitious branch component of the Extended Ward in kVAr.
Return type:: float

GetTotalRealPowerMW() → float

Returns the total real power output from the equivalent radial in MW.

Returns:: The total real power output from the equivalent radial in MW.
Return type:: float

GetTotalReactivePowerMVAr() → float

Returns the total reactive power output from the equivalent radial in MVAr.

Returns:: The total reactive power output from the equivalent radial in MVAr.
Return type:: float

GetTotalRealPowerkW() → float

Returns the total real power output from the equivalent radial in kW.

Returns:: The total real power output from the equivalent radial in kW.
Return type:: float

GetTotalReactivePowerkVAr() → float

Returns the total reactive power output from the equivalent radial in kVAr.

Returns:: The total reactive power output from the equivalent radial in kVAr.
Return type:: float

GetTotalApparentPowerMVA() → float

Returns the total apparent power output from equivalent radial in MVA.

Returns:: The total apparent power output from equivalent radial in MVA.
Return type:: float

GetTotalApparentPowerkVA() → float

Returns the total apparent power output from equivalent radial in kVA.

Returns:: The total apparent power output from equivalent radial in kVA.
Return type:: float