LoadflowRecords Module

This module contains all Loadflow record information for passing data to and from the ERACS Loadflow calculation engine.

class TLFSetUpData(*args)

A simple class which sits between the user and the complex ctypes record structure class, _TLFSetUpDate, which holds all of the data passed to Loadflow at the beginning of the study to set up the calculation (using the SetupCalculation procedure).

Inherits: Global.TEracsEngineInterfaceSetupData.

property BaseMva

System study base, MVA.

Type: float.
Writable: True.

property BaseFrequency

System frequency (Hz).

Type: float.
Writable: True.

property ConvergenceTolerance

Convergence tolerance (pu).

Type: float.
Writable: True.

property NumberOfIterations

Number of iterations.

Type: int.
Writable: True.

property OverloadThreshold

Overload threshold (pu).

Type: float.
Writable: True.

property PMultiplier

Shunt real power multiplier.

Type: float.
Writable: True.

property QMultiplier

Shunt reactive power multiplier.

Type: float.
Writable: True.

property TapSelector

Tap changer selector.

Type: int.
Writable: True.

property BusLowVoltLimit

Busbar lower voltage limit.

Type: float.
Writable: True.

property BusHighVoltLimit

Busbar upper voltage limit.

Type: float.
Writable: True.

property UsePVvoltForSlack

Indicates whether target voltage of a P,V-type generator should be used as target voltage when a P,V-type generator is converted to a slack-type generator.

Type: bool.
Writable: True.

property TxBaseVoltage

Indicates the voltage base to be used for transformer impedance (i.e. Winding Rating or Tapped Voltage).

Type: int.
Writable: True.

property InitialTapPosition

Indicates the initial tap position to be used for the Loadflow calculation.

Type: int.
Writable: True.

property GridFaultLevelSelection

Indicates the grid infeed fault level selection for the Loadflow calculation.

Type: int.
Writable: True.

SetDefaults()

This method should be called to set the default values before loading up the next set of data. This class’s object is re-used for all elements, so restoring default values beforehand is important to avoid bugs.

Raises: TEracsDataError – If any of the keys are missing.

LoadParameters(AParametersDictionary, AEracsVersion='3.11.0')

Loads all data from the Loadflow parameter record into SetUpData.

Parameters: AParametersDictionary (dict) – Dictionary containing Loadflow parameter data.
Raises: TEracsDataError – If the dictionary is missing required keys.

LoadHeaders(AHeaderDictionary)

Loads all data from the header record into SetUpData.

Parameters: AHeaderDictionary (dict) – A header dictionary containing all header related data.
Raises: TEracsDataError – If the dictionary is missing required keys.

class TLFBusData(*args)

A simple class for the TLFBusData ctypes record structure class. This class provides an easier way of passing data into loadflow without getting involved with ctypes.

Inherits: Global.TEracsEngineInterfaceDataElement.

property RatedKV

Nominal voltage (kV).

Type: float.
Writable: True.

property Frequency

Frequency (Hz).

Type: float.
Writable: True.

property ThreePhaseRating

Three phase fault rating (MVA).

Type: float.
Writable: True.

property SinglePhaseRating

Single phase fault rating (MVA).

Type: float.
Writable: True.

SetDefaults(): Sets the default values for certain attributes inside the TLFBusData object.

LoadFromDict(ABusbarDictionary)

A dictionary is passed in, and desired key-value pairs populate the corresponding fields using the defined properties.

Parameters: ABusbarDictionary (dict) – A dictionary containing data for a busbar.
Raises: TEracsDataError – If busbar dictionary is missing required keys.

class TLFLineCableData(*args)

A simple class for easy access to the TLFLineCableData class, removing the need to learn about ctypes, since this simple class handles type conversion between ctypes and Python native data types.

Inherits: Global.TEracsEngineInterfaceDataElementWithLibrary.

property TypeCode

Set Typecode to be either a normal cable, or an embedded cable, or a transmission line.

Type: int.
Writable: True.

property Busbar1

Sequence number of the first busbar connection.

Type: int.
Writable: True.

property Busbar2

Sequence number of the second busbar connection.

Type: int.
Writable: True.

property ConnectionIndicator1

Connection indicator for busbar1.

Type: int.
Writable: True.

property ConnectionIndicator2

Connection indicator for busbar2.

