Module Contents#




class dss.ILoads.ILoads(api_util)#

Bases: dss._cffi_api_util.Iterable

property AllNames: List[str]#

Array of all names of this object type

property AllocationFactor: float#

Factor for allocating loads by connected xfkva

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

property CVRcurve: str#

Name of a loadshape with both Mult and Qmult, for CVR factors as a function of time.

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

property CVRvars: float#

Percent reduction in Q for percent reduction in V. Must be used with dssLoadModelCVR.

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

property CVRwatts: float#

Percent reduction in P for percent reduction in V. Must be used with dssLoadModelCVR.

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

property Cfactor: float#

Factor relates average to peak kw. Used for allocation with kwh and kwhdays

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

property Class: int#

Code number used to separate loads by class or group. No effect on the solution.

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

property Count: int#

Number of objects of this type

property First: int#

Sets the first object of this type active. Returns 0 if none.

property Growth: str#

Name of the growthshape curve for yearly load growth factors.

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

property IsDelta: bool#

Delta loads are connected line-to-line.

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

property Model: dss.enums.LoadModels#

The Load Model defines variation of P and Q with voltage.

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

property Name: str#

Gets the current name or sets the active object of this type by name

property Next: int#

Sets next object of this type active. Returns 0 if no more.

property NumCust: int#

Number of customers in this load, defaults to one.

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

property PF: float#

Get or set Power Factor for Active Load. Specify leading PF as negative. Updates kvar based on present value of kW

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

property PctMean: float#

Average percent of nominal load in Monte Carlo studies; only if no loadshape defined for this load.

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

property PctStdDev: float#

Percent standard deviation for Monte Carlo load studies; if there is no loadshape assigned to this load.

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

property Phases: int#

Number of phases

(API Extension)

property RelWeight: float#

Relative Weighting factor for the active LOAD

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

property Rneut: float#

Neutral resistance for wye-connected loads.

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

property Sensor: str#

Name of the sensor monitoring this load.

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

property Spectrum: str#

Name of harmonic current spectrum shape.

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

property Status: dss.enums.LoadStatus#

Response to load multipliers: Fixed (growth only), Exempt (no LD curve), Variable (all).

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

property Vmaxpu: float#

Maximum per-unit voltage to use the load model. Above this, constant Z applies.

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

property Vminemerg: float#

Minimum voltage for unserved energy (UE) evaluation.

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

property Vminnorm: float#

Minimum voltage for energy exceeding normal (EEN) evaluations.

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

property Vminpu: float#

Minimum voltage to apply the load model. Below this, constant Z is used.

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

property Xneut: float#

Neutral reactance for wye-connected loads.

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

property Yearly: str#

Name of yearly duration loadshape

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

property ZIPV: dss._types.Float64Array#

Array of 7 doubles with values for ZIPV property of the load object

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

__iter__() Iterator[dss._cffi_api_util.Iterable]#

Get an iterator of the object collection.

Note that OpenDSS, via the classic APIs, only allow a single object of a specific type to be activated. That is, you cannot use references of distinct objects and interact with both at the same time, or keep a reference to use later. You need to reactivate the target object or ensure it is the active one.

For an alternative, consider using our AltDSS-Python package.

(API Extension)

__len__() int#
property daily: str#

Name of the loadshape for a daily load profile.

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

property duty: str#

Name of the loadshape for a duty cycle simulation.

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

property idx: int#

Gets the current index or sets the active object of this type by index

While the official API included this for some classes, this is an API Extension for:

  • Capacitors

  • CapControls

  • ISources

  • LineCodes

  • Lines

  • LoadShapes

  • Meters

  • Monitors

  • RegControls

  • Sensors

  • SwtControls

  • Transformers

  • Vsources

  • XYCurves

(API Extension)

property kV: float#

kV rating for active Load. For 2 or more phases set Line-Line kV. Else actual kV across terminals.

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

property kW: float#

Set kW for active Load. Updates kvar based on present PF.

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

property kva: float#

Base load kva. Also defined kw and kvar or pf input, or load allocation by kwh or xfkva.

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

property kvar: float#

Reactive power in kvar for active Load. If set, updates PF based on present kW.

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

property kwh: float#

kWh billed for this period. Can be used with Cfactor for load allocation.

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

property kwhdays: float#

Length of kWh billing period for average demand calculation. Default 30.

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

property pctSeriesRL: float#

Percent of Load that is modeled as series R-L for harmonics studies

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

property xfkVA: float#

Rated service transformer kVA for load allocation, using AllocationFactor. Affects kW, kvar, and pf.

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