LoadflowRecords Module¶

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

class TLFSetUpData¶

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.

BaseMva¶

System study base, MVA.

Type: Float.
Writable: True.

BaseFrequency¶

System frequency (Hz).

Type: Float.
Writable: True.

ConvergenceTolerance¶

Convergence tolerance (pu).

Type: Float.
Writable: True.

NumberOfIterations¶

Number of iterations.

Type: Integer.
Writable: True.

OverloadThreshold¶

Overload threshold (pu).

Type: Float.
Writable: True.

PMultiplier¶

Shunt real power multiplier.

Type: Float.
Writable: True.

QMultiplier¶

Shunt reactive power multiplier.

Type: Float.
Writable: True.

TapSelector¶

Tap changer selector.

Type: Integer.
Writable: True.

BusLowVoltLimit¶

Busbar lower voltage limit.

Type: Float.
Writable: True.

BusHighVoltLimit¶

Busbar upper voltage limit.

Type: Float.
Writable: True.

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: Boolean.
Writable: True.

TxBaseVoltage¶

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

Type: Integer.
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)¶

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¶

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.

RatedKV¶

Nominal voltage (kV).

Type: Float.
Writable: True.

Frequency¶

Frequency (Hz).

Type: Float.
Writable: True.

ThreePhaseRating¶

Three phase fault rating (MVA).

Type: Float.
Writable: True.

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¶

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.

TypeCode¶

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

Type: Integer.
Writable: True.

Busbar1¶

Sequence number of the first busbar connection.

Type: Integer.
Writable: True.

Busbar2¶

Sequence number of the second busbar connection.

Type: Integer.
Writable: True.

ConnectionIndicator1¶

Connection indicator for busbar1.

Type: Integer.
Writable: True.

ConnectionIndicator2¶

Connection indicator for busbar2.

Type: Integer.
Writable: True.

NumberOfCircuits¶

Number of circuits.

Type: Integer.
Writable: True.

Length¶

Length of transmission line/cable.

Type: Float.
Writable: True.

Rating¶

Transmission Line/Cable rating (kA).

Type: Float.
Writable: True.

RatedKV¶

Rated voltage (kV).

Type: Float.
Writable: True.

ConversionIndicator¶

Conversion indicator.

Type: Integer.
Writable: True.

R¶

Positive/Negative sequence series resistance.

Type: Float.
Writable: True.

X¶

Positive/Negative sequence series reactance.

Type: Float.
Writable: True.

B¶

Positive/Negative sequence shunt susceptance.

Type: Float.
Writable: True.

Rz¶

Zero sequence series resistance.

Type: Float.
Writable: True.

Xz¶

Zero sequence series reactance.

Type: Float.
Writable: True.

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¶

Cable data for a Loadflow study.

Inherits: TLFLineCableData.

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

class TLFTransmissionLineData¶

Transmission line data for a Loadflow study.

Inherits: TLFLineCableData.

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

class TLFSeriesElementData¶

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

Inherits: Global.TEracsEngineInterfaceDataElementWithLibrary.

Busbar1¶

Sequence number of the first busbar connection.

Type: Integer.
Writable: True.

Busbar2¶

Sequence number of the second busbar connection.

Type: Integer.
Writable: True.

ConnectionIndicator1¶

Connection indicator for busbar1.

Type: Integer.
Writable: True.

ConnectionIndicator2¶

Connection indicator for busbar2.

Type: Integer.
Writable: True.

NumberInParallel¶

Number in parallel.

Type: Integer.
Writable: True.

MVA¶

Rating (MVA).

Type: Float.
Writable: True.

RatedKV¶

Rated voltage (kV).

Type: Float.
Writable: True.

ConversionIndicator¶

Conversion indicator.

Type: Integer.
Writable: True.

R¶

Positive/Negative sequence series resistance.

Type: Float.
Writable: True.

X¶

Positive/Negative sequence series reactance.

Type: Float.
Writable: True.

Type¶

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

Type: Integer.
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¶

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.

TransformerNumber¶

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

Type: Integer.
Writable: True.

WindingNumber¶

Transformer winding number tap changer is attached to.

Type: Integer.
Writable: True.

ControlBusbar¶

Sequence number of the control busbar.

Type: Integer.
Writable: True.

AdjacentBusbar¶

Sequence number of the adjacent busbar.