Type: int.
Writable: True.

property NumberOfCircuits

Number of circuits.

Type: int.
Writable: True.

property Length

Length of transmission line/cable.

Type: float.
Writable: True.

property Rating

Transmission Line/Cable rating (kA).

Type: float.
Writable: True.

property RatedKV

Rated voltage (kV).

Type: float.
Writable: True.

property ConversionIndicator

Conversion indicator.

Type: int.
Writable: True.

property R

Positive/Negative sequence series resistance.

Type: float.
Writable: True.

property X

Positive/Negative sequence series reactance.

Type: float.
Writable: True.

property B

Positive/Negative sequence shunt susceptance.

Type: float.
Writable: True.

property Rz

Zero sequence series resistance.

Type: float.
Writable: True.

property Xz

Zero sequence series reactance.

Type: float.
Writable: True.

property Bz

Zero sequence shunt susceptance.

Type: float.
Writable: True.

SetDefaults(): Sets the default values for certain attributes inside the TLFLineCableData Object.

LoadFromDict(ALineCableDictionary)

A dictionary is passed in, and desired key-value pairs populate the corresponding attributes.

Parameters: ALineCableDictionary – A dictionary containing data for a Transmission Line/Cable element.
Raises: TEracsDataError – If dictionary is missing required keys.

LoadAsEmbedded(AEmbeddedCableDict, AParentDict)

Does the same as LoadFromDict, but loads embedded data for embedded cables instead.

Parameters

AEmbeddedCableDict (dict) – Dictionary containing embedded cable data.
AParentDict (dict) – Parent element dictionary.

Raises

TEracsDataError – If dictionaries are missing required keys.

class TLFCableData(*args)

Cable data for a Loadflow study.

Inherits: TLFLineCableData.

SetDefaults(): Sets the default values for certain attributes inside the TLFLineCableData Object.

class TLFTransmissionLineData(*args)

Transmission line data for a Loadflow study.

Inherits: TLFLineCableData.

SetDefaults(): Sets the default values for certain attributes inside the TLFLineCableData Object.

class TLFSeriesElementData(*args)

A simple class for easy access to _TLFSeriesElementData, removing the need to use ctypes directly.

Inherits: Global.TEracsEngineInterfaceDataElementWithLibrary.

property Busbar1

Sequence number of the first busbar connection.

Type: int.
Writable: True.

property Busbar2

Sequence number of the second busbar connection.

Type: int.
Writable: True.

property ConnectionIndicator1

Connection indicator for busbar1.

Type: int.
Writable: True.

property ConnectionIndicator2

Connection indicator for busbar2.

Type: int.
Writable: True.

property NumberInParallel

Number in parallel.

Type: int.
Writable: True.

property MVA

Rating (MVA).

Type: float.
Writable: True.

property RatedKV

Rated voltage (kV).

Type: float.
Writable: True.

property ConversionIndicator

Conversion indicator.

Type: int.
Writable: True.

property R

Positive/Negative sequence series resistance.

Type: float.
Writable: True.

property X

Positive/Negative sequence series reactance.

Type: float.
Writable: True.

property Type

Type of series element (capacitor, inductor, resistor).

Type: int.
Writable: True.

SetDefaults(): Sets the default values for certain attributes inside the _TLFSeriesElementData Object.

LoadFromDict(ASeriesElementDictionary)

A dictionary is passed in, and desired key-value pairs populate the corresponding attributes in the _TLFSeriesElementData object.

Parameters: ASeriesElementDictionary (dict) – A dictionary containing data for a series element.

class TLFTapData(*args)

Simple class for easier access to _TLFTapData class. This object should be populated using the LoadFromDict method, and passed to the LoadTapData low-level Loadflow procedure.

Inherits: Global.TEracsEngineInterfaceDataElement.

property TransformerNumber

Sequence number of the transformer the tap changer is connected to.

Type: int.
Writable: True.

property WindingNumber

Transformer winding number tap changer is attached to.

Type: int.
Writable: True.

property ControlBusbar

Sequence number of the control busbar.

Type: int.
Writable: True.

property AdjacentBusbar

Sequence number of the adjacent busbar.

Type: int.
Writable: True.

property LowerTargetVoltage

Lower target voltage (pu).

Type: float.
Writable: True.

property UpperTargetVoltage

