IscTransformer
The IscTransformer
class provides access to an IPSA transformer, to set and get data values and to retrieve load flow and fault level results. Note that in IPSA a transformer is modelled as a combination of a branch and a tap changer. Therefore the transformer impedance data is stored in a branch instance and functions such as GetLineDValue()
are used to access branch type data.
Field Values
Type |
Field Name |
Description |
---|---|---|
Integer |
FromUID |
Gets the unique ID of the sending busbar. |
Integer |
ToUID |
Gets the unique ID of the receiving busbar. |
String |
FromBusName |
Gets the sending busbar name. |
String |
ToBusName |
Gets the receiving busbar name. |
String |
Name |
Gets the transformer name. |
Integer |
Type |
Specifies the transformer type as follows:
|
Integer |
Winding |
Transformer winding type connection as follows:
|
Float |
NEResistanceW1PU |
Winding 1 neutral earth resistance in per unit. |
Float |
NEReactanceW1PU |
Winding 1 neutral earth reactance in per unit. |
Float |
NEResistanceW2PU |
Winding 2 neutral earth resistance in per unit. |
Float |
NEReactanceW2PU |
Winding 2 neutral earth reactance in per unit. |
Float |
TapNominalPC |
Nominal tap position, optionally used in a flat start. |
Float |
TapStartPC |
Present tap position, used as a starting point for the next load flow. |
Float |
MinTapPC |
Minimum tap position, normally negative or zero. |
Float |
TapStepPC |
Tap increment. This defaults to 0.01 if left blank. |
Float |
MaxTapPC |
Maximum tap position, normally positive or zero. |
Float |
DxDTap |
Changes in reactance with tap change. This value is used in compounding only. |
Boolean |
LockTap |
Sets the flag to lock the transformer tap changer. Use |
Float |
SpecVPU |
Target voltage in per unit. Positive means control ‘to’ busbar, negative means control ‘from’ busbar. Magnitudes of less than 0.5 pu mean fixed tap operation. |
Float |
RBWidthPC |
Full bandwidth of the voltage sensing relay. This should be larger than tap step size. |
Float |
CompRPC |
Line drop compensation resistance in percentage on the compensation rating base. |
Float |
CompXPC |
Line drop compensation reactance in percentage on the compensation rating base. |
Float |
RatingMVA |
Rating used for line drop compensation impedances. This can be a different value from the branch rating used for overloads. |
Float |
PhShiftDeg |
Phase shift angle. A positive value makes the receiving end voltage lead the sending end voltage. |
Float |
SpecPowerMW |
Quad Booster target power in MW - can be specified as zero. |
Boolean |
SpecPowerAtSend |
Control the power at the “from” side of the transformer. |
Float |
MinPhShiftDeg |
Min phase shift angle - both angle limits are required for Power control. |
Float |
MaxPhShiftDeg |
Max phase shift angle - both angle limits are required for Power control. |
Float |
PhShiftStepDeg |
Phase shift step - default value is 0.01 degrees. |
String |
DbType |
Gets the transformer database type including both tap and impedance information. |
Integer |
DbParallel |
Gets the number of transformers in parallel. This is only used for database transformers. |
String |
PluginID |
Gets and sets the plugin name associated with this transformer. |
Float |
VoltFactorPt |
Sets the voltage factor for use in IEC60909 fault calculations. |
Integer |
RemoteCtlBusbarUID |
Specifies the UID of the remote busbar which is used as the basis for the transformer voltage control. |
IscTransformer Class
- class ipsa.IscTransformer
Provides access to an IPSA transformer.
- 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.
- GetLineIValue(nFieldIndex: int) int
Returns an integer value for the field index for the line associated with this transformer.
- GetLineDValue(nFieldIndex: int) float
Returns a double value for the field index for the line associated with this transformer.
- GetLineSValue(nFieldIndex: int) str
Returns a string value for the field index for the line associated with this transformer.
- SetLineIValue(nFieldIndex: int, nValue: int) bool
Sets the value for the field index from an integer for the line associated with this transformer.
- SetLineDValue(nFieldIndex: int, dValue: float) bool
Sets the value for the field index from a double for the line associated with this transformer.
- SetLineSValue(nFieldIndex: int, strValue: int) bool
Sets the value for the field index from a string for the line associated with this transformer.
- SetRatingskA(nRatingIndex: int, dSendRatingkA: float, dRecieveRatingkA: float) None
Sets the sending and receiving end current ratings in kA for the transformer.
- GetRatingSendkA(nRatingIndex: int) float
Returns the sending end current ratings in kA for the transformer.
- GetRatingReceivekA(nRatingIndex: int) float
Returns the receiving end current ratings in kA for the transformer.
- GetControlledBusbarName() str
Returns the name of the busbar whose voltage is controlled by the transformer.
- Returns:
The name of the busbar whose voltage is controlled by the transformer.
- Return type:
- PopulateByDBEntry(strTransformerDataName: str, strLine1DataName: str, strLine2DataName: str, nParallel: int, nParallelFrom: int, nParallelTo: int, dlengthFrom: float, dLengthTo: float) bool
Populates the object data with database information from the first database that was loaded.
- Parameters:
strTransformerDataName (str) – The name of the transformer.
strLine1DataName (str) – The name of the From branch.
strLine2DataName (str) – The name of the To branch.
nParallel (int) – The number of parallel components.
nParallelFrom (int) – The number of parallel components for the From branch.
nParallelTo (int) – The number of parallel components for the To branch.
dlengthFrom (float) – The length of the From branch.
dLengthTo (float) – The length of the To branch.
- Returns:
True if successful.
- Return type:
- GetSendPowerMagnitudeMVA() float
Returns the transformer sending end power in MVA.
- Returns:
The transformer sending end power in MVA.
- Return type:
- GetSendPowerMagnitudekVA() float
Returns the transformer sending end power in kVA.
- Returns:
The transformer sending end power in kVA.
- Return type:
- GetSendRealPowerMW() float
Returns the transformer sending end power in MW.
- Returns:
The transformer sending end power in MW.
- Return type:
- GetSendReactivePowerMVAr() float
Returns the transformer sending end power in MVAr.
- Returns:
The transformer sending end power in MVAr.
- Return type:
- GetSendRealPowerkW() float
Returns the transformer sending end power in kW.
- Returns:
The transformer sending end power in kW.
- Return type:
- GetSendReactivePowerkVAr() float
Returns the transformer sending end power in kVAr.
- Returns:
The transformer sending end power in kVAr.
- Return type:
- GetReceivePowerMagnitudeMVA() float
Returns the transformer receiving end power in MVA.
- Returns:
The transformer receiving end power in MVA.
- Return type:
- GetReceivePowerMagnitudekVA() float
Returns the transformer receiving end power in kVA.
- Returns:
The transformer receiving end power in kVA.
- Return type:
- GetReceiveRealPowerMW() float
Returns the transformer receiving end power in MW.
- Returns:
The transformer receiving end power in MW.
- Return type:
- GetReceiveReactivePowerMVAr() float
Returns the transformer receiving end power in MVAr.
- Returns:
The transformer receiving end power in MVAr.
- Return type:
- GetReceiveRealPowerkW() float
Returns the transformer receiving end power in kW.
- Returns:
The transformer receiving end power in kW.
- Return type:
- GetReceiveReactivePowerkVAr() float
Returns the transformer receiving end power in kVAr.
- Returns:
The transformer receiving end power in kVAr.
- Return type:
- GetLargestPowerMagnitudeMVA() float
- GetLargestPowerMagnitudeMVA(nStudyUID: int) float
Returns the highest transformer power in MVA.
- GetLargestPowerMagnitudekVA() float
Returns the highest transformer power in kVA.
- Returns:
The highest transformer power in kVA.
- Return type:
- GetLargestRealPowerMW() float
Returns the highest transformer power in MW.
- Returns:
The highest transformer power in MW.
- Return type:
- GetLargestReactivePowerMVAr() float
Returns the highest transformer power in MVAr.
- Returns:
The highest transformer power in MVAr.
- Return type:
- GetLargestRealPowerkW() float
Returns the highest transformer power in kW.
- Returns:
The highest transformer power in kW.
- Return type:
- GetLargestReactivePowerkVAr() float
Returns the highest transformer power in kVAr.
- Returns:
The highest transformer power in kVAr.
- Return type:
- GetLossesMW() float
Returns the transformer losses in MW.
- Returns:
The transformer losses in MW.
- Return type:
- GetLossesMVAr() float
Returns the transformer losses in MVAr.
- Returns:
The transformer losses in MVAr.
- Return type:
- GetLosseskW() float
Returns the transformer losses in kW.
- Returns:
The transformer losses in kW.
- Return type:
- GetLosseskVAr() float
Returns the transformer losses in kVAr.
- Returns:
The transformer losses in kVAr.
- Return type:
- GetSpecVoltagePU() float
Returns the target busbar voltage in per unit.
- Returns:
The target busbar voltage in per unit.
- Return type:
- GetActualVoltagePU() float
Returns the actual busbar voltage in per unit.
- Returns:
The actual busbar voltage in per unit.
- Return type:
- GetTapPC() float
Returns the current tap position in percentage.
- Returns:
The current tap position in percentage.
- Return type:
- GetMinTapPC() float
Returns the minimum tap position in percentage.
- Returns:
The minimum tap position in percentage.
- Return type:
- GetMaxTapPC() float
Returns the maximum tap position in percentage.
- Returns:
The maximum tap position in percentage.
- Return type:
- GetPhShiftDeg() float
Returns the current phase shift in degrees.
- Returns:
The current phase shift in degrees.
- Return type:
- GetPhShiftRad() float
Returns the current phase shift in radians.
- Returns:
The current phase shift in radians.
- Return type:
- GetHasCompounding() bool
Returns True if the transformer has compounding, False otherwise.
- Returns:
True if the transformer has compounding, False otherwise.
- Return type:
- GetFaultRedComponentFromMVA() float
Returns the red phase fault level component in MVA at the “From” end of the transformer.
- Returns:
The red phase fault level component in MVA at the “From” end of the transformer.
- Return type:
- GetFaultRedComponentToMVA() float
Returns the red phase fault level component in MVA at the “To” end of the transformer.
- Returns:
The red phase fault level component in MVA at the “To” end of the transformer.
- Return type:
- GetFaultYellowComponentFromMVA() float
Returns the yellow phase fault level component in MVA at the “From” end of the transformer.
- Returns:
The yellow phase fault level component in MVA at the “From” end of the transformer.
- Return type:
- GetFaultYellowComponentToMVA() float
Returns the yellow phase fault level component in MVA at the “To” end of the transformer.
- Returns:
The yellow phase fault level component in MVA at the “To” end of the transformer.
- Return type:
- GetFaultBlueComponentFromMVA() float
Returns the blue phase fault level component in MVA at the “From” end of the transformer.
- Returns:
The blue phase fault level component in MVA at the “From” end of the transformer.
- Return type:
- GetFaultBlueComponentToMVA() float
Returns the blue phase fault level component in MVA at the “To” end of the transformer.
- Returns:
The blue phase fault level component in MVA at the “To” end of the transformer.
- Return type:
- GetFaultRedComponentFromkA() float
Returns the red phase fault level component in kA at the “From” end of the transformer.
- Returns:
The red phase fault level component in kA at the “From” end of the transformer.
- Return type:
- GetFaultRedComponentTokA() float
Returns the red phase fault level component in kA at the “To” end of the transformer.
- Returns:
The red phase fault level component in kA at the “To” end of the transformer.
- Return type:
- GetFaultYellowComponentFromkA() float
Returns the yellow phase fault level component in kA at the “From” end of the transformer.
- Returns:
The yellow phase fault level component in kA at the “From” end of the transformer.
- Return type:
- GetFaultYellowComponentTokA() float
Returns the yellow phase fault level component in kA at the “To” end of the transformer.
- Returns:
The yellow phase fault level component in kA at the “To” end of the transformer.
- Return type:
- GetFaultBlueComponentFromkA() float
Returns the blue phase fault level component in kA at the “From” end of the transformer.
- Returns:
The blue phase fault level component in kA at the “From” end of the transformer.
- Return type:
- GetFaultBlueComponentTokA() float
Returns the blue phase fault level component in kA at the “To” end of the transformer.
- Returns:
The blue phase fault level component in kA at the “To” end of the transformer.
- Return type:
- GetFaultPositiveComponentFromMVA() float
Returns the positive sequence fault level component in MVA at the “From” end of the transformer.
- Returns:
The positive sequence fault level component in MVA at the “From” end of the transformer.
- Return type:
- GetFaultPositiveComponentToMVA() float
Returns the positive sequence fault level component in MVA at the “To” end of the transformer.
- Returns:
The positive sequence fault level component in MVA at the “To” end of the transformer.
- Return type:
- GetFaultNegativeComponentFromMVA() float
Returns the negative sequence fault level component in MVA at the “From” end of the transformer.
- Returns:
The negative sequence fault level component in MVA at the “From” end of the transformer.
- Return type:
- GetFaultNegativeComponentToMVA() float
Returns the negative sequence fault level component in MVA at the “To” end of the transformer.
- Returns:
The negative sequence fault level component in MVA at the “To” end of the transformer.
- Return type:
- GetFaultZeroComponentFromMVA() float
Returns the zero sequence fault level component in MVA at the “From” end of the transformer.
- Returns:
The zero sequence fault level component in MVA at the “From” end of the transformer.
- Return type:
- GetFaultZeroComponentToMVA() float
Returns the zero sequence fault level component in MVA at the “To” end of the transformer.
- Returns:
The zero sequence fault level component in MVA at the “To” end of the transformer.
- Return type:
- GetFaultPositiveComponentFromkA() float
Returns the positive sequence fault level component in kA at the “From” end of the transformer.
- Returns:
The positive sequence fault level component in kA at the “From” end of the transformer.
- Return type:
- GetFaultPositiveComponentTokA() float
Returns the positive sequence fault level component in kA at the “To” end of the transformer.
- Returns:
The positive sequence fault level component in kA at the “To” end of the transformer.
- Return type:
- GetFaultNegativeComponentFromkA() float
Returns the negative sequence fault level component in kA at the “From” end of the transformer.
- Returns:
The negative sequence fault level component in kA at the “From” end of the transformer.
- Return type:
- GetFaultNegativeComponentTokA() float
Returns the negative sequence fault level component in kA at the “To” end of the transformer.
- Returns:
The negative sequence fault level component in kA at the “To” end of the transformer.
- Return type:
- GetFaultZeroComponentFromkA() float
Returns the zero sequence fault level component in kA at the “From” end of the transformer.
- Returns:
The zero sequence fault level component in kA at the “From” end of the transformer.
- Return type:
- GetFaultZeroComponentTokA() float
Returns the zero sequence fault level component in kA at the “To” end of the transformer.
- Returns:
The zero sequence fault level component in kA at the “To” end of the transformer.
- Return type:
- GetFaultRedComponentFromAngleDeg() float
Returns the red phase component of fault angle in degrees at the “From” end of the transformer.
- Returns:
The red phase component of fault angle in degrees at the “From” end of the transformer.
- Return type:
- GetFaultRedComponentToAngleDeg() float
Returns the red phase component of fault angle in degrees at the “To” end of the transformer.
- Returns:
The red phase component of fault angle in degrees at the “To” end of the transformer.
- Return type:
- GetFaultYellowComponentFromAngleDeg() float
Returns the yellow phase component of fault angle in degrees at the “From” end of the transformer.
- Returns:
The yellow phase component of fault angle in degrees at the “From” end of the transformer.
- Return type:
- GetFaultYellowComponentToAngleDeg() float
Returns the yellow phase component of fault angle in degrees at the “To” end of the transformer.
- Returns:
The yellow phase component of fault angle in degrees at the “To” end of the transformer.
- Return type:
- GetFaultBlueComponentFromAngleDeg() float
Returns the blue phase component of fault angle in degrees at the “From” end of the transformer.
- Returns:
The blue phase component of fault angle in degrees at the “From” end of the transformer.
- Return type:
- GetFaultBlueComponentToAngleDeg() float
Returns the blue phase component of fault angle in degrees at the “To” end of the transformer.
- Returns:
The blue phase component of fault angle in degrees at the “To” end of the transformer.
- Return type:
- GetFaultPositiveComponentFromAngleDeg() float
Returns the positive sequence component of fault angle in degrees at the “From” end of the transformer.
- Returns:
The positive sequence component of fault angle in degrees at the “From” end of the transformer.
- Return type:
- GetFaultPositiveComponentToAngleDeg() float
Returns the positive sequence component of fault angle in degrees at the “To” end of the transformer.
- Returns:
The positive sequence component of fault angle in degrees at the “To” end of the transformer.
- Return type:
- GetFaultNegativeComponentFromAngleDeg() float
Returns the negative sequence component of fault angle in degrees at the “From” end of the transformer.
- Returns:
The negative sequence component of fault angle in degrees at the “From” end of the transformer.
- Return type:
- GetFaultNegativeComponentToAngleDeg() float
Returns the negative sequence component of fault angle in degrees at the “To” end of the transformer.
- Returns:
The negative sequence component of fault angle in degrees at the “To” end of the transformer.
- Return type:
- GetFaultZeroComponentFromAngleDeg() float
Returns the zero sequence component of fault angle in degrees at the “From” end of the transformer.
- Returns:
The zero sequence component of fault angle in degrees at the “From” end of the transformer.
- Return type:
- GetFaultZeroComponentToAngleDeg() float
Returns the zero sequence component of fault angle in degrees at the “To” end of the transformer.
- Returns:
The zero sequence component of fault angle in degrees at the “To” end of the transformer.
- Return type:
- GetCurrentMagnitude(dOrder: float) float
Returns the current magnitude in per unit on the network base for the harmonic order.
- GetResistance(dOrder: float) float
Returns the transformer harmonic resistance in per unit on the network base for the harmonic order.
- GetReactance(dOrder: float) float
Returns the transformer harmonic reactance in per unit on the network base for the harmonic order.
- GetShuntResistance(dOrder: float) float
Returns the transformer harmonic shunt resistance in per unit on the network base for the harmonic order.
- GetShuntReactance(dOrder: float) float
Returns the transformer harmonic shunt reactance in per unit on the network base for the harmonic order.
- GetProfileMinimumFlowMVA() float
Returns the minimum branch flow in MVA from the profile study results.
- Returns:
The minimum branch flow in MVA from the profile study results.
- Return type:
- GetProfileMinimumFlowkA() float
Returns the minimum branch flow in kA from the profile study results.
- Returns:
The minimum branch flow in kA from the profile study results.
- Return type:
- GetProfileMaximumFlowMVA() float
Returns the maximum branch flow in MVA from the profile study results.
- Returns:
The maximum branch flow in MVA from the profile study results.
- Return type:
- GetProfileMaximumFlowkA() float
Returns the maximum branch flow in kA from the profile study results.
- Returns:
The maximum branch flow in kA from the profile study results.
- Return type:
- GetProfileMedianFlowMVA() float
Returns the median of the branch flow in MVA from the profile study results.
- Returns:
The median of the branch flow in MVA from the profile study results.
- Return type:
- GetProfileMedianFlowkA() float
Returns the median of the branch flow in kA from the profile study results.
- Returns:
The median of the branch flow in kA from the profile study results.
- Return type:
- GetMinimumProfileIndex() int
Returns the category index which identifies the minimum branch flow from the profile study results.
- Returns:
The minimum category index.
- Return type:
- GetMaximumProfileIndex() int
Returns the category index which identifies the maximum branch flow from the profile study results.
- Returns:
The maximum category index.
- Return type:
- GetDCLFSendPowerMagnitudeMVA() float
Returns the transformer sending end power in MVA.
- Returns:
The transformer sending end power in MVA.
- Return type:
- GetDCLFSendPowerMagnitudekVA() float
Returns the transformer sending end power in kVA.
- Returns:
The transformer sending end power in kVA.
- Return type:
- GetDCLFSendRealPowerMW() float
Returns the transformer sending end power in MW.
- Returns:
The transformer sending end power in MW.
- Return type:
- GetDCLFSendRealPowerkW() float
Returns the transformer sending end power in kW.
- Returns:
The transformer sending end power in kW.
- Return type:
- GetDCLFReceivePowerMagnitudeMVA() float
Returns the transformer receiving end power in MVA.
- Returns:
The transformer receiving end power in MVA.
- Return type:
- GetDCLFReceivePowerMagnitudekVA() float
Returns the transformer receiving end power in kVA.
- Returns:
The transformer receiving end power in kVA.
- Return type:
- GetDCLFReceiveRealPowerMW() float
Returns the transformer receiving end power in MW.
- Returns:
The transformer receiving end power in MW.
- Return type:
- GetDCLFReceiveRealPowerkW() float
Returns the transformer receiving end power in kW.
- Returns:
The transformer receiving end power in kW.
- Return type:
- GetDCLFReceiveReactivePowerkVAr() float
Returns the transformer receiving end power in kVAr.
- Returns:
The transformer receiving end power in kVAr.
- Return type:
- GetDCLFLargestPowerMagnitudeMVA() float
Returns the highest transformer end power in MVA.
- Returns:
The highest transformer end power in MVA.
- Return type:
- GetDCLFLargestPowerMagnitudekVA() float
Returns the highest transformer end power in kVA.
- Returns:
The highest transformer end power in kVA.
- Return type:
- GetDCLFLargestRealPowerMW() float
Returns the highest transformer end power in MW.
- Returns:
The highest transformer end power in MW.
- Return type:
- GetDCLFLargestRealPowerkW() float
Returns the highest transformer end power in kW.
- Returns:
The highest transformer end power in kW.
- Return type:
- GetDCLFLossesMW() float
Returns the transformer losses in MW.
- Returns:
The transformer losses in MW.
- Return type:
- GetDCLFLosseskW() float
Returns the transformer losses in kW.
- Returns:
The transformer losses in kW.
- Return type: