InjectionRecords Module
This module contains all Harmonic Injection record information for passing data to and from the ERACS Harmonic Injection calculation engine.
- class THISetupData(*args)
The setup object for Harmonic Injection. This class contains the record structure for passing in the harmonic injection setup data to the module.
- Inherits
- property StudyTitle
Harmonic Injection study title (maximum of 80 characters).
- Type
str.
- Writable
True.
- property NInjections
Number of harmonic current injection sources.
- Type
int.
- Writable
True.
- property HarmOff
Harmonic Offset for study (-10 <= HarmOff <= 10).
- Type
float.
- Writable
True.
- property TripInd
Triplen indicator (0 - Positive Sequence Connectivity, 1 - Zero Sequence Connectivity).
- Type
int.
- Writable
True.
- property OutputOption
Output option (1 - None, 2 - Full, 3 - Elements Above Thresholds).
- Type
int.
- Writable
True.
- property cLimit
Current threshold (0 <= cLimit <= 200).
- Type
float.
- Writable
True.
- property vLimit
Voltage threshold (0 <= vLimit <= 200).
- Type
float.
- Writable
True.
- property TIFInd
TIF weighting factors (0 - 1935 Values, 1 - IEEE 519-1992, 2 - CCITT Vol.VI).
- Type
int.
- Writable
True.
- property StudyType
Indicates the type of study (3 - Injection, 8 - G5/4 (unsupported)).
- Type
int.
- Writable
True.
- property PCCBusbar
Sequence number of busbar adjacent to selected Point of Common Coupling (PCC).
- Type
int.
- Writable
True.
- property PCCTypecode
The typecode of the Point of Common Coupling (PCC).
- Type
int.
- Writable
True.
- property PCCSeqnum
The sequence number of the Point of Common Coupling (PCC).
- Type
int.
- Writable
True.
- SetDefaults()
Sets the default values for all setup data for the Harmonic Injection study, this sets the values in the underlying ctypes record.
- class THITxData(*args)
The transformer data object which includes q and e constants required by the “Factor K” calculation. If both values are zero, the factor is not calculated.
- Inherits
- property SeqNum
Sequence number of the transformer.
- Type
int.
- Writable
True.
- property q
Exponential winding constant.
- Type
float.
- Writable
True.
- property e
Eddy current loss at fundamental.
- Type
float.
- Writable
True.
- property CoreConstInd
Indicates whether the transformer is core-type (0 - Shell type, 1 - Core type).
- Type
float.
- Writable
True.
- SetDefaults()
Sets the default values for the harmonic impedance profile data.
- LoadFromDict(ATxDictionary: dict)
A dictionary is passed in, and desired key-value pairs populate the properties exposed by THITxData.
- Parameters
ATxDictionary (dict) – A dictionary containing data for the transformer.
- Raises
TEracsDataError – If the dictionary is missing required keys.
- class THIInjectionData(*args)
The harmonic current injection source object for passing injection data to the Harmonic Injection module. This is for adding injection sources to the study.
- Inherits
- property Description
The description for the injection data.
- Type
String (40).
- Writable
True.
- property Units
The units used for the harmonic values. Should be one of the following: 0 - Relative, 1 - Absolute.
- Type
int.
- Writable
True.
- property ScaleFact
The calculation program will multiply each magnitude value by this per unit scaling factor.
- Type
float.
- Writable
True.
- property NHarm
Number of harmonic values.
- Type
int.
- Writable
True.
- property HarmValues
Data for each harmonic value.
- Type
Array.
- Writeable
True.
- SetDefaults()
Sets the default values for the harmonic injection data.
- LoadFromDict(AInjectionDict: dict)
A dictionary is passed in, and desired key-value pairs populate the corresponding properties.
- Parameters
AInjectionDict (dict) – A dictionary containing necessary injection data.
- Raises
TEracsDataError – If the dictionary is missing expected keys.
- class THIInjResult(*args)
Contains a _THIInjResultComplex object which is passed into the Harmonic Injection DLL and populated with results. This class simplifies access to the results. All properties are read-only.
- property TypeCode
Typecode of the element acting as the injection source.
- Type
int.
- Writable
False.
- property D
Harmonic distortion, %
- Type
float.
- Writable
False.
- property IFund
Fundamental current magnitude (A).
- Type
float.
- Writable
False.
- property IkAFund
Fundamental current magnitude (kA).
- Type
float.
- Writable
False.
- property IFundAngle
Fundamental current angle (degrees).
- Type
float.
- Writable
False.
- property IFundAngleRad
Fundamental current angle (radians).
- Type
float.
- Writable
False.
- property Ivalues
Injected current values for each harmonic number.
- Type
list.
- Writable
False.
- class THIBusResult(*args)
Contains a _THIBusResultComplex object which is passed into the Harmonic Injection DLL and populated with busbar results.
- property D
Harmonic distortion %.
- Type
float.
- Writable
False.
- property TFF
Telephone Form Factor.
- Type
float.
- Writable
False.
- property BusAng
Busbar angle (degrees).
- Type
float.
- Writable
False.
- property BusAngRad
Busbar angle (radians).
- Type
float.
- Writable
False.
- property VFund
Fundamental voltage magnitude (kV).
- Type
float.
- Writable
False.
- property VvFund
Fundamental voltage magnitude (V).
- Type
float.
- Writable
False.
- property VFundAngle
Fundamental voltage angle (degrees).
- Type
float.
- Writable
False.
- property VFundAngleRad
Fundamental voltage angle (radians).
- Type
float.
- Writable
False.
- property Vvalues
Voltage value for each harmonic number.
- Type
Array.
- Writable
False.
- class THIBranchResult(*args)
Contains a _THIBranchResultComplex object which is passed into the Harmonic Injection DLL and populated with branch (transmission line/cable/series element) results.
- property End1
Results for the first end.
- Type
_THIEndResultComplex.
- Writable
False.
- property End2
Results for the second end.
- Type
_THIEndResultComplex.
- Writable
False.
- class THITxResult(*args)
Contains a _THITxResultComplex object which is passed into the Harmonic Injection DLL and populated with transformer results.
- property Winding1
Results for the first winding.
- Type
_THIWindingResultComplex.
- Writable
False.
- property Winding2
Results for the second winding.
- Type
_THIWindingResultComplex.
- Writable
False.
- property Winding3
Results for the third winding.
- Type
_THIWindingResultComplex.
- Writable
False.
- property Winding4
Results for the fourth winding.
- Type
_THIWindingResultComplex.
- Writable
False.
- class THIMachineResult(*args)
Contains a _THIMachineResultComplex object which is passed into the Harmonic Injection DLL and populated with induction machine/synchronous machine/shunt results.
- property D
Harmonic distortion %.
- Type
float.
- Writable
False.
- property IFund
Fundamental magnitude (A).
- Type
float.
- Writable
False.
- property IkAFund
Fundamental magnitude (kA).
- Type
float.
- Writable
False.
- property IFundAngle
Fundamental angle (degrees).
- Type
float.
- Writable
False.
- property IFundAngleRad
Fundamental angle (radians).
- Type
float.
- Writable
False.
- property Ivalues
Current values for each harmonic number.
- Type
list.
- Writable
False.