Type: Integer.
Writable: True.

LowerTargetVoltage¶

Lower target voltage (pu).

Type: Float.
Writable: True.

UpperTargetVoltage¶

Upper target voltage (pu).

Type: Float.
Writable: True.

MinTap¶

Minimum tap (%).

Type: Float.
Writable: True.

MaxTap¶

Maximum tap (%).

Type: Float.
Writable: True.

TapIncrement¶

Tap increment (%).

Type: Float.
Writable: True.

CompoundingSelector¶

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

Type: Integer.
Writable: True.

CompoundingR¶

Compounding resistance.

Type: Float.
Writable: True.

CompoundingX¶

Compounding reactance.

Type: Float.
Writable: True.

AddTaps¶

Number of additional taps.

Type: Integer.
Writable: True.

PrevTap¶

Previous tap position.

Type: Float.
Writable: True.

PrevTapNumber¶

Previous tap number.

Type: Integer.
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¶

Simple class for sending neutral earthing data to Loadflow.

Inherits: Global.TEracsEngineInterfaceDataElement.

Resistance¶

Neutral earthing resistance (Ohms).

Type: Float.
Writable: True.

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¶

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

Inherits: Global.TEracsEngineInterfaceDataElement.

Busbar¶

Sequence number of the busbar connection.

Type: Integer.
Writable: True.

ConnectionIndicator¶

Connection indicator for the busbar connection.

Type: Integer.
Writable: True.

TapPosition¶

Off load tap changer nominal tap position (%).

Type: Float.
Writable: True.

MVA¶

Rated MVA.

Type: Float.
Writable: True.

RatedKV¶

Rated voltage (kV).

Type: Float.
Writable: True.

WindingType¶

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

Type: Integer.
Writable: True.

Angle¶

Transformer winding angle (degrees).

Type: Float.
Writable: True.

PosNegSequenceResistance¶

Positive/Negative sequence resistance.

Type: Float.
Writable: True.

PosNegSequenceReactance¶

Positive/Negative sequence reactance.

Type: Float.
Writable: True.

ZeroSequenceResistance¶

Zero sequence resistance.

Type: Float.
Writable: True.

ZeroSequenceReactance¶

Zero sequence reactance.

Type: Float.
Writable: True.

Neut¶

Neutral earth object.

Type: _TLFNeutralDataComplex.
Writable: False.

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¶

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

Inherits: Global.TEracsEngineInterfaceDataElementWithLibrary.

NumberOfCircuits¶

Number of circuits.

Type: Integer.
Writable: True.

NumberOfWindings¶

Number of windings.

Type: Integer.
Writable: True.

ConversionIndicator¶

Conversion indicator.

Type: Integer.
Writable: True.

Winding1¶

Transformer winding 1 object reference.

Type: TLFWindingData.
Writable: False.

Winding2¶

Transformer winding 2 object reference.

Type: TLFWindingData.
Writable: False.

Winding3¶

Transformer winding 3 object reference.

Type: TLFWindingData.
Writable: False.

Winding4¶

Transformer winding 4 object reference.

Type: TLFWindingData.
Writable: False.

CoreTypeIndicator¶

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

Type: Integer.
Writable: True.

CoreTypePseudoDeltaResistance¶

Zero sequence resistance.

Type: Float.
Writable: True.

CoreTypePseudoDeltaReactance¶

Zero sequence reactance.

Type: Float.
Writable: True.

DataType¶

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

Type: Integer.
Writable: True.

VectorGroup¶

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

Type: String.
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¶

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

Inherits: Global.TEracsEngineInterfaceDataElementWithLibrary.

Busbar¶

Sequence number of the busbar connection.

Type: Integer.
Writable: True.

ConnectionIndicator¶

Connection indicator for the busbar connection.

Type: Integer.
Writable: True.

NumberOfCircuits¶

Number of circuits.

Type: Integer.
Writable: True.

MachineType¶

Machine type (motor, generator).

Type: Integer.
Writable: True.

Power¶

Input power.

Type: Float.
Writable: True.

MVA¶

Rated MVA.

Type: Float.
Writable: True.

MW¶

Rated Power (MW).

Type: Float.
Writable: True.

RatedKV¶

Rated voltage (kV).

Type: Float.
Writable: True.

RatedHZ¶

Rated frequency (Hz).

