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
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:
|
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:
|
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 |
Maximum machine real power. |
Float |
SMaxMVA |
Maximum machine apparent power. |
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 |
|
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:
|
Integer |
GenStage |
The stage at which the generation production/planning is situated:
|
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. |
IscSynMachine Class
- class ipsa.IscSynMachine
Provides access to an IPSA generator (or more specifically, a synchronous machine).
- SetIValue(nFieldIndex: int, nValue: int) bool
Sets the value for the enumerated field from an integer.
- SetDValue(nFieldIndex: int, dValue: float) bool
Sets the value for the enumerated field from a double.
- SetSValue(nFieldIndex: int, strValue: int) bool
Sets the value for the enumerated field from a string.
- SetBValue(nFieldIndex: int, bValue: bool) bool
Sets the value for the enumerated field from boolean.
- PopulateByDBEntry(strGeneratorDataName: str, nParallel: int) bool
Populates the object data with database information from the first database that was loaded.
- GetVoltageMagnitudePU() float
Returns the generator voltage magnitude in per unit.
- Returns:
The generator voltage magnitude in per unit.
- Return type:
- GetVoltageAngleRad() float
Returns the voltage angle in radians.
- Returns:
The voltage angle.
- Return type:
- GetVoltageAngleDeg() float
Returns the voltage angle in degrees.
- Returns:
The voltage angle.
- Return type:
- GetPowerMagnitudeMVA() float
Returns the generator output in MVA.
- Returns:
The generator output in MVA.
- Return type:
- GetPowerMagnitudekVA() float
Returns the generator output in kVA.
- Returns:
The generator output in kVA.
- Return type:
- GetRealPowerMW() float
Returns the generator output in MW.
- Returns:
The generator output in MW.
- Return type:
- GetReactivePowerMVAr() float
Returns the generator output in MVAr.
- Returns:
The generator output in MVAr.
- Return type:
- GetRealPowerkW() float
Returns the generator output in kW.
- Returns:
The generator output in kW.
- Return type:
- GetReactivePowerkVAr() float
Returns the generator output in kVAr.
- Returns:
The generator output in kVAr.
- Return type:
- GetFaultRedComponentMVA() float
Returns the red phase component of fault level in MVA.
- Returns:
The red phase component of fault level in MVA.
- Return type:
- GetFaultYellowComponentMVA() float
Returns the yellow phase component of fault level in MVA.
- Returns:
The yellow phase component of fault level in MVA.
- Return type:
- GetFaultBlueComponentMVA() float
Returns the blue phase component of fault level in MVA.
- Returns:
The blue phase component of fault level in MVA.
- Return type:
- GetFaultPositiveComponentMVA() float
Returns the positive sequence component of fault level in MVA.
- Returns:
The positive sequence component of fault level in MVA.
- Return type:
- GetFaultNegativeComponentMVA() float
Returns the negative sequence component of fault level in MVA.
- Returns:
The negative sequence component of fault level in MVA.
- Return type:
- GetFaultZeroComponentMVA() float
Returns the zero sequence component of fault level in MVA.
- Returns:
The zero sequence component of fault level in MVA.
- Return type:
- GetCurrentMagnitude(dOrder: float) float
Returns the current magnitude in per unit on the network base for the harmonic order.
- GetImpedanceMagnitude(dOrder: float) float
Returns the impedance magnitude in per unit on the network base for the harmonic order.