IscSynMachine

The IscSynMachine class provides access to an IPSA generator (or more specifically, a synchronous machine), to set and get data values and to retrieve load flow and fault level results.

Field Values

IscSynMachine Field Values

Type

Field Name

Description

Integer

FromUID

Gets the unique ID for busbar.

String

BusName

Gets the busbar name.

String

Name

Gets the synchronous machine name.

Integer

Status

Status:

  • 0 = Switched in

  • -1 = Switched out

Float

VoltPU

Per unit voltage target.

Float

VoltBandwidthPC

Bandwidth of acceptable busbar voltage.

Integer

CtlBusbar

UID of controlled busbar.

Float

GenMW

Generated real power.

Float

GenMVAr

Generated reactive power.

Float

GenMVArMax

Maximum reactive power limit for PV control.

Float

GenMVArMin

Minimum reactive power limit for PV control.

Float

GenRatedMW

Generator rated MW.

Float

GenRatedMVA

Generator rated MVA.

Integer

ProfileUID

Gets and sets the UID identifying the profile to be applied to the synchronous machine.

Float

SynResistancePU

Positive sequence or armature resistance.

Float

SynReactancePU

Positive sequence or d-axis synchronous reactance.

Float

ZSResistancePU

Zero sequence resistance.

Float

ZSReactancePU

Zero sequence reactance.

Float

NEResistancePU

Neutral earthing resistance.

Float

NEReactancePU

Neutral earthing reactance.

Integer

WindingEarthing

Neutral earthing connection type:

  • 0 = Star wound, unearthed

  • 1 = Star wound, neutral earthed

Float

DAxisTrXPU

D-axis transient reactance.

Float

DAxisTrTCSec

D-axis transient open-circuit time constant.

Float

DAxisStrXPU

D-axis sub transient reactance.

Float

DAxisStrTCSec

D-axis sub transient open-circuit time constant.

Float

QAxisXPU

Q-axis synchronous reactance.

Float

QAxisTrXPU

Q-axis transient reactance.

Float

QAxisTrTCSec

Q-axis transient open-circuit time constant.

Float

QAxisStrXPU

Q-axis sub transient reactance.

Float

QAxisStrTCSec

Q-axis sub transient open-circuit time constant.

Float

InertiaSec

Inertia constant.

Float

DampFactor

Damping factor.

Float

PotierXPU

Potier reactance (required only if a saturation factor is entered).

Float

SaturationFact

Per unit field current required to generate 1.2 per unit voltage in open circuit.

Integer

TID

Gets the ID for two generators to share the same prime mover.

Float

PMaxMW or PMaxOutMW

Maximum machine real power.

Float

QMaxOutMVAr

Maximum machine reactive power.

Float

SMaxMVA or SMaxOutMVA

Maximum machine apparent power.

Float

QMaxAbsMVAr

Maximum reactive power the machine can absorb.

Float

SatDAxisXPU

Saturated d-axis synchronous reactance.

Float

SatDAxisTrXPU

Saturated d-axis transient reactance.

Float

SatDAxisTrTCSec

Saturated d-axis transient open-circuit time constant.

Float

SatDAxisStTrXPU

Saturated d-axis sub transient reactance.

Float

SatDAxisStrTCSec

Saturated d-axis sub transient open-circuit time constant.

Float

SatQAxisStrXPU

Saturated q-axis sub transient reactance.

String

DbGenType

Gets the database type.

Integer

DbGenPar

Gets the number of database generators in parallel.

Boolean

EnhancedModelling

True to indicate if rotor field current, calculated from the leakage reactance is modelled in transient stability. False if the leakage reactance is not used.

Float

LeakageReactance

The leakage reactance in per unit, required for extended field modelling.

Float

VoltageFactorPg

The voltage factor (P_g) of the machine, only for use in IEC60909 fault calculations.

Float

DispPMaxPC

Maximum economic dispatch as a percentage of the machine maximum power.

Float

DispPMinPC

Minimum economic dispatch as a percentage of the machine maximum power.

Integer

GenTechnology

The specific type of generator that can be categorized:

  • 0 = Synchronous machine (default)

  • 1 = Energy storage

  • 2 = Solar

  • 3 = Wind

  • 4 = Hydroelectric

  • 5 = Nuclear

  • 6 = Gas

  • 7 = Coal

  • 8 = Diesel

  • 9 = Geothermal

  • 10 = Tidal

  • 11 = Future generation (TBC)

Integer

GenStage

The stage at which the generation production/planning is situated:

  • 0 = Proposed

  • 1 = Accepted

  • 2 = Completed

  • 3 = Energized (default, in service)

Float

StorageIERatio

For energy storage components, this is the ratio between where a storage unit behaves as an import or an export. If the storage is flipped from export to import, the real power is multiplied by this ratio. Default is 1.

Float

HarmRC0 HarmRC12 HarmRC1 HarmRC2 HarmRC3

Harmonic polynomial constants RC0, RC12, RC1, RC2 and RC3 in:

