Loads Class |
[This is preliminary documentation and is subject to change.]
[Missing <summary> documentation for "T:dss_sharp.Loads"]
Namespace: dss_sharp
The Loads type exposes the following members.
Name | Description | |
---|---|---|
AllNames |
Array of strings with all Load names in the circuit.
| |
AllocationFactor |
Factor for allocating loads by connected xfkva
| |
Cfactor |
Factor relates average to peak kw. Used for allocation with kwh and kwhdays
| |
Class | ||
Count |
Number of Load objects in active circuit.
| |
CVRcurve |
Name of a loadshape with both Mult and Qmult, for CVR factors as a function of time.
| |
CVRvars |
Percent reduction in Q for percent reduction in V. Must be used with dssLoadModelCVR.
| |
CVRwatts |
Percent reduction in P for percent reduction in V. Must be used with dssLoadModelCVR.
| |
daily |
Name of the loadshape for a daily load profile.
| |
duty |
Name of the loadshape for a duty cycle simulation.
| |
First |
Sets the first Load active. Returns 0 if no more.
| |
Growth |
Name of the growthshape curve for yearly load growth factors.
| |
idx |
Get/set active Load by index; index is 1-based: 1..count
| |
IsDelta |
Delta loads are connected line-to-line.
| |
kV |
Set kV rating for active Load. For 2 or more phases set Line-Line kV. Else actual kV across terminals.
| |
kva |
Base load kva. Also defined kw and kvar or pf input, or load allocation by kwh or xfkva.
| |
kvar |
Get/set kvar for active Load. If set, updates PF based on present kW.
| |
kW |
Set kW for active Load. Updates kvar based on present PF.
| |
kwh |
kwh billed for this period. Can be used with Cfactor for load allocation.
| |
kwhdays |
Length of kwh billing period for average demand calculation. Default 30.
| |
Model |
The Load Model defines variation of P and Q with voltage.
| |
Name |
Sets the active Load by Name.
| |
Next |
Sets the next Load active. Returns 0 if no more.
| |
NumCust |
Number of customers in this load, defaults to one.
| |
PctMean |
Average percent of nominal load in Monte Carlo studies; only if no loadshape defined for this load.
| |
pctSeriesRL |
Percent of Load that is modeled as series R-L for harmonics studies
| |
PctStdDev |
Percent standard deviation for Monte Carlo load studies; if there is no loadshape assigned to this load.
| |
PF |
Get or set Power Factor for Active Load. Specify leading PF as negative. Updates kvar based on present value of kW
| |
Phases |
Number of phases
| |
RelWeight |
Relative Weighting factor for the active LOAD
| |
Rneut |
Neutral resistance for wye-connected loads.
| |
Sensor |
Name of the sensor monitoring this load.
| |
Spectrum |
Name of harmonic current spectrrum shape.
| |
Status |
Response to load multipliers: Fixed (growth only), Exempt (no LD curve), Variable (all).
| |
Vmaxpu |
Maximum per-unit voltage to use the load model. Above this, constant Z applies.
| |
Vminemerg |
Minimum voltage for unserved energy (UE) evaluation.
| |
Vminnorm |
Minimum voltage for energy exceeding normal (EEN) evaluations.
| |
Vminpu |
Minimum voltage to apply the load model. Below this, constant Z is used.
| |
xfkVA |
Rated service transformer kVA for load allocation, using AllocationFactor. Affects kW, kvar, and pf.
| |
Xneut |
Neutral reactance for wye-connected loads.
| |
Yearly |
Name of yearly duration loadshape
| |
ZIPV |
Array of 7 doubles with values for ZIPV property of the load object
|
Name | Description | |
---|---|---|
CheckForError | (Inherited from ContextState.) | |
Equals | (Inherited from Object.) | |
Finalize | (Inherited from Object.) | |
GetContextHandle |
Returns the low-level handle of the current OpenDSS/DSS-CAPI instance.
(Inherited from ContextState.) | |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
MemberwiseClone | (Inherited from Object.) | |
ToString | (Inherited from Object.) |
Name | Description | |
---|---|---|
apiutil | (Inherited from ContextState.) | |
ctx | (Inherited from ContextState.) |