Upper target voltage (pu).

Type: float.
Writable: True.

property MinTap

Minimum tap (%).

Type: float.
Writable: True.

property MaxTap

Maximum tap (%).

Type: float.
Writable: True.

property TapIncrement

Tap increment (%).

Type: float.
Writable: True.

property CompoundingSelector

Compounding indicator (None, pu on winding rating, pu on study base, Ohms).

Type: int.
Writable: True.

property CompoundingR

Compounding resistance.

Type: float.
Writable: True.

property CompoundingX

Compounding reactance.

Type: float.
Writable: True.

property AddTaps

Number of additional taps.

Type: int.
Writable: True.

property PrevTap

Previous tap position.

Type: float.
Writable: True.

property PrevTapNumber

Previous tap number.

Type: int.
Writable: True.

SetDefaults(): Sets the default values for certain attributes inside the TLFTapChangerData Object.

LoadFromDict(ATapChangerDictionary)

A dictionary is passed in, and desired key-value pairs populate the corresponding attributes in the _TLFTapData Object.

Parameters: ATapChangerDictionary (dict) – A dictionary containing data for a tap changer.
Raises: TEracsDataError – If the tap dictionary is missing required keys.

class TLFNeutralData(*args)

Simple class for sending neutral earthing data to Loadflow.

Inherits: Global.TEracsEngineInterfaceDataElement.

property Resistance

Neutral earthing resistance (Ohms).

Type: float.
Writable: True.

property Reactance

Neutral earthing reactance (Ohms).

Type: float.
Writable: True.

SetDefaults(): Does nothing.

LoadFromDict(ANeutralEarthDict)

A dictionary is passed in, and desired key-value pairs populate the corresponding fields in the _TLFNeutralDataComplex object.

Parameters: ANeutralEarthDict (dict) – A dictionary containing data for a Neutral Earth.
Raises: TEracsDataError – If the neutral earthing dictionary is missing required keys.

class TLFWindingData(*args)

Transformer winding data to be passed to Loadflow. Simplifies access to avoid use of ctypes.

Inherits: Global.TEracsEngineInterfaceDataElement.

property Busbar

Sequence number of the busbar connection.

Type: int.
Writable: True.

property ConnectionIndicator

Connection indicator for the busbar connection.

Type: int.
Writable: True.

property TapPosition

Off load tap changer nominal tap position (%).

Type: float.
Writable: True.

property MVA

Rated MVA.

Type: float.
Writable: True.

property RatedKV

Rated voltage (kV).

Type: float.
Writable: True.

property WindingType

Transformer winding type (delta, star, grounded star, zig-zag, grounded zig-zag).

Type: int.
Writable: True.

property Angle

Transformer winding angle (degrees).

Type: float.
Writable: True.

property PosNegSequenceResistance

Positive/Negative sequence resistance.

Type: float.
Writable: True.

property PosNegSequenceReactance

Positive/Negative sequence reactance.

Type: float.
Writable: True.

property ZeroSequenceResistance

Zero sequence resistance.

Type: float.
Writable: True.

property ZeroSequenceReactance

Zero sequence reactance.

Type: float.
Writable: True.

property Neut

Neutral earth object.

Type: _TLFNeutralDataComplex.
Writable: False.

property Cable

Cable object.

Type: _TLFLineCableDataComplex.
Writable: False.

ClearEmbeddedElements(): Clear any neutral earth and embedded cable object references.

AssignCable(): Assign embedded cable element reference.

SetDefaults(): Does nothing.

LoadFromDict(AWindingDict, AEmbedded=False)

A dictionary is passed in, and desired key-value pairs populate the corresponding fields in the _TLFWindingDataComplex object.

Parameters

AWindingDict (dict) – A dictionary containing data for a transformer winding.
AEmbedded (bool) – (Optional) Whether the winding is part of an embedded transformer.

Raises

TEracsDataError – If the winding dictionary is missing required keys.

class TLFTxData(*args)

Transformer data to be passed to Loadflow. Simplifies access to avoid use of ctypes.

Inherits: Global.TEracsEngineInterfaceDataElementWithLibrary.

property NumberOfCircuits

Number of circuits.

Type: int.
Writable: True.

property NumberOfWindings

Number of windings.

Type: int.
Writable: True.

property ConversionIndicator