Type: Float.
Writable: True.

ConversionIndicator¶

Conversion indicator (pu on rating, or Ohms).

Type: Integer.
Writable: True.

Rs¶

Stator resistance.

Type: Float.
Writable: True.

Xs¶

Stator reactance.

Type: Float.
Writable: True.

Xm¶

Magnetising reactance.

Type: Float.
Writable: True.

Rrs¶

Rotor stationary resistance.

Type: Float.
Writable: True.

Xrs¶

Rotor stationary reactance.

Type: Float.
Writable: True.

Rrr¶

Rotor running resistance.

Type: Float.
Writable: True.

Xrr¶

Rotor running reactance.

Type: Float.
Writable: True.

RotorIndicator¶

Rotor impedance indicator.

Type: Integer.
Writable: True.

CablePtr¶

Cable object pointer.

Type: ctypes.pointer.
Writable: False.

Cable¶

Cable object.

Type: _TLFLineCableDataComplex.
Writable: False.

MP_R¶

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

Type: _TLFMPDataComplex
Writable: False.

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¶

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

Inherits: Global.TEracsEngineInterfaceDataElement.

Busbar¶

Sequence number of the busbar connection.

Type: Integer.
Writable: True.

ConnectionIndicator¶

Connection indicator for the busbar connection.

Type: Integer.
Writable: True.

TargetVoltage¶

Target terminal voltage magnitude (pu).

Type: Float.
Writable: True.

ThreePhaseFault¶

Three phase fault infeed (MVA).

Type: Float.
Writable: True.

ThreePhaseX2R¶

Three phase X/R ratio.

Type: Float.
Writable: True.

SinglePhaseFault¶

Single phase fault infeed (MVA).

Type: Float.
Writable: True.

SinglePhaseX2R¶

Single phase X/R ratio.

Type: Float.
Writable: True.

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

LoadFromDict(AInfGenDictionary)¶

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
Raises: TEracsDataError – If the infinite generator dictionary is missing required keys.

class TLFSyncMachData¶

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

Inherits: Global.TEracsEngineInterfaceDataElementWithLibrary.

Busbar¶

Sequence number of the busbar connection.

Type: Integer.
Writable: True.

ConnectionIndicator¶

Connection indicator for the busbar connection.

Type: Integer.
Writable: True.

GeneratorType¶

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

Type: Integer.
Writable: True.

TargetVoltage¶

Target terminal voltage magnitude (pu).

Type: Float.
Writable: True.

TargetAngle¶

Target voltage angle (degrees).

Type: Float.
Writable: True.

MachineType¶

Machine type (motor, generator).

Type: Integer.
Writable: True.

RealPower¶

Target real power (MW).

Type: Float.
Writable: True.

ReactivePower¶

Target reactive power (MVAr).

Type: Float.
Writable: True.

NumberOfCircuits¶

Number of machines in parallel.

Type: Integer.
Writable: True.

MVA¶

Rated MVA.

Type: Float.
Writable: True.

MW¶

Rated Power (MW).

Type: Float.
Writable: True.

RatedKV¶

Rated Voltage (kV).

Type: Float.
Writable: True.

PositiveSequenceResistance¶

Positive sequence resistance (pu).

Type: Float.
Writable: True.

PositiveSequenceReactance¶

Positive sequence reactance (pu).

Type: Float.
Writable: True.

NegativeSequenceResistance¶

Negative sequence resistance (pu).

Type: Float.
Writable: True.

NegativeSequenceReactance¶

Negative sequence reactance (pu).

Type: Float.
Writable: True.

ZeroSequenceResistance¶

Zero sequence resistance (pu).

Type: Float.
Writable: True.

ZeroSequenceReactance¶

Zero sequence reactance (pu).

Type: Float.
Writable: True.

NeutPtr¶

Neutral earth object pointer.

Type: ctypes.pointer.
Writable: False.

Neut¶

Neutral earth object.

Type: _TLFNeutralDataComplex.
Writable: False.

CablePtr¶

Embedded Cable object pointer.

Type: ctypes.pointer.
Writable: False.

Cable¶

Embedded Cable object.

Type: _TLFLineCableDataComplex.
Writable: False.

TxPtr¶

Embedded Transformer object pointer.

Type: ctypes.pointer.
Writable: False.

Tx¶

Embedded Transformer object.

