IscAnalysisFL

Field Values

IscAnalysisFL Field Values

Type

Field Name

Description

Integer

FaultEngine

Sets the fault level engine to either the standard Ipsa method or the IEC60909 method. Should be one of:

  • 0 = Standard Ipsa method

  • 1 = IEC60909 method

Integer

FaultStudyType

Specifies the type of fault study. Should be one of:

  • FaultAllBusbars

  • FaultSelectedBusbars

  • FaultSingleBusbar

  • FaultLine

  • FaultTransformer

  • FaultWaveformBus

  • FaultWaveformBranch

  • FaultBreakerDuty

  • FaultMotorStart

Float

FaultTime

Time of fault in seconds.

Float

FaultResistance

Fault resistance in per unit on the system base.

Float

FaultReactance

Fault reactance in per unit on the system base.

Integer

FaultEngineType

Type of fault to be applied. Should be one of:

  • LineGround

  • LineLine

  • LineLineGround

  • LineLineLine

Integer

FaultEngineResultType

Type of fault result obtained. Should be one of:

  • SymRMS

  • AsymPeak

  • AsymRMS

  • BusWave : Note, Plot waveform is currently not supported from PyIPSA

  • BranchWave : Note, Plot waveform is currently not supported from PyIPSA

Integer

MaxFaultIterations

Maximum number of iterations to run the fault level.

Boolean

FaultFlatStart

Sets voltages at 1 p.u. before calculating fault levels, returns True if successful.

Integer

UseSaturatedImpedances

Uses generator saturated impedances in fault calculation.

Integer

AssumeAVRAction

Assumes generator impedances decay to transient rather than steady state values.

Integer

SMSaliency

Sets the synchronous machine salience to either the given value or (Xq = Xd). Should be one of:

  • 0 = As given: The direct axis and quadrature axis parameters entered for each generator will be used in the fault calculations.

  • 1 = (Xq = Xd): Steady-state quadrature axis parameters are assumed to be the same as direct axis parameters for all generators.

Integer

XRCalcMethod

Sets the X/R calculation method to either DC decay or Driving Point. Should be one of:

  • 0 = DC decay: The DC component decays with time, following a single exponential curve, and the X/R ratio will change. (Note: Under this option the calculation takes the DC component at the time of fault, and the DC component at the specified time after the fault, and then fits a single exponential to these values.)

  • 1 = Driving point: The X/R ratio is calculated at the time the fault occurs and does not change.

Integer

XRSMEnhanced

Set to 0 to use the Ipsa 2.3.2 method of calculating the DC decay. Set to 1 to use the Ipsa 2.4.2 enhanced method of calculating the DC decay.

Boolean

FaultUse2ndHarmonic

If selected then second harmonic fault level will be included in any peak fault calculation for line-to-line faults.

Integer

SingleBusToFault

Busbar UID to apply fault on.

Integer

BranchToFault

Branch UID to apply fault on.

Float

DistanceAlongBranch

Distance along branch to apply fault on. This is a per unit value with zero representing the “From” end of the branch and 1.0 representing the “To” end of the branch.

Boolean

FaultUseCDPs

Switch to decide whether the fault engine will include the impact of converter driven plants.

Integer

FaultCDPStudyMode

The calculation method for CDPs. Currently only the simple method (0) works for PyIPSA. To input the data for the advanced method (1) you would need to open the IPSA UI.

Integer

FaultCDPInterpMethod

Chooses the interpolation method for the universal machines that represent the CDPs (in the advanced method):

  • 0 = Machine specific settings

  • 1 = Globally use linear interpolation

  • 2 = Globally use cubic interpolation

Boolean

ShowCDPWarnings

If True the warnings of the CDP engine will be shown.

Boolean

FaultCDPDefined

If True use defined fault with CDPs in the fault engine.

Boolean

FaultCDPDefaultRatedI

If True use the default rating of universal machine.

Integer

FaultCDPNumIterations

Specifies the number of iterations for CDP-G74 voltages.

Float

IEC909DefaultPhaseAngle