Conversion indicator.

Type: int.
Writable: True.

property Winding1

Transformer winding 1 object reference.

Type: TLFWindingData.
Writable: False.

property Winding2

Transformer winding 2 object reference.

Type: TLFWindingData.
Writable: False.

property Winding3

Transformer winding 3 object reference.

Type: TLFWindingData.
Writable: False.

property Winding4

Transformer winding 4 object reference.

Type: TLFWindingData.
Writable: False.

property CoreTypeIndicator

Indicates whether the transformer is core-type and whether the effects of leakage to the tank should be modelled.

Type: int.
Writable: True.

property CoreTypePseudoDeltaResistance

Zero sequence resistance.

Type: float.
Writable: True.

property CoreTypePseudoDeltaReactance

Zero sequence reactance.

Type: float.
Writable: True.

property DataType

Indicates whether the transformer was entered in GUI using nameplate data entry facility.

Type: int.
Writable: True.

property VectorGroup

Defines the transformer’s vector group, for example ‘Dyn11’.

Type: str.
Writable: True.

ClearWindings(): Clears all previously loaded transformer winding data.

SetDefaults(): Sets default values for the transformer.

LoadFromDict(ATxDict, AEmbedded=False)

A dictionary is passed in, and desired key-value pairs populate the corresponding fields in the _TLFTxDataComplex object.

Parameters

ATxDict (dict) – A dictionary containing data for a Transformer.
AEmbedded (bool) – (Optional) Whether the transformer is embedded in a generator.

Raises

TEracsDataError – If the transformer dictionary is missing required keys.

class TLFIndMachData(*args)

Induction machine data to be passed to Loadflow. Simplifies access to avoid use of ctypes.

Inherits: Global.TEracsEngineInterfaceDataElementWithLibrary.

property Busbar

Sequence number of the busbar connection.

Type: int.
Writable: True.

property ConnectionIndicator

Connection indicator for the busbar connection.

Type: int.
Writable: True.

property NumberOfCircuits

Number of circuits.

Type: int.
Writable: True.

property MachineType

Machine type (motor, generator).

Type: int.
Writable: True.

property Power

Input power.

Type: float.
Writable: True.

property MVA

Rated MVA.

Type: float.
Writable: True.

property MW

Rated Power (MW).

Type: float.
Writable: True.

property RatedKV

Rated voltage (kV).

Type: float.
Writable: True.

property RatedHZ

Rated frequency (Hz).

Type: float.
Writable: True.

property ConversionIndicator

Conversion indicator (pu on rating, or Ohms).

Type: int.
Writable: True.

property Rs

Stator resistance.

Type: float.
Writable: True.

property Xs

Stator reactance.

Type: float.
Writable: True.

property Xm

Magnetising reactance.

Type: float.
Writable: True.

property Rrs

Rotor stationary resistance.

Type: float.
Writable: True.

property Xrs

Rotor stationary reactance.

Type: float.
Writable: True.

property Rrr

Rotor running resistance.

Type: float.
Writable: True.

property Xrr

Rotor running reactance.

Type: float.
Writable: True.

property RotorIndicator

Rotor impedance indicator.

Type: int.
Writable: True.

property CablePtr

Cable object pointer.

Type: ctypes.pointer.
Writable: False.

property Cable

Cable object.

Type: _TLFLineCableDataComplex.
Writable: False.

property MP_R

Pointer to machine’s rotor resistance (multi-point curve).

Type: _TLFMPDataComplex
Writable: False.

property MP_X

Pointer to machine’s rotor reactance (multi-point curve).

Type: _TLFMPDataComplex
Writable: False.

ClearEmbeddedElements(): Clears any cable object references.

AssignEmbeddedCable(): Assigns embedded cable element.

AssignEmbeddedMultiPointR(): Assigns multi-point resistive element.

AssignEmbeddedMultiPointX(): Assigns multi-point reactive element.

SetDefaults(): Sets defaults for the induction machine data object.

LoadFromDict(AIndMachDict)

A dictionary is passed in, and desired key-value pairs populate the corresponding fields in the _TLFIndMachDataComplex object.

Parameters: AIndMachData (dict) – A dictionary containing data for an induction machine.
Raises: TEracsDataError – If the induction machine dictionary is missing required keys.

LoadCurveFromDict(ACurveDict, AObjectPtr)