Type: _TLFTxDataComplex.
Writable: False.

RemoteBus¶

Sequence number of the remote busbar.

Type: Integer.
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¶

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

Inherits: Global.TEracsEngineInterfaceDataElementWithLibrary.

Busbar¶

Sequence number of the busbar connection.

Type: Integer.
Writable: True.

ConnectionIndicator¶

Connection indicator for the busbar connection.

Type: Integer.
Writable: True.

ShuntType¶

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

Type: Integer.
Writable: True.

NumberInParallel¶

Number in parallel.

Type: Integer.
Writable: True.

MVA¶

Rating (MVA).

Type: Float.
Writable: True.

RatedVoltage¶

Rated voltage (kV).

Type: Float.
Writable: True.

ValP1¶

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

Type: Float.
Writable: True.

ValP2¶

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

Type: Float.
Writable: True.

ValZ1¶

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

Type: Float.
Writable: True.

ValZ2¶

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

Type: Float.
Writable: True.

ValP3¶

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

Type: Float.
Writable: True.

ValP4¶

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

Type: Float.
Writable: True.

ControlBusbar¶

Sequence number of the control busbar.

Type: Integer.
Writable: True.

ControlBranch¶

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

Type: Integer.
Writable: True.

ControlBranchType¶

Indicates type of branch.

Type: Integer.
Writable: True.

NumberOfExternalParameters¶

Number of external parameters.

Type: Integer.
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¶

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.

Busbar1¶

Sequence number of the first busbar connection.

Type: Integer.
Writable: True.

Busbar2¶

Sequence number of the second busbar connection.

Type: Integer.
Writable: True.

ConnectionIndicator¶

Connection indicator along the bus section.

Type: Integer.
Writable: True.

ThreePhaseCapacity¶

Three phase breaking capacity (MVA).

Type: Float.
Writable: True.

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¶

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.

Pg¶

Total generated real power (MW).

Type: Float.
Writable: False.

Qg¶

Total generated reactive power (MVAr).

Type: Float.
Writable: False.

PLoad¶

Total load (MW).

Type: Float.
Writable: False.

QLoad¶

Total load (MVAr).

Type: Float.
Writable: False.

PLoss¶

Total loss (MW).

Type: Float.
Writable: False.

QLoss¶

Total loss (MVAr).

Type: Float.
Writable: False.

Base¶

Base/system (MVA).

Type: Float.
Writable: False.

Frequency¶

System base frequency (Hz).

Type: Float.
Writable: False.

MaxVoltage¶

Maximum busbar voltage (pu).

Type: Float.
Writable: False.

MaxVoltageBusbar¶

Name of busbar with maximum voltage.

Type: String.
Writable: False.

MinVoltage¶

Minimum busbar voltage (pu).

Type: Float.
Writable: False.

MinVoltageBusbar¶

Name of busbar with minimum voltage.

Type: String.
Writable: False.

MaxThreePhaseFault¶

Maximum three phase fault level (kA).

Type: Float.
Writable: False.

MaxThreePhaseFaultBusbar¶

Name of busbar with maximum three phase fault level.

Type: String.
Writable: False.

MinThreePhaseFault¶

Minimum three phase fault level (kA).

Type: Float.
Writable: False.

MinThreePhaseFaultBusbar¶

Name of busbar with minimum three phase fault level.

Type: String.
Writable: False.

NumberOfIterations¶

Number of iterations taken to solve Loadflow.

Type: Integer.
Writable: False.

ConvergenceError¶

Convergence error.

Type: Float.
Writable: False.

class TLFBusResult¶

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.

Vpu¶

Voltage magnitude (pu).

Type: Float.
Writable: False.

V¶

Voltage magnitude (kV).

Type: Float.
Writable: False.

ThetaV¶

Voltage angle (degrees).

Type: Float.
Writable: False.

Vdiff¶

Voltage difference (%).

Type: Float.
Writable: False.

Frequency¶

Frequency (Hz).

Type: Float.
Writable: False.

PLoad¶

Total load real power (MW).

Type: Float.
Writable: False.

QLoad¶

Total load reactive power (MVAr).

Type: Float.
Writable: False.

Pg¶

Total generated real power (MW).

Type: Float.
Writable: False.

Qg¶

Total generated reactive power (MVAr).

Type: Float.
Writable: False.

