Class: Pvsystem¶
A Pvsystem object in OpenDSS representing a photovoltaic generator with inverter-based grid connection.
URI: dss:Pvsystem
classDiagram
class Pvsystem
click Pvsystem href "../Pvsystem/"
Pvsystem : AmpLimit
Pvsystem : AmpLimitGain
Pvsystem : Balanced
Pvsystem : basefreq
Pvsystem : bus1
Pvsystem : class_class
Pvsystem : conn
Pvsystem : ControlMode
Pvsystem : daily
Pvsystem : debugtrace
Pvsystem : duty
Pvsystem : DutyStart
Pvsystem : DynamicEq
Pvsystem : DynOut
Pvsystem : EffCurve
Pvsystem : enabled
Pvsystem : irradiance
Pvsystem : Kp
Pvsystem : kv
Pvsystem : kVA
Pvsystem : kvar
Pvsystem : kvarMax
Pvsystem : kvarMaxAbs
Pvsystem : kVDC
Pvsystem : like
Pvsystem : LimitCurrent
Pvsystem : model
Pvsystem : name
Pvsystem : P_TCurve
Pvsystem : pct_Cutin
Pvsystem : pct_Cutout
Pvsystem : pct_PminkvarMax
Pvsystem : pct_PminNoVars
Pvsystem : pct_Pmpp
Pvsystem : pct_R
Pvsystem : pct_X
Pvsystem : pf
Pvsystem : PFPriority
Pvsystem : phases
Pvsystem : PITol
Pvsystem : Pmpp
Pvsystem : SafeMode
Pvsystem : SafeVoltage
Pvsystem : spectrum
Pvsystem : Tdaily
Pvsystem : Tduty
Pvsystem : Temperature
Pvsystem : Tyearly
Pvsystem : UserData
Pvsystem : UserModel
Pvsystem : VarFollowInverter
Pvsystem : Vmaxpu
Pvsystem : Vminpu
Pvsystem : WattPriority
Pvsystem : yearly
Class Properties¶
| Property | Value |
|---|---|
| Class URI | dss:Pvsystem |
Slots¶
| Name | Cardinality and Range | Description | Inheritance |
|---|---|---|---|
| name | 1 String |
Object name | direct |
| phases | 0..1 Integer |
Number of Phases, this PVSystem element | direct |
| bus1 | 0..1 String |
Bus to which the PVSystem element is connected | direct |
| kv | 0..1 Float |
Nominal rated (1 | direct |
| irradiance | 0..1 Float |
Get/set the present irradiance value in kW/sq-m | direct |
| Pmpp | 0..1 Float |
Get/set the rated max power of the PV array for 1 | direct |
| pct_Pmpp | 0..1 Float |
Upper limit on active power as a percentage of Pmpp | direct |
| Temperature | 0..1 Float |
Get/set the present Temperature (deg C) for the P-T curve | direct |
| pf | 0..1 Float |
Nominally, the power factor for the output power | direct |
| conn | 0..1 String |
={wye | LN |
| kvar | 0..1 Float |
Get/set the present kvar value | direct |
| kVA | 0..1 Float |
kVA rating of inverter | direct |
| pct_Cutin | 0..1 Float |
% cut-in power -- % of kVA rating of inverter | direct |
| pct_Cutout | 0..1 Float |
% cut-out power -- % of kVA rating of inverter | direct |
| EffCurve | 0..1 Float |
An XYCurve object, previously defined, that describes the PER UNIT efficiency... | direct |
| P_TCurve | 0..1 Float |
An XYCurve object, previously defined, that describes the PV array PER UNIT P... | direct |
| pct_R | 0..1 Float |
Equivalent percent internal resistance, ohms | direct |
| pct_X | 0..1 Float |
Equivalent percent internal reactance, ohms | direct |
| model | 0..1 Integer |
Integer code (default=1) for the model to use for power output variation with... | direct |
| Vminpu | 0..1 Float |
Minimum per unit voltage | direct |
| Vmaxpu | 0..1 Float |
Maximum per unit voltage | direct |
| Balanced | 0..1 Boolean |
{Yes | No*} Default is No |
| LimitCurrent | 0..1 Float |
Limits current magnitude to Vminpu value for both 1-phase and 3-phase PVSyste... | direct |
| yearly | 0..1 String |
Dispatch shape to use for yearly simulations | direct |
| daily | 0..1 String |
Dispatch shape to use for daily simulations | direct |
| duty | 0..1 Integer |
Load shape to use for duty cycle dispatch simulations | direct |
| Tyearly | 0..1 String |
Temperature shape to use for yearly simulations | direct |
| Tdaily | 0..1 String |
Temperature shape to use for daily simulations | direct |
| Tduty | 0..1 Integer |
Temperature shape to use for duty cycle dispatch simulations | direct |
| class_class | 0..1 Integer |
An arbitrary integer number representing the class of PVSystem element | direct |
| UserModel | 0..1 Float |
Name of DLL containing user-written model for Dynamics studies | direct |
| UserData | 0..1 String |
String that gets passed to user-written model for defining the data required ... | direct |
| debugtrace | 0..1 Boolean |
{Yes | No } Default is no |
| VarFollowInverter | 0..1 Boolean |
Boolean variable (Yes | No) or (True |
| DutyStart | 0..1 String |
Starting time offset [hours] into the duty cycle shape | direct |
| WattPriority | 0..1 String |
{Yes/No*/True/False} Set inverter to watt priority instead of the default var... | direct |
| PFPriority | 0..1 String |
{Yes/No*/True/False} Set inverter to operate with PF priority when in constan... | direct |
| pct_PminNoVars | 0..1 Float |
Minimum active power as percentage of Pmpp under which there is no vars produ... | direct |
| pct_PminkvarMax | 0..1 Float |
Minimum active power as percentage of Pmpp that allows the inverter to produc... | direct |
| kvarMax | 0..1 Float |
Maximum reactive power GENERATION (un-signed, kvar) for the inverter | direct |
| kvarMaxAbs | 0..1 Float |
Maximum reactive power ABSORPTION (un-signed, kvar) for the inverter | direct |
| kVDC | 0..1 Float |
Indicates the rated voltage (kV) at the input of the inverter at the peak of ... | direct |
| Kp | 0..1 String |
It is the proportional gain for the PI controller within the inverter | direct |
| PITol | 0..1 String |
It is the tolerance (%) for the closed loop controller of the inverter | direct |
| SafeVoltage | 0..1 Float |
Indicates the voltage level (%) respect to the base voltage level for which t... | direct |
| SafeMode | 0..1 String |
(Read only) Indicates whether the inverter entered (Yes) or not (No) into Saf... | direct |
| DynamicEq | 0..1 String |
The name of the dynamic equation (DinamicExp) that will be used for defining ... | direct |
| DynOut | 0..1 Float |
The name of the variables within the Dynamic equation that will be used to go... | direct |
| ControlMode | 0..1 String |
Defines the control mode for the inverter | direct |
| AmpLimit | 0..1 Float |
Is the current limiter per phase for the IBR when operating in GFM mode | direct |
| AmpLimitGain | 0..1 Float |
Use it for fine tunning the current limiter when active, by default is 0 | direct |
| spectrum | 0..1 Float |
Name of harmonic voltage or current spectrum for this PVSystem element | direct |
| basefreq | 0..1 Float |
Base Frequency for ratings | direct |
| enabled | 0..1 Boolean |
{Yes | No or True |
| like | 0..1 String |
Make like another object, e | direct |
Comments¶
- Each DSS PVSystem creates two CIM objects: PhotoVoltaicUnit (the PV panel; holds maxP/minP) and PowerElectronicsConnection (the inverter; holds ratedS, ratedU, p, q, maxQ, minQ). The converter returns the PowerElectronicsConnection; the PhotoVoltaicUnit is linked via PowerElectronicsConnection.PowerElectronicsUnit.
Identifier and Mapping Information¶
Schema Source¶
- from schema: https://gridappsd.github.io/dss-graph/opendss
Mappings¶
| Mapping Type | Mapped Value |
|---|---|
| self | dss:Pvsystem |
| native | dss:Pvsystem |
| close | cim:PhotoVoltaicUnit |
LinkML Source¶
Direct¶
name: Pvsystem
description: A Pvsystem object in OpenDSS representing a photovoltaic generator with
inverter-based grid connection.
comments:
- 'Each DSS PVSystem creates two CIM objects: PhotoVoltaicUnit (the PV panel; holds
maxP/minP) and PowerElectronicsConnection (the inverter; holds ratedS, ratedU, p,
q, maxQ, minQ). The converter returns the PowerElectronicsConnection; the PhotoVoltaicUnit
is linked via PowerElectronicsConnection.PowerElectronicsUnit.'
from_schema: https://gridappsd.github.io/dss-graph/opendss
close_mappings:
- cim:PhotoVoltaicUnit
attributes:
name:
name: name
description: Object name. Must be unique per object type.
comments:
- Name applied to both PhotoVoltaicUnit and PowerElectronicsConnection with suffix
'_pv' / '_pec'.
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
exact_mappings:
- cim:IdentifiedObject.name
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
description: Number of Phases, this PVSystem element
comments:
- 'Import: inferred from bus1 node suffix. Export: len(PowerElectronicsConnection.PowerElectronicsConnectionPhase).'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
related_mappings:
- cim:PowerElectronicsConnectionPhase
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
bus1:
name: bus1
annotations:
order:
tag: order
value: 2
description: Bus to which the PVSystem element is connected
comments:
- 'Structural mapping via traversal: equipment.Terminals[0].ConnectivityNode.name.
Phase suffix reconstructed from PowerElectronicsConnectionPhase objects.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
related_mappings:
- cim:Terminal.ConnectivityNode
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Windgen
- Capacitor
- Line
- Reactor
- Fault
- Isource
- Vsource
range: string
required: false
kv:
name: kv
annotations:
order:
tag: order
value: 3
description: Nominal rated (1.0 per unit) voltage, kV, for PVSystem element. For
2- and 3-phase PVSystems, specify phase-phase kV. Otherwise, specify actual
kV across each branch.
comments:
- 'Direct unit conversion with no phase-count-dependent scaling: ratedU = Voltage(kv,
''kV'') on import, kv = ratedU.to(''kV'') on export. OpenDSS PVSystem kV is
always line-to-line regardless of phase count, so single-phase PVSystems are
not scaled by sqrt(3). CIM stores the value in V (SI base).'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
exact_mappings:
- cim:PowerElectronicsConnection.ratedU
domain_of:
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Capacitor
- Reactor
range: float
required: false
minimum_value: 0.0
irradiance:
name: irradiance
annotations:
order:
tag: order
value: 4
dss_name:
tag: dss_name
value: irrad
description: Get/set the present irradiance value in kW/sq-m
comments:
- 'OpenDSS-only (N/A): operational state variable; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
range: float
required: false
minimum_value: 0.0
Pmpp:
name: Pmpp
annotations:
order:
tag: order
value: 5
description: Get/set the rated max power of the PV array for 1.0 kW/sq-m irradiance,
kW.
comments:
- 'Import: PhotoVoltaicUnit.maxP = ActivePower(Pmpp, ''kW''). Export: Pmpp = maxP.to(''kW'').
CIM stores in W (SI base).'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
exact_mappings:
- cim:PowerElectronicsUnit.maxP
rank: 1000
domain_of:
- Pvsystem
range: float
required: false
pct_Pmpp:
name: pct_Pmpp
annotations:
order:
tag: order
value: 6
dss_name:
tag: dss_name
value: '%Pmpp'
description: Upper limit on active power as a percentage of Pmpp
comments:
- 'OpenDSS-only (N/A): operational curtailment factor; no CIM equivalent in the
standard profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
range: float
required: false
Temperature:
name: Temperature
annotations:
order:
tag: order
value: 7
description: Get/set the present Temperature (deg C) for the P-T curve.
comments:
- 'OpenDSS-only (N/A): operational state variable; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
range: float
required: false
pf:
name: pf
annotations:
order:
tag: order
value: 8
dss_default:
tag: dss_default
value: float(0.88)
description: Nominally, the power factor for the output power. Default is 0.88.
Consumed to compute kvar if kvar is not specified.
comments:
- 'Import fallback only, used when kvar is not explicitly specified: q = Pmpp
* tan(acos(|pf|)), sign-flipped when pf is negative (leading power factor),
then stored on PowerElectronicsConnection.q. CIM has no dedicated power-factor
field, so pf itself is not stored — only its derived q value is. Export never
recovers pf; it always writes an explicit kvar value.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
related_mappings:
- cim:PowerElectronicsConnection.q
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Upfc
range: float
required: false
minimum_value: -1.0
maximum_value: 1.0
conn:
name: conn
annotations:
order:
tag: order
value: 9
description: ={wye|LN|delta|LL}
comments:
- 'No dedicated CIM connection-kind field is set. Import: when conn is ''delta'',
PowerElectronicsConnection.description is set to the literal string ''conn=delta''
as a workaround; wye (the default) leaves description unset. Export: reads that
literal string back to decide whether to write conn=delta; otherwise conn is
omitted and OpenDSS defaults to wye.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
related_mappings:
- cim:PowerElectronicsConnection.description
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Autotrans
- Capacitor
- Reactor
- Transformer
- Xfmrcode
- Sensor
range: string
required: false
kvar:
name: kvar
annotations:
order:
tag: order
value: 10
description: Get/set the present kvar value. Positive is capacitive (generator
convention).
comments:
- 'Import: PEC.q = ReactivePower(-kvar, ''kVAr'') — negated because DSS uses generator
convention (positive kvar = capacitive = +Q supplied to grid), while CIM Terminal
uses load convention (positive q = absorbed). Export: kvar = -PEC.q.to(''kVAr'').'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
close_mappings:
- cim:PowerElectronicsConnection.q
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
- Capacitor
- Reactor
range: float
required: false
kVA:
name: kVA
annotations:
order:
tag: order
value: 11
description: kVA rating of inverter. Defaults to 1.1 * Pmpp.
comments:
- 'Import: PEC.ratedS = ApparentPower(kVA, ''kVA''). Export: kVA = ratedS.to(''kVA'').
CIM stores in VA (SI base).'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
exact_mappings:
- cim:PowerElectronicsConnection.ratedS
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Autotrans
- Transformer
- Xfmrcode
range: float
required: false
pct_Cutin:
name: pct_Cutin
annotations:
order:
tag: order
value: 12
dss_name:
tag: dss_name
value: '%Cutin'
description: '% cut-in power -- % of kVA rating of inverter. Below this, PVSystem
is idle.'
comments:
- 'OpenDSS-only (N/A): inverter dispatch threshold; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
- Storage
range: float
required: false
pct_Cutout:
name: pct_Cutout
annotations:
order:
tag: order
value: 13
dss_name:
tag: dss_name
value: '%Cutout'
description: '% cut-out power -- % of kVA rating of inverter. Below this, PVSystem
turns off.'
comments:
- 'OpenDSS-only (N/A): inverter dispatch threshold; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
- Storage
range: float
required: false
EffCurve:
name: EffCurve
annotations:
order:
tag: order
value: 14
description: An XYCurve object, previously defined, that describes the PER UNIT
efficiency vs PER UNIT of rated kVA for the inverter.
todos:
- No CIM equivalent. Inverter efficiency curve; requires CIM extension or mapping
to a custom XYCurve linked to the PEC.
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
- Storage
range: float
required: false
P-TCurve:
name: P-TCurve
annotations:
order:
tag: order
value: 15
description: An XYCurve object, previously defined, that describes the PV array
PER UNIT Pmpp vs Temperature curve.
todos:
- No CIM equivalent. Temperature derating curve for PV panel; requires CIM extension.
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
range: float
required: false
pct_R:
name: pct_R
annotations:
order:
tag: order
value: 16
dss_name:
tag: dss_name
value: '%R'
description: Equivalent percent internal resistance, ohms. Default is 0.
comments:
- 'OpenDSS-only (N/A): internal resistance used for short-circuit simulation;
no standard CIM equivalent on PowerElectronicsConnection.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
- Storage
- Autotrans
- Transformer
- Xfmrcode
range: float
required: false
pct_X:
name: pct_X
annotations:
order:
tag: order
value: 17
dss_name:
tag: dss_name
value: '%X'
description: Equivalent percent internal reactance, ohms. Default is 50.
comments:
- 'OpenDSS-only (N/A): internal reactance used for short-circuit simulation; no
standard CIM equivalent on PowerElectronicsConnection.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
- Storage
range: float
required: false
model:
name: model
annotations:
order:
tag: order
value: 18
dss_default:
tag: dss_default
value: int(1)
dss_valid_values:
tag: dss_valid_values
value: 1,2,3
description: Integer code (default=1) for the model to use for power output variation
with voltage. 1=Constant P+jQ, 2=Constant Z, 3=Constant I.
comments:
- 'OpenDSS-only (N/A): DSS V/Q model selector; no direct CIM equivalent in the
standard profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: integer
required: false
Vminpu:
name: Vminpu
annotations:
order:
tag: order
value: 19
dss_default:
tag: dss_default
value: float(0.0)
description: Minimum per unit voltage. Default = 0.9. Below this, inverter trips
and the element goes to constant impedance mode.
comments:
- 'Import: PEC.maxIFault = 1.0 / Vminpu (current limit scales inversely with voltage
minimum). Export: Vminpu = 1.0 / maxIFault. Approximate mapping — maxIFault
is the primary CIM field used by OpenDSS for fault current limiting.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
close_mappings:
- cim:PowerElectronicsConnection.maxIFault
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: float
required: false
minimum_value: 0.0
Vmaxpu:
name: Vmaxpu
annotations:
order:
tag: order
value: 20
dss_default:
tag: dss_default
value: float(1.1)
description: Maximum per unit voltage. Default = 1.1.
comments:
- 'OpenDSS-only (N/A): overvoltage trip threshold; no direct CIM equivalent in
the standard profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: float
required: false
minimum_value: 0.0
Balanced:
name: Balanced
annotations:
order:
tag: order
value: 21
description: '{Yes | No*} Default is No. If true, force balanced operation.'
comments:
- 'OpenDSS-only (N/A): simulation option; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
domain_of:
- Generator
- Pvsystem
- Storage
range: boolean
required: false
LimitCurrent:
name: LimitCurrent
annotations:
order:
tag: order
value: 22
description: Limits current magnitude to Vminpu value for both 1-phase and 3-phase
PVSystems similar to Generator Model 7.
comments:
- 'OpenDSS-only (N/A): current-limiting simulation flag; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
- Storage
range: float
required: false
yearly:
name: yearly
annotations:
order:
tag: order
value: 23
description: Dispatch shape to use for yearly simulations. LoadShape name.
todos:
- Loadshape converter not yet implemented. DSS LoadShape name should map to a
CIM SeasonDayTypeSchedule or RegularIntervalSchedule linked to the PowerElectronicsConnection.
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
related_mappings:
- cim:SeasonDayTypeSchedule
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
daily:
name: daily
annotations:
order:
tag: order
value: 24
description: Dispatch shape to use for daily simulations. LoadShape name.
todos:
- Loadshape converter not yet implemented.
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
related_mappings:
- cim:SeasonDayTypeSchedule
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
duty:
name: duty
annotations:
order:
tag: order
value: 25
description: Load shape to use for duty cycle dispatch simulations.
todos:
- Loadshape converter not yet implemented.
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
related_mappings:
- cim:SeasonDayTypeSchedule
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: integer
required: false
Tyearly:
name: Tyearly
annotations:
order:
tag: order
value: 26
description: Temperature shape to use for yearly simulations.
comments:
- 'OpenDSS-only (N/A): temperature-driven derating schedule; no CIM equivalent
in the standard profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
range: string
required: false
Tdaily:
name: Tdaily
annotations:
order:
tag: order
value: 27
description: Temperature shape to use for daily simulations.
comments:
- 'OpenDSS-only (N/A): temperature-driven derating schedule; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
range: string
required: false
Tduty:
name: Tduty
annotations:
order:
tag: order
value: 28
description: Temperature shape to use for duty cycle dispatch simulations.
comments:
- 'OpenDSS-only (N/A): temperature-driven derating schedule; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
range: integer
required: false
class_class:
name: class_class
annotations:
order:
tag: order
value: 29
dss_name:
tag: dss_name
value: class
description: An arbitrary integer number representing the class of PVSystem element.
comments:
- 'OpenDSS-only (N/A): internal classification integer; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
- Storage
- Windgen
range: integer
required: false
UserModel:
name: UserModel
annotations:
order:
tag: order
value: 30
description: Name of DLL containing user-written model for Dynamics studies.
comments:
- 'OpenDSS-only (N/A): dynamics DLL hook; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
- Capcontrol
range: float
required: false
UserData:
name: UserData
annotations:
order:
tag: order
value: 31
description: String that gets passed to user-written model for defining the data
required for that model.
comments:
- 'OpenDSS-only (N/A): dynamics DLL data; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
- Capcontrol
range: string
required: false
debugtrace:
name: debugtrace
annotations:
order:
tag: order
value: 32
description: '{Yes | No } Default is no. If true, writes debug trace to a file.'
comments:
- 'OpenDSS-only (N/A): simulation debug flag; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
- Regcontrol
range: boolean
required: false
VarFollowInverter:
name: VarFollowInverter
annotations:
order:
tag: order
value: 33
description: Boolean variable (Yes|No) or (True|False). When True, reactive power
follows the inverter dispatch.
comments:
- 'OpenDSS-only (N/A): inverter control mode flag; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
- Storage
range: boolean
required: false
DutyStart:
name: DutyStart
annotations:
order:
tag: order
value: 34
description: Starting time offset [hours] into the duty cycle shape. Default is
0.
comments:
- 'OpenDSS-only (N/A): simulation time offset; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
domain_of:
- Generator
- Pvsystem
- Windgen
range: string
required: false
WattPriority:
name: WattPriority
annotations:
order:
tag: order
value: 35
description: '{Yes/No*/True/False} Set inverter to watt priority instead of the
default var priority.'
comments:
- 'OpenDSS-only (N/A): inverter operating mode priority; no CIM equivalent in
the standard profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
- Storage
range: string
required: false
PFPriority:
name: PFPriority
annotations:
order:
tag: order
value: 36
description: '{Yes/No*/True/False} Set inverter to operate with PF priority when
in constant PF mode.'
comments:
- 'OpenDSS-only (N/A): inverter operating mode priority; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
- Storage
range: string
required: false
pct_PminNoVars:
name: pct_PminNoVars
annotations:
order:
tag: order
value: 37
dss_name:
tag: dss_name
value: '%PminNoVars'
description: Minimum active power as percentage of Pmpp under which there is no
vars production/absorption.
comments:
- 'OpenDSS-only (N/A): inverter deadband parameter; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
- Storage
range: float
required: false
pct_PminkvarMax:
name: pct_PminkvarMax
annotations:
order:
tag: order
value: 38
dss_name:
tag: dss_name
value: '%PminkvarMax'
description: Minimum active power as percentage of Pmpp that allows the inverter
to produce/absorb reactive power up to its kvarMax or kvarMaxAbs.
comments:
- 'OpenDSS-only (N/A): inverter reactive capability threshold; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
- Storage
range: float
required: false
kvarMax:
name: kvarMax
annotations:
order:
tag: order
value: 39
description: Maximum reactive power GENERATION (un-signed, kvar) for the inverter.
comments:
- 'Import: PEC.maxQ = ReactivePower(kvarMax, ''kVAr''). Export: kvarMax = maxQ.to(''kVAr'').
CIM stores in VAr (SI base).'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
exact_mappings:
- cim:PowerElectronicsConnection.maxQ
rank: 1000
domain_of:
- Pvsystem
- Storage
range: float
required: false
kvarMaxAbs:
name: kvarMaxAbs
annotations:
order:
tag: order
value: 40
description: Maximum reactive power ABSORPTION (un-signed, kvar) for the inverter.
comments:
- 'Import: PEC.minQ = ReactivePower(-kvarMaxAbs, ''kVAr'') — negated because absorption
is negative Q in CIM convention. Export: kvarMaxAbs = abs(minQ.to(''kVAr'')).'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
close_mappings:
- cim:PowerElectronicsConnection.minQ
rank: 1000
domain_of:
- Pvsystem
- Storage
range: float
required: false
kVDC:
name: kVDC
annotations:
order:
tag: order
value: 41
description: Indicates the rated voltage (kV) at the input of the inverter at
the peak of PV energy production.
comments:
- 'OpenDSS-only (N/A): DC-side voltage rating; no CIM equivalent in the standard
AC profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
- Storage
range: float
required: false
Kp:
name: Kp
annotations:
order:
tag: order
value: 42
description: It is the proportional gain for the PI controller within the inverter.
comments:
- 'OpenDSS-only (N/A): inverter PI controller tuning parameter; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
- Storage
range: string
required: false
PITol:
name: PITol
annotations:
order:
tag: order
value: 43
description: It is the tolerance (%) for the closed loop controller of the inverter.
comments:
- 'OpenDSS-only (N/A): inverter PI controller tolerance; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
- Storage
range: string
required: false
SafeVoltage:
name: SafeVoltage
annotations:
order:
tag: order
value: 44
description: Indicates the voltage level (%) respect to the base voltage level
for which the Inverter will operate.
comments:
- 'OpenDSS-only (N/A): grid-forming safe-voltage operating threshold; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
- Storage
range: float
required: false
SafeMode:
name: SafeMode
annotations:
order:
tag: order
value: 45
description: (Read only) Indicates whether the inverter entered (Yes) or not (No)
into Safe Mode.
comments:
- 'OpenDSS-only (N/A): read-only operational state flag; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
- Storage
range: string
required: false
DynamicEq:
name: DynamicEq
annotations:
order:
tag: order
value: 46
description: The name of the dynamic equation (DinamicExp) that will be used for
defining the dynamic behavior of the generator.
comments:
- 'OpenDSS-only (N/A): dynamics model reference; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
DynOut:
name: DynOut
annotations:
order:
tag: order
value: 47
description: The name of the variables within the Dynamic equation that will be
used to govern the PVSystem dynamics.
comments:
- 'OpenDSS-only (N/A): dynamics output variable mapping; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
range: float
required: false
ControlMode:
name: ControlMode
annotations:
order:
tag: order
value: 48
description: Defines the control mode for the inverter. {GFM | GFL*} Default is
GFL.
comments:
- 'OpenDSS-only (N/A): grid-forming vs. grid-following mode flag; no CIM equivalent
in the standard profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
- Storage
range: string
required: false
AmpLimit:
name: AmpLimit
annotations:
order:
tag: order
value: 49
description: Is the current limiter per phase for the IBR when operating in GFM
mode.
comments:
- 'OpenDSS-only (N/A): GFM current limiter; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
- Storage
range: float
required: false
AmpLimitGain:
name: AmpLimitGain
annotations:
order:
tag: order
value: 50
description: Use it for fine tunning the current limiter when active, by default
is 0.
comments:
- 'OpenDSS-only (N/A): GFM limiter gain; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
domain_of:
- Pvsystem
- Storage
range: float
required: false
spectrum:
name: spectrum
annotations:
order:
tag: order
value: 51
description: Name of harmonic voltage or current spectrum for this PVSystem element.
comments:
- 'OpenDSS-only (N/A): harmonic spectrum reference; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Gicsource
- Isource
- Vsource
range: float
required: false
basefreq:
name: basefreq
annotations:
order:
tag: order
value: 52
description: Base Frequency for ratings.
comments:
- Not stored on CIM PowerElectronicsConnection; base frequency is a circuit-level
property in CIM. Converter must derive this from circuit context.
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
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: 53
dss_default:
tag: dss_default
value: 'true'
description: '{Yes|No or True|False} Indicates whether this element is enabled.'
comments:
- 'OpenDSS-only (N/A): if False, converter returns None and no CIM objects are
created. All CIM PEC objects are assumed enabled.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
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: 54
description: 'Make like another object, e.g.: New PVSystem.PV2 like=PV1 ...'
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/pvsystem
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:Pvsystem
Induced¶
name: Pvsystem
description: A Pvsystem object in OpenDSS representing a photovoltaic generator with
inverter-based grid connection.
comments:
- 'Each DSS PVSystem creates two CIM objects: PhotoVoltaicUnit (the PV panel; holds
maxP/minP) and PowerElectronicsConnection (the inverter; holds ratedS, ratedU, p,
q, maxQ, minQ). The converter returns the PowerElectronicsConnection; the PhotoVoltaicUnit
is linked via PowerElectronicsConnection.PowerElectronicsUnit.'
from_schema: https://gridappsd.github.io/dss-graph/opendss
close_mappings:
- cim:PhotoVoltaicUnit
attributes:
name:
name: name
description: Object name. Must be unique per object type.
comments:
- Name applied to both PhotoVoltaicUnit and PowerElectronicsConnection with suffix
'_pv' / '_pec'.
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
exact_mappings:
- cim:IdentifiedObject.name
identifier: true
owner: Pvsystem
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
description: Number of Phases, this PVSystem element
comments:
- 'Import: inferred from bus1 node suffix. Export: len(PowerElectronicsConnection.PowerElectronicsConnectionPhase).'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
related_mappings:
- cim:PowerElectronicsConnectionPhase
owner: Pvsystem
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
bus1:
name: bus1
annotations:
order:
tag: order
value: 2
description: Bus to which the PVSystem element is connected
comments:
- 'Structural mapping via traversal: equipment.Terminals[0].ConnectivityNode.name.
Phase suffix reconstructed from PowerElectronicsConnectionPhase objects.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
related_mappings:
- cim:Terminal.ConnectivityNode
owner: Pvsystem
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Windgen
- Capacitor
- Line
- Reactor
- Fault
- Isource
- Vsource
range: string
required: false
kv:
name: kv
annotations:
order:
tag: order
value: 3
description: Nominal rated (1.0 per unit) voltage, kV, for PVSystem element. For
2- and 3-phase PVSystems, specify phase-phase kV. Otherwise, specify actual
kV across each branch.
comments:
- 'Direct unit conversion with no phase-count-dependent scaling: ratedU = Voltage(kv,
''kV'') on import, kv = ratedU.to(''kV'') on export. OpenDSS PVSystem kV is
always line-to-line regardless of phase count, so single-phase PVSystems are
not scaled by sqrt(3). CIM stores the value in V (SI base).'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
exact_mappings:
- cim:PowerElectronicsConnection.ratedU
owner: Pvsystem
domain_of:
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Capacitor
- Reactor
range: float
required: false
minimum_value: 0.0
irradiance:
name: irradiance
annotations:
order:
tag: order
value: 4
dss_name:
tag: dss_name
value: irrad
description: Get/set the present irradiance value in kW/sq-m
comments:
- 'OpenDSS-only (N/A): operational state variable; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
range: float
required: false
minimum_value: 0.0
Pmpp:
name: Pmpp
annotations:
order:
tag: order
value: 5
description: Get/set the rated max power of the PV array for 1.0 kW/sq-m irradiance,
kW.
comments:
- 'Import: PhotoVoltaicUnit.maxP = ActivePower(Pmpp, ''kW''). Export: Pmpp = maxP.to(''kW'').
CIM stores in W (SI base).'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
exact_mappings:
- cim:PowerElectronicsUnit.maxP
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
range: float
required: false
pct_Pmpp:
name: pct_Pmpp
annotations:
order:
tag: order
value: 6
dss_name:
tag: dss_name
value: '%Pmpp'
description: Upper limit on active power as a percentage of Pmpp
comments:
- 'OpenDSS-only (N/A): operational curtailment factor; no CIM equivalent in the
standard profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
range: float
required: false
Temperature:
name: Temperature
annotations:
order:
tag: order
value: 7
description: Get/set the present Temperature (deg C) for the P-T curve.
comments:
- 'OpenDSS-only (N/A): operational state variable; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
range: float
required: false
pf:
name: pf
annotations:
order:
tag: order
value: 8
dss_default:
tag: dss_default
value: float(0.88)
description: Nominally, the power factor for the output power. Default is 0.88.
Consumed to compute kvar if kvar is not specified.
comments:
- 'Import fallback only, used when kvar is not explicitly specified: q = Pmpp
* tan(acos(|pf|)), sign-flipped when pf is negative (leading power factor),
then stored on PowerElectronicsConnection.q. CIM has no dedicated power-factor
field, so pf itself is not stored — only its derived q value is. Export never
recovers pf; it always writes an explicit kvar value.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
related_mappings:
- cim:PowerElectronicsConnection.q
owner: Pvsystem
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Upfc
range: float
required: false
minimum_value: -1.0
maximum_value: 1.0
conn:
name: conn
annotations:
order:
tag: order
value: 9
description: ={wye|LN|delta|LL}
comments:
- 'No dedicated CIM connection-kind field is set. Import: when conn is ''delta'',
PowerElectronicsConnection.description is set to the literal string ''conn=delta''
as a workaround; wye (the default) leaves description unset. Export: reads that
literal string back to decide whether to write conn=delta; otherwise conn is
omitted and OpenDSS defaults to wye.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
related_mappings:
- cim:PowerElectronicsConnection.description
owner: Pvsystem
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Autotrans
- Capacitor
- Reactor
- Transformer
- Xfmrcode
- Sensor
range: string
required: false
kvar:
name: kvar
annotations:
order:
tag: order
value: 10
description: Get/set the present kvar value. Positive is capacitive (generator
convention).
comments:
- 'Import: PEC.q = ReactivePower(-kvar, ''kVAr'') — negated because DSS uses generator
convention (positive kvar = capacitive = +Q supplied to grid), while CIM Terminal
uses load convention (positive q = absorbed). Export: kvar = -PEC.q.to(''kVAr'').'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
close_mappings:
- cim:PowerElectronicsConnection.q
owner: Pvsystem
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
- Capacitor
- Reactor
range: float
required: false
kVA:
name: kVA
annotations:
order:
tag: order
value: 11
description: kVA rating of inverter. Defaults to 1.1 * Pmpp.
comments:
- 'Import: PEC.ratedS = ApparentPower(kVA, ''kVA''). Export: kVA = ratedS.to(''kVA'').
CIM stores in VA (SI base).'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
exact_mappings:
- cim:PowerElectronicsConnection.ratedS
owner: Pvsystem
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Autotrans
- Transformer
- Xfmrcode
range: float
required: false
pct_Cutin:
name: pct_Cutin
annotations:
order:
tag: order
value: 12
dss_name:
tag: dss_name
value: '%Cutin'
description: '% cut-in power -- % of kVA rating of inverter. Below this, PVSystem
is idle.'
comments:
- 'OpenDSS-only (N/A): inverter dispatch threshold; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
- Storage
range: float
required: false
pct_Cutout:
name: pct_Cutout
annotations:
order:
tag: order
value: 13
dss_name:
tag: dss_name
value: '%Cutout'
description: '% cut-out power -- % of kVA rating of inverter. Below this, PVSystem
turns off.'
comments:
- 'OpenDSS-only (N/A): inverter dispatch threshold; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
- Storage
range: float
required: false
EffCurve:
name: EffCurve
annotations:
order:
tag: order
value: 14
description: An XYCurve object, previously defined, that describes the PER UNIT
efficiency vs PER UNIT of rated kVA for the inverter.
todos:
- No CIM equivalent. Inverter efficiency curve; requires CIM extension or mapping
to a custom XYCurve linked to the PEC.
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
- Storage
range: float
required: false
P-TCurve:
name: P-TCurve
annotations:
order:
tag: order
value: 15
description: An XYCurve object, previously defined, that describes the PV array
PER UNIT Pmpp vs Temperature curve.
todos:
- No CIM equivalent. Temperature derating curve for PV panel; requires CIM extension.
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
alias: P_TCurve
owner: Pvsystem
domain_of:
- Pvsystem
range: float
required: false
pct_R:
name: pct_R
annotations:
order:
tag: order
value: 16
dss_name:
tag: dss_name
value: '%R'
description: Equivalent percent internal resistance, ohms. Default is 0.
comments:
- 'OpenDSS-only (N/A): internal resistance used for short-circuit simulation;
no standard CIM equivalent on PowerElectronicsConnection.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
- Storage
- Autotrans
- Transformer
- Xfmrcode
range: float
required: false
pct_X:
name: pct_X
annotations:
order:
tag: order
value: 17
dss_name:
tag: dss_name
value: '%X'
description: Equivalent percent internal reactance, ohms. Default is 50.
comments:
- 'OpenDSS-only (N/A): internal reactance used for short-circuit simulation; no
standard CIM equivalent on PowerElectronicsConnection.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
- Storage
range: float
required: false
model:
name: model
annotations:
order:
tag: order
value: 18
dss_default:
tag: dss_default
value: int(1)
dss_valid_values:
tag: dss_valid_values
value: 1,2,3
description: Integer code (default=1) for the model to use for power output variation
with voltage. 1=Constant P+jQ, 2=Constant Z, 3=Constant I.
comments:
- 'OpenDSS-only (N/A): DSS V/Q model selector; no direct CIM equivalent in the
standard profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
owner: Pvsystem
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: integer
required: false
Vminpu:
name: Vminpu
annotations:
order:
tag: order
value: 19
dss_default:
tag: dss_default
value: float(0.0)
description: Minimum per unit voltage. Default = 0.9. Below this, inverter trips
and the element goes to constant impedance mode.
comments:
- 'Import: PEC.maxIFault = 1.0 / Vminpu (current limit scales inversely with voltage
minimum). Export: Vminpu = 1.0 / maxIFault. Approximate mapping — maxIFault
is the primary CIM field used by OpenDSS for fault current limiting.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
close_mappings:
- cim:PowerElectronicsConnection.maxIFault
owner: Pvsystem
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: float
required: false
minimum_value: 0.0
Vmaxpu:
name: Vmaxpu
annotations:
order:
tag: order
value: 20
dss_default:
tag: dss_default
value: float(1.1)
description: Maximum per unit voltage. Default = 1.1.
comments:
- 'OpenDSS-only (N/A): overvoltage trip threshold; no direct CIM equivalent in
the standard profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
owner: Pvsystem
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: float
required: false
minimum_value: 0.0
Balanced:
name: Balanced
annotations:
order:
tag: order
value: 21
description: '{Yes | No*} Default is No. If true, force balanced operation.'
comments:
- 'OpenDSS-only (N/A): simulation option; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
owner: Pvsystem
domain_of:
- Generator
- Pvsystem
- Storage
range: boolean
required: false
LimitCurrent:
name: LimitCurrent
annotations:
order:
tag: order
value: 22
description: Limits current magnitude to Vminpu value for both 1-phase and 3-phase
PVSystems similar to Generator Model 7.
comments:
- 'OpenDSS-only (N/A): current-limiting simulation flag; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
- Storage
range: float
required: false
yearly:
name: yearly
annotations:
order:
tag: order
value: 23
description: Dispatch shape to use for yearly simulations. LoadShape name.
todos:
- Loadshape converter not yet implemented. DSS LoadShape name should map to a
CIM SeasonDayTypeSchedule or RegularIntervalSchedule linked to the PowerElectronicsConnection.
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
related_mappings:
- cim:SeasonDayTypeSchedule
owner: Pvsystem
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
daily:
name: daily
annotations:
order:
tag: order
value: 24
description: Dispatch shape to use for daily simulations. LoadShape name.
todos:
- Loadshape converter not yet implemented.
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
related_mappings:
- cim:SeasonDayTypeSchedule
owner: Pvsystem
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
duty:
name: duty
annotations:
order:
tag: order
value: 25
description: Load shape to use for duty cycle dispatch simulations.
todos:
- Loadshape converter not yet implemented.
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
related_mappings:
- cim:SeasonDayTypeSchedule
owner: Pvsystem
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: integer
required: false
Tyearly:
name: Tyearly
annotations:
order:
tag: order
value: 26
description: Temperature shape to use for yearly simulations.
comments:
- 'OpenDSS-only (N/A): temperature-driven derating schedule; no CIM equivalent
in the standard profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
range: string
required: false
Tdaily:
name: Tdaily
annotations:
order:
tag: order
value: 27
description: Temperature shape to use for daily simulations.
comments:
- 'OpenDSS-only (N/A): temperature-driven derating schedule; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
range: string
required: false
Tduty:
name: Tduty
annotations:
order:
tag: order
value: 28
description: Temperature shape to use for duty cycle dispatch simulations.
comments:
- 'OpenDSS-only (N/A): temperature-driven derating schedule; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
range: integer
required: false
class_class:
name: class_class
annotations:
order:
tag: order
value: 29
dss_name:
tag: dss_name
value: class
description: An arbitrary integer number representing the class of PVSystem element.
comments:
- 'OpenDSS-only (N/A): internal classification integer; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
- Storage
- Windgen
range: integer
required: false
UserModel:
name: UserModel
annotations:
order:
tag: order
value: 30
description: Name of DLL containing user-written model for Dynamics studies.
comments:
- 'OpenDSS-only (N/A): dynamics DLL hook; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
owner: Pvsystem
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
- Capcontrol
range: float
required: false
UserData:
name: UserData
annotations:
order:
tag: order
value: 31
description: String that gets passed to user-written model for defining the data
required for that model.
comments:
- 'OpenDSS-only (N/A): dynamics DLL data; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
owner: Pvsystem
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
- Capcontrol
range: string
required: false
debugtrace:
name: debugtrace
annotations:
order:
tag: order
value: 32
description: '{Yes | No } Default is no. If true, writes debug trace to a file.'
comments:
- 'OpenDSS-only (N/A): simulation debug flag; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
owner: Pvsystem
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
- Regcontrol
range: boolean
required: false
VarFollowInverter:
name: VarFollowInverter
annotations:
order:
tag: order
value: 33
description: Boolean variable (Yes|No) or (True|False). When True, reactive power
follows the inverter dispatch.
comments:
- 'OpenDSS-only (N/A): inverter control mode flag; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
- Storage
range: boolean
required: false
DutyStart:
name: DutyStart
annotations:
order:
tag: order
value: 34
description: Starting time offset [hours] into the duty cycle shape. Default is
0.
comments:
- 'OpenDSS-only (N/A): simulation time offset; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
owner: Pvsystem
domain_of:
- Generator
- Pvsystem
- Windgen
range: string
required: false
WattPriority:
name: WattPriority
annotations:
order:
tag: order
value: 35
description: '{Yes/No*/True/False} Set inverter to watt priority instead of the
default var priority.'
comments:
- 'OpenDSS-only (N/A): inverter operating mode priority; no CIM equivalent in
the standard profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
- Storage
range: string
required: false
PFPriority:
name: PFPriority
annotations:
order:
tag: order
value: 36
description: '{Yes/No*/True/False} Set inverter to operate with PF priority when
in constant PF mode.'
comments:
- 'OpenDSS-only (N/A): inverter operating mode priority; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
- Storage
range: string
required: false
pct_PminNoVars:
name: pct_PminNoVars
annotations:
order:
tag: order
value: 37
dss_name:
tag: dss_name
value: '%PminNoVars'
description: Minimum active power as percentage of Pmpp under which there is no
vars production/absorption.
comments:
- 'OpenDSS-only (N/A): inverter deadband parameter; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
- Storage
range: float
required: false
pct_PminkvarMax:
name: pct_PminkvarMax
annotations:
order:
tag: order
value: 38
dss_name:
tag: dss_name
value: '%PminkvarMax'
description: Minimum active power as percentage of Pmpp that allows the inverter
to produce/absorb reactive power up to its kvarMax or kvarMaxAbs.
comments:
- 'OpenDSS-only (N/A): inverter reactive capability threshold; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
- Storage
range: float
required: false
kvarMax:
name: kvarMax
annotations:
order:
tag: order
value: 39
description: Maximum reactive power GENERATION (un-signed, kvar) for the inverter.
comments:
- 'Import: PEC.maxQ = ReactivePower(kvarMax, ''kVAr''). Export: kvarMax = maxQ.to(''kVAr'').
CIM stores in VAr (SI base).'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
exact_mappings:
- cim:PowerElectronicsConnection.maxQ
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
- Storage
range: float
required: false
kvarMaxAbs:
name: kvarMaxAbs
annotations:
order:
tag: order
value: 40
description: Maximum reactive power ABSORPTION (un-signed, kvar) for the inverter.
comments:
- 'Import: PEC.minQ = ReactivePower(-kvarMaxAbs, ''kVAr'') — negated because absorption
is negative Q in CIM convention. Export: kvarMaxAbs = abs(minQ.to(''kVAr'')).'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
close_mappings:
- cim:PowerElectronicsConnection.minQ
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
- Storage
range: float
required: false
kVDC:
name: kVDC
annotations:
order:
tag: order
value: 41
description: Indicates the rated voltage (kV) at the input of the inverter at
the peak of PV energy production.
comments:
- 'OpenDSS-only (N/A): DC-side voltage rating; no CIM equivalent in the standard
AC profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
- Storage
range: float
required: false
Kp:
name: Kp
annotations:
order:
tag: order
value: 42
description: It is the proportional gain for the PI controller within the inverter.
comments:
- 'OpenDSS-only (N/A): inverter PI controller tuning parameter; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
- Storage
range: string
required: false
PITol:
name: PITol
annotations:
order:
tag: order
value: 43
description: It is the tolerance (%) for the closed loop controller of the inverter.
comments:
- 'OpenDSS-only (N/A): inverter PI controller tolerance; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
- Storage
range: string
required: false
SafeVoltage:
name: SafeVoltage
annotations:
order:
tag: order
value: 44
description: Indicates the voltage level (%) respect to the base voltage level
for which the Inverter will operate.
comments:
- 'OpenDSS-only (N/A): grid-forming safe-voltage operating threshold; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
- Storage
range: float
required: false
SafeMode:
name: SafeMode
annotations:
order:
tag: order
value: 45
description: (Read only) Indicates whether the inverter entered (Yes) or not (No)
into Safe Mode.
comments:
- 'OpenDSS-only (N/A): read-only operational state flag; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
- Storage
range: string
required: false
DynamicEq:
name: DynamicEq
annotations:
order:
tag: order
value: 46
description: The name of the dynamic equation (DinamicExp) that will be used for
defining the dynamic behavior of the generator.
comments:
- 'OpenDSS-only (N/A): dynamics model reference; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
owner: Pvsystem
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
DynOut:
name: DynOut
annotations:
order:
tag: order
value: 47
description: The name of the variables within the Dynamic equation that will be
used to govern the PVSystem dynamics.
comments:
- 'OpenDSS-only (N/A): dynamics output variable mapping; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
owner: Pvsystem
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
range: float
required: false
ControlMode:
name: ControlMode
annotations:
order:
tag: order
value: 48
description: Defines the control mode for the inverter. {GFM | GFL*} Default is
GFL.
comments:
- 'OpenDSS-only (N/A): grid-forming vs. grid-following mode flag; no CIM equivalent
in the standard profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
- Storage
range: string
required: false
AmpLimit:
name: AmpLimit
annotations:
order:
tag: order
value: 49
description: Is the current limiter per phase for the IBR when operating in GFM
mode.
comments:
- 'OpenDSS-only (N/A): GFM current limiter; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
- Storage
range: float
required: false
AmpLimitGain:
name: AmpLimitGain
annotations:
order:
tag: order
value: 50
description: Use it for fine tunning the current limiter when active, by default
is 0.
comments:
- 'OpenDSS-only (N/A): GFM limiter gain; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
rank: 1000
owner: Pvsystem
domain_of:
- Pvsystem
- Storage
range: float
required: false
spectrum:
name: spectrum
annotations:
order:
tag: order
value: 51
description: Name of harmonic voltage or current spectrum for this PVSystem element.
comments:
- 'OpenDSS-only (N/A): harmonic spectrum reference; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
owner: Pvsystem
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Gicsource
- Isource
- Vsource
range: float
required: false
basefreq:
name: basefreq
annotations:
order:
tag: order
value: 52
description: Base Frequency for ratings.
comments:
- Not stored on CIM PowerElectronicsConnection; base frequency is a circuit-level
property in CIM. Converter must derive this from circuit context.
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
owner: Pvsystem
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: 53
dss_default:
tag: dss_default
value: 'true'
description: '{Yes|No or True|False} Indicates whether this element is enabled.'
comments:
- 'OpenDSS-only (N/A): if False, converter returns None and no CIM objects are
created. All CIM PEC objects are assumed enabled.'
from_schema: https://gridappsd.github.io/dss-graph/pce/pvsystem
owner: Pvsystem
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: 54
description: 'Make like another object, e.g.: New PVSystem.PV2 like=PV1 ...'
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/pvsystem
owner: Pvsystem
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:Pvsystem