Load curve data into the multi-point curve objects.

Parameters

ACurveDict (dict) – The curve data dictionary to read from.
AObjectPtr (_TLFMPDataComplex) – The object to write data to.

Raises

TEracsDataError – If the curve dictionary is missing required keys.

class TLFInfGenData(*args)

Infinite generator (grid infeed) data to be passed to Loadflow. Simplifies access to avoid use of ctypes.

Inherits: Global.TEracsEngineInterfaceDataElement.

property Busbar

Sequence number of the busbar connection.

Type: int.
Writable: True.

property ConnectionIndicator

Connection indicator for the busbar connection.

Type: int.
Writable: True.

property TargetVoltage

Target terminal voltage magnitude (pu).

Type: float.
Writable: True.

property ThreePhaseFault

Three phase fault infeed (MVA).

Type: float.
Writable: True.

property ThreePhaseX2R

Three phase X/R ratio.

Type: float.
Writable: True.

property SinglePhaseFault

Single phase fault infeed (MVA).

Type: float.
Writable: True.

property SinglePhaseX2R

Single phase X/R ratio.

Type: float.
Writable: True.

SetDefaults(): Sets the default values for certain attributes inside the TLFInfGenData Object.

LoadFromDict(AInfGenDictionary, AFaultLevelSel: int)

A dictionary is passed in, and desired key-value pairs populate the corresponding fields in the _TLFInfGenData object.

Parameters

AInfGenDictionary (dict) – A dictionary containing data for an Infinite Generator
AFaultLevelSel (int) – The fault level selection (max = 0, 1 = min, 2 = other)

Raises

TEracsDataError – If the infinite generator dictionary is missing required keys.

class TLFSyncMachData(*args)

Synchronous machine data to be passed to Loadflow. Simplifies access to avoid use of ctypes directly.

Inherits: Global.TEracsEngineInterfaceDataElementWithLibrary.

property Busbar

Sequence number of the busbar connection.

Type: int.
Writable: True.

property ConnectionIndicator

Connection indicator for the busbar connection.

Type: int.
Writable: True.

property GeneratorType

Generator type (Slack / P,V / P,Q / V,Angle).

Type: int.
Writable: True.

property TargetVoltage

Target terminal voltage magnitude (pu).

Type: float.
Writable: True.

property TargetAngle

Target voltage angle (degrees).

Type: float.
Writable: True.

property MachineType

Machine type (motor, generator).

Type: int.
Writable: True.

property RealPower

Target real power (MW).

Type: float.
Writable: True.

property ReactivePower

Target reactive power (MVAr).

Type: float.
Writable: True.

property NumberOfCircuits

Number of machines in parallel.

Type: int.
Writable: True.

property MVA

Rated MVA.

Type: float.
Writable: True.

property MW

Rated Power (MW).

Type: float.
Writable: True.

property RatedKV

Rated Voltage (kV).

Type: float.
Writable: True.

property PositiveSequenceResistance

Positive sequence resistance (pu).

Type: float.
Writable: True.

property PositiveSequenceReactance

Positive sequence reactance (pu).

Type: float.
Writable: True.

property NegativeSequenceResistance

Negative sequence resistance (pu).

Type: float.
Writable: True.

property NegativeSequenceReactance

Negative sequence reactance (pu).

Type: float.
Writable: True.

property ZeroSequenceResistance

Zero sequence resistance (pu).

Type: float.
Writable: True.

property ZeroSequenceReactance

Zero sequence reactance (pu).

Type: float.
Writable: True.

property NeutPtr

Neutral earth object pointer.

Type: ctypes.pointer.
Writable: False.

property Neut

Neutral earth object.

Type: _TLFNeutralDataComplex.
Writable: False.

property CablePtr

Embedded Cable object pointer.

Type: ctypes.pointer.
Writable: False.

property Cable

Embedded Cable object.

Type: _TLFLineCableDataComplex.
Writable: False.

property TxPtr

Embedded Transformer object pointer.

Type: ctypes.pointer.
Writable: False.

property Tx

Embedded Transformer object.

Type: _TLFTxDataComplex.
Writable: False.

property RemoteBus

Sequence number of the remote busbar.

Type: int.
Writable: True.

ClearEmbeddedElements(): Clears any neutral earth, embedded cable, and embedded transformer object references.

