Class: Load¶
A Load object in OpenDSS representing an energy consumer connected to a bus in the distribution system.
URI: dss:Load
classDiagram
class Load
click Load href "../Load/"
Load : allocationfactor
Load : basefreq
Load : bus1
Load : Cfactor
Load : conn
Load --> "0..1" ConnectionType : conn
click ConnectionType href "../ConnectionType/"
Load : CVRcurve
Load : CVRvars
Load : CVRwatts
Load : daily
Load : duty
Load : enabled
Load : growth
Load : kV
Load : kVA
Load : kvar
Load : kW
Load : kwh
Load : kwhdays
Load : like
Load : load_class
Load : model
Load --> "0..1" LoadModel : model
click LoadModel href "../LoadModel/"
Load : name
Load : NumCust
Load : pct_mean
Load : pct_SeriesRL
Load : pct_stddev
Load : pf
Load : phases
Load : puXharm
Load : RelWeight
Load : Rneut
Load : spectrum
Load : status
Load --> "0..1" LoadStatus : status
click LoadStatus href "../LoadStatus/"
Load : Vlowpu
Load : Vmaxpu
Load : Vminemerg
Load : Vminnorm
Load : Vminpu
Load : xfkVA
Load : Xneut
Load : XRharm
Load : yearly
Load : ZIPV
Class Properties¶
| Property | Value |
|---|---|
| Class URI | dss:Load |
Slots¶
| Name | Cardinality and Range | Description | Inheritance |
|---|---|---|---|
| name | 1 String |
Object name | direct |
| phases | 0..1 Integer |
Number of Phases, this load | direct |
| bus1 | 1 String |
Bus to which the load is connected | direct |
| kV | 0..1 Float |
Nominal rated (1 | direct |
| kW | 0..1 Float |
Total base kW for the load | direct |
| pf | 0..1 Float |
Load power factor | direct |
| model | 0..1 LoadModel |
Integer code for the model to use for load variation with voltage | direct |
| yearly | 0..1 String |
LOADSHAPE object name for yearly simulations | direct |
| daily | 0..1 String |
LOADSHAPE object name for daily simulations | direct |
| duty | 0..1 String |
LOADSHAPE object name for duty cycle simulations | direct |
| growth | 0..1 String |
Growthshape object name to use for growth factors by years | direct |
| conn | 0..1 ConnectionType |
Connection type | direct |
| kvar | 0..1 Float |
Base kvar for specifying load as kW & kvar | direct |
| Rneut | 0..1 Float |
Neutral resistance of wye-connected load in actual ohms | direct |
| Xneut | 0..1 Float |
Neutral reactance of wye-connected load in actual ohms | direct |
| status | 0..1 LoadStatus |
Load status | direct |
| load_class | 0..1 Integer |
An arbitrary integer number representing the class of load so that load value... | direct |
| Vminpu | 0..1 Float |
Minimum per unit voltage for which the MODEL is assumed to apply | direct |
| Vmaxpu | 0..1 Float |
Maximum per unit voltage for which the MODEL is assumed to apply | direct |
| Vminnorm | 0..1 Float |
Minimum per unit voltage for load EEN evaluations, Normal limit | direct |
| Vminemerg | 0..1 Float |
Minimum per unit voltage for load UE evaluations, Emergency limit | direct |
| xfkVA | 0..1 Float |
Rated kVA of service transformer for allocating loads based on connected kVA ... | direct |
| allocationfactor | 0..1 Float |
Allocation factor for allocating loads based on connected kVA at a bus | direct |
| kVA | 0..1 Float |
Specify base Load in kVA (and power factor) | direct |
| pct_mean | 0..1 Float |
Percent mean value for load to use for monte carlo studies if no loadshape is... | direct |
| pct_stddev | 0..1 Float |
Percent Std deviation value for load to use for monte carlo studies if no loa... | direct |
| CVRwatts | 0..1 Float |
Percent reduction in active power per 1% reduction in voltage from 100% rated | direct |
| CVRvars | 0..1 Float |
Percent reduction in reactive power per 1% reduction in voltage from 100% rat... | direct |
| kwh | 0..1 Float |
kWh billed for this period | direct |
| kwhdays | 0..1 Float |
Length of kWh billing period in days (24 hr days) | direct |
| Cfactor | 0..1 Float |
Factor relating average kW to peak kW | direct |
| CVRcurve | 0..1 String |
Curve describing both watt and var factors as a function of time | direct |
| NumCust | 0..1 Integer |
Number of customers, this load | direct |
| ZIPV | * Float |
Array of 7 coefficients for ZIP load model | direct |
| pct_SeriesRL | 0..1 Float |
Percent of load that is series R-L for Harmonic studies | direct |
| RelWeight | 0..1 Float |
Relative weighting factor for reliability calcs | direct |
| Vlowpu | 0..1 Float |
Per unit voltage at which the model switches to constant Z model (model=2) | direct |
| puXharm | 0..1 Float |
Special reactance, pu (based on kVA, kV properties), for the series impedance... | direct |
| XRharm | 0..1 Float |
X/R ratio of the special harmonics mode reactance specified by the puXHARM pr... | direct |
| spectrum | 0..1 String |
Name of harmonic current spectrum for this load | direct |
| basefreq | 0..1 Float |
Base Frequency for ratings | direct |
| enabled | 0..1 Boolean |
Indicates whether this element is enabled | direct |
| like | 0..1 String |
Make like another object, e | direct |
Comments¶
- OpenDSS Load maps to CIM EnergyConsumer. On export, a single EnergyConsumer can produce more than one DSS Load: an unbalanced multi-phase wye load (per-phase kW/kvar not all equal) is split into one single-phase Load per EnergyConsumerPhase so the imbalance is preserved, and a 2-phase wye load below 250 V (a center-tap/split-phase service) is split the same way into two single-phase 120 V loads. Balanced loads export as a single multi-phase Load.
Identifier and Mapping Information¶
Schema Source¶
- from schema: https://gridappsd.github.io/dss-graph/opendss
Mappings¶
| Mapping Type | Mapped Value |
|---|---|
| self | dss:Load |
| native | dss:Load |
| exact | cim:EnergyConsumer |
LinkML Source¶
Direct¶
name: Load
description: A Load object in OpenDSS representing an energy consumer connected to
a bus in the distribution system.
comments:
- 'OpenDSS Load maps to CIM EnergyConsumer. On export, a single EnergyConsumer can
produce more than one DSS Load: an unbalanced multi-phase wye load (per-phase kW/kvar
not all equal) is split into one single-phase Load per EnergyConsumerPhase so the
imbalance is preserved, and a 2-phase wye load below 250 V (a center-tap/split-phase
service) is split the same way into two single-phase 120 V loads. Balanced loads
export as a single multi-phase Load.'
from_schema: https://gridappsd.github.io/dss-graph/opendss
exact_mappings:
- cim:EnergyConsumer
attributes:
name:
name: name
description: Object name. Must be unique per object type.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
exact_mappings:
- cim:IdentifiedObject.name
rank: 1000
identifier: true
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Cndata
- Dynamicexp
- Growthshape
- Linecode
- Linegeometry
- Linespacing
- Loadshape
- Priceshape
- Spectrum
- TccCurve
- Tsdata
- Tshape
- Wiredata
- Xfmrcode
- Xycurve
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: string
required: true
phases:
name: phases
annotations:
order:
tag: order
value: 1
dss_default:
tag: dss_default
value: int(3)
description: Number of Phases, this load. Load is evenly divided among phases.
comments:
- 'Import: if bus1 has an explicit phase suffix (e.g. ".1.2.3"), that is authoritative;
otherwise phases selects that many of A, B, C in order. One EnergyConsumerPhase
object is created per resolved phase. Export: phases = len(EnergyConsumerPhase),
except a 2-phase delta load exports as phases=1 (DSS represents a single-phase
L-L delta load this way).'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
related_mappings:
- cim:EnergyConsumerPhase
rank: 1000
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Xfmrcode
- Fault
- Gicsource
- Isource
- Vsource
range: integer
required: false
minimum_value: 1
maximum_value: 3
bus1:
name: bus1
annotations:
order:
tag: order
value: 2
description: Bus to which the load is connected. May include specific node specification.
comments:
- 'Import: bus name extracted from Terminal[0].ConnectivityNode.name; phase suffix
reconstructed from EnergyConsumerPhase.phase values. Export: bus1 = cn.name
+ ''.'' + ''.''.join(phase_suffix).'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
related_mappings:
- cim:Terminal.ConnectivityNode
rank: 1000
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Windgen
- Capacitor
- Line
- Reactor
- Fault
- Isource
- Vsource
range: string
required: true
kV:
name: kV
annotations:
order:
tag: order
value: 3
description: Nominal rated (1.0 per unit) voltage, kV, for load. For 2- and 3-phase
loads, specify phase-phase kV. Otherwise, specify actual kV across each branch
of the load. If wye (star), specify phase-neutral kV. If delta or phase-phase
connected, specify phase-phase kV.
comments:
- 'CIM BaseVoltage.nominalVoltage is always phase-phase (L-L). Import: EnergyConsumer.BaseVoltage.nominalVoltage
= Voltage(kV × √3, ''kV'') for a single-phase wye load, or Voltage(kV, ''kV'')
for delta or for 2-/3-phase wye (kV is already L-L in those cases). Export:
kV = nominalVoltage.to(''kV'') / √3 for a single-phase wye load, otherwise kV
= nominalVoltage.to(''kV''). If kV is omitted on import, the voltage is left
unset and filled in later by BFS-based repair.'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
close_mappings:
- cim:BaseVoltage.nominalVoltage
rank: 1000
domain_of:
- Load
- Autotrans
- Transformer
- Xfmrcode
range: float
required: false
minimum_value: 0.0
kW:
name: kW
annotations:
order:
tag: order
value: 4
description: Total base kW for the load. Normally, you would enter the maximum
kW for the load for the first year and allow it to be adjusted by the load shapes,
growth shapes, and global load multiplier.
comments:
- 'Import: EnergyConsumer.p = ActivePower(kW, ''kW''); if kW is not given but
kVA and pf are, kW = kVA × |pf| first (see kVA and pf comments). Export: kW
= p.to(''kW''). Sign: CIM positive p = power consumed (load convention matches);
no sign flip needed for loads.'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
close_mappings:
- cim:EnergyConsumer.p
rank: 1000
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Storage
- Vsconverter
- Windgen
range: float
required: false
pf:
name: pf
annotations:
order:
tag: order
value: 5
dss_default:
tag: dss_default
value: float(0.88)
description: Load power factor. Enter negative for leading power factor (when
kW and kvar have opposite signs).
comments:
- 'Not stored on CIM EnergyConsumer; CIM stores p and q independently. Import:
used only when kvar is not explicitly given — kvar = kW × tan(acos(|pf|)), sign-negated
if pf is negative (leading). Export: pf is always recomputed as p / sqrt(p²
+ q²) (1.0 if p and q are both zero); the sign of the original pf is not preserved.'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Upfc
range: float
required: false
minimum_value: -1.0
maximum_value: 1.0
model:
name: model
annotations:
order:
tag: order
value: 6
dss_default:
tag: dss_default
value: int(1)
dss_valid_values:
tag: dss_valid_values
value: 1,2,3,4,5,6,7,8
description: Integer code for the model to use for load variation with voltage.
1=Constant P+jQ (default), 2=Constant Z, 3=Const P Quadratic Q, 4=Nominal Linear
P Quadratic Q (CVR), 5=Constant I, 6=Const P Fixed Q, 7=Const P Fixed Impedance
Q, 8=ZIPV.
comments:
- 'Import: each DSS model value (1-8) selects a fixed ZIP (constant-impedance/current/power)
fraction profile for p and q, which is stored on a shared LoadResponseCharacteristic
and linked via EnergyConsumer.LoadResponse; model=4 (CVR) instead sets exponentModel=True
with CVRwatts/CVRvars as the p/q voltage exponents, and model=8 (ZIPV) reads
the 7-element ZIPV array directly into the ZIP fractions. Export: the reverse
lookup matches the LoadResponseCharacteristic''s ZIP fractions against the same
standard profiles (models 1, 2, 3, 5); an exponent model exports as model=4
with CVRwatts/CVRvars; any other combination of fractions exports as model=8
with a ZIPV array (Vminpu fixed at 0.5).'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
close_mappings:
- cim:LoadResponseCharacteristic
rank: 1000
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: LoadModel
required: false
yearly:
name: yearly
annotations:
order:
tag: order
value: 7
description: LOADSHAPE object name for yearly simulations. Must be previously
defined as a Loadshape object.
todos:
- Loadshape converter not yet implemented. DSS LoadShape name should map to a
CIM SeasonDayTypeSchedule or RegularIntervalSchedule linked to EnergyConsumer
via LoadGroup.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
related_mappings:
- cim:SeasonDayTypeSchedule
rank: 1000
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
daily:
name: daily
annotations:
order:
tag: order
value: 8
description: LOADSHAPE object name for daily simulations. Must be previously defined
as a Loadshape object of 24 hrs, typically.
todos:
- Loadshape converter not yet implemented. DSS LoadShape name should map to a
CIM SeasonDayTypeSchedule or RegularIntervalSchedule linked to EnergyConsumer
via LoadGroup.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
related_mappings:
- cim:SeasonDayTypeSchedule
rank: 1000
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
duty:
name: duty
annotations:
order:
tag: order
value: 9
description: LOADSHAPE object name for duty cycle simulations. Must be previously
defined as a Loadshape object. Typically would have time intervals less than
1 hr.
todos:
- Loadshape converter not yet implemented. DSS LoadShape name should map to a
CIM SeasonDayTypeSchedule or RegularIntervalSchedule linked to EnergyConsumer
via LoadGroup.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
related_mappings:
- cim:SeasonDayTypeSchedule
rank: 1000
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
growth:
name: growth
annotations:
order:
tag: order
value: 10
description: Growthshape object name to use for growth factors by years. Must
be previously defined as a Growthshape object. Defaults to circuit default growth
factor.
todos:
- GrowthShape converter not yet implemented. DSS GrowthShape name should reference
a CIM GrowthShape object.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
related_mappings:
- cim:GrowthShape
rank: 1000
domain_of:
- Load
range: string
required: false
conn:
name: conn
annotations:
order:
tag: order
value: 11
description: Connection type. Default is wye.
comments:
- 'Import: DSS ''wye''/''delta'' maps to CIM PhaseShuntConnectionKind.Y / D. Export:
reverse enum lookup.'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
exact_mappings:
- cim:EnergyConsumer.phaseConnection
rank: 1000
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Autotrans
- Capacitor
- Reactor
- Transformer
- Xfmrcode
- Sensor
range: ConnectionType
required: false
kvar:
name: kvar
annotations:
order:
tag: order
value: 12
description: Base kvar for specifying load as kW & kvar. Assumes kW has been already
defined. Alternative to specifying the power factor.
comments:
- 'Import: EnergyConsumer.q = ReactivePower(kvar, ''kVAr''). Export: kvar = q.to(''kVAr'').
Sign: positive q = inductive (lagging) consumption in CIM load convention.'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
close_mappings:
- cim:EnergyConsumer.q
rank: 1000
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
- Capacitor
- Reactor
range: float
required: false
Rneut:
name: Rneut
annotations:
order:
tag: order
value: 13
dss_default:
tag: dss_default
value: float(-1.0)
description: Neutral resistance of wye-connected load in actual ohms. Default
is -1. If entered as negative, the neutral can be open or floating.
todos:
- No CIM equivalent. Requires CIM extension (e.g. custom attribute on EnergyConsumer
or dedicated NeutralImpedance class) to round-trip.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
domain_of:
- Load
- Transformer
- Xfmrcode
range: float
required: false
Xneut:
name: Xneut
annotations:
order:
tag: order
value: 14
dss_default:
tag: dss_default
value: float(0.0)
description: Neutral reactance of wye-connected load in actual ohms. May be positive
or negative.
todos:
- No CIM equivalent. Requires CIM extension alongside Rneut.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
domain_of:
- Load
- Transformer
- Xfmrcode
range: float
required: false
status:
name: status
annotations:
order:
tag: order
value: 15
description: Load status. Variable=all multipliers apply, Fixed=no load multipliers
(growth still applies), Exempt=not modified by global load multiplier.
todos:
- No CIM equivalent for load multiplier status flags. Requires CIM extension.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
domain_of:
- Load
- Generator
range: LoadStatus
required: false
load_class:
name: load_class
annotations:
order:
tag: order
value: 16
dss_name:
tag: dss_name
value: class
dss_default:
tag: dss_default
value: int(1)
description: An arbitrary integer number representing the class of load so that
load values may be segregated by load value. Default is 1; not used internally.
todos:
- No CIM equivalent. Could potentially map to a PSRType classification but no
standard CIM field exists.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
domain_of:
- Load
range: integer
required: false
Vminpu:
name: Vminpu
annotations:
order:
tag: order
value: 17
dss_default:
tag: dss_default
value: float(0.95)
description: Minimum per unit voltage for which the MODEL is assumed to apply.
Lower end of normal voltage range. Default is 0.95.
todos:
- No CIM equivalent. Requires CIM extension for per-unit voltage model applicability
bounds.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: float
required: false
Vmaxpu:
name: Vmaxpu
annotations:
order:
tag: order
value: 18
dss_default:
tag: dss_default
value: float(1.05)
description: Maximum per unit voltage for which the MODEL is assumed to apply.
Default is 1.05.
todos:
- No CIM equivalent. Requires CIM extension alongside Vminpu.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: float
required: false
Vminnorm:
name: Vminnorm
annotations:
order:
tag: order
value: 19
dss_default:
tag: dss_default
value: float(0.0)
description: Minimum per unit voltage for load EEN evaluations, Normal limit.
Default is 0, which defaults to system vminnorm property.
todos:
- No CIM equivalent. Requires CIM extension for normal-range voltage limit on
loads.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
domain_of:
- Load
range: float
required: false
Vminemerg:
name: Vminemerg
annotations:
order:
tag: order
value: 20
dss_default:
tag: dss_default
value: float(0.0)
description: Minimum per unit voltage for load UE evaluations, Emergency limit.
Default is 0, which defaults to system vminemerg property.
todos:
- No CIM equivalent. Requires CIM extension for emergency-range voltage limit
on loads.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
domain_of:
- Load
range: float
required: false
xfkVA:
name: xfkVA
annotations:
order:
tag: order
value: 21
dss_default:
tag: dss_default
value: float(0.0)
description: Rated kVA of service transformer for allocating loads based on connected
kVA at a bus. Default is 0.0.
todos:
- No CIM equivalent. Load allocation metadata; requires CIM extension.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
domain_of:
- Load
range: float
required: false
allocationfactor:
name: allocationfactor
annotations:
order:
tag: order
value: 22
dss_default:
tag: dss_default
value: float(0.5)
description: Allocation factor for allocating loads based on connected kVA at
a bus. Default is 0.5.
todos:
- No CIM equivalent. Load allocation metadata; requires CIM extension alongside
xfkVA.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
domain_of:
- Load
range: float
required: false
kVA:
name: kVA
annotations:
order:
tag: order
value: 23
description: Specify base Load in kVA (and power factor).
comments:
- 'Not stored on CIM EnergyConsumer; p and q are stored independently. Import:
used only when kW is not given — combined with pf to derive kW = kVA × |pf|
(see kW comments); kvar is then derived from that kW and pf as usual. Export:
not written; kVA is not reconstructed on the DSS side (only kW/kvar/pf are).'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Autotrans
- Transformer
- Xfmrcode
range: float
required: false
pct_mean:
name: pct_mean
annotations:
order:
tag: order
value: 24
dss_name:
tag: dss_name
value: '%mean'
dss_default:
tag: dss_default
value: float(50.0)
description: Percent mean value for load to use for monte carlo studies if no
loadshape is assigned to this load. Default is 50.
todos:
- No CIM equivalent. Monte Carlo study metadata; requires CIM extension.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
domain_of:
- Load
range: float
required: false
pct_stddev:
name: pct_stddev
annotations:
order:
tag: order
value: 25
dss_name:
tag: dss_name
value: '%stddev'
dss_default:
tag: dss_default
value: float(10.0)
description: Percent Std deviation value for load to use for monte carlo studies
if no loadshape is assigned to this load. Default is 10.
todos:
- No CIM equivalent. Monte Carlo study metadata; requires CIM extension.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
domain_of:
- Load
- Fault
range: float
required: false
CVRwatts:
name: CVRwatts
annotations:
order:
tag: order
value: 26
dss_default:
tag: dss_default
value: float(1.0)
description: Percent reduction in active power per 1% reduction in voltage from
100% rated. Default is 1. Applies to Model=4 only.
comments:
- 'Only meaningful when model=CVR (4). Import: LoadResponseCharacteristic.pVoltageExponent
= CVRwatts (or 1.0 if not specified), with exponentModel set True. Export: CVRwatts
= pVoltageExponent (or 1.0 if not set), written only when the LoadResponseCharacteristic
has exponentModel=True (which exports as model=4).'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
close_mappings:
- cim:LoadResponseCharacteristic.pVoltageExponent
rank: 1000
domain_of:
- Load
range: float
required: false
CVRvars:
name: CVRvars
annotations:
order:
tag: order
value: 27
dss_default:
tag: dss_default
value: float(2.0)
description: Percent reduction in reactive power per 1% reduction in voltage from
100% rated. Default is 2. Applies to Model=4 only.
comments:
- 'Only meaningful when model=CVR (4). Import: LoadResponseCharacteristic.qVoltageExponent
= CVRvars (or 2.0 if not specified), alongside CVRwatts (see CVRwatts comments).
Export: CVRvars = qVoltageExponent (or 2.0 if not set), written alongside CVRwatts
under the same condition.'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
close_mappings:
- cim:LoadResponseCharacteristic.qVoltageExponent
rank: 1000
domain_of:
- Load
range: float
required: false
kwh:
name: kwh
annotations:
order:
tag: order
value: 28
dss_default:
tag: dss_default
value: float(0.0)
description: kWh billed for this period. Default is 0.
todos:
- No CIM equivalent. Billing energy metadata; requires CIM extension.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
domain_of:
- Load
range: float
required: false
kwhdays:
name: kwhdays
annotations:
order:
tag: order
value: 29
dss_default:
tag: dss_default
value: float(30.0)
description: Length of kWh billing period in days (24 hr days). Default is 30.
todos:
- No CIM equivalent. Billing period metadata; requires CIM extension alongside
kwh.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
domain_of:
- Load
range: float
required: false
Cfactor:
name: Cfactor
annotations:
order:
tag: order
value: 30
dss_default:
tag: dss_default
value: float(4.0)
description: Factor relating average kW to peak kW. Default is 4.0.
todos:
- No CIM equivalent. Load factor metadata; requires CIM extension.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
domain_of:
- Load
range: float
required: false
CVRcurve:
name: CVRcurve
annotations:
order:
tag: order
value: 31
description: Curve describing both watt and var factors as a function of time.
Refers to a LoadShape object with both Mult and Qmult defined. Default is NONE.
todos:
- Loadshape converter not yet implemented. CVRcurve LoadShape reference should
map to a CIM schedule linked via LoadResponseCharacteristic.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
related_mappings:
- cim:SeasonDayTypeSchedule
rank: 1000
domain_of:
- Load
range: string
required: false
NumCust:
name: NumCust
annotations:
order:
tag: order
value: 32
dss_default:
tag: dss_default
value: int(1)
description: Number of customers, this load. Default is 1.
comments:
- 'Import: EnergyConsumer.customerCount = NumCust. Export: NumCust = customerCount.
Direct integer mapping; no unit conversion.'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
exact_mappings:
- cim:EnergyConsumer.customerCount
rank: 1000
domain_of:
- Load
range: integer
required: false
ZIPV:
name: ZIPV
annotations:
order:
tag: order
value: 33
description: Array of 7 coefficients for ZIP load model. First 3 are ZIP weighting
factors for real power (should sum to 1). Next 3 are ZIP weighting factors for
reactive power (should sum to 1). Last 1 is cut-off voltage in p.u. of base
kV.
comments:
- 'Only meaningful when model=ZIPV (8). Import: the 7 elements (p_z, p_i, p_p,
q_z, q_i, q_p, Vminpu) are read directly into the matching LoadResponseCharacteristic
ZIP-fraction fields (Vminpu is not currently stored). Export: when the LoadResponseCharacteristic''s
ZIP fractions don''t match one of the standard DSS profiles (models 1/2/3/5)
and it is not an exponent model, ZIPV is written as [p_z, p_i, p_p, q_z, q_i,
q_p, 0.5] — the 7th element (Vminpu) is always exported as a fixed 0.5, since
it is not stored on CIM.'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
close_mappings:
- cim:LoadResponseCharacteristic
rank: 1000
domain_of:
- Load
range: float
required: false
multivalued: true
pct_SeriesRL:
name: pct_SeriesRL
annotations:
order:
tag: order
value: 34
dss_name:
tag: dss_name
value: '%SeriesRL'
dss_default:
tag: dss_default
value: float(50.0)
description: Percent of load that is series R-L for Harmonic studies. Default
is 50. Remainder is assumed to be parallel R and L.
todos:
- No CIM equivalent. Harmonic study circuit decomposition; requires CIM extension.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
domain_of:
- Load
range: float
required: false
RelWeight:
name: RelWeight
annotations:
order:
tag: order
value: 35
dss_default:
tag: dss_default
value: float(1.0)
description: Relative weighting factor for reliability calcs. Default is 1. Used
to designate high priority loads such as hospitals.
todos:
- No CIM equivalent. Reliability priority weighting; requires CIM extension.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
domain_of:
- Load
range: float
required: false
Vlowpu:
name: Vlowpu
annotations:
order:
tag: order
value: 36
dss_default:
tag: dss_default
value: float(0.50)
description: Per unit voltage at which the model switches to constant Z model
(model=2). Default is 0.50.
todos:
- No CIM equivalent. Voltage-dependent model switching threshold; requires CIM
extension.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
domain_of:
- Load
range: float
required: false
puXharm:
name: puXharm
annotations:
order:
tag: order
value: 37
dss_default:
tag: dss_default
value: float(0.0)
description: Special reactance, pu (based on kVA, kV properties), for the series
impedance branch in the load model for HARMONICS analysis. Default is 0.
todos:
- No CIM equivalent. Harmonic-mode series reactance; requires CIM extension.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
domain_of:
- Load
range: float
required: false
XRharm:
name: XRharm
annotations:
order:
tag: order
value: 38
dss_default:
tag: dss_default
value: float(6.0)
description: X/R ratio of the special harmonics mode reactance specified by the
puXHARM property at fundamental frequency. Default is 6.
todos:
- No CIM equivalent. Harmonic-mode X/R ratio; requires CIM extension alongside
puXharm.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
domain_of:
- Load
range: float
required: false
spectrum:
name: spectrum
annotations:
order:
tag: order
value: 39
dss_default:
tag: dss_default
value: string(defaultload)
description: Name of harmonic current spectrum for this load. Default is "defaultload".
todos:
- No CIM equivalent. Harmonic current spectrum reference; requires CIM extension.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Gicsource
- Isource
- Vsource
range: string
required: false
basefreq:
name: basefreq
annotations:
order:
tag: order
value: 40
description: Base Frequency for ratings.
todos:
- Not stored on CIM EnergyConsumer. Base frequency should be extracted from the
CIM BaseVoltage or circuit-level object. Converter must derive this from circuit
context.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: float
required: false
enabled:
name: enabled
annotations:
order:
tag: order
value: 41
dss_default:
tag: dss_default
value: 'true'
description: Indicates whether this element is enabled.
comments:
- 'OpenDSS-only (N/A): CIM EnergyConsumer has no enabled/disabled flag; CIM consumers
are always considered active in the network model.'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: boolean
required: false
like:
name: like
annotations:
order:
tag: order
value: 42
description: 'Make like another object, e.g.: New Load.L2 like=L1 ...'
comments:
- 'OpenDSS-only (N/A): DSS template/copy directive resolved at parse time; no
CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Cndata
- Dynamicexp
- Growthshape
- Linecode
- Linegeometry
- Linespacing
- Loadshape
- Priceshape
- Spectrum
- TccCurve
- Tsdata
- Tshape
- Wiredata
- Xfmrcode
- Xycurve
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: string
required: false
class_uri: dss:Load
Induced¶
name: Load
description: A Load object in OpenDSS representing an energy consumer connected to
a bus in the distribution system.
comments:
- 'OpenDSS Load maps to CIM EnergyConsumer. On export, a single EnergyConsumer can
produce more than one DSS Load: an unbalanced multi-phase wye load (per-phase kW/kvar
not all equal) is split into one single-phase Load per EnergyConsumerPhase so the
imbalance is preserved, and a 2-phase wye load below 250 V (a center-tap/split-phase
service) is split the same way into two single-phase 120 V loads. Balanced loads
export as a single multi-phase Load.'
from_schema: https://gridappsd.github.io/dss-graph/opendss
exact_mappings:
- cim:EnergyConsumer
attributes:
name:
name: name
description: Object name. Must be unique per object type.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
exact_mappings:
- cim:IdentifiedObject.name
rank: 1000
identifier: true
owner: Load
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Cndata
- Dynamicexp
- Growthshape
- Linecode
- Linegeometry
- Linespacing
- Loadshape
- Priceshape
- Spectrum
- TccCurve
- Tsdata
- Tshape
- Wiredata
- Xfmrcode
- Xycurve
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: string
required: true
phases:
name: phases
annotations:
order:
tag: order
value: 1
dss_default:
tag: dss_default
value: int(3)
description: Number of Phases, this load. Load is evenly divided among phases.
comments:
- 'Import: if bus1 has an explicit phase suffix (e.g. ".1.2.3"), that is authoritative;
otherwise phases selects that many of A, B, C in order. One EnergyConsumerPhase
object is created per resolved phase. Export: phases = len(EnergyConsumerPhase),
except a 2-phase delta load exports as phases=1 (DSS represents a single-phase
L-L delta load this way).'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
related_mappings:
- cim:EnergyConsumerPhase
rank: 1000
owner: Load
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Xfmrcode
- Fault
- Gicsource
- Isource
- Vsource
range: integer
required: false
minimum_value: 1
maximum_value: 3
bus1:
name: bus1
annotations:
order:
tag: order
value: 2
description: Bus to which the load is connected. May include specific node specification.
comments:
- 'Import: bus name extracted from Terminal[0].ConnectivityNode.name; phase suffix
reconstructed from EnergyConsumerPhase.phase values. Export: bus1 = cn.name
+ ''.'' + ''.''.join(phase_suffix).'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
related_mappings:
- cim:Terminal.ConnectivityNode
rank: 1000
owner: Load
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Windgen
- Capacitor
- Line
- Reactor
- Fault
- Isource
- Vsource
range: string
required: true
kV:
name: kV
annotations:
order:
tag: order
value: 3
description: Nominal rated (1.0 per unit) voltage, kV, for load. For 2- and 3-phase
loads, specify phase-phase kV. Otherwise, specify actual kV across each branch
of the load. If wye (star), specify phase-neutral kV. If delta or phase-phase
connected, specify phase-phase kV.
comments:
- 'CIM BaseVoltage.nominalVoltage is always phase-phase (L-L). Import: EnergyConsumer.BaseVoltage.nominalVoltage
= Voltage(kV × √3, ''kV'') for a single-phase wye load, or Voltage(kV, ''kV'')
for delta or for 2-/3-phase wye (kV is already L-L in those cases). Export:
kV = nominalVoltage.to(''kV'') / √3 for a single-phase wye load, otherwise kV
= nominalVoltage.to(''kV''). If kV is omitted on import, the voltage is left
unset and filled in later by BFS-based repair.'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
close_mappings:
- cim:BaseVoltage.nominalVoltage
rank: 1000
owner: Load
domain_of:
- Load
- Autotrans
- Transformer
- Xfmrcode
range: float
required: false
minimum_value: 0.0
kW:
name: kW
annotations:
order:
tag: order
value: 4
description: Total base kW for the load. Normally, you would enter the maximum
kW for the load for the first year and allow it to be adjusted by the load shapes,
growth shapes, and global load multiplier.
comments:
- 'Import: EnergyConsumer.p = ActivePower(kW, ''kW''); if kW is not given but
kVA and pf are, kW = kVA × |pf| first (see kVA and pf comments). Export: kW
= p.to(''kW''). Sign: CIM positive p = power consumed (load convention matches);
no sign flip needed for loads.'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
close_mappings:
- cim:EnergyConsumer.p
rank: 1000
owner: Load
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Storage
- Vsconverter
- Windgen
range: float
required: false
pf:
name: pf
annotations:
order:
tag: order
value: 5
dss_default:
tag: dss_default
value: float(0.88)
description: Load power factor. Enter negative for leading power factor (when
kW and kvar have opposite signs).
comments:
- 'Not stored on CIM EnergyConsumer; CIM stores p and q independently. Import:
used only when kvar is not explicitly given — kvar = kW × tan(acos(|pf|)), sign-negated
if pf is negative (leading). Export: pf is always recomputed as p / sqrt(p²
+ q²) (1.0 if p and q are both zero); the sign of the original pf is not preserved.'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
owner: Load
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Upfc
range: float
required: false
minimum_value: -1.0
maximum_value: 1.0
model:
name: model
annotations:
order:
tag: order
value: 6
dss_default:
tag: dss_default
value: int(1)
dss_valid_values:
tag: dss_valid_values
value: 1,2,3,4,5,6,7,8
description: Integer code for the model to use for load variation with voltage.
1=Constant P+jQ (default), 2=Constant Z, 3=Const P Quadratic Q, 4=Nominal Linear
P Quadratic Q (CVR), 5=Constant I, 6=Const P Fixed Q, 7=Const P Fixed Impedance
Q, 8=ZIPV.
comments:
- 'Import: each DSS model value (1-8) selects a fixed ZIP (constant-impedance/current/power)
fraction profile for p and q, which is stored on a shared LoadResponseCharacteristic
and linked via EnergyConsumer.LoadResponse; model=4 (CVR) instead sets exponentModel=True
with CVRwatts/CVRvars as the p/q voltage exponents, and model=8 (ZIPV) reads
the 7-element ZIPV array directly into the ZIP fractions. Export: the reverse
lookup matches the LoadResponseCharacteristic''s ZIP fractions against the same
standard profiles (models 1, 2, 3, 5); an exponent model exports as model=4
with CVRwatts/CVRvars; any other combination of fractions exports as model=8
with a ZIPV array (Vminpu fixed at 0.5).'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
close_mappings:
- cim:LoadResponseCharacteristic
rank: 1000
owner: Load
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: LoadModel
required: false
yearly:
name: yearly
annotations:
order:
tag: order
value: 7
description: LOADSHAPE object name for yearly simulations. Must be previously
defined as a Loadshape object.
todos:
- Loadshape converter not yet implemented. DSS LoadShape name should map to a
CIM SeasonDayTypeSchedule or RegularIntervalSchedule linked to EnergyConsumer
via LoadGroup.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
related_mappings:
- cim:SeasonDayTypeSchedule
rank: 1000
owner: Load
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
daily:
name: daily
annotations:
order:
tag: order
value: 8
description: LOADSHAPE object name for daily simulations. Must be previously defined
as a Loadshape object of 24 hrs, typically.
todos:
- Loadshape converter not yet implemented. DSS LoadShape name should map to a
CIM SeasonDayTypeSchedule or RegularIntervalSchedule linked to EnergyConsumer
via LoadGroup.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
related_mappings:
- cim:SeasonDayTypeSchedule
rank: 1000
owner: Load
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
duty:
name: duty
annotations:
order:
tag: order
value: 9
description: LOADSHAPE object name for duty cycle simulations. Must be previously
defined as a Loadshape object. Typically would have time intervals less than
1 hr.
todos:
- Loadshape converter not yet implemented. DSS LoadShape name should map to a
CIM SeasonDayTypeSchedule or RegularIntervalSchedule linked to EnergyConsumer
via LoadGroup.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
related_mappings:
- cim:SeasonDayTypeSchedule
rank: 1000
owner: Load
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
growth:
name: growth
annotations:
order:
tag: order
value: 10
description: Growthshape object name to use for growth factors by years. Must
be previously defined as a Growthshape object. Defaults to circuit default growth
factor.
todos:
- GrowthShape converter not yet implemented. DSS GrowthShape name should reference
a CIM GrowthShape object.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
related_mappings:
- cim:GrowthShape
rank: 1000
owner: Load
domain_of:
- Load
range: string
required: false
conn:
name: conn
annotations:
order:
tag: order
value: 11
description: Connection type. Default is wye.
comments:
- 'Import: DSS ''wye''/''delta'' maps to CIM PhaseShuntConnectionKind.Y / D. Export:
reverse enum lookup.'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
exact_mappings:
- cim:EnergyConsumer.phaseConnection
rank: 1000
owner: Load
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Autotrans
- Capacitor
- Reactor
- Transformer
- Xfmrcode
- Sensor
range: ConnectionType
required: false
kvar:
name: kvar
annotations:
order:
tag: order
value: 12
description: Base kvar for specifying load as kW & kvar. Assumes kW has been already
defined. Alternative to specifying the power factor.
comments:
- 'Import: EnergyConsumer.q = ReactivePower(kvar, ''kVAr''). Export: kvar = q.to(''kVAr'').
Sign: positive q = inductive (lagging) consumption in CIM load convention.'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
close_mappings:
- cim:EnergyConsumer.q
rank: 1000
owner: Load
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
- Capacitor
- Reactor
range: float
required: false
Rneut:
name: Rneut
annotations:
order:
tag: order
value: 13
dss_default:
tag: dss_default
value: float(-1.0)
description: Neutral resistance of wye-connected load in actual ohms. Default
is -1. If entered as negative, the neutral can be open or floating.
todos:
- No CIM equivalent. Requires CIM extension (e.g. custom attribute on EnergyConsumer
or dedicated NeutralImpedance class) to round-trip.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
owner: Load
domain_of:
- Load
- Transformer
- Xfmrcode
range: float
required: false
Xneut:
name: Xneut
annotations:
order:
tag: order
value: 14
dss_default:
tag: dss_default
value: float(0.0)
description: Neutral reactance of wye-connected load in actual ohms. May be positive
or negative.
todos:
- No CIM equivalent. Requires CIM extension alongside Rneut.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
owner: Load
domain_of:
- Load
- Transformer
- Xfmrcode
range: float
required: false
status:
name: status
annotations:
order:
tag: order
value: 15
description: Load status. Variable=all multipliers apply, Fixed=no load multipliers
(growth still applies), Exempt=not modified by global load multiplier.
todos:
- No CIM equivalent for load multiplier status flags. Requires CIM extension.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
owner: Load
domain_of:
- Load
- Generator
range: LoadStatus
required: false
load_class:
name: load_class
annotations:
order:
tag: order
value: 16
dss_name:
tag: dss_name
value: class
dss_default:
tag: dss_default
value: int(1)
description: An arbitrary integer number representing the class of load so that
load values may be segregated by load value. Default is 1; not used internally.
todos:
- No CIM equivalent. Could potentially map to a PSRType classification but no
standard CIM field exists.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
owner: Load
domain_of:
- Load
range: integer
required: false
Vminpu:
name: Vminpu
annotations:
order:
tag: order
value: 17
dss_default:
tag: dss_default
value: float(0.95)
description: Minimum per unit voltage for which the MODEL is assumed to apply.
Lower end of normal voltage range. Default is 0.95.
todos:
- No CIM equivalent. Requires CIM extension for per-unit voltage model applicability
bounds.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
owner: Load
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: float
required: false
Vmaxpu:
name: Vmaxpu
annotations:
order:
tag: order
value: 18
dss_default:
tag: dss_default
value: float(1.05)
description: Maximum per unit voltage for which the MODEL is assumed to apply.
Default is 1.05.
todos:
- No CIM equivalent. Requires CIM extension alongside Vminpu.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
owner: Load
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: float
required: false
Vminnorm:
name: Vminnorm
annotations:
order:
tag: order
value: 19
dss_default:
tag: dss_default
value: float(0.0)
description: Minimum per unit voltage for load EEN evaluations, Normal limit.
Default is 0, which defaults to system vminnorm property.
todos:
- No CIM equivalent. Requires CIM extension for normal-range voltage limit on
loads.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
owner: Load
domain_of:
- Load
range: float
required: false
Vminemerg:
name: Vminemerg
annotations:
order:
tag: order
value: 20
dss_default:
tag: dss_default
value: float(0.0)
description: Minimum per unit voltage for load UE evaluations, Emergency limit.
Default is 0, which defaults to system vminemerg property.
todos:
- No CIM equivalent. Requires CIM extension for emergency-range voltage limit
on loads.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
owner: Load
domain_of:
- Load
range: float
required: false
xfkVA:
name: xfkVA
annotations:
order:
tag: order
value: 21
dss_default:
tag: dss_default
value: float(0.0)
description: Rated kVA of service transformer for allocating loads based on connected
kVA at a bus. Default is 0.0.
todos:
- No CIM equivalent. Load allocation metadata; requires CIM extension.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
owner: Load
domain_of:
- Load
range: float
required: false
allocationfactor:
name: allocationfactor
annotations:
order:
tag: order
value: 22
dss_default:
tag: dss_default
value: float(0.5)
description: Allocation factor for allocating loads based on connected kVA at
a bus. Default is 0.5.
todos:
- No CIM equivalent. Load allocation metadata; requires CIM extension alongside
xfkVA.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
owner: Load
domain_of:
- Load
range: float
required: false
kVA:
name: kVA
annotations:
order:
tag: order
value: 23
description: Specify base Load in kVA (and power factor).
comments:
- 'Not stored on CIM EnergyConsumer; p and q are stored independently. Import:
used only when kW is not given — combined with pf to derive kW = kVA × |pf|
(see kW comments); kvar is then derived from that kW and pf as usual. Export:
not written; kVA is not reconstructed on the DSS side (only kW/kvar/pf are).'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
owner: Load
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Autotrans
- Transformer
- Xfmrcode
range: float
required: false
pct_mean:
name: pct_mean
annotations:
order:
tag: order
value: 24
dss_name:
tag: dss_name
value: '%mean'
dss_default:
tag: dss_default
value: float(50.0)
description: Percent mean value for load to use for monte carlo studies if no
loadshape is assigned to this load. Default is 50.
todos:
- No CIM equivalent. Monte Carlo study metadata; requires CIM extension.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
owner: Load
domain_of:
- Load
range: float
required: false
pct_stddev:
name: pct_stddev
annotations:
order:
tag: order
value: 25
dss_name:
tag: dss_name
value: '%stddev'
dss_default:
tag: dss_default
value: float(10.0)
description: Percent Std deviation value for load to use for monte carlo studies
if no loadshape is assigned to this load. Default is 10.
todos:
- No CIM equivalent. Monte Carlo study metadata; requires CIM extension.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
owner: Load
domain_of:
- Load
- Fault
range: float
required: false
CVRwatts:
name: CVRwatts
annotations:
order:
tag: order
value: 26
dss_default:
tag: dss_default
value: float(1.0)
description: Percent reduction in active power per 1% reduction in voltage from
100% rated. Default is 1. Applies to Model=4 only.
comments:
- 'Only meaningful when model=CVR (4). Import: LoadResponseCharacteristic.pVoltageExponent
= CVRwatts (or 1.0 if not specified), with exponentModel set True. Export: CVRwatts
= pVoltageExponent (or 1.0 if not set), written only when the LoadResponseCharacteristic
has exponentModel=True (which exports as model=4).'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
close_mappings:
- cim:LoadResponseCharacteristic.pVoltageExponent
rank: 1000
owner: Load
domain_of:
- Load
range: float
required: false
CVRvars:
name: CVRvars
annotations:
order:
tag: order
value: 27
dss_default:
tag: dss_default
value: float(2.0)
description: Percent reduction in reactive power per 1% reduction in voltage from
100% rated. Default is 2. Applies to Model=4 only.
comments:
- 'Only meaningful when model=CVR (4). Import: LoadResponseCharacteristic.qVoltageExponent
= CVRvars (or 2.0 if not specified), alongside CVRwatts (see CVRwatts comments).
Export: CVRvars = qVoltageExponent (or 2.0 if not set), written alongside CVRwatts
under the same condition.'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
close_mappings:
- cim:LoadResponseCharacteristic.qVoltageExponent
rank: 1000
owner: Load
domain_of:
- Load
range: float
required: false
kwh:
name: kwh
annotations:
order:
tag: order
value: 28
dss_default:
tag: dss_default
value: float(0.0)
description: kWh billed for this period. Default is 0.
todos:
- No CIM equivalent. Billing energy metadata; requires CIM extension.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
owner: Load
domain_of:
- Load
range: float
required: false
kwhdays:
name: kwhdays
annotations:
order:
tag: order
value: 29
dss_default:
tag: dss_default
value: float(30.0)
description: Length of kWh billing period in days (24 hr days). Default is 30.
todos:
- No CIM equivalent. Billing period metadata; requires CIM extension alongside
kwh.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
owner: Load
domain_of:
- Load
range: float
required: false
Cfactor:
name: Cfactor
annotations:
order:
tag: order
value: 30
dss_default:
tag: dss_default
value: float(4.0)
description: Factor relating average kW to peak kW. Default is 4.0.
todos:
- No CIM equivalent. Load factor metadata; requires CIM extension.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
owner: Load
domain_of:
- Load
range: float
required: false
CVRcurve:
name: CVRcurve
annotations:
order:
tag: order
value: 31
description: Curve describing both watt and var factors as a function of time.
Refers to a LoadShape object with both Mult and Qmult defined. Default is NONE.
todos:
- Loadshape converter not yet implemented. CVRcurve LoadShape reference should
map to a CIM schedule linked via LoadResponseCharacteristic.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
related_mappings:
- cim:SeasonDayTypeSchedule
rank: 1000
owner: Load
domain_of:
- Load
range: string
required: false
NumCust:
name: NumCust
annotations:
order:
tag: order
value: 32
dss_default:
tag: dss_default
value: int(1)
description: Number of customers, this load. Default is 1.
comments:
- 'Import: EnergyConsumer.customerCount = NumCust. Export: NumCust = customerCount.
Direct integer mapping; no unit conversion.'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
exact_mappings:
- cim:EnergyConsumer.customerCount
rank: 1000
owner: Load
domain_of:
- Load
range: integer
required: false
ZIPV:
name: ZIPV
annotations:
order:
tag: order
value: 33
description: Array of 7 coefficients for ZIP load model. First 3 are ZIP weighting
factors for real power (should sum to 1). Next 3 are ZIP weighting factors for
reactive power (should sum to 1). Last 1 is cut-off voltage in p.u. of base
kV.
comments:
- 'Only meaningful when model=ZIPV (8). Import: the 7 elements (p_z, p_i, p_p,
q_z, q_i, q_p, Vminpu) are read directly into the matching LoadResponseCharacteristic
ZIP-fraction fields (Vminpu is not currently stored). Export: when the LoadResponseCharacteristic''s
ZIP fractions don''t match one of the standard DSS profiles (models 1/2/3/5)
and it is not an exponent model, ZIPV is written as [p_z, p_i, p_p, q_z, q_i,
q_p, 0.5] — the 7th element (Vminpu) is always exported as a fixed 0.5, since
it is not stored on CIM.'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
close_mappings:
- cim:LoadResponseCharacteristic
rank: 1000
owner: Load
domain_of:
- Load
range: float
required: false
multivalued: true
pct_SeriesRL:
name: pct_SeriesRL
annotations:
order:
tag: order
value: 34
dss_name:
tag: dss_name
value: '%SeriesRL'
dss_default:
tag: dss_default
value: float(50.0)
description: Percent of load that is series R-L for Harmonic studies. Default
is 50. Remainder is assumed to be parallel R and L.
todos:
- No CIM equivalent. Harmonic study circuit decomposition; requires CIM extension.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
owner: Load
domain_of:
- Load
range: float
required: false
RelWeight:
name: RelWeight
annotations:
order:
tag: order
value: 35
dss_default:
tag: dss_default
value: float(1.0)
description: Relative weighting factor for reliability calcs. Default is 1. Used
to designate high priority loads such as hospitals.
todos:
- No CIM equivalent. Reliability priority weighting; requires CIM extension.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
owner: Load
domain_of:
- Load
range: float
required: false
Vlowpu:
name: Vlowpu
annotations:
order:
tag: order
value: 36
dss_default:
tag: dss_default
value: float(0.50)
description: Per unit voltage at which the model switches to constant Z model
(model=2). Default is 0.50.
todos:
- No CIM equivalent. Voltage-dependent model switching threshold; requires CIM
extension.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
owner: Load
domain_of:
- Load
range: float
required: false
puXharm:
name: puXharm
annotations:
order:
tag: order
value: 37
dss_default:
tag: dss_default
value: float(0.0)
description: Special reactance, pu (based on kVA, kV properties), for the series
impedance branch in the load model for HARMONICS analysis. Default is 0.
todos:
- No CIM equivalent. Harmonic-mode series reactance; requires CIM extension.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
owner: Load
domain_of:
- Load
range: float
required: false
XRharm:
name: XRharm
annotations:
order:
tag: order
value: 38
dss_default:
tag: dss_default
value: float(6.0)
description: X/R ratio of the special harmonics mode reactance specified by the
puXHARM property at fundamental frequency. Default is 6.
todos:
- No CIM equivalent. Harmonic-mode X/R ratio; requires CIM extension alongside
puXharm.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
owner: Load
domain_of:
- Load
range: float
required: false
spectrum:
name: spectrum
annotations:
order:
tag: order
value: 39
dss_default:
tag: dss_default
value: string(defaultload)
description: Name of harmonic current spectrum for this load. Default is "defaultload".
todos:
- No CIM equivalent. Harmonic current spectrum reference; requires CIM extension.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
owner: Load
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Gicsource
- Isource
- Vsource
range: string
required: false
basefreq:
name: basefreq
annotations:
order:
tag: order
value: 40
description: Base Frequency for ratings.
todos:
- Not stored on CIM EnergyConsumer. Base frequency should be extracted from the
CIM BaseVoltage or circuit-level object. Converter must derive this from circuit
context.
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
owner: Load
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: float
required: false
enabled:
name: enabled
annotations:
order:
tag: order
value: 41
dss_default:
tag: dss_default
value: 'true'
description: Indicates whether this element is enabled.
comments:
- 'OpenDSS-only (N/A): CIM EnergyConsumer has no enabled/disabled flag; CIM consumers
are always considered active in the network model.'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
owner: Load
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: boolean
required: false
like:
name: like
annotations:
order:
tag: order
value: 42
description: 'Make like another object, e.g.: New Load.L2 like=L1 ...'
comments:
- 'OpenDSS-only (N/A): DSS template/copy directive resolved at parse time; no
CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/load
rank: 1000
owner: Load
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Cndata
- Dynamicexp
- Growthshape
- Linecode
- Linegeometry
- Linespacing
- Loadshape
- Priceshape
- Spectrum
- TccCurve
- Tsdata
- Tshape
- Wiredata
- Xfmrcode
- Xycurve
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: string
required: false
class_uri: dss:Load