IscAnalysisNR

Field Values

IscAnalysisNR Field Values

Type

Field Name

Description

Integer

ReductionAlgorithm

Network reduction algorithm option:

  • 0 = Ward equivalence

  • 1 = Extended ward equivalence

Integer

BoundaryUID

UID of the boundary that defines the reduction.

Boolean

UseImpedanceCutOff

If True, use the branch impedence cut off for reduction.

Float

ImpedanceCutOffPU

The maximum branch impedence allowed in per unit.

Integer

BoundaryRetentionMode

The mode for managing the boundary elements:

  • 0 = Retain boundary elements

  • 1 = Remove radial elements

Integer

ACDCConversionMode

The mode of conversion for the AC/DC interface:

  • 0 = Largest power value

  • 1 = AC-DC radials

Integer

YBusMatrixDecompositionRoutine

The matrix decomposition method used for the reduction:

  • 0 = LU (most common)

  • 1 = QR (accurate, but slow)

  • 2 = BiCGSTAB (iterative solver)

Boolean

EquivalentInjectionCutoff

If True, filter out low MVA equivalent injections.

Float

EquivalentInjCutoffMVA

The minimum equivalent injection retained power in MVA.

Boolean

EquivalentBranchZCutoff

If True, filter out high impedence equivalent branches.

Float

EquivalentBrZCutoffPU

The maximum equivalent branch impedence in per unit.

Integer

DrawEquivalents:

Logic for which equivalents are drawn:

  • 0 = Don’t draw the equivalents

  • 1 = Draw the equivalent branches

  • 2 = Draw the equivalent branches and radials

Boolean

DeleteBoundaryPostReduction

If True, delete the used boundary after the reduction.

Boolean

ExportNetworkPreReduction

If True, export the existing network before the reduction.

Integer

CatalogMode

The mode of the catalog distribution:

  • 0 = Do not expose the catalog

  • 1 = Distribute catalog generation equally

  • 2 = Weight catalog items by equivalent MW

IscAnalysisNR Class

class ipsa.IscAnalysisNR

Analysis class for Network Reduction.

GetIValue(nFieldIndex: int) → int

Returns an integer value for the enumerated field.

Parameters:

nFieldIndex (int) – The given enumerated field.

Returns:

The integer value for the field.

Return type:

int

GetDValue(nFieldIndex: int) → float

Returns a float value for the enumerated field.

Parameters:

nFieldIndex (int) – The given enumerated field.

Returns:

The float value for the field.

Return type:

float

GetSValue(nFieldIndex: int) → str

Returns a string value for the enumerated field.

Parameters:

nFieldIndex (int) – The given enumerated field.

Returns:

The string value for the field.

Return type:

str

GetBValue(nFieldIndex: int) → bool

Returns a boolean value for the enumerated field.

Parameters:

nFieldIndex (int) – The given enumerated field.

Returns:

The boolean value for the field.

Return type:

bool

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

Sets the integer value for the enumerated field.

Parameters:

  • nFieldIndex (int) – The given enumerated field.

  • nValue (int) – The integer value that will be set.

Returns:

True if successful.

Return type:

bool

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

Sets the float value for the enumerated field.

Parameters:

  • nFieldIndex (int) – The given enumerated field.

  • dValue (float) – The float value that will be set.

Returns:

True if successful.

Return type:

bool

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

Sets the string value for the enumerated field.

Parameters:

  • nFieldIndex (int) – The given enumerated field.

  • strValue (str) – The string value that will be set.

Returns:

True if successful.

Return type:

bool

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

Sets the boolean value for the enumerated field.

Parameters:

  • nFieldIndex (int) – The given enumerated field.

  • bValue (bool) – The boolean value that will be set.

Returns:

True if successful.

Return type:

bool

GetFieldType(nFieldIndex: int) → str

Returns the field type as a string for the enumerated field.

Parameters:

nFieldIndex (int) – The given enumerated field.

Returns:

The field type.

Return type:

str

GetFieldName(nFieldIndex: int) → str

Returns the field name as a string for the enumerated field.

Parameters:

nFieldIndex (int) – The given enumerated field.

Returns:

The field name.

Return type:

str