AssignEmbeddedCable(): Assigns embedded cable element.

AssignEmbeddedNeutral(): Assigns embedded neutral earth element.

AssignEmbeddedTransformer(): Assigns embedded transformer element.

SetDefaults(): Sets the typecode to that of a synchronous machine.

LoadFromDict(ASyncMachDict)

A dictionary is passed in, and desired key-value pairs populate the corresponding fields in the _TLFSyncMachDataComplex object.

Parameters: ASyncMachDict (dict) – A dictionary containing data for a Synchronous Machine.
Raises: TEracsDataError – If the synchronous machine dictionary is missing required keys.

class TLFShuntData(*args)

Shunt data to be passed to Loadflow. Simplifies access to avoid use of ctypes.

Inherits: Global.TEracsEngineInterfaceDataElementWithLibrary.

property Busbar

Sequence number of the busbar connection.

Type: int.
Writable: True.

property ConnectionIndicator

Connection indicator for the busbar connection.

Type: int.
Writable: True.

property ShuntType

Shunt type (fixed PQ, fixed admittance, fixed impedance, constant current, inco arc furnace, controlled shunt).

Type: int.
Writable: True.

property NumberInParallel

Number in parallel.

Type: int.
Writable: True.

property MVA

Rating (MVA).

Type: float.
Writable: True.

property RatedVoltage

Rated voltage (kV).

Type: float.
Writable: True.

property ValP1

Depends on shunt type, could be one of these units (MW, MVA, kW, kVA, G, R, Ir).

Type: float.
Writable: True.

property ValP2

Depends on shunt type, could be one of these units (MVAr, pf, MW, kVAr, kW, B, X, Ij).

Type: float.
Writable: True.

property ValZ1

Depends on shunt type, could be one of these units (Gz, Rz).

Type: float.
Writable: True.

property ValZ2

Depends on shunt type, could be one of these units (Bz, Xz).

Type: float.
Writable: True.

property ValP3

Depends on shunt type, could be one of these units (Pmult, Smult, Ymult, Zmult, Imult, MVARat).

Type: float.
Writable: True.

property ValP4

Depends on shunt type, could be one of these units (Qmult, Pmult).

Type: float.
Writable: True.

property ControlBusbar

Sequence number of the control busbar.

Type: int.
Writable: True.

property ControlBranch

Sequence number of the control branch, zero if not used.

Type: int.
Writable: True.

property ControlBranchType

Indicates type of branch.

Type: int.
Writable: True.

property NumberOfExternalParameters

Number of external parameters.

Type: int.
Writable: True.

SetDefaults(): Sets the default values for certain attributes inside the _TLFShuntData object.

LoadFromDict(AShuntDictionary)

A dictionary is passed in, and desired key-value pairs populate the corresponding field in the _TLFShuntData object.

Parameters: AShuntDictionary (dict) – A dictionary containing data for a Shunt.
Raises: TEracsDataError – If the shunt dictionary is missing required keys.

class TLFBusSectionData(*args)

Simple class for easier access to _TLFBusSectionDataComplex class. This object should be populated using the LoadFromDict method, and used in Loadflow easy.

Inherits: Global.TEracsEngineInterfaceDataElement.

property Busbar1

Sequence number of the first busbar connection.

Type: int.
Writable: True.

property Busbar2

Sequence number of the second busbar connection.

Type: int.
Writable: True.

property ConnectionIndicator

Connection indicator along the bus section.

Type: int.
Writable: True.

property ThreePhaseCapacity

Three phase breaking capacity (MVA).

Type: float.
Writable: True.

property SinglePhaseCapacity

Single phase breaking capacity (MVA).

Type: float.
Writable: True.

SetDefaults(): Sets the default values for certain attributes inside the _TLFBusSectionDataComplex object.

LoadFromDict(ABusSectionDictionary)

A dictionary is passed in, and desired key-value pairs populate the corresponding fields in the _TLFBusSectionDataComplex object.

Parameters: ABusSectionDictionary (dict) – A dictionary containing data for a Bus Section
Raises: TEracsDataError – If the bus section dictionary is missing required keys.

class TLFSummaryResults(*args)

Contains a _TLFSummaryResultsComplex object which is passed into the Loadflow DLL and populated with results. This class simplifies access to the results. All properties are read-only.

