Impedance Module

Inheritance diagram of Impedance

Impedance calculation module for interfacing with the ERACS Harmonic Impedance engine and running studies. Note that only single point Impedance studies are supported in the Python Interface; trying to set the study type to an Impedance Survey will produce an error. Impedance Surveys can be mimicked in Python by simply running repeated studies across each busbar.

class TEracsImpedance

The low-level ERACS Impedance calculation module. Use this to run Harmonic Impedance studies, or use the TEracsImpedanceEasy class for a simplified approach.

Inherits

Harmonic.TEracsHarmonic - This module is dependent on Loadflow.

property VersionNumber

Version number of the calculation module.

Type

str.

Writable

False.

property ProgramNumber

Program number of the calculation.

Type

int.

Writable

False.

Example

1 = Loadflow

property NumberOfPoints

Number of points in the Harmonic Impedance study.

Type

int.

Writable

False.

property HarmonicValues

Harmonic values as a list.

Type

list.

Writable

False.

SetupCalculation(ASetupSimple: Eracs.ImpedanceRecords.THZSetUpData)

The second method to call in the Impedance DLL after PassTDFBlock. It passes all required calculation parameters needed to run Harmonic Impedance.

Parameters

ASetupSimple (THZSetUpData) – Object which contains a record structure holding all of the setup information and is passed to Impedance DLL.

Raises

TEracsDataError – If the injection bus is not set first.

GetResult(AResultTypeCode, AResultDictionary)

Get the next Harmonic Impedance result for a particular element specified by the result typecode.

Parameters
  • AResultTypeCode (str) – The typecode of the results, for example: ‘busbar’ or ‘summary’.

  • AResultDictionary (dict) – This dictionary is populated with the results from the study for the next item.

Returns

True if the dictionary contains a result (there were more results available).

class TEracsImpedanceEasy

The easy way of running Harmonic Impedance studies. This class contains an instance of TEracsImpedance which it uses to pass in data and extract results. The results can be accessed via properties.

Inherits

Harmonic.TEracsHarmonicEasy - All Loadflow-dependent harmonic easy calculation modules should inherit from this class.

property SummaryResults

The summary results for the Harmonic Impedance study.

Type

dict.

Writable

False.

property BusbarHarmonicImpedance

The busbar harmonic results for the study.

Type

List.TEracsListResult.

Writable

False.

property BusbarTransferCoefficient

The busbar transfer coefficient results for the study.

Type

List.TEracsListResult.

Writable

False.

property InjectionBus

Injection busbar, one of the Harmonic Impedance setup parameters.

Type

str.

Writable

True.

property HarmOff

Harmonic offset, one of the Harmonic Impedance setup parameters.

Type

int.

Writable

True.

property HarmMin

Minimum harmonic, one of the Harmonic Impedance setup parameters.

Type

int.

Writable

True.

property HarmMax

Maximum harmonic, one of the Harmonic Impedance setup parameters.

Type

int.

Writable

True.

property HarmInt

Harmonic intervals, one of the Harmonic Impedance setup parameters.

Type

int.

Writable

True.

property NumberOfPoints

Total number of points in the summary results.

Type

int.

Writable

False.

property HarmonicValues

List of all harmonic values in the summary results.

Type

list.

Writable

False.

property OutputUnits

The output units used for the harmonic values (1 = pu, 2 = Ohms).

Type

int.

Writable

True.

property StudyType

Harmonic Impedance study type, surveys are not supported and must be a single point study.

Type

int.

Writable

True.

ClearResults()

Clears all Harmonic Impedance results (usually called in the parent class RunCalc method to clear all previous results to prevent polluting the new results with the old ones).