dss.IPDElements

Module Contents

Classes

IPDElements

API

class dss.IPDElements.IPDElements(api_util, prefer_lists=False)

Bases: dss._cffi_api_util.Base

property AccumulatedL: float

Accumulated failure rate for this branch on downline

Requires a previous call to RelCalc command

Original COM help: https://opendss.epri.com/AccumulatedL.html

property AllCplxSeqCurrents: dss._types.Float64ArrayOrComplexArray

Complex double array of Sequence Currents for all conductors of all terminals, for each PD elements.

(API Extension)

property AllCurrents: dss._types.Float64ArrayOrComplexArray

Complex array of currents for all conductors, all terminals, for each PD element.

(API Extension)

property AllCurrentsMagAng: dss._types.Float64Array

Complex array (magnitude and angle format) of currents for all conductors, all terminals, for each PD element.

(API Extension)

AllMaxCurrents(AllNodes: bool = False) → dss._types.Float64Array

Array of doubles with the maximum current across the conductors, for each PD element.

By default, only the first terminal is used for the maximum current, matching the behavior of the “export capacity” command. Pass AllNodes=True to force the analysis to all terminals.

See also: https://sourceforge.net/p/electricdss/discussion/beginners/thread/da5b93ca/

(API Extension)

property AllNames: List[str]

Array of strings consisting of all PD element names.

(API Extension)

property AllNumConductors: dss._types.Int32Array

Integer array listing the number of conductors of all PD elements

(API Extension)

property AllNumPhases: dss._types.Int32Array

Integer array listing the number of phases of all PD elements

(API Extension)

property AllNumTerminals: dss._types.Int32Array

Integer array listing the number of terminals of all PD elements

(API Extension)

AllPctEmerg(AllNodes: bool = False) → dss._types.Float64Array

Array of doubles with the maximum current across the conductors as a percentage of the Emergency Ampere Rating, for each PD element.

By default, only the first terminal is used for the maximum current, matching the behavior of the “export capacity” command. Pass AllNodes=True to force the analysis to all terminals.

See also: https://sourceforge.net/p/electricdss/discussion/beginners/thread/da5b93ca/

(API Extension)

AllPctNorm(AllNodes: bool = False) → dss._types.Float64Array

Array of doubles with the maximum current across the conductors as a percentage of the Normal Ampere Rating, for each PD element.

By default, only the first terminal is used for the maximum current, matching the behavior of the “export capacity” command. Pass AllNodes=True to force the analysis to all terminals.

See also: https://sourceforge.net/p/electricdss/discussion/beginners/thread/da5b93ca/

(API Extension)

property AllPowers: dss._types.Float64ArrayOrComplexArray

Complex array of powers into each conductor of each terminal, for each PD element.

(API Extension)

property AllSeqCurrents: dss._types.Float64Array

Double array of the symmetrical component currents (magnitudes only) into each 3-phase terminal, for each PD element.

(API Extension)

property AllSeqPowers: dss._types.Float64ArrayOrComplexArray

Complex array of sequence powers into each 3-phase terminal, for each PD element

(API Extension)

property Count: int

Number of PD elements (including disabled elements)

Original COM help: https://opendss.epri.com/Count12.html

property FaultRate: float

Get/Set Number of failures per year. For LINE elements: Number of failures per unit length per year.

property First: int

(read-only) Set the first enabled PD element to be the active element. Returns 0 if none found.

property FromTerminal: int

(read-only) Number of the terminal of active PD element that is on the “from” side. This is set after the meter zone is determined.

Requires an energy meter with an updated zone.

property IsShunt: bool

(read-only) Boolean indicating of PD element should be treated as a shunt element rather than a series element. Applies to Capacitor and Reactor elements in particular.

property Lambda: float

Failure rate for this branch. Faults per year including length of line.

Requires a previous call to RelCalc command

Original COM help: https://opendss.epri.com/Lambda1.html

property Name: str

Get/Set name of active PD Element. Returns null string if active element is not PDElement type.

property Next: int

(read-only) Advance to the next PD element in the circuit. Enabled elements only. Returns 0 when no more elements.

property Numcustomers: int

Number of customers, this branch

Requires an energy meter with an updated zone.

Original COM help: https://opendss.epri.com/Numcustomers.html

property ParentPDElement: int

(read-only) Sets the parent PD element to be the active circuit element. Returns 0 if no more elements upline.

Requires an energy meter with an updated zone.

property RepairTime: float

Average repair time for this element in hours

Original COM help: https://opendss.epri.com/RepairTime.html

property SectionID: int

Integer ID of the feeder section that this PDElement branch is part of

Requires a previous call to RelCalc command

Original COM help: https://opendss.epri.com/SectionID1.html

property TotalMiles: float

Total miles of line from this element to the end of the zone. For recloser siting algorithm.

Requires a previous call to RelCalc command

Original COM help: https://opendss.epri.com/TotalMiles1.html

property Totalcustomers: int

Total number of customers from this branch to the end of the zone

Requires a circuit with an energy meter with an updated zone.

Original COM help: https://opendss.epri.com/TotalCustomers1.html

__init__(api_util, prefer_lists=False)

__iter__() → Iterator[dss.IPDElements.IPDElements]

__len__() → int

property pctPermanent: float

Get/Set percent of faults that are permanent (require repair). Otherwise, fault is assumed to be transient/temporary.

Original COM help: https://opendss.epri.com/pctPermanent.html