Inherits: Global.TEracsEngineInterfaceResult.

StoreIntoDictionary(AOutputDictionary: dict)

Store all information from the underlying object into a dictionary.

Parameters: AOutputDictionary (dict) – The dictionary to populate with field data.
Raises: TEracsArgumentError – If first argument is not a dict.

property ResX

The X coordinate for the summary results box.

Type: int.
Writable: True.

property ResY

The Y coordinate for the summary results box.

Type: int.
Writable: True.

property Caption

The caption for the summary results box.

Type: str.
Writable: True.

property Pg

Total generated real power (MW).

Type: float.
Writable: False.

property Qg

Total generated reactive power (MVAr).

Type: float.
Writable: False.

property PLoad

Total load (MW).

Type: float.
Writable: False.

property QLoad

Total load (MVAr).

Type: float.
Writable: False.

property PLoss

Total loss (MW).

Type: float.
Writable: False.

property QLoss

Total loss (MVAr).

Type: float.
Writable: False.

property Base

Base/system (MVA).

Type: float.
Writable: False.

property Frequency

System base frequency (Hz).

Type: float.
Writable: False.

property MaxVoltage

Maximum busbar voltage (pu).

Type: float.
Writable: False.

property MaxVoltageBusbar

Name of busbar with maximum voltage.

Type: str.
Writable: False.

property MinVoltage

Minimum busbar voltage (pu).

Type: float.
Writable: False.

property MinVoltageBusbar

Name of busbar with minimum voltage.

Type: str.
Writable: False.

property MaxThreePhaseFault

Maximum three phase fault level (kA).

Type: float.
Writable: False.

property MaxThreePhaseFaultBusbar

Name of busbar with maximum three phase fault level.

Type: str.
Writable: False.

property MinThreePhaseFault

Minimum three phase fault level (kA).

Type: float.
Writable: False.

property MinThreePhaseFaultBusbar

Name of busbar with minimum three phase fault level.

Type: str.
Writable: False.

property NumberOfIterations

Number of iterations taken to solve Loadflow.

Type: int.
Writable: False.

property ConvergenceError

Convergence error.

Type: float.
Writable: False.

class TLFBusResult(*args)

Contains a _TLFBusResultComplex object which is passed into the Loadflow DLL and populated with results. This class simplifies access to the results. All properties are read-only.

Inherits: Global.TEracsEngineInterfaceResultElement.

property Vpu

Voltage magnitude (pu).

Type: float.
Writable: False.

property V

Voltage magnitude (kV).

Type: float.
Writable: False.

property ThetaV

Voltage angle (degrees).

Type: float.
Writable: False.

property Vdiff

Voltage difference (%).

Type: float.
Writable: False.

property Frequency

Frequency (Hz).

Type: float.
Writable: False.

property PLoad

Total load real power (MW).

Type: float.
Writable: False.

property QLoad

Total load reactive power (MVAr).

Type: float.
Writable: False.

property Pg

Total generated real power (MW).

Type: float.
Writable: False.

property Qg

Total generated reactive power (MVAr).

Type: float.
Writable: False.

property ThreePhaseFaultLevel

Three phase fault level (MVA).

Type: float.
Writable: False.

property ThreePhaseFaultCurrent

Three phase fault current (kA).

Type: float.
Writable: False.

property ThreePhaseX2R

Three phase X/R ratio.

Type: float.
Writable: False.

property SinglePhaseFaultLevel

Single phase fault level (MVA).

Type: float.
Writable: False.

property SinglePhaseFaultCurrent

Single phase fault current (kA).

Type: float.
Writable: False.

property SinglePhaseX2R

Single phase X/R ratio.

Type: float.
Writable: False.

property PositiveDrivingMagnitude

Magnitude of positive sequence driving point impedance (pu).

Type: float.
Writable: False.

property PositiveDrivingAngle

Angle of positive sequence driving point impedance (degrees).

Type: float.
Writable: False.

property NegativeDrivingMagnitude

Magnitude of negative sequence driving point impedance (pu).

Type: float.
Writable: False.

property NegativeDrivingAngle

Angle of negative sequence driving point impedance (degrees).

Type: float.
Writable: False.

property ZeroDrivingMagnitude

Magnitude of zero sequence driving point impedance (pu).