ThreePhaseFaultLevel¶

Three phase fault level (MVA).

Type: Float.
Writable: False.

ThreePhaseFaultCurrent¶

Three phase fault current (kA).

Type: Float.
Writable: False.

ThreePhaseX2R¶

Three phase X/R ratio.

Type: Float.
Writable: False.

SinglePhaseFaultLevel¶

Single phase fault level (MVA).

Type: Float.
Writable: False.

SinglePhaseFaultCurrent¶

Single phase fault current (kA).

Type: Float.
Writable: False.

SinglePhaseX2R¶

Single phase X/R ratio.

Type: Float.
Writable: False.

PositiveDrivingMagnitude¶

Magnitude of positive sequence driving point impedance (pu).

Type: Float.
Writable: False.

PositiveDrivingAngle¶

Angle of positive sequence driving point impedance (degrees).

Type: Float.
Writable: False.

NegativeDrivingMagnitude¶

Magnitude of negative sequence driving point impedance (pu).

Type: Float.
Writable: False.

NegativeDrivingAngle¶

Angle of negative sequence driving point impedance (degrees).

Type: Float.
Writable: False.

ZeroDrivingMagnitude¶

Magnitude of zero sequence driving point impedance (pu).

Type: Float.
Writable: False.

ZeroDrivingAngle¶

Angle of zero sequence driving point impedance (degrees).

Type: Float.
Writable: False.

Flag¶

Voltage out of range flag.

Type: Integer.
Writable: False.

class TLFLineResult¶

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.

End1¶

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

Type: Dictionary.
Writable: False.

End2¶

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

Type: Dictionary.
Writable: False.

PLoss¶

Real power loss (MW).

Type: Float.
Writable: False.

QLoss¶

Reactive power loss (MVAr).

Type: Float.
Writable: False.

VoltageDropPu¶

Voltage drop (pu).

Type: Float.
Writable: False.

VoltageDropKv¶

Voltage drop (kV).

Type: Float.
Writable: False.

Flag¶

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

Type: Integer.
Writable: False.

class TLFTapResult¶

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.

TapNumber¶

Calculated on tap position number.

Type: Integer.
Writable: False.

OffTap¶

Calculated off nominal tap position (%).

Type: Float.
Writable: False.

Flag¶

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

Type: Integer.
Writable: False.

class TLFTxResult¶

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

Inherits: Global.TEracsEngineInterfaceResultElement.

class TLFIndMachResult¶

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

Inherits: Global.TEracsEngineInterfaceResultElement.

class TLFSyncMachResult¶

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

Inherits: Global.TEracsEngineInterfaceResultElement.

class TLFShuntResult¶

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.

P¶

Real power flow (MW).

Type: Float.
Writable: False.

Q¶

Reactive power flow (MVAr).

Type: Float.
Writable: False.

S¶

Apparent power (MVA).

Type: Float.
Writable: False.

I¶

Terminal current (kA).

Type: Float.
Writable: False.

ThetaI¶

Angle of terminal current (degrees).

Type: Float.
Writable: False.

PowerFactor¶

Power factor.

Type: Float.
Writable: False.

PercentLoad¶

Percentage loading.

Type: Float.
Writable: False.

PowerDirection¶

Direction of power flow.

Type: Integer.
Writable: False.

Voltage¶

Terminal voltage magnitude (kV).

Type: Float.
Writable: False.

ThetaVoltage¶

Terminal voltage angle (degrees).

Type: Float.
Writable: False.

Flag¶

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

Type: Integer.
Writable: False.

class TLFBusSectionResult¶

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.

P¶

Real power flow (MW).

Type: Float.
Writable: False.

Q¶

Reactive power flow (MVAr).

Type: Float.
Writable: False.

S¶

Apparent power (MVA).

Type: Float.
Writable: False.

I¶

Terminal current (kA).

Type: Float.
Writable: False.

ThetaI¶

Angle of terminal current (degrees).

Type: Float.
Writable: False.

PowerFactor¶

Power factor.

Type: Float.
Writable: False.

PercentLoad¶

Percentage loading.

Type: Float.
Writable: False.

PowerDirection¶

Direction of power flow.

Type: Integer.
Writable: False.

Flag¶

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

Type: Integer.
Writable: False.

LoadflowRecords Module¶

ERACS Python Interface

Navigation