IscAnalysisAF

Field Values

IscAnalysisAF Field Values

Type

Field Name

Description

Integer

IEEEStandard

Standard according to IEEE-1584 for the arc flash calculation used:

  • 0 = 2002 standard

  • 1 = 2018 standard

Float

BoundaryEnergyJcm2

Boundary energy defined at the standard level for a 2nd degree burn (defaults to 5 J/cm2).

Float

ReducedFaultCurrentPC

Reduction of fault current for more conservative arc flash calculation (default to 15%).

Integer

ProtPlotFault

Whether it should plot at fault location or by current:

  • 1 = plot overcurrent at busbar

  • 2 = plot overcurrent for given current

Integer

ProtFaultBusbar

The busbar to fault.

Float

ProtFaultCurrentA

Fault current in Amps.

Float

FaultTime

Fault time in seconds.

Float

FaultResistance

Fault resistance in per unit.

Float

FaultReactance

Fault reactance in per unit.

Boolean

FaultFlatStart

If True, apply flat start voltages before calculating fault.

Integer

UseSaturatedImpedances

SM saturation representation:

  • 0 = None

  • 1 = G74

  • 2 = Always

Integer

AssumeAVRAction

Assume generator impedances decay to transient rather than steady state values:

  • 0 = None

  • 1 = Decay to Xd

Integer

SMSaliency

SM saliency representation:

  • 0 = As given

  • 1 = Xq = Xd

Integer

XRCalcMethod

X/R ratio is calculation method:

  • 0 = DC decay (single exponential)

  • 1 = Driving point impedance

Integer

XRSMEnhanced

Enhanced modelling of synchronous machine DC decay:

  • 0 = Not in use

  • 1 = In use

Boolean

FaultUse2ndHarmonic

If True, use 2nd Harmonic in Peak Results.

Integer

NFPAStandard

NFPA Standard:

  • 0 = 2000

  • 1 = 2004

  • 2 = 2009

  • 3 = 2012

  • 4 = User-Defined

List[Float]

NFPAUserDefined

List of user-defined PPE incident energy levels in (cal/cm^2).

Integer

ProtCalculateOpTime

How the analysis obtains the clearing time:

  • 0 = Calculate the clearing time (requires protection devices)

  • 1 = Specify the clearing time (requires a time)

Float

ProtSetOpTimeS

Fault clearing time in seconds.

Float

ProtSetReducedOpTimeS

Fault clearing time for reduced arc flash current in seconds.

Boolean

LimitMaximumOpTime

If True, limit the maximum fault clearing time, to that set.

Float

MaximumOpTimeS

Maximum fault clearing time in seconds.

List[Integer]

ProtPlotOCDevices

Overcurrent devices to plot.

IscAnalysisAF Class

class ipsa.IscAnalysisAF

Analysis class for the ArcFlash analysis.

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

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

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

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

Note, when setting ProPlotOCDevices, UIDs which do not correspond to protection containers or protection devices will be ignored.

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

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