Class: Generator¶
A Generator object in OpenDSS representing a power generator connected to a bus in the distribution system.
URI: dss:Generator
classDiagram
class Generator
click Generator href "../Generator/"
Generator : Balanced
Generator : basefreq
Generator : bus1
Generator : conn
Generator --> "0..1" ConnectionType : conn
click ConnectionType href "../ConnectionType/"
Generator : D
Generator : daily
Generator : debugtrace
Generator : dispmode
Generator --> "0..1" DispatchMode : dispmode
click DispatchMode href "../DispatchMode/"
Generator : dispvalue
Generator : duty
Generator : DutyStart
Generator : DynamicEq
Generator : DynOut
Generator : enabled
Generator : forceon
Generator : FuelkWh
Generator : gen_class
Generator : H
Generator : kv
Generator : kVA
Generator : kvar
Generator : kW
Generator : like
Generator : maxkvar
Generator : minkvar
Generator : model
Generator --> "0..1" GeneratorModel : model
click GeneratorModel href "../GeneratorModel/"
Generator : MVA
Generator : name
Generator : pct_Fuel
Generator : pct_Reserve
Generator : pf
Generator : phases
Generator : pvfactor
Generator : Refuel
Generator : ShaftData
Generator : ShaftModel
Generator : spectrum
Generator : status
Generator --> "0..1" GenStatus : status
click GenStatus href "../GenStatus/"
Generator : UseFuel
Generator : UserData
Generator : UserModel
Generator : Vmaxpu
Generator : Vminpu
Generator : Vpu
Generator : Xd
Generator : Xdp
Generator : Xdpp
Generator : XRdp
Generator : yearly
Class Properties¶
| Property | Value |
|---|---|
| Class URI | dss:Generator |
Slots¶
| Name | Cardinality and Range | Description | Inheritance |
|---|---|---|---|
| name | 1 String |
Object name | direct |
| phases | 0..1 Integer |
Number of Phases, this Generator | direct |
| bus1 | 0..1 String |
Bus to which the Generator is connected | direct |
| kv | 0..1 Float |
Nominal rated (1 | direct |
| kW | 0..1 Float |
Total base kW for the Generator | direct |
| pf | 0..1 Float |
Generator power factor | direct |
| kvar | 0..1 Float |
Specify the base kvar | direct |
| model | 0..1 GeneratorModel |
Integer code for the model to use for generation variation with voltage | 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 |
| 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 String |
Load shape to use for duty cycle dispatch simulations such as for wind genera... | direct |
| dispmode | 0..1 DispatchMode |
Dispatch mode | direct |
| dispvalue | 0..1 Float |
Dispatch value | direct |
| conn | 0..1 ConnectionType |
Connection type | direct |
| status | 0..1 GenStatus |
Fixed or Variable | direct |
| gen_class | 0..1 Integer |
An arbitrary integer number representing the class of Generator | direct |
| Vpu | 0..1 Float |
Per Unit voltage set point for Model = 3 | direct |
| maxkvar | 0..1 Float |
Maximum kvar limit for Model = 3 | direct |
| minkvar | 0..1 Float |
Minimum kvar limit for Model = 3 | direct |
| pvfactor | 0..1 Float |
Deceleration factor for P-V generator model (Model=3) | direct |
| forceon | 0..1 Boolean |
Forces generator ON despite requirements of other dispatch modes | direct |
| kVA | 0..1 Float |
kVA rating of electrical machine | direct |
| MVA | 0..1 Float |
MVA rating of electrical machine | direct |
| Xd | 0..1 Float |
Per unit synchronous reactance of machine | direct |
| Xdp | 0..1 Float |
Per unit transient reactance of the machine | direct |
| Xdpp | 0..1 Float |
Per unit subtransient reactance of the machine | direct |
| H | 0..1 Float |
Per unit mass constant of the machine | direct |
| D | 0..1 Float |
Damping constant | direct |
| UserModel | 0..1 String |
Name of DLL containing user-written model for Dynamics studies | direct |
| UserData | 0..1 String |
String that gets passed to user-written model | direct |
| ShaftModel | 0..1 String |
Name of user-written DLL containing a Shaft model | direct |
| ShaftData | 0..1 String |
String that gets passed to user-written shaft dynamic model | direct |
| DutyStart | 0..1 Float |
Starting time offset [hours] into the duty cycle shape | direct |
| debugtrace | 0..1 Boolean |
Turn this on to capture the progress of the generator model for each iteratio... | direct |
| Balanced | 0..1 Boolean |
For Model=7, force balanced current only for 3-phase generators | direct |
| XRdp | 0..1 Float |
X/R ratio for Xdp property for FaultStudy and Dynamic modes | direct |
| UseFuel | 0..1 Boolean |
Activates the use of fuel for the operation of the generator | direct |
| FuelkWh | 0..1 Float |
Nominal level of fuel for the generator (kWh) | direct |
| pct_Fuel | 0..1 Float |
Current amount of fuel available in percentage of FuelkWh (0-100) | direct |
| pct_Reserve | 0..1 Float |
Reserve level in percentage of FuelkWh (0-100) | direct |
| Refuel | 0..1 Boolean |
Boolean value to manually refuel the generator when needed | direct |
| DynamicEq | 0..1 String |
Name of the dynamic equation (DynamicExp) for defining the dynamic behavior o... | direct |
| DynOut | * String |
Name of the variables within the Dynamic equation for governing generator dyn... | direct |
| spectrum | 0..1 String |
Name of harmonic voltage or current spectrum for this generator | 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 Generator maps to CIM SynchronousMachine. Active/reactive power use generator sign convention: CIM Terminal positive p = power into equipment, so generator p is negative (power flows out). The converter covers only steady-state rating and dispatch attributes (bus, phases, kV, kW, kvar, kVA, connection); dynamics/fault-study parameters (Xd, Xdp, Xdpp, H, D, user models) and dispatch-mode/fuel-model attributes have no equivalent in the steady-state CIM profile used here.
Identifier and Mapping Information¶
Schema Source¶
- from schema: https://gridappsd.github.io/dss-graph/opendss
Mappings¶
| Mapping Type | Mapped Value |
|---|---|
| self | dss:Generator |
| native | dss:Generator |
| exact | cim:SynchronousMachine |
LinkML Source¶
Direct¶
name: Generator
description: A Generator object in OpenDSS representing a power generator connected
to a bus in the distribution system.
comments:
- 'OpenDSS Generator maps to CIM SynchronousMachine. Active/reactive power use generator
sign convention: CIM Terminal positive p = power into equipment, so generator p
is negative (power flows out). The converter covers only steady-state rating and
dispatch attributes (bus, phases, kV, kW, kvar, kVA, connection); dynamics/fault-study
parameters (Xd, Xdp, Xdpp, H, D, user models) and dispatch-mode/fuel-model attributes
have no equivalent in the steady-state CIM profile used here.'
from_schema: https://gridappsd.github.io/dss-graph/opendss
exact_mappings:
- cim:SynchronousMachine
attributes:
name:
name: name
description: Object name. Must be unique per object type.
comments:
- Direct string mapping; no conversion needed.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
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
dss_default:
tag: dss_default
value: int(3)
description: Number of Phases, this Generator. Power is evenly divided among phases.
todos:
- Per-phase detail is discarded. A per-phase-aware roundtrip would need RotatingMachinePhase
objects (present in CIM18 but not in the cimhub_2026 profile used here — see
the commented-out code in the importer).
comments:
- 'OpenDSS-only (N/A): phases is not read directly — the phase count is implied
by parsing bus1''s node suffix during import, but the resulting phase count
is only used for a log message and is not stored on the SynchronousMachine.
Export always writes a bare bus1 with no phase suffix, so the exported Generator
relies on OpenDSS''s default 3-phase assumption regardless of the original phase
count.'
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
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 Generator is connected. May include specific node
specification.
comments:
- 'Structural mapping via traversal. Import: bus1 (including any phase suffix)
is parsed to build the Terminal/ConnectivityNode structure; the phase suffix
itself is not separately retained on the SynchronousMachine (see phases comments).
Export: bus1 = Terminals[0].ConnectivityNode.name, with no phase suffix appended.'
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
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 Generator. For 2- and
3-phase Generators, specify phase-phase kV. Otherwise, for phases=1 or phases>3,
specify actual kV across each branch of the Generator.
comments:
- 'Unit conversion only: kV ↔ V. Import: ratedU = cim.Voltage(kv, ''kV''). Export:
kv = ratedU.to(''kV'').'
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
exact_mappings:
- cim:RotatingMachine.ratedU
rank: 1000
domain_of:
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Capacitor
- Reactor
range: float
required: false
minimum_value: 0.0
kW:
name: kW
annotations:
order:
tag: order
value: 4
description: Total base kW for the Generator. A positive value denotes power coming
OUT of the element. This value is modified depending on the dispatch mode.
comments:
- 'Generator sign convention: DSS kW positive = generation out; CIM Terminal p
is negative for a generator (power flows out of equipment). Import: p = cim.ActivePower(-kW,
''kW''). Export: kW = -p.to(''kW'').'
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
exact_mappings:
- cim:RotatingMachine.p
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Storage
- Vsconverter
- Windgen
range: float
required: false
pf:
name: pf
description: Generator power factor. Default is 0.80. Enter negative for leading
power factor. A positive power factor signifies the generator produces vars.
comments:
- 'OpenDSS-only (N/A): pf itself is not stored on CIM, but it feeds a derivation
formula used only as a fallback when kvar is not given. Import: kvar = kW ×
tan(acos(|pf|)), sign-flipped if pf is negative (leading power factor), then
combined into q the same way as an explicit kvar (see kvar comments). Export:
pf is not recovered from q — the exporter always writes an explicit kvar instead.'
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
related_mappings:
- cim:RotatingMachine.q
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Upfc
range: float
required: false
minimum_value: -1.0
maximum_value: 1.0
kvar:
name: kvar
annotations:
order:
tag: order
value: 6
description: 'Specify the base kvar. Alternative to specifying the power factor.
Side effect: the power factor value is altered to agree.'
comments:
- 'Generator sign convention (same negation as kW). Import (when kvar is given):
q = cim.ReactivePower(-kvar, ''kVAr''). If kvar is omitted, q is instead derived
from kW and pf (see pf comments). Export: kvar = -q.to(''kVAr'').'
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
exact_mappings:
- cim:RotatingMachine.q
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
- Capacitor
- Reactor
range: float
required: false
model:
name: model
annotations:
order:
tag: order
value: 7
dss_default:
tag: dss_default
value: int(1)
dss_valid_values:
tag: dss_valid_values
value: 1,2,3,4,5,6,7
description: Integer code for the model to use for generation variation with voltage.
1=Constant kW at specified pf, 2=Constant admittance, 3=Const kW const kV, 4=Const
kW Fixed Q, 5=Const kW Fixed Q as reactance, 6=User model, 7=Const kW kvar current-limited.
todos:
- No CIM equivalent for DSS generator model enumeration.
comments:
- OpenDSS generator model code; no direct CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: GeneratorModel
required: false
Vminpu:
name: Vminpu
annotations:
order:
tag: order
value: 8
dss_default:
tag: dss_default
value: float(0.90)
description: Minimum per unit voltage for which the Model is assumed to apply.
Default is 0.90.
todos:
- Requires CIM extension to roundtrip (e.g. operational voltage limits).
comments:
- OpenDSS voltage limit; no CIM equivalent in the standard profile.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: float
required: false
Vmaxpu:
name: Vmaxpu
annotations:
order:
tag: order
value: 9
dss_default:
tag: dss_default
value: float(1.10)
description: Maximum per unit voltage for which the Model is assumed to apply.
Default is 1.10.
todos:
- Requires CIM extension to roundtrip (e.g. operational voltage limits).
comments:
- OpenDSS voltage limit; no CIM equivalent in the standard profile.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: float
required: false
yearly:
name: yearly
annotations:
order:
tag: order
value: 10
description: Dispatch shape to use for yearly simulations. Must be previously
defined as a Loadshape object.
todos:
- LoadShape converter not yet implemented; roundtrip requires mapping DSS LoadShape
to CIM RegularIntervalSchedule.
comments:
- Reference to a DSS LoadShape object. CIM equivalent is a time-series via RegularIntervalSchedule/RegularTimePoint.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
related_mappings:
- cim:RegularTimePoint
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
daily:
name: daily
annotations:
order:
tag: order
value: 11
description: Dispatch shape to use for daily simulations. Must be previously defined
as a Loadshape object of 24 hrs, typically.
todos:
- LoadShape converter not yet implemented; roundtrip requires mapping DSS LoadShape
to CIM RegularIntervalSchedule.
comments:
- Reference to a DSS LoadShape object. CIM equivalent is a time-series via RegularIntervalSchedule/RegularTimePoint.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
related_mappings:
- cim:RegularTimePoint
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
duty:
name: duty
annotations:
order:
tag: order
value: 12
description: Load shape to use for duty cycle dispatch simulations such as for
wind generation. Must be previously defined as a Loadshape object.
todos:
- LoadShape converter not yet implemented; roundtrip requires mapping DSS LoadShape
to CIM RegularIntervalSchedule.
comments:
- Reference to a DSS LoadShape object. CIM equivalent is a time-series via RegularIntervalSchedule/RegularTimePoint.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
related_mappings:
- cim:RegularTimePoint
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
dispmode:
name: dispmode
annotations:
order:
tag: order
value: 13
description: Dispatch mode. Default, Loadlevel, or Price.
todos:
- No CIM equivalent for DSS dispatch mode enumeration.
comments:
- OpenDSS dispatch mode; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
range: DispatchMode
required: false
dispvalue:
name: dispvalue
annotations:
order:
tag: order
value: 14
dss_default:
tag: dss_default
value: float(0.0)
description: Dispatch value. If = 0.0 (default) then Generator follows dispatch
curves. If > 0 then Generator is ON only when price or load exceeds this value.
todos:
- No CIM equivalent for dispatch trigger value.
comments:
- OpenDSS dispatch threshold; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
range: float
required: false
conn:
name: conn
annotations:
order:
tag: order
value: 15
description: Connection type. Default is wye.
comments:
- 'No dedicated CIM slot for generator winding connection in the standard profile.
Import: wye is the default and requires no action; conn=delta sets SynchronousMachine.description
to the literal text "conn=delta" as a workaround. Export: description is checked
for that exact literal to restore conn=delta; otherwise conn is left unset (wye
default).'
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
related_mappings:
- cim:SynchronousMachine.description
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Autotrans
- Capacitor
- Reactor
- Transformer
- Xfmrcode
- Sensor
range: ConnectionType
required: false
status:
name: status
annotations:
order:
tag: order
value: 18
description: Fixed or Variable. If Fixed, dispatch multipliers do not apply. Default
is Variable.
todos:
- No CIM equivalent for Fixed/Variable dispatch status.
comments:
- OpenDSS dispatch status; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
domain_of:
- Load
- Generator
range: GenStatus
required: false
gen_class:
name: gen_class
annotations:
order:
tag: order
value: 19
dss_name:
tag: dss_name
value: class
dss_default:
tag: dss_default
value: int(1)
description: An arbitrary integer number representing the class of Generator.
todos:
- No CIM equivalent for DSS generator class integer.
comments:
- Arbitrary DSS classification integer; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
range: integer
required: false
Vpu:
name: Vpu
annotations:
order:
tag: order
value: 20
dss_default:
tag: dss_default
value: float(1.0)
description: Per Unit voltage set point for Model = 3. Default is 1.0.
todos:
- No CIM equivalent for DSS Vpu (Model=3 set point).
comments:
- OpenDSS Model=3 voltage set point; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
range: float
required: false
maxkvar:
name: maxkvar
annotations:
order:
tag: order
value: 21
description: Maximum kvar limit for Model = 3. Defaults to twice the specified
load kvar.
todos:
- No CIM equivalent currently mapped for Generator maxkvar.
comments:
- 'OpenDSS Model=3 reactive limit; no direct CIM equivalent. Note: PVSystem uses
cim:PowerElectronicsConnection.maxQ for this concept, but Generator does not
currently map maxkvar.'
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
range: float
required: false
minkvar:
name: minkvar
annotations:
order:
tag: order
value: 22
description: Minimum kvar limit for Model = 3. Enter a negative number if generator
can absorb vars.
todos:
- No CIM equivalent currently mapped for Generator minkvar.
comments:
- OpenDSS Model=3 reactive limit; no CIM equivalent currently mapped.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
range: float
required: false
pvfactor:
name: pvfactor
annotations:
order:
tag: order
value: 23
dss_default:
tag: dss_default
value: float(0.1)
description: Deceleration factor for P-V generator model (Model=3). Default is
0.1.
todos:
- No CIM equivalent for DSS pvfactor.
comments:
- OpenDSS P-V model deceleration factor; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
range: float
required: false
forceon:
name: forceon
annotations:
order:
tag: order
value: 24
dss_default:
tag: dss_default
value: 'false'
description: Forces generator ON despite requirements of other dispatch modes.
todos:
- No CIM equivalent for DSS forceon flag.
comments:
- OpenDSS dispatch override; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
range: boolean
required: false
kVA:
name: kVA
annotations:
order:
tag: order
value: 25
description: kVA rating of electrical machine. Defaults to 1.2 * kW if not specified.
comments:
- 'Unit conversion only: kVA ↔ VA. Import: ratedS = cim.ApparentPower(kVA, ''kVA'').
Export: kVA = ratedS.to(''kVA'').'
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
exact_mappings:
- cim:RotatingMachine.ratedS
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Autotrans
- Transformer
- Xfmrcode
range: float
required: false
MVA:
name: MVA
annotations:
order:
tag: order
value: 26
description: MVA rating of electrical machine. Alternative to using kVA.
todos:
- MVA is not read by the importer. If implemented, it should be treated as an
alternate input for RotatingMachine.ratedS when kVA is absent.
comments:
- 'OpenDSS-only (N/A) for now: the current importer only reads kVA, never MVA;
if both are given in a DSS file, MVA is silently ignored. No CIM field is set
from this property.'
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
- Windgen
- Gictransformer
range: float
required: false
Xd:
name: Xd
annotations:
order:
tag: order
value: 27
dss_default:
tag: dss_default
value: float(1.0)
description: Per unit synchronous reactance of machine. Default is 1.0.
todos:
- Dynamic/fault study parameter — requires CIM Dynamics profile extension to roundtrip.
comments:
- Synchronous machine dynamic parameter; no CIM equivalent in steady-state profile.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
range: float
required: false
Xdp:
name: Xdp
annotations:
order:
tag: order
value: 28
dss_default:
tag: dss_default
value: float(0.27)
description: Per unit transient reactance of the machine. Used for Dynamics mode
and Fault studies. Default is 0.27.
todos:
- Dynamic/fault study parameter — requires CIM Dynamics profile extension to roundtrip.
comments:
- Synchronous machine dynamic parameter; no CIM equivalent in steady-state profile.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
range: float
required: false
Xdpp:
name: Xdpp
annotations:
order:
tag: order
value: 29
dss_default:
tag: dss_default
value: float(0.20)
description: Per unit subtransient reactance of the machine. Used for Harmonics.
Default is 0.20.
todos:
- Dynamic/fault study parameter — requires CIM Dynamics profile extension to roundtrip.
comments:
- Synchronous machine dynamic parameter; no CIM equivalent in steady-state profile.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
range: float
required: false
H:
name: H
annotations:
order:
tag: order
value: 30
dss_default:
tag: dss_default
value: float(1.0)
description: Per unit mass constant of the machine. MW-sec/MVA. Default is 1.0.
todos:
- Dynamic parameter — requires CIM Dynamics profile extension to roundtrip.
comments:
- Synchronous machine inertia constant; no CIM equivalent in steady-state profile.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
- Generic5
- Indmach012
range: float
required: false
D:
name: D
annotations:
order:
tag: order
value: 31
dss_default:
tag: dss_default
value: float(1.0)
description: Damping constant. Usual range is 0 to 4. Default is 1.0.
todos:
- Dynamic parameter — requires CIM Dynamics profile extension to roundtrip.
comments:
- Synchronous machine damping constant; no CIM equivalent in steady-state profile.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
- Generic5
- Indmach012
range: float
required: false
UserModel:
name: UserModel
annotations:
order:
tag: order
value: 32
description: Name of DLL containing user-written model for Dynamics studies.
todos:
- No CIM equivalent for DSS UserModel DLL reference.
comments:
- OpenDSS user DLL reference; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
- Capcontrol
range: string
required: false
UserData:
name: UserData
annotations:
order:
tag: order
value: 33
description: String that gets passed to user-written model.
todos:
- No CIM equivalent for DSS UserData string.
comments:
- OpenDSS user DLL data string; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
- Capcontrol
range: string
required: false
ShaftModel:
name: ShaftModel
annotations:
order:
tag: order
value: 34
description: Name of user-written DLL containing a Shaft model.
todos:
- No CIM equivalent for DSS ShaftModel DLL reference.
comments:
- OpenDSS shaft DLL reference; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
range: string
required: false
ShaftData:
name: ShaftData
annotations:
order:
tag: order
value: 35
description: String that gets passed to user-written shaft dynamic model.
todos:
- No CIM equivalent for DSS ShaftData string.
comments:
- OpenDSS shaft DLL data string; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
range: string
required: false
DutyStart:
name: DutyStart
annotations:
order:
tag: order
value: 36
dss_default:
tag: dss_default
value: float(0.0)
description: Starting time offset [hours] into the duty cycle shape. Defaults
to 0.
todos:
- No CIM equivalent for DSS DutyStart time offset.
comments:
- OpenDSS time offset into duty shape; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
- Pvsystem
- Windgen
range: float
required: false
debugtrace:
name: debugtrace
annotations:
order:
tag: order
value: 37
dss_default:
tag: dss_default
value: 'false'
description: Turn this on to capture the progress of the generator model for each
iteration.
comments:
- OpenDSS simulation diagnostic flag; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
- Regcontrol
range: boolean
required: false
Balanced:
name: Balanced
annotations:
order:
tag: order
value: 38
dss_default:
tag: dss_default
value: 'false'
description: For Model=7, force balanced current only for 3-phase generators.
Default is No.
todos:
- No CIM equivalent for DSS Balanced flag.
comments:
- OpenDSS Model=7 flag; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
- Pvsystem
- Storage
range: boolean
required: false
XRdp:
name: XRdp
annotations:
order:
tag: order
value: 39
dss_default:
tag: dss_default
value: float(20.0)
description: X/R ratio for Xdp property for FaultStudy and Dynamic modes. Default
is 20.
todos:
- Fault study parameter — requires CIM Dynamics profile extension to roundtrip.
comments:
- Synchronous machine fault study parameter; no CIM equivalent in steady-state
profile.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
range: float
required: false
UseFuel:
name: UseFuel
annotations:
order:
tag: order
value: 40
dss_default:
tag: dss_default
value: 'false'
description: Activates the use of fuel for the operation of the generator.
todos:
- No CIM equivalent for DSS fuel model parameters.
comments:
- OpenDSS fuel model flag; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
range: boolean
required: false
FuelkWh:
name: FuelkWh
annotations:
order:
tag: order
value: 41
dss_default:
tag: dss_default
value: float(0.0)
description: Nominal level of fuel for the generator (kWh). Only applies if UseFuel
= Yes/True.
todos:
- No CIM equivalent for DSS FuelkWh.
comments:
- OpenDSS fuel capacity; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
range: float
required: false
pct_Fuel:
name: pct_Fuel
annotations:
order:
tag: order
value: 42
dss_name:
tag: dss_name
value: '%Fuel'
description: Current amount of fuel available in percentage of FuelkWh (0-100).
todos:
- No CIM equivalent for DSS %Fuel.
comments:
- OpenDSS fuel level percentage; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
range: float
required: false
pct_Reserve:
name: pct_Reserve
annotations:
order:
tag: order
value: 43
dss_name:
tag: dss_name
value: '%Reserve'
description: Reserve level in percentage of FuelkWh (0-100).
todos:
- No CIM equivalent for DSS %Reserve.
comments:
- OpenDSS fuel reserve percentage; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
- Storagecontroller
range: float
required: false
Refuel:
name: Refuel
annotations:
order:
tag: order
value: 44
dss_default:
tag: dss_default
value: 'false'
description: Boolean value to manually refuel the generator when needed.
todos:
- No CIM equivalent for DSS Refuel flag.
comments:
- OpenDSS fuel model control; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
range: boolean
required: false
DynamicEq:
name: DynamicEq
annotations:
order:
tag: order
value: 45
description: Name of the dynamic equation (DynamicExp) for defining the dynamic
behavior of the generator.
todos:
- No CIM equivalent for DSS DynamicEq reference.
comments:
- OpenDSS dynamic equation reference; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
DynOut:
name: DynOut
annotations:
order:
tag: order
value: 46
description: Name of the variables within the Dynamic equation for governing generator
dynamics.
todos:
- No CIM equivalent for DSS DynOut variable list.
comments:
- OpenDSS dynamic equation variable references; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
multivalued: true
spectrum:
name: spectrum
annotations:
order:
tag: order
value: 47
dss_default:
tag: dss_default
value: string(default)
description: Name of harmonic voltage or current spectrum for this generator.
Default is "default".
todos:
- No CIM equivalent for DSS spectrum reference.
comments:
- OpenDSS harmonic spectrum reference; no CIM equivalent in the standard profile.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
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: 48
description: Base Frequency for ratings.
todos:
- Extract base frequency from CIM circuit metadata on import; do not map to machine
object.
comments:
- Not stored on the CIM SynchronousMachine directly; base frequency is a circuit-level
property (cim:BaseVoltage or network metadata).
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
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: 49
dss_default:
tag: dss_default
value: 'true'
description: Indicates whether this element is enabled.
comments:
- OpenDSS enable/disable flag; CIM machines are always modelled as enabled. No
CIM equivalent needed.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
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: 50
description: 'Make like another object, e.g.: New Generator.G2 like=G1 ...'
comments:
- OpenDSS template inheritance; resolved at parser time, no CIM equivalent needed.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
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:Generator
Induced¶
name: Generator
description: A Generator object in OpenDSS representing a power generator connected
to a bus in the distribution system.
comments:
- 'OpenDSS Generator maps to CIM SynchronousMachine. Active/reactive power use generator
sign convention: CIM Terminal positive p = power into equipment, so generator p
is negative (power flows out). The converter covers only steady-state rating and
dispatch attributes (bus, phases, kV, kW, kvar, kVA, connection); dynamics/fault-study
parameters (Xd, Xdp, Xdpp, H, D, user models) and dispatch-mode/fuel-model attributes
have no equivalent in the steady-state CIM profile used here.'
from_schema: https://gridappsd.github.io/dss-graph/opendss
exact_mappings:
- cim:SynchronousMachine
attributes:
name:
name: name
description: Object name. Must be unique per object type.
comments:
- Direct string mapping; no conversion needed.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
exact_mappings:
- cim:IdentifiedObject.name
identifier: true
owner: Generator
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 Generator. Power is evenly divided among phases.
todos:
- Per-phase detail is discarded. A per-phase-aware roundtrip would need RotatingMachinePhase
objects (present in CIM18 but not in the cimhub_2026 profile used here — see
the commented-out code in the importer).
comments:
- 'OpenDSS-only (N/A): phases is not read directly — the phase count is implied
by parsing bus1''s node suffix during import, but the resulting phase count
is only used for a log message and is not stored on the SynchronousMachine.
Export always writes a bare bus1 with no phase suffix, so the exported Generator
relies on OpenDSS''s default 3-phase assumption regardless of the original phase
count.'
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
owner: Generator
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 Generator is connected. May include specific node
specification.
comments:
- 'Structural mapping via traversal. Import: bus1 (including any phase suffix)
is parsed to build the Terminal/ConnectivityNode structure; the phase suffix
itself is not separately retained on the SynchronousMachine (see phases comments).
Export: bus1 = Terminals[0].ConnectivityNode.name, with no phase suffix appended.'
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
related_mappings:
- cim:Terminal.ConnectivityNode
owner: Generator
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 Generator. For 2- and
3-phase Generators, specify phase-phase kV. Otherwise, for phases=1 or phases>3,
specify actual kV across each branch of the Generator.
comments:
- 'Unit conversion only: kV ↔ V. Import: ratedU = cim.Voltage(kv, ''kV''). Export:
kv = ratedU.to(''kV'').'
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
exact_mappings:
- cim:RotatingMachine.ratedU
rank: 1000
owner: Generator
domain_of:
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Capacitor
- Reactor
range: float
required: false
minimum_value: 0.0
kW:
name: kW
annotations:
order:
tag: order
value: 4
description: Total base kW for the Generator. A positive value denotes power coming
OUT of the element. This value is modified depending on the dispatch mode.
comments:
- 'Generator sign convention: DSS kW positive = generation out; CIM Terminal p
is negative for a generator (power flows out of equipment). Import: p = cim.ActivePower(-kW,
''kW''). Export: kW = -p.to(''kW'').'
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
exact_mappings:
- cim:RotatingMachine.p
owner: Generator
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Storage
- Vsconverter
- Windgen
range: float
required: false
pf:
name: pf
description: Generator power factor. Default is 0.80. Enter negative for leading
power factor. A positive power factor signifies the generator produces vars.
comments:
- 'OpenDSS-only (N/A): pf itself is not stored on CIM, but it feeds a derivation
formula used only as a fallback when kvar is not given. Import: kvar = kW ×
tan(acos(|pf|)), sign-flipped if pf is negative (leading power factor), then
combined into q the same way as an explicit kvar (see kvar comments). Export:
pf is not recovered from q — the exporter always writes an explicit kvar instead.'
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
related_mappings:
- cim:RotatingMachine.q
owner: Generator
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Upfc
range: float
required: false
minimum_value: -1.0
maximum_value: 1.0
kvar:
name: kvar
annotations:
order:
tag: order
value: 6
description: 'Specify the base kvar. Alternative to specifying the power factor.
Side effect: the power factor value is altered to agree.'
comments:
- 'Generator sign convention (same negation as kW). Import (when kvar is given):
q = cim.ReactivePower(-kvar, ''kVAr''). If kvar is omitted, q is instead derived
from kW and pf (see pf comments). Export: kvar = -q.to(''kVAr'').'
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
exact_mappings:
- cim:RotatingMachine.q
owner: Generator
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
- Capacitor
- Reactor
range: float
required: false
model:
name: model
annotations:
order:
tag: order
value: 7
dss_default:
tag: dss_default
value: int(1)
dss_valid_values:
tag: dss_valid_values
value: 1,2,3,4,5,6,7
description: Integer code for the model to use for generation variation with voltage.
1=Constant kW at specified pf, 2=Constant admittance, 3=Const kW const kV, 4=Const
kW Fixed Q, 5=Const kW Fixed Q as reactance, 6=User model, 7=Const kW kvar current-limited.
todos:
- No CIM equivalent for DSS generator model enumeration.
comments:
- OpenDSS generator model code; no direct CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
owner: Generator
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: GeneratorModel
required: false
Vminpu:
name: Vminpu
annotations:
order:
tag: order
value: 8
dss_default:
tag: dss_default
value: float(0.90)
description: Minimum per unit voltage for which the Model is assumed to apply.
Default is 0.90.
todos:
- Requires CIM extension to roundtrip (e.g. operational voltage limits).
comments:
- OpenDSS voltage limit; no CIM equivalent in the standard profile.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
owner: Generator
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: float
required: false
Vmaxpu:
name: Vmaxpu
annotations:
order:
tag: order
value: 9
dss_default:
tag: dss_default
value: float(1.10)
description: Maximum per unit voltage for which the Model is assumed to apply.
Default is 1.10.
todos:
- Requires CIM extension to roundtrip (e.g. operational voltage limits).
comments:
- OpenDSS voltage limit; no CIM equivalent in the standard profile.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
owner: Generator
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: float
required: false
yearly:
name: yearly
annotations:
order:
tag: order
value: 10
description: Dispatch shape to use for yearly simulations. Must be previously
defined as a Loadshape object.
todos:
- LoadShape converter not yet implemented; roundtrip requires mapping DSS LoadShape
to CIM RegularIntervalSchedule.
comments:
- Reference to a DSS LoadShape object. CIM equivalent is a time-series via RegularIntervalSchedule/RegularTimePoint.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
related_mappings:
- cim:RegularTimePoint
owner: Generator
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
daily:
name: daily
annotations:
order:
tag: order
value: 11
description: Dispatch shape to use for daily simulations. Must be previously defined
as a Loadshape object of 24 hrs, typically.
todos:
- LoadShape converter not yet implemented; roundtrip requires mapping DSS LoadShape
to CIM RegularIntervalSchedule.
comments:
- Reference to a DSS LoadShape object. CIM equivalent is a time-series via RegularIntervalSchedule/RegularTimePoint.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
related_mappings:
- cim:RegularTimePoint
owner: Generator
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
duty:
name: duty
annotations:
order:
tag: order
value: 12
description: Load shape to use for duty cycle dispatch simulations such as for
wind generation. Must be previously defined as a Loadshape object.
todos:
- LoadShape converter not yet implemented; roundtrip requires mapping DSS LoadShape
to CIM RegularIntervalSchedule.
comments:
- Reference to a DSS LoadShape object. CIM equivalent is a time-series via RegularIntervalSchedule/RegularTimePoint.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
related_mappings:
- cim:RegularTimePoint
owner: Generator
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
dispmode:
name: dispmode
annotations:
order:
tag: order
value: 13
description: Dispatch mode. Default, Loadlevel, or Price.
todos:
- No CIM equivalent for DSS dispatch mode enumeration.
comments:
- OpenDSS dispatch mode; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
range: DispatchMode
required: false
dispvalue:
name: dispvalue
annotations:
order:
tag: order
value: 14
dss_default:
tag: dss_default
value: float(0.0)
description: Dispatch value. If = 0.0 (default) then Generator follows dispatch
curves. If > 0 then Generator is ON only when price or load exceeds this value.
todos:
- No CIM equivalent for dispatch trigger value.
comments:
- OpenDSS dispatch threshold; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
range: float
required: false
conn:
name: conn
annotations:
order:
tag: order
value: 15
description: Connection type. Default is wye.
comments:
- 'No dedicated CIM slot for generator winding connection in the standard profile.
Import: wye is the default and requires no action; conn=delta sets SynchronousMachine.description
to the literal text "conn=delta" as a workaround. Export: description is checked
for that exact literal to restore conn=delta; otherwise conn is left unset (wye
default).'
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
related_mappings:
- cim:SynchronousMachine.description
owner: Generator
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Autotrans
- Capacitor
- Reactor
- Transformer
- Xfmrcode
- Sensor
range: ConnectionType
required: false
status:
name: status
annotations:
order:
tag: order
value: 18
description: Fixed or Variable. If Fixed, dispatch multipliers do not apply. Default
is Variable.
todos:
- No CIM equivalent for Fixed/Variable dispatch status.
comments:
- OpenDSS dispatch status; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
owner: Generator
domain_of:
- Load
- Generator
range: GenStatus
required: false
gen_class:
name: gen_class
annotations:
order:
tag: order
value: 19
dss_name:
tag: dss_name
value: class
dss_default:
tag: dss_default
value: int(1)
description: An arbitrary integer number representing the class of Generator.
todos:
- No CIM equivalent for DSS generator class integer.
comments:
- Arbitrary DSS classification integer; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
range: integer
required: false
Vpu:
name: Vpu
annotations:
order:
tag: order
value: 20
dss_default:
tag: dss_default
value: float(1.0)
description: Per Unit voltage set point for Model = 3. Default is 1.0.
todos:
- No CIM equivalent for DSS Vpu (Model=3 set point).
comments:
- OpenDSS Model=3 voltage set point; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
range: float
required: false
maxkvar:
name: maxkvar
annotations:
order:
tag: order
value: 21
description: Maximum kvar limit for Model = 3. Defaults to twice the specified
load kvar.
todos:
- No CIM equivalent currently mapped for Generator maxkvar.
comments:
- 'OpenDSS Model=3 reactive limit; no direct CIM equivalent. Note: PVSystem uses
cim:PowerElectronicsConnection.maxQ for this concept, but Generator does not
currently map maxkvar.'
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
range: float
required: false
minkvar:
name: minkvar
annotations:
order:
tag: order
value: 22
description: Minimum kvar limit for Model = 3. Enter a negative number if generator
can absorb vars.
todos:
- No CIM equivalent currently mapped for Generator minkvar.
comments:
- OpenDSS Model=3 reactive limit; no CIM equivalent currently mapped.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
range: float
required: false
pvfactor:
name: pvfactor
annotations:
order:
tag: order
value: 23
dss_default:
tag: dss_default
value: float(0.1)
description: Deceleration factor for P-V generator model (Model=3). Default is
0.1.
todos:
- No CIM equivalent for DSS pvfactor.
comments:
- OpenDSS P-V model deceleration factor; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
range: float
required: false
forceon:
name: forceon
annotations:
order:
tag: order
value: 24
dss_default:
tag: dss_default
value: 'false'
description: Forces generator ON despite requirements of other dispatch modes.
todos:
- No CIM equivalent for DSS forceon flag.
comments:
- OpenDSS dispatch override; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
range: boolean
required: false
kVA:
name: kVA
annotations:
order:
tag: order
value: 25
description: kVA rating of electrical machine. Defaults to 1.2 * kW if not specified.
comments:
- 'Unit conversion only: kVA ↔ VA. Import: ratedS = cim.ApparentPower(kVA, ''kVA'').
Export: kVA = ratedS.to(''kVA'').'
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
exact_mappings:
- cim:RotatingMachine.ratedS
owner: Generator
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Autotrans
- Transformer
- Xfmrcode
range: float
required: false
MVA:
name: MVA
annotations:
order:
tag: order
value: 26
description: MVA rating of electrical machine. Alternative to using kVA.
todos:
- MVA is not read by the importer. If implemented, it should be treated as an
alternate input for RotatingMachine.ratedS when kVA is absent.
comments:
- 'OpenDSS-only (N/A) for now: the current importer only reads kVA, never MVA;
if both are given in a DSS file, MVA is silently ignored. No CIM field is set
from this property.'
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
- Windgen
- Gictransformer
range: float
required: false
Xd:
name: Xd
annotations:
order:
tag: order
value: 27
dss_default:
tag: dss_default
value: float(1.0)
description: Per unit synchronous reactance of machine. Default is 1.0.
todos:
- Dynamic/fault study parameter — requires CIM Dynamics profile extension to roundtrip.
comments:
- Synchronous machine dynamic parameter; no CIM equivalent in steady-state profile.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
range: float
required: false
Xdp:
name: Xdp
annotations:
order:
tag: order
value: 28
dss_default:
tag: dss_default
value: float(0.27)
description: Per unit transient reactance of the machine. Used for Dynamics mode
and Fault studies. Default is 0.27.
todos:
- Dynamic/fault study parameter — requires CIM Dynamics profile extension to roundtrip.
comments:
- Synchronous machine dynamic parameter; no CIM equivalent in steady-state profile.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
range: float
required: false
Xdpp:
name: Xdpp
annotations:
order:
tag: order
value: 29
dss_default:
tag: dss_default
value: float(0.20)
description: Per unit subtransient reactance of the machine. Used for Harmonics.
Default is 0.20.
todos:
- Dynamic/fault study parameter — requires CIM Dynamics profile extension to roundtrip.
comments:
- Synchronous machine dynamic parameter; no CIM equivalent in steady-state profile.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
range: float
required: false
H:
name: H
annotations:
order:
tag: order
value: 30
dss_default:
tag: dss_default
value: float(1.0)
description: Per unit mass constant of the machine. MW-sec/MVA. Default is 1.0.
todos:
- Dynamic parameter — requires CIM Dynamics profile extension to roundtrip.
comments:
- Synchronous machine inertia constant; no CIM equivalent in steady-state profile.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
- Generic5
- Indmach012
range: float
required: false
D:
name: D
annotations:
order:
tag: order
value: 31
dss_default:
tag: dss_default
value: float(1.0)
description: Damping constant. Usual range is 0 to 4. Default is 1.0.
todos:
- Dynamic parameter — requires CIM Dynamics profile extension to roundtrip.
comments:
- Synchronous machine damping constant; no CIM equivalent in steady-state profile.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
- Generic5
- Indmach012
range: float
required: false
UserModel:
name: UserModel
annotations:
order:
tag: order
value: 32
description: Name of DLL containing user-written model for Dynamics studies.
todos:
- No CIM equivalent for DSS UserModel DLL reference.
comments:
- OpenDSS user DLL reference; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
- Capcontrol
range: string
required: false
UserData:
name: UserData
annotations:
order:
tag: order
value: 33
description: String that gets passed to user-written model.
todos:
- No CIM equivalent for DSS UserData string.
comments:
- OpenDSS user DLL data string; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
- Capcontrol
range: string
required: false
ShaftModel:
name: ShaftModel
annotations:
order:
tag: order
value: 34
description: Name of user-written DLL containing a Shaft model.
todos:
- No CIM equivalent for DSS ShaftModel DLL reference.
comments:
- OpenDSS shaft DLL reference; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
range: string
required: false
ShaftData:
name: ShaftData
annotations:
order:
tag: order
value: 35
description: String that gets passed to user-written shaft dynamic model.
todos:
- No CIM equivalent for DSS ShaftData string.
comments:
- OpenDSS shaft DLL data string; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
range: string
required: false
DutyStart:
name: DutyStart
annotations:
order:
tag: order
value: 36
dss_default:
tag: dss_default
value: float(0.0)
description: Starting time offset [hours] into the duty cycle shape. Defaults
to 0.
todos:
- No CIM equivalent for DSS DutyStart time offset.
comments:
- OpenDSS time offset into duty shape; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
- Pvsystem
- Windgen
range: float
required: false
debugtrace:
name: debugtrace
annotations:
order:
tag: order
value: 37
dss_default:
tag: dss_default
value: 'false'
description: Turn this on to capture the progress of the generator model for each
iteration.
comments:
- OpenDSS simulation diagnostic flag; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
- Regcontrol
range: boolean
required: false
Balanced:
name: Balanced
annotations:
order:
tag: order
value: 38
dss_default:
tag: dss_default
value: 'false'
description: For Model=7, force balanced current only for 3-phase generators.
Default is No.
todos:
- No CIM equivalent for DSS Balanced flag.
comments:
- OpenDSS Model=7 flag; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
- Pvsystem
- Storage
range: boolean
required: false
XRdp:
name: XRdp
annotations:
order:
tag: order
value: 39
dss_default:
tag: dss_default
value: float(20.0)
description: X/R ratio for Xdp property for FaultStudy and Dynamic modes. Default
is 20.
todos:
- Fault study parameter — requires CIM Dynamics profile extension to roundtrip.
comments:
- Synchronous machine fault study parameter; no CIM equivalent in steady-state
profile.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
range: float
required: false
UseFuel:
name: UseFuel
annotations:
order:
tag: order
value: 40
dss_default:
tag: dss_default
value: 'false'
description: Activates the use of fuel for the operation of the generator.
todos:
- No CIM equivalent for DSS fuel model parameters.
comments:
- OpenDSS fuel model flag; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
range: boolean
required: false
FuelkWh:
name: FuelkWh
annotations:
order:
tag: order
value: 41
dss_default:
tag: dss_default
value: float(0.0)
description: Nominal level of fuel for the generator (kWh). Only applies if UseFuel
= Yes/True.
todos:
- No CIM equivalent for DSS FuelkWh.
comments:
- OpenDSS fuel capacity; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
range: float
required: false
pct_Fuel:
name: pct_Fuel
annotations:
order:
tag: order
value: 42
dss_name:
tag: dss_name
value: '%Fuel'
description: Current amount of fuel available in percentage of FuelkWh (0-100).
todos:
- No CIM equivalent for DSS %Fuel.
comments:
- OpenDSS fuel level percentage; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
range: float
required: false
pct_Reserve:
name: pct_Reserve
annotations:
order:
tag: order
value: 43
dss_name:
tag: dss_name
value: '%Reserve'
description: Reserve level in percentage of FuelkWh (0-100).
todos:
- No CIM equivalent for DSS %Reserve.
comments:
- OpenDSS fuel reserve percentage; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
- Storagecontroller
range: float
required: false
Refuel:
name: Refuel
annotations:
order:
tag: order
value: 44
dss_default:
tag: dss_default
value: 'false'
description: Boolean value to manually refuel the generator when needed.
todos:
- No CIM equivalent for DSS Refuel flag.
comments:
- OpenDSS fuel model control; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
range: boolean
required: false
DynamicEq:
name: DynamicEq
annotations:
order:
tag: order
value: 45
description: Name of the dynamic equation (DynamicExp) for defining the dynamic
behavior of the generator.
todos:
- No CIM equivalent for DSS DynamicEq reference.
comments:
- OpenDSS dynamic equation reference; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
DynOut:
name: DynOut
annotations:
order:
tag: order
value: 46
description: Name of the variables within the Dynamic equation for governing generator
dynamics.
todos:
- No CIM equivalent for DSS DynOut variable list.
comments:
- OpenDSS dynamic equation variable references; no CIM equivalent.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
rank: 1000
owner: Generator
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
multivalued: true
spectrum:
name: spectrum
annotations:
order:
tag: order
value: 47
dss_default:
tag: dss_default
value: string(default)
description: Name of harmonic voltage or current spectrum for this generator.
Default is "default".
todos:
- No CIM equivalent for DSS spectrum reference.
comments:
- OpenDSS harmonic spectrum reference; no CIM equivalent in the standard profile.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
owner: Generator
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: 48
description: Base Frequency for ratings.
todos:
- Extract base frequency from CIM circuit metadata on import; do not map to machine
object.
comments:
- Not stored on the CIM SynchronousMachine directly; base frequency is a circuit-level
property (cim:BaseVoltage or network metadata).
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
owner: Generator
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: 49
dss_default:
tag: dss_default
value: 'true'
description: Indicates whether this element is enabled.
comments:
- OpenDSS enable/disable flag; CIM machines are always modelled as enabled. No
CIM equivalent needed.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
owner: Generator
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: 50
description: 'Make like another object, e.g.: New Generator.G2 like=G1 ...'
comments:
- OpenDSS template inheritance; resolved at parser time, no CIM equivalent needed.
from_schema: https://gridappsd.github.io/dss-graph/pce/generator
owner: Generator
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:Generator