Glossary¶
This is a glossary of all possible values contained in data and result dictionaries as well as other general information.
Loadflow Data & Results¶
Find out the data and results for each Loadflow record at LoadflowRecords Module
Fault Data¶
Find out the data for each Fault data record at FaultRecords Module
Fault Results¶
Summary Results
Key |
Description |
|---|---|
“f1” |
Positive Sequence Fault Current (kA) |
“f2” |
Positive Sequence Fault Current Angle (degrees) |
“f3” |
Negative Sequence Fault Current (kA) |
“f4” |
Negative Sequence Fault Current Angle (degrees) |
“f5” |
Zero Sequence Fault Current (kA) |
“f6” |
Zero Sequence Fault Current Angle (degrees) |
“f7” |
Phase L1 Fault Current (kA) |
“f8” |
Phase L1 Fault Current Angle (degrees) |
“f9” |
Phase L2 Fault Current (kA) |
“f10” |
Phase L2 Fault Current Angle (degrees) |
“f11” |
Phase L3 Fault Current (kA) |
“f12” |
Phase L3 Fault Current Angle (degrees) |
“f13” |
Residual Fault Current (kA) |
“f14” |
Residual Fault Current Angle (degrees) |
“f15” |
Fault MVA |
“f16” |
X/R Ratio |
Busbar Results
Key |
Description |
|---|---|
“SeqNum” |
Sequence number of the element |
“Vip” |
Positive Sequence Voltage (kV) |
“ThetaVip” |
Positive Sequence Voltage Angle (degrees) |
“Vin” |
Negative Sequence Voltage (kV) |
“ThetaVin” |
Negative Sequence Voltage Angle (degrees) |
“Viz” |
Zero Sequence Voltage (kV) |
“ThetaViz” |
Zero Sequence Voltage Angle (degrees) |
“Vi1” |
Phase L1 Voltage (kV) |
“ThetaVi1” |
Phase L1 Voltage Angle (degrees) |
“Vi2” |
Phase L2 Voltage (kV) |
“Vi2Theta” |
Phase L2 Voltage Angle (degrees) |
“Vi3” |
Phase L3 Voltage (kV) |
“ThetaVi3” |
Phase L3 Voltage Angle (degrees) |
“Vires” |
Residual Voltage (kV) |
“ThetaVires” |
Residual Voltage Angle (degrees) |
“FaultMVA” |
Fault MVA |
Transmission Line/Cable/Series Element/Bus Section Results
The same values exist for “End2.”
Key |
Description |
|---|---|
“SeqNum” |
Sequence number of the element |
“End1.Ip” |
Positive Sequence Fault Current (kA) |
“End1.ThetaIp” |
Positive Sequence Fault Current Angle (degrees) |
“End1.In” |
Negative Sequence Fault Current (kA) |
“End1.ThetaIn” |
Negative Sequence Fault Current Angle (degrees) |
“End1.Iz” |
Zero Sequence Fault Current (kA) |
“End1.ThetaIz” |
Zero Sequence Fault Current Angle (degrees) |
“End1.Il1” |
Phase L1 Fault Current (kA) |
“End1.ThetaIl1” |
Phase L1 Fault Current Angle (degrees) |
“End1.I12” |
Phase L2 Fault Current (kA) |
“End1.ThetaIl2” |
Phase L2 Fault Current Angle (degrees) |
“End1.Il3” |
Phase L3 Fault Current (kA) |
“End1.ThetaIl3” |
Phase L3 Fault Current Angle (degrees) |
“End1.Ires” |
Residual Fault Current (kA) |
“End1.ThetaIres” |
Residual Fault Current Angle (degrees) |
“End1.PowerDir” |
Direction of positive sequence power flow [-1 = Out of device, 0 = No Flow, 1 = Into device] |
“End1.ConInd” |
Connection Indicator [-1 = Element disconnected by calculation, 0 = Element disconnected, 1 = Element connected] |
Transformer Results
The same values exist for “Winding2.”, “Winding3.”, and “Winding4.”
Key |
Description |
|---|---|
“SeqNum” |
Sequence number of the element |
“Winding1.Ip” |
Positive Sequence Fault Current (kA) |
“Winding1.ThetaIp” |
Positive Sequence Fault Current Angle (degrees) |
“Winding1.In” |
Negative Sequence Fault Current (kA) |
“Winding1.ThetaIn” |
Negative Sequence Fault Current Angle (degrees) |
“Winding1.Iz” |
Zero Sequence Fault Current (kA) |
“Winding1.ThetaIz” |
Zero Sequence Fault Current Angle (degrees) |
“Winding1.Il1” |
Phase L1 Fault Current (kA) |
“Winding1.ThetaIl1” |
Phase L1 Fault Current Angle (degrees) |
“Winding1.I12” |
Phase L2 Fault Current (kA) |
“Winding1.ThetaIl2” |
Phase L2 Fault Current Angle (degrees) |
“Winding1.Il3” |
Phase L3 Fault Current (kA) |
“Winding1.ThetaIl3” |
Phase L3 Fault Current Angle (degrees) |
“Winding1.Ires” |
Residual Fault Current (kA) |
“Winding1.ThetaIres” |
Residual Fault Current Angle (degrees) |
“Winding1.PowerDir” |
Direction of positive sequence power flow [-1 = Out of device, 0 = No Flow, 1 = Into device] |
“Winding1.ConInd” |
Connection Indicator [-1 = Element disconnected by calculation, 0 = Element disconnected, 1 = Element connected] |
“IntFaultContrib” |
If fault applied to Transformer, it’ll be pointer to similar results to Winding Results |
Neutral Earth Results
Key |
Description |
|---|---|
“SeqNum” |
Sequence number of the element |
“Vne” |
Neutral Voltage (kV) |
“ThetaVne” |
Neutral Voltage Angle (degrees) |
“Ine” |
Neutral Current (kA) |
“ThetaIne” |
Neutral Current Angle (degrees) |
Synchronous Machine/Induction Machine/Shunt/Wind Turbine Generator Results
Key |
Description |
|---|---|
“SeqNum” |
Sequence number of the element |
“Ip” |
Positive Sequence Fault Current (kA) |
“ThetaIp” |
Positive Sequence Fault Current Angle (degrees) |
“In” |
Negative Sequence Fault Current (kA) |
“ThetaIn” |
Negative Sequence Fault Current Angle (degrees) |
“Iz” |
Zero Sequence Fault Current (kA) |
“ThetaIz” |
Zero Sequence Fault Current Angle (degrees) |
“Il1” |
Phase L1 Fault Current (kA) |
“ThetaIl1” |
Phase L1 Fault Current Angle (degrees) |
“Il2” |
Phase L2 Fault Current (kA) |
“ThetaIl2” |
Phase L2 Fault Current Angle (degrees) |
“Il3” |
Phase L3 Fault Current (kA) |
“ThetaIl3” |
Phase L3 Fault Current Angle (degrees) |
“Ires” |
Residual Fault Current (kA) |
“ThetaIres” |
Residual Fault Current Angle (degrees) |
“PowerDir” |
Direction of positive sequence power flow [-1 = Out of device, 0 = No Flow, 1 = Into device] |
“ConInd” |
Connection Indicator [-1 = Element disconnected by calculation, 0 = Element disconnected, 1 = Element connected] |
Injection Dictionary¶
The dictionary for adding a new harmonic current injection source to the current Harmonic Injection study. The keys are expected and an error will be raised if any are missing.
Key |
Description |
|---|---|
“typecode” |
The typecode of the harmonic current injection source element (an integer value) |
“id” |
If the keyname (below) is specified in the dictionary, this is the identifier for the element we’re wanting as an injection source. If keyname is not specified (and therefore it’s assumed we’re manually providing injection data in the dictionary), this is the harmonic current injection identifier (a string) |
“keyname” |
The keyname for the harmonic current library data that should be associated with the harmonic current injection source element. If this is provided, the other elements below apart from scalefact are optional |
“seqnum” |
The sequence number of the harmonic current injection source data (an integer value) |
“description” |
A description of the harmonic current injection source data. This can be set to an empty string for no description |
“units” |
The units used for the harmonic values. This should be 0 for relative magnitude in per unit or 1 for absolute magnitude in amperes |
“scalefact” |
The calculation program will multiply each magnitude value by this per unit scaling factor |
“harmvalues” |
A Python list of harmonic values in a dictionary, the dictionary is defined below |
HarmValues Dictionary¶
The dictionary layout to be used for an item in the harmvalues list passed in for a new injection source.
Key |
Description |
|---|---|
“n” |
The harmonic number |
“mag” |
The magnitude of the harmonic. Units are as specified in Injection Dictionary “units” above |
“angle” |
Angle of the harmonic (degrees) |
Injection Data¶
Find out the data for each Injection data record at InjectionRecords Module
Injection Results¶
IValues
Key |
Description |
|---|---|
“i” |
Current magnitude (A) |
“angle” |
Current angle (degrees) |
“anglerad” |
Current angle (radians) |
“ika” |
Current magnitude (kA) |
“iper” |
Current magnitude (% of Fundamental) |
“ipu” |
Current magnitude (pu) |
VValues
Key |
Description |
|---|---|
“v” |
Voltage magnitude (kV) |
“angle” |
Voltage angle (degrees) |
“anglerad” |
Voltage angle (radians) |
“vv” |
Voltage magnitude (V) |
“vper” |
Voltage magnitude (% of Fundamental) |
“vpu” |
Voltage magnitude (pu) |
Waveform Results
Key |
Description |
|---|---|
“ifft” |
The inverse fast fourier transform results, directly plottable using the Matplotlib Python library. The ifft is a list of magnitudes which should be plotted against the [0, 0.0001, 0.0002, 0.0003] # Time range
[-1.22483261e-03, 4.90912096e-01, 9.84337111e-01, 1.47817684e+00] # Ifft
# Example usage
matplotlib.plot(self.__Injection.TimeRange, result["waveforms"]["ifft"])
|
“harmonics” |
The individual harmonic waveforms, as a dictionary with harmonic values as the keys, directly plottable using the Matplotlib Python library. Each harmonic number is included, and each harmonic number has a list of magnitudes which should be plotted against the [0, 0.0001, 0.0002, 0.0003] # Time range
{1.0: array([-0.01044907, -0.00976586, -0.00747626, -0.00395688])} # Harmonics
# Example usage
matplotlib.plot(self.__Injection.TimeRange, result["waveforms"]["harmonics"][1.0])
|
Injection Results
Key |
Description |
|---|---|
“id” |
The identifier for the element (a string) |
“typecode” |
The typecode for the element (an integer value) |
“seqnum” |
The sequence number for the element (an integer value) |
“busbarid” |
The identifier of the busbar which the target element is attached to (a string) |
“d” |
Harmonic distortion (%) |
“ifund” |
Fundamental current magnitude (A) |
“ikafund” |
Fundamental current magnitude (kA) |
“ifundangle” |
Fundamental current angle (degrees) |
“ifundanglerad” |
Fundamental current angle (radians) |
“ivalues” |
List of ivalues for each harmonic number |
“waveforms” |
The injection source waveform results dictionary |
Busbar Results
Key |
Description |
|---|---|
“id” |
The identifier for the busbar (a string) |
“seqnum” |
The sequence number for the busbar (an integer value) |
“d” |
Harmonic distortion (%) |
“tff” |
Telephone form factor |
“busang” |
Busbar angle (degrees) |
“busangrad” |
Busbar angle (radians) |
“vfund” |
Fundamental voltage magnitude (kV) |
“vvfund” |
Fundamental voltage magnitude (V) |
“vfundangle” |
Fundamental voltage angle (degrees) |
“vfundanglerad” |
Fundamental voltage angle (radians) |
“vvalues” |
List of vvalues for each harmonic number |
“waveforms” |
The busbar waveform results dictionary |
Branch End Results
Key |
Description |
|---|---|
“d” |
Harmonic distortion (%) |
“tff” |
Telephone form factor |
“ifund” |
Fundamental current magnitude (A) |
“ikafund” |
Fundamental current magnitude (kA) |
“ifundangle” |
Fundamental current angle (degrees) |
“ifundanglerad” |
Fundamental current angle (radians) |
“ivalues” |
List of ivalues for each harmonic number |
“waveforms” |
The end waveform results dictionary for a particular end of a branch |
Transmission Line/Cable/Series Element Results
Key |
Description |
|---|---|
“id” |
The identifier for the branch element (a string) |
“seqnum” |
The sequence number for the branch element (an integer value) |
“end1” |
|
“end2” |
Winding Results
Key |
Description |
|---|---|
“d” |
Harmonic distortion (%) |
“tff” |
Telephone form factor |
“kf” |
K-factor |
“hlf” |
Harmonic Loss Factor |
“fk” |
Factor K |
“ifund” |
Fundamental current magnitude (A) |
“ikafund” |
Fundamental current magnitude (kA) |
“ifundangle” |
Fundamental current angle (degrees) |
“ifundanglerad” |
Fundamental current angle (radians) |
“ivalues” |
List of ivalues for each harmonic number |
“waveforms” |
The winding waveform results dictionary |
Transformer Results
Key |
Description |
|---|---|
“id” |
The identifier for the transformer (a string) |
“seqnum” |
The sequence number for the transformer (an integer value) |
“winding1” |
|
“winding2” |
|
“winding3” |
Winding 3 results or None |
“winding4” |
Winding 4 results or None |
Induction Machine/Synchronous Machine/Shunt Results
Key |
Description |
|---|---|
“id” |
The identifier for the leaf node (a string) |
“seqnum” |
The sequence number for the leaf node (an integer value) |
“busbarid” |
The identifier of the busbar which the leaf node is connected to (a string) |
“d” |
Harmonic distortion (%) |
“ifund” |
Fundamental current magnitude (A) |
“ikafund” |
Fundamental current magnitude (kA) |
“ifundangle” |
Fundamental current angle (degrees) |
“ifundanglerad” |
Fundamental current angle (radians) |
“ivalues” |
List of ivalues for each harmonic number |
“waveforms” |
The machine waveform results dictionary |
Study Parameters Element Type (Loadflow)¶
Key |
Description |
|---|---|
“LoadflowParam” |
Loadflow Parameters |
“BusSection” |
Bus Section |
“Switch” |
Switch element |
“Grid” |
Grid Infeed |
“Winding1” |
Winding 1 of a Transformer |
“Winding2” |
Winding 2 of a Transformer |
“Winding3” |
Winding 3 of a Transformer |
“Winding4” |
Winding 4 of a Transformer |
“SyncMachine” |
Synchronous Machine |
“IndMachine” |
Induction Machine |
“Shunt” |
Shunt |
Study Parameters Element ID (For LoadflowParam)¶
Key |
Description |
|---|---|
“PMult” |
Shunt Real Power Multiplier |
“QMult” |
Shunt Reactive Power Multiplier |
“Tapsel” |
Tap Changer Selector |
Study Parameters (Fault)¶
The order of study parameters is important and must be specified in the order given below
Key |
Description |
|---|---|
“Typecode” |
Typecode of the element to use. |
“Seqnum” |
Sequence number of the element. Load the data into an TEracsData object to find out. |
“ReactOption” |
Reactance Option [1 = Positive Sequence, 2 = Transient, 3 = Sub-Transient] |
“FaultType” |
Fault Type [1 = Phase to Earth, 2 = Phase to Phase, 3 = Two Phase to Earth, 4 = Three Phase, 5 = Single Phase Open Circuit, 6 = Two Phase Open Circuit] |
“FaultPos” |
Position of the fault along a cable or transmission line from the first busbar, as a percentage [0-100] |
“Rph” |
Fault’s Phase Resistance |
“Xph” |
Fault’s Phase Reactance |
“Rgrnd” |
Fault’s Ground Resistance |
“Xgrnd” |
Fault’s Ground Reactance |
“IncMotor” |
Include Motor Contribution [0 = No, 1 = Yes] |
Result Selection Element Type (Loadflow & Fault)¶
Key |
Description |
|---|---|
“SummaryRes” |
Summary Results |
“Busbar” |
Busbar Results |
“Line” |
Transmission Line Results |
“Cable” |
Cable Results |
“Series” |
Series Element Results |
“BusSection” |
Bus Section Results |
“Grid” |
Grid Infeed Results |
“SyncMachine” |
Synchronous Machine Results |
“IndMachine” |
Induction Machine Results |
“Shunt” |
Shunt Results |
“Transformer” |
Transformer Results |
“Neutral” |
Neutral Earth Results |
Typecodes¶
Number |
Element |
|---|---|
1 |
Busbar |
2 |
Transmission Line |
3 |
Cable |
4 |
Transformer |
5 |
Tap Changer |
6 |
Switch |
7 |
Induction Machine |
8 |
Synchronous Machine |
9 |
Shunt |
10 |
Bus Section |
11 |
Protection Device |
12 |
AVR |
13 |
Governor |
14 |
Series Element |
15 |
Wind Turbine Generator |
16 |
Auto Transformer |
17 |
Neutral Earth |
18 |
Mechanical Load |
19 |
Time Variant Function |
20 |
Controller |
22 |
Grid Infeed |
102 |
Harmonic Current Injection Source |
Dialog Prompts¶
Reasons
Integer Value |
Description |
|---|---|
0 |
No particular reason |
1 |
General warning |
2 |
Voltage convergence |
>2 |
An error of some sort |
Buttons
The integer value represents a bitflag. So for example, the integer value could be 3, meaning there’s ‘Yes’ and ‘No’ buttons (because 1[Yes] + 2[No] = 3[Yes/No]) read up about bitflags for more information.
Integer Value |
Description |
|---|---|
0 |
No buttons |
1 |
‘Yes’ button |
2 |
‘No’ button |
4 |
‘OK’ button |
8 |
‘Cancel’ button |
16 |
‘Help’ button |
32 |
‘Abort’ button |
64 |
‘Retry’ button |
128 |
‘Ignore’ button |
256 |
‘All’ button |