\(R_{h} = R[RC0 + RC12.h^{0.5} 0 + RC1.h + RC2.h^2 + RC3.h^3]\)

Float

HarmXC0 HarmXC1 HarmXC2 HarmXC3 HarmXCEX HarmXEX

Harmonic polynomial constants XC0, XC1, XC2, XC3, XCEX and XEX in:

\(X_{h} = X[XC0 + XC1.h + XC2.h^2 + XC3.h^3 + XCEX.h^{XEX}]\)

Float

DistFactor

Distribution factor.

Float

GenCostPerMW

Cost of generating real power.

Float

AbsCostPerMW

Cost of absorbing real power.

Float

GenCostPerMVAr

Cost of generating reactive power.

Float

AbsCostPerMVAr

Cost of absorbing reactive power.

String

Comment

Gets and sets the comments.

Boolean

Aggregate

An equivalent for a collection of the same object.

IscSynMachine Class

class ipsa.IscSynMachine

Provides access to an IPSA generator (or more specifically, a synchronous 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(strGeneratorDataName: str, nParallel: int) → bool

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

Parameters:

  • strGeneratorDataName (str) – The name of the generator.

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

Returns:

True if successful.

Return type:

bool

GetVoltageMagnitudePU() → float

Returns the generator voltage magnitude in per unit.

Returns:

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

GetPowerMagnitudeMVA() → float

Returns the generator output in MVA.

Returns:

The generator output in MVA.

Return type:

float

GetPowerMagnitudekVA() → float

Returns the generator output in kVA.

Returns:

The generator output in kVA.

Return type:

float

GetRealPowerMW() → float

Returns the generator output in MW.

Returns:

The generator output in MW.

Return type:

float

GetReactivePowerMVAr() → float

Returns the generator output in MVAr.

Returns:

The generator output in MVAr.

Return type:

float

GetRealPowerkW() → float

Returns the generator output in kW.

Returns:

The generator output in kW.

Return type:

float

GetReactivePowerkVAr() → float

Returns the generator output in kVAr.

Returns:

The generator output in kVAr.

Return type:

float

GetFaultACMagnitudekA() → float

Returns the AC Magnitude of fault level in kA.

Returns:

The AC Magnitude of fault level in kA.

Return type:

float

GetFaultDCMagnitudekA() → float

Returns the DC Magnitude of fault level in kA.

Returns:

The DC Magnitude of fault level in kA.

Return type:

float

GetFaultDCPC() → float

Returns the fault level DC percentage.

Returns:

The fault level DC percentage.

Return type:

float

GetFaultSecondHarmonickA() → float

Returns the second harmonic of the fault level in kA.

Returns:

The second harmonic of the fault level in kA.

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

GetFaultRedMagnitudekA() → float

Returns the red phase fault level component in kA.

Returns:

The red phase fault level component in kA.

Return type:

float

GetFaultYellowMagnitudekA() → float

Returns the yellow phase fault level component in kA.

Returns:

The yellow phase fault level component in kA.

Return type:

float

GetFaultBlueMagnitudekA() → float

Returns the blue phase fault level component in kA.

Returns:

The blue phase fault level component in kA.

Return type:

float

GetFaultPositiveMagnitudekA() → float

Returns the positive sequence fault level component in kA.

Returns:

The positive sequence fault level component in kA.

Return type:

float

GetFaultNegativeMagnitudekA() → float

Returns the negative sequence fault level component in kA.

Returns:

The negative sequence fault level component in kA.

Return type:

float

GetFaultZeroMagnitudekA() → float

Returns the zero sequence fault level component in kA.

Returns:

The zero sequence fault level component in kA.

Return type:

float

GetFaultRedAngleDeg() → float

Returns the red phase fault level angle in degrees.

Returns:

The red phase fault level angle in degrees.

Return type:

float

GetFaultYellowAngleDeg() → float

Returns the yellow phase fault level angle in degrees.

Returns:

The yellow phase fault level angle in degrees.

Return type:

float

GetFaultBlueAngleDeg() → float

Returns the blue phase fault level angle in degrees.

Returns:

The blue phase fault level angle in degrees.

Return type:

float

GetFaultPositiveAngleDeg() → float

Returns the positive sequence fault level angle in degrees.

Returns:

The positive sequence fault level angle in degrees.

Return type:

float

GetFaultNegativeAngleDeg() → float

Returns the negative sequence fault level angle in degrees.

Returns:

The negative sequence fault level angle in degrees.

Return type:

float

GetFaultZeroAngleDeg() → float

Returns the zero sequence fault level angle in degrees.

Returns:

The zero sequence fault level angle in degrees.

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

GetImpedanceMagnitude(dOrder: float) → float

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

Parameters:

dOrder (float) – The harmonic order.

Returns:

The impedance magnitude in per unit.

Return type:

float

GetDCLFRealPowerMW() → float

Returns the generator output in MW.

Returns:

The generator output in MW.

Return type:

float

GetDCLFRealPowerkW() → float

Returns the generator output in kW.

Returns:

The generator output in kW.

Return type:

float