Specifies the default synchronous machine power factor. IEC909UseDefaultPF should be set to True to use this value.

Integer

IEC909Method

Sets the method used to determine the X/R ratio as defined by:

  • 1 = IEC 60909 Method A

  • 2 = IEC 60909 Method B

  • 3 = IEC 60909 Method C

Boolean

IEC909IgnoreImpedanceCorrection

If set to True then IEC60909 impedance correction factors will not be applied to generators and power station transformers.

Integer

IEC909VoltageCorrectionFactor

One of the following IEC60909 voltage level based correction factors to be applied to the pre-fault voltage at the faulted busbar:

  • 1 = Ignore

  • 2 = Cmax (LV + 6%)

  • 3 = Cmax (LV + 10%)

  • 4 = Cmin

Boolean

IEC909UseDefaultPF

Set to True to use the synchronous machine default power factor.

Boolean

IEC909NearTo

Setting to True causes all faults as assumed to be “Near-To”. If it is not selected then the analysis will neglect any decay effects.

Integer

IEC909TFRatingIndex

Identifies which rating set to use for transformers.

Float

FaultPlotMaxTime

Fault plot max time in seconds for waveform plots.

Boolean

FaultPlotinCycles

Fault plot time in cycles for waveform plots, returns True if successful.

Boolean

FaultPlotinkA

Fault plot current in kA for waveform plots, returns True if successful.

  • 1 = not selected

  • 2 = selected

Boolean

FaultPlotRed

Fault plot red phase for waveform plots, returns True if successful.

Boolean

FaultPlotYellow

Fault plot yellow phase for waveform plots, returns True if successful.

Boolean

FaultPlotBlue

Fault plot blue phase for waveform plots, returns True if successful.

Boolean

FaultPlotDC

Fault plot DC component for waveform plots, returns True if successful.

Boolean

FaultPlotRMS

Fault plot RMS component for waveform plots, returns True if successful.

Boolean

FaultPlot2Harm

Fault plot 2nd harmonic component for waveform plots, returns True if successful.

Boolean

FaultPlotMaxAsymmRed

Fault plot maximum asymmetry in red phase for waveform plots, returns True if successful.

Integer

MotorToStart

The motor calculation is started for the motor UID.

Boolean

FaultUseMotorLoad

Set to True to consider the equivalent motor parameters from the static loads.

Boolean

FaultTransformerTap

Set to True to use the minimum transformer impedance (currently using max tap position).

List[Float]

MotorLoadVoltageskV

The nominal voltages in kV from the tabulated motor fault data for the entire network.

List[Float]

MotorLoadStatorRPU

The stator resistance values in PU from the tabulated motor fault data for the entire network.

List[Float]

MotorLoadStatorXPU

The stator reactance values in PU from the tabulated motor fault data for the entire network.

List[Float]

MotorLoadMagXPU

The magnetising reactance values in PU from the tabulated motor fault data for the entire network.

List[Float]

MotorLoadRotorInnerRPU

The rotor (inner) resistances in PU from the tabulated motor fault data for the entire network.

List[Float]

MotorLoadRotorInnerXPU

The rotor (inner) reactances in PU from the tabulated motor fault data for the entire network.

List[Float]

MotorLoadRotorOuterRPU

The rotor (outer) resistances in PU from the tabulated motor fault data for the entire network.

List[Float]

MotorLoadRotorOuterXPU

The rotor (outer) reactances in PU from the tabulated motor fault data for the entire network.

IscAnalysisFL Class

class ipsa.IscAnalysisFL

Analysis class for the fault level analysis. Motor start analysis options are provided under the fault level analysis class.

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

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 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

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

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

SetBusesToFault(nUIDs: List[int]) → None

Specifies which busbars will be faulted as defined by the list of busbar UIDs. Only applicable when the FaultStudyType is set to FaultSelectedBusbars.

Parameters:

nUIDs (list(int)) – The list of busbar UIDs which will be faulted.

GetBusesToFault() → List[int]

Returns a list of busbar UIDs representing the busbars that have been selected to be faulted.

Returns:

The list of faulted busbars.

Return type:

list(int)