IscIndMachine

The IscIndMachine class provides access to an IPSA induction machine, to set and get data values and to retrieve load flow and fault level results.

Field Values

IscIndMachine Field Values

Type

Field Name

Description

Integer

FromUID

Gets the unique ID for busbar.

String

BusName

Gets the busbar name.

String

Name

Gets the induction machine name.

Integer

Status

Status:

  • 0 = Switched in

  • 1 = Switched in, but can be switched out during transient studies

  • -1 = Switched out, but can be switched in during transient studies

Float

MechPowerMW

Mechanical power output of motor. Use negative values for induction generators.

Float

SlipPC

Slip in %.

Float

MagnetXPU

Magnetising reactance.

Float

StatorRPU

Stator resistance.

Float

StatorXPU

Stator reactance.

Integer

Model

The motor model used:

  • 0 = Running - standstill

  • 1 = Inner - outer

  • 2 = Not used

  • 3 = Not used

  • 4 = Running - standstill DFIG with slip control

  • 5 = Inner - outer DFIG with slip control

  • 6 = Running - standstill DFIG with slip and power factor control

  • 7 = Inner - outer DFIG with slip and power factor control

Float

RotorRPU

Inner cage or running rotor resistance.

Float

RotorXPU

Inner cage or running rotor reactance.

Float

StandRPU

Outer cage or standstill rotor resistance.

Float

StartXPU

Outer cage or standstill rotor reactance.

Float

TSlipB

Load torque-speed coefficient B.

Float

TSlipC

Load torque-speed squared coefficient C.

Float

InertiaSec

Inertia constant in kWs / kVA.

Float

DropoffVPU

If the voltage falls below this value disconnection will begin.

Float

DropPickUpDelaySec

The time taken to disconnect the machine.

Float

LockTimeSec

If a machine is disconnected for this length of time it will not be reconnected.

Float

UnderspeedPU

Under speed setting in per unit.

Float

OverspeedPU

Overspeed setting in per unit.

Float

PickUpTimeSec

The time taken to reconnect the machine.

Float

PickUpVoltagePU

If the voltage in per unit rises above this value reconnection will begin.

Float

SwitchOut1Sec

Time for the first switch-out operation. If the machine is already switched out, leave this entry blank.

Float

SwitchIn1Sec

Time for first switch-in.

Float

SwitchOut2Sec

Time for second switch-out.

Float

SwitchIn2Sec

Time for second switch-in.

Integer

MaxSwitchOp

Maximum number of automatic switching operations before the machine is locked out.

Integer

DFFeedBusbar

Feed busbar UID for doubly-fed model.

Float

DFPowerFactor

Power factor for doubly-fed model.

Boolean

DFExportQ

If True then reactive power is exported by the machine, else it is imported.

Integer

DFRotorReferenceFrame

Rotor reference frame, either:

  • 0 = Direct-Quadrature aligned to stator voltage

  • 1 = Real-Imaginary aligned to stator voltage

Integer

DFFaultSwitchMode

How the DFIG behaves when a fault is detected:

  • 0 = Turn off rotor, stator and turbine.

  • 1 = Turn off rotor, switch permanently to induction generator mode.

  • 2 = Turn off rotor, switch to induction generator mode, reset on time.

  • 3 = Turn off rotor, switch to induction generator mode, reset on current.

Float

DFFaultRotorCurrentLimit

When DFIG rotor current exceeds this value the DFIG alters its behaviour as determined by the fault switch mode.

Float

DFFaultCrowbarLimit

The effect of this parameter is determined by the fault switch mode. See the online help manual for details.

Float

DFFaultCrowbarResPU

Crowbar fault resistance (per unit on system base and rotor voltage base).

String

DbType

Gets the database type.

Integer

DbPar

Gets the number of motors in parallel.

Integer

ControlModelType

Gets the Dynamic Model type.

  • 0 = Built in

  • 1 = Plugin

  • 2 = UDM

Float

RatedMW

The rated MW power of the machine. Only used in IEC60909 fault analysis.

Float

RatedMVA

The rated MVA power of the machine. Only used in IEC60909 fault analysis.

Integer

PolePairs

The number of pole pairs of the machine. Only used in IEC60909 fault analysis.

String

ControlPluginID

Gets the control plugin ID.

IscIndMachine Class

class ipsa.IscIndMachine

Provides access to an IPSA induction machine.

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

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

PopulateByDBEntry(strIMachineDataName: str, nParallel: int) → bool

Populates the object data with database information from the first database that was loaded.

Parameters:

  • strIMachineDataName (str) – The name of the induction machine.

  • nParallel (int) – The number of parallel components.

Returns:

True if successful.

Return type:

bool

GetStatorPowerMagnitudeMVA() → float

Returns stator power in MVA.

Returns:

The stator power in MVA.

Return type:

float

GetStatorPowerMagnitudekVA() → float

Returns stator power in kVA.

Returns:

The stator power in kVA.

Return type:

float

GetStatorRealPowerMW() → float

Returns stator power in MW.