Type: float.
Writable: False.

property ZeroDrivingAngle

Angle of zero sequence driving point impedance (degrees).

Type: float.
Writable: False.

property Flag

Voltage out of range flag.

Type: int.
Writable: False.

class TLFLineResult(*args)

Contains a _TLFLineResultComplex object which is passed into the Loadflow DLL and populated with results. This class simplifies access to the results. All properties are read-only.

Inherits: Global.TEracsEngineInterfaceResultElement.

property End1

Containing all results for first connection point (p, q, s, i, thetai, pf, percentload, powerdir).

Type: dict.
Writable: False.

property End2

Containing all results for second connection point (p, q, s, i, thetai, pf, percentload, powerdir).

Type: dict.
Writable: False.

property PLoss

Real power loss (MW).

Type: float.
Writable: False.

property QLoss

Reactive power loss (MVAr).

Type: float.
Writable: False.

property VoltageDropPu

Voltage drop (pu).

Type: float.
Writable: False.

property VoltageDropKv

Voltage drop (kV).

Type: float.
Writable: False.

property Flag

Overload flag, if greater than zero the element should be highlighted.

Type: int.
Writable: False.

class TLFTapResult(*args)

Contains a _TLFTapResultComplex object which is passed into the Loadflow DLL and populated with results. This class simplifies access to the results. All properties are read-only.

Inherits: TEracsEngineInterfaceResultElement.

property TapNumber

Calculated on tap position number.

Type: int.
Writable: False.

property OffTap

Calculated off nominal tap position (%).

Type: float.
Writable: False.

property Flag

Overload flag, if greater than zero the element should be highlighted.

Type: int.
Writable: False.

class TLFTxResult(*args)

Contains a _TLFTxResultComplex object which is passed into the Loadflow DLL and populated with results.

Inherits: Global.TEracsEngineInterfaceResultElement.

class TLFIndMachResult(*args)

Contains a _TLFIndMachResultComplex object which is passed into the Loadflow DLL and populated with results.

Inherits: Global.TEracsEngineInterfaceResultElement.

class TLFSyncMachResult(*args)

Contains a _TLFSyncMachResultComplex object which is passed into the Loadflow DLL and populated with results.

Inherits: Global.TEracsEngineInterfaceResultElement.

class TLFShuntResult(*args)

Contains a _TLFShuntResultComplex object which is passed into the Loadflow DLL and populated with results. This class simplifies access to the results. All properties are read-only.

Inherits: Global.TEracsEngineInterfaceResultElement.

property P

Real power flow (MW).

Type: float.
Writable: False.

property Q

Reactive power flow (MVAr).

Type: float.
Writable: False.

property S

Apparent power (MVA).

Type: float.
Writable: False.

property I

Terminal current (kA).

Type: float.
Writable: False.

property ThetaI

Angle of terminal current (degrees).

Type: float.
Writable: False.

property PowerFactor

Power factor.

Type: float.
Writable: False.

property PercentLoad

Percentage loading.

Type: float.
Writable: False.

property PowerDirection

Direction of power flow.

Type: int.
Writable: False.

property Voltage

Terminal voltage magnitude (kV).

Type: float.
Writable: False.

property ThetaVoltage

Terminal voltage angle (degrees).

Type: float.
Writable: False.

property Flag

Overload flag, if greater than zero the element should be highlighted.

Type: int.
Writable: False.

class TLFBusSectionResult(*args)

Contains a _TLFBusSectionResultComplex object which is passed into the Loadflow DLL and populated with results. This class simplifies access to the results. All properties are read-only.

Inherits: Global.TEracsEngineInterfaceResultElement.

property P

Real power flow (MW).

Type: float.
Writable: False.

property Q

Reactive power flow (MVAr).

Type: float.
Writable: False.

property S

Apparent power (MVA).

Type: float.
Writable: False.

property I

Terminal current (kA).

Type: float.
Writable: False.

property ThetaI

Angle of terminal current (degrees).

Type: float.
Writable: False.

property PowerFactor

Power factor.

Type: float.
Writable: False.

property PercentLoad

Percentage loading.

Type: float.
Writable: False.

property PowerDirection

Direction of power flow.

Type: int.
Writable: False.

property Flag

Overload flag, if greater than zero the element should be highlighted.

Type: int.
Writable: False.