Returns:

The stator power in MW.

Return type:

float

GetStatorReactivePowerMVAr() → float

Returns stator power in MVAr.

Returns:

The stator power in MVAr.

Return type:

float

GetStatorRealPowerkW() → float

Returns stator power in kW.

Returns:

The stator power in kW.

Return type:

float

GetStatorReactivePowerkVAr() → float

Returns stator power in kVAr.

Returns:

The stator power in kVAr.

Return type:

float

GetRotorPowerMagnitudeMVA() → float

Returns rotor power in MVA.

Returns:

The rotor power in MVA.

Return type:

float

GetRotorPowerMagnitudekVA() → float

Returns rotor power in kVA.

Returns:

The rotor power in kVA.

Return type:

float

GetRotorRealPowerMW() → float

Returns rotor power in MW.

Returns:

The rotor power in MW.

Return type:

float

GetRotorReactivePowerMVAr() → float

Returns rotor power in MVAr.

Returns:

The rotor power in MVAr.

Return type:

float

GetRotorRealPowerkW() → float

Returns rotor power in kW.

Returns:

The rotor power in kW.

Return type:

float

GetRotorReactivePowerkVAr() → float

Returns rotor power in kVAr.

Returns:

The rotor power in kVAr.

Return type:

float

GetMechanicalRealPowerMW() → float

Returns mechanical shaft power in MW.

Returns:

The mechanical shaft power in MW.

Return type:

float

GetMechanicalRealPowerkW() → float

Returns mechanical shaft power in kW.

Returns:

The mechanical shaft power in kW.

Return type:

float

GetSlipPU() → float

Returns the motor slip in per unit where 0.0 is synchronous speed, -1.0 if stationary.

Returns:

The motor slip in per unit.

Return type:

float

GetSlipPC() → float

Returns the motor slip in percent where 0% is synchronous speed, -100% if stationary.

Returns:

The motor slip in percent.

Return type:

float

GetEfficiencyPC() → float

Returns the motor efficiency in percent.

Returns:

The motor efficiency in percent.

Return type:

float

GetPowerFactor() → float

Returns the operating power factor.

Returns:

The operating power factor.

Return type:

float

GetCurrentkA() → float

Returns the total current in kA.

Returns:

The total current in kA.

Return type:

float

GetCurrentA() → float

Returns the total current in Amps.

Returns:

The total current in Amps.

Return type:

float

GetTorqueMNm() → float

Returns the shaft torque in MNm.

Returns:

The shaft torque in MNm.

Return type:

float

GetTorquekNm() → float

Returns the shaft torque in kNm.

Returns:

The shaft torque in kNm.

Return type:

float

GetFaultRedComponentMVA() → float

Returns the red phase component of fault level in MVA.

Returns:

The red phase component of fault level in MVA.

Return type:

float

GetFaultYellowComponentMVA() → float

Returns the yellow phase component of fault level in MVA.

Returns:

The yellow phase component of fault level in MVA.

Return type:

float

GetFaultBlueComponentMVA() → float

Returns the blue phase component of fault level in MVA.

Returns:

The blue phase component of fault level in MVA.

Return type:

float

GetFaultPositiveComponentMVA() → float

Returns the positive sequence component of fault level in MVA.

Returns:

The positive sequence component of fault level in MVA.

Return type:

float

GetFaultNegativeComponentMVA() → float

Returns the negative sequence component of fault level in MVA.

Returns:

The negative sequence component of fault level in MVA.

Return type:

float

GetFaultZeroComponentMVA() → float

Returns the zero sequence component of fault level in MVA.

Returns:

The zero sequence component of fault level in MVA.

Return type:

float

GetCurrentMagnitude(dOrder: float) → float

Returns the current magnitude in per unit on the network base for the harmonic order.

Parameters:

dOrder (float) – The harmonic order.

Returns:

The current magnitude in per unit.

Return type:

float

GetCurrentAngle(dOrder: float) → float

Returns the current angle in radians for the harmonic order.

Parameters:

dOrder (float) – The harmonic order.

Returns:

The current angle in radians.

Return type:

float

GetDCLFStatorPowerMagnitudeMVA() → float

Returns stator power in MVA.

Returns:

The stator power in MVA.

Return type:

float

GetDCLFStatorPowerMagnitudekVA() → float

Returns stator power in kVA.

Returns:

The stator power in kVA.

Return type:

float

GetDCLFStatorRealPowerMW() → float

Returns stator power in MW.

Returns:

The stator power in MW.

Return type:

float

GetDCLFStatorRealPowerkW() → float

Returns stator power in kW.

Returns:

The stator power in kW.

Return type:

float

GetDCLFEfficiencyPC() → float

Returns the motor efficiency in percent.

Returns:

The motor efficiency in percent.

Return type:

float

GetDCLFCurrentkA() → float

Returns the total current in kA.

Returns:

The total current in kA.

Return type:

float

GetDCLFCurrentA() → float

Returns the total current in Amps.

Returns:

The total current in Amps.

Return type:

float