Class: Reactor¶
A Reactor object in OpenDSS representing a series or shunt impedance branch. Two-terminal reactors (bus1 + bus2) are mapped to CIM SeriesCompensator. Single-terminal (shunt) reactors are not currently supported and are skipped.
URI: dss:Reactor
classDiagram
class Reactor
click Reactor href "../Reactor/"
Reactor : basefreq
Reactor : bus1
Reactor : bus2
Reactor : conn
Reactor : emergamps
Reactor : enabled
Reactor : faultrate
Reactor : kv
Reactor : kvar
Reactor : LCurve
Reactor : like
Reactor : LmH
Reactor : name
Reactor : normamps
Reactor : Parallel
Reactor : pctperm
Reactor : phases
Reactor : R
Reactor : RCurve
Reactor : repair
Reactor : Rmatrix
Reactor : Rp
Reactor : X
Reactor : Xmatrix
Reactor : Z
Reactor : Z0
Reactor : Z1
Reactor : Z2
Class Properties¶
| Property | Value |
|---|---|
| Class URI | dss:Reactor |
Slots¶
| Name | Cardinality and Range | Description | Inheritance |
|---|---|---|---|
| name | 1 String |
Object name | direct |
| bus1 | 0..1 String |
Name of first bus | direct |
| bus2 | 0..1 String |
Name of 2nd bus | direct |
| phases | 0..1 Integer |
Number of phases | direct |
| kvar | 0..1 Float |
Total kvar, all phases | direct |
| kv | 0..1 Float |
For 2, 3-phase, kV phase-phase | direct |
| conn | 0..1 String |
={wye | delta |
| Rmatrix | 0..1 Integer |
Resistance matrix, lower triangle, ohms at base frequency | direct |
| Xmatrix | 0..1 Integer |
Reactance matrix, lower triangle, ohms at base frequency | direct |
| Parallel | 0..1 Boolean |
{Yes | No} Default=No |
| R | 0..1 Float |
Resistance (in series with reactance), each phase, ohms | direct |
| X | 0..1 Float |
Reactance, each phase, ohms at base frequency | direct |
| Rp | 0..1 Float |
Resistance in parallel with R and X (the entire branch) | direct |
| Z1 | 0..1 Float |
Positive-sequence impedance, ohms, as a 2-element array [R, X] | direct |
| Z2 | 0..1 Float |
Negative-sequence impedance, ohms, as a 2-element array [R, X] | direct |
| Z0 | 0..1 Float |
Zero-sequence impedance, ohms, as a 2-element array [R, X] | direct |
| Z | 0..1 Float |
Alternative way of defining R and X properties as a complex array | direct |
| RCurve | 0..1 Float |
Name of XYCurve object describing per-unit variation of phase resistance, R, ... | direct |
| LCurve | 0..1 Float |
Name of XYCurve object describing per-unit variation of phase inductance, L=X... | direct |
| LmH | 0..1 Float |
Inductance, mH | direct |
| normamps | 0..1 Float |
Normal rated current | direct |
| emergamps | 0..1 Float |
Maximum or emerg current | direct |
| faultrate | 0..1 String |
Failure rate per year | direct |
| pctperm | 0..1 Float |
Percent of failures that become permanent | direct |
| repair | 0..1 String |
Hours to repair | 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¶
- OpenDSS two-terminal Reactor maps to CIM SeriesCompensator ("a series capacitor or reactor or an AC transmission line without charging susceptance"). Only the two-terminal configuration is supported; single-terminal shunt reactors are skipped on import (bus2 absent) and return no CIM object.
Identifier and Mapping Information¶
Schema Source¶
- from schema: https://gridappsd.github.io/dss-graph/opendss
Mappings¶
| Mapping Type | Mapped Value |
|---|---|
| self | dss:Reactor |
| native | dss:Reactor |
| exact | cim:SeriesCompensator |
LinkML Source¶
Direct¶
name: Reactor
description: A Reactor object in OpenDSS representing a series or shunt impedance
branch. Two-terminal reactors (bus1 + bus2) are mapped to CIM SeriesCompensator.
Single-terminal (shunt) reactors are not currently supported and are skipped.
comments:
- OpenDSS two-terminal Reactor maps to CIM SeriesCompensator ("a series capacitor
or reactor or an AC transmission line without charging susceptance"). Only the two-terminal
configuration is supported; single-terminal shunt reactors are skipped on import
(bus2 absent) and return no CIM object.
from_schema: https://gridappsd.github.io/dss-graph/opendss
exact_mappings:
- cim:SeriesCompensator
attributes:
name:
name: name
description: Object name. Must be unique per object type.
comments:
- Direct name mapping; no conversion needed.
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
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
bus1:
name: bus1
annotations:
order:
tag: order
value: 1
description: Name of first bus. Primary terminal connection.
comments:
- 'Terminal 1 structural mapping: equipment.Terminals[0].ConnectivityNode.name.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
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
bus2:
name: bus2
annotations:
order:
tag: order
value: 2
description: Name of 2nd bus. If absent, this is a single-terminal shunt reactor
(not currently supported by the converter).
comments:
- 'Terminal 2 structural mapping: equipment.Terminals[1].ConnectivityNode.name.
If absent, converter returns None (shunt reactor not supported).'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
related_mappings:
- cim:Terminal.ConnectivityNode
domain_of:
- Gicline
- Upfc
- Capacitor
- Line
- Reactor
- Fault
- Vsource
range: string
required: false
phases:
name: phases
annotations:
order:
tag: order
value: 3
description: Number of phases.
comments:
- 'Import: inferred from the bus1 node suffix via parse_bus_phases(); not stored
directly on CIM SeriesCompensator. Export: always written as 3 (the exporter
treats SeriesCompensator as a symmetric 3-phase element and does not recover
the original phase count).'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
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
kvar:
name: kvar
annotations:
order:
tag: order
value: 4
description: Total kvar, all phases. Used to derive reactance when X is not specified.
comments:
- 'Import fallback, only used when X is not given: X = kV² / kvar × 1000 (derived
reactance in ohms). Export: not written back; x is the authoritative CIM attribute
and is always exported via the X property directly.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
close_mappings:
- cim:SeriesCompensator.x
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
- Capacitor
- Reactor
range: float
required: false
kv:
name: kv
annotations:
order:
tag: order
value: 5
description: For 2, 3-phase, kV phase-phase. Used with kvar to derive reactance.
comments:
- Used only when deriving X from kvar (see kvar comments). Not stored directly
on CIM SeriesCompensator.
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
domain_of:
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Capacitor
- Reactor
range: float
required: false
conn:
name: conn
annotations:
order:
tag: order
value: 6
description: ={wye | delta |LN |LL} Default is wye, which is equivalent to LN.
comments:
- 'OpenDSS-only (N/A): CIM SeriesCompensator has no phaseConnection attribute;
it is a two-terminal series element.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Autotrans
- Capacitor
- Reactor
- Transformer
- Xfmrcode
- Sensor
range: string
required: false
Rmatrix:
name: Rmatrix
annotations:
order:
tag: order
value: 7
description: Resistance matrix, lower triangle, ohms at base frequency.
todos:
- Phase-impedance matrix path not yet implemented for Reactor.
comments:
- 'OpenDSS-only (N/A): matrix form not supported in the current converter. Use
R property for scalar resistance.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
rank: 1000
domain_of:
- Reactor
range: integer
required: false
Xmatrix:
name: Xmatrix
annotations:
order:
tag: order
value: 8
description: Reactance matrix, lower triangle, ohms at base frequency.
todos:
- Phase-impedance matrix path not yet implemented for Reactor.
comments:
- 'OpenDSS-only (N/A): matrix form not supported in the current converter. Use
X property for scalar reactance.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
rank: 1000
domain_of:
- Reactor
range: integer
required: false
Parallel:
name: Parallel
annotations:
order:
tag: order
value: 9
description: '{Yes | No} Default=No. If Yes, model as a parallel R-L combination
instead of series.'
comments:
- 'OpenDSS-only (N/A): circuit topology modifier; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
rank: 1000
domain_of:
- Reactor
range: boolean
required: false
R:
name: R
annotations:
order:
tag: order
value: 10
description: Resistance (in series with reactance), each phase, ohms.
comments:
- 'Import: SeriesCompensator.r = Resistance(R, ''ohm''); the zero-sequence resistance
r0 is also set equal to r, since the DSS Reactor has no separate zero-sequence
input. Export: R = r.to(''ohm''). CIM stores in ohm (SI base).'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
exact_mappings:
- cim:SeriesCompensator.r
domain_of:
- Gicline
- Capacitor
- Reactor
- Regcontrol
range: float
required: false
X:
name: X
annotations:
order:
tag: order
value: 11
description: Reactance, each phase, ohms at base frequency.
comments:
- 'Import: SeriesCompensator.x = Reactance(X, ''ohm''); the zero-sequence reactance
x0 is also set equal to x, since the DSS Reactor has no separate zero-sequence
input. Export: X = x.to(''ohm''). CIM stores in ohm (SI base).'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
exact_mappings:
- cim:SeriesCompensator.x
domain_of:
- Gicline
- Reactor
- Regcontrol
range: float
required: false
Rp:
name: Rp
annotations:
order:
tag: order
value: 12
description: Resistance in parallel with R and X (the entire branch). Represents
core loss equivalent.
comments:
- 'OpenDSS-only (N/A): parallel loss resistance; no CIM equivalent on SeriesCompensator
in the standard profile.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
rank: 1000
domain_of:
- Reactor
range: float
required: false
Z1:
name: Z1
annotations:
order:
tag: order
value: 13
description: Positive-sequence impedance, ohms, as a 2-element array [R, X].
todos:
- Converter does not currently consume Z1 as an R/X source; would need to be added
to the import fallback chain to roundtrip models that only set Z1.
comments:
- 'OpenDSS-only (N/A): alternate input form for R and X; the current converter
reads R and X directly and does not fall back to Z1.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
rank: 1000
domain_of:
- Reactor
- Vsource
range: float
required: false
Z2:
name: Z2
annotations:
order:
tag: order
value: 14
description: Negative-sequence impedance, ohms, as a 2-element array [R, X].
comments:
- 'OpenDSS-only (N/A): negative-sequence impedance input; no CIM equivalent on
SeriesCompensator (which is a symmetric series element).'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
rank: 1000
domain_of:
- Reactor
- Vsource
range: float
required: false
Z0:
name: Z0
annotations:
order:
tag: order
value: 15
description: Zero-sequence impedance, ohms, as a 2-element array [R, X].
todos:
- Converter does not read Z0; wiring it in would let r0/x0 reflect the DSS zero-sequence
input instead of defaulting to r/x.
comments:
- 'OpenDSS-only input, not currently consumed by the converter: r0/x0 are instead
defaulted to r/x on import (see R/X comments), so a Z0 value distinct from Z1
is silently dropped.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
related_mappings:
- cim:SeriesCompensator.r0
- cim:SeriesCompensator.x0
rank: 1000
domain_of:
- Reactor
- Vsource
range: float
required: false
Z:
name: Z
annotations:
order:
tag: order
value: 16
description: Alternative way of defining R and X properties as a complex array.
todos:
- Converter does not currently consume Z as an R/X source; would need to be added
to the import fallback chain to roundtrip models that only set Z.
comments:
- 'OpenDSS-only (N/A): alternate input form for R and X; the current converter
reads R and X directly and does not fall back to Z.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
rank: 1000
domain_of:
- Reactor
range: float
required: false
RCurve:
name: RCurve
annotations:
order:
tag: order
value: 17
description: Name of XYCurve object describing per-unit variation of phase resistance,
R, vs. frequency.
comments:
- 'OpenDSS-only (N/A): frequency-dependent resistance curve; no CIM equivalent
in the standard profile.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
rank: 1000
domain_of:
- Reactor
range: float
required: false
LCurve:
name: LCurve
annotations:
order:
tag: order
value: 18
description: Name of XYCurve object describing per-unit variation of phase inductance,
L=X/w, vs. frequency.
comments:
- 'OpenDSS-only (N/A): frequency-dependent inductance curve; no CIM equivalent
in the standard profile.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
rank: 1000
domain_of:
- Reactor
range: float
required: false
LmH:
name: LmH
annotations:
order:
tag: order
value: 19
description: Inductance, mH. Alternate way to specify X at base frequency.
todos:
- Converter does not currently consume LmH as an X source; would need to be added
to the import fallback chain to roundtrip models that only set LmH.
comments:
- 'OpenDSS-only (N/A): alternate way to specify X (formula: X = 2π × f × LmH ×
1e-3, mH → ohm) via basefreq f, but the current converter reads R and X directly
and does not fall back to LmH.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
rank: 1000
domain_of:
- Reactor
range: float
required: false
normamps:
name: normamps
annotations:
order:
tag: order
value: 20
description: Normal rated current.
todos:
- Converter not yet implemented. Should map to a CurrentLimit (limitType=normalOperating)
on an OperationalLimitSet for this equipment.
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
related_mappings:
- cim:CurrentLimit
domain_of:
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Cndata
- Linecode
- Linegeometry
- Tsdata
- Wiredata
- Fault
range: float
required: false
emergamps:
name: emergamps
annotations:
order:
tag: order
value: 21
description: Maximum or emerg current.
todos:
- Converter not yet implemented. Should map to a CurrentLimit (limitType=emergency)
on the OperationalLimitSet.
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
related_mappings:
- cim:CurrentLimit
domain_of:
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Cndata
- Linecode
- Linegeometry
- Tsdata
- Wiredata
- Fault
range: float
required: false
faultrate:
name: faultrate
annotations:
order:
tag: order
value: 22
description: Failure rate per year.
todos:
- Requires CIM extension to roundtrip.
comments:
- Reliability parameter; no CIM equivalent in the standard profile.
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
domain_of:
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Linecode
- Fault
range: string
required: false
pctperm:
name: pctperm
annotations:
order:
tag: order
value: 23
description: Percent of failures that become permanent.
todos:
- Requires CIM extension to roundtrip.
comments:
- Reliability parameter; no CIM equivalent in the standard profile.
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
domain_of:
- Autotrans
- Capacitor
- Gictransformer
- Reactor
- Linecode
- Fault
range: float
required: false
repair:
name: repair
annotations:
order:
tag: order
value: 24
description: Hours to repair.
todos:
- Requires CIM extension to roundtrip.
comments:
- Reliability parameter; no CIM equivalent in the standard profile.
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
domain_of:
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Linecode
- Fault
range: string
required: false
basefreq:
name: basefreq
annotations:
order:
tag: order
value: 25
description: Base Frequency for ratings.
comments:
- 'OpenDSS-only (N/A): not stored on CIM SeriesCompensator; base frequency is
a circuit-level property in CIM. Only relevant to the LmH → X formula (see LmH
comments), which the converter does not currently run.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
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: 26
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 object is created.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
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: 27
description: 'Make like another object, e.g.: New Reactor.R2 like=R1 ...'
comments:
- 'OpenDSS-only (N/A): DSS template/copy directive resolved at parse time; no
CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
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:Reactor
Induced¶
name: Reactor
description: A Reactor object in OpenDSS representing a series or shunt impedance
branch. Two-terminal reactors (bus1 + bus2) are mapped to CIM SeriesCompensator.
Single-terminal (shunt) reactors are not currently supported and are skipped.
comments:
- OpenDSS two-terminal Reactor maps to CIM SeriesCompensator ("a series capacitor
or reactor or an AC transmission line without charging susceptance"). Only the two-terminal
configuration is supported; single-terminal shunt reactors are skipped on import
(bus2 absent) and return no CIM object.
from_schema: https://gridappsd.github.io/dss-graph/opendss
exact_mappings:
- cim:SeriesCompensator
attributes:
name:
name: name
description: Object name. Must be unique per object type.
comments:
- Direct name mapping; no conversion needed.
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
exact_mappings:
- cim:IdentifiedObject.name
identifier: true
owner: Reactor
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
bus1:
name: bus1
annotations:
order:
tag: order
value: 1
description: Name of first bus. Primary terminal connection.
comments:
- 'Terminal 1 structural mapping: equipment.Terminals[0].ConnectivityNode.name.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
related_mappings:
- cim:Terminal.ConnectivityNode
owner: Reactor
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Windgen
- Capacitor
- Line
- Reactor
- Fault
- Isource
- Vsource
range: string
required: false
bus2:
name: bus2
annotations:
order:
tag: order
value: 2
description: Name of 2nd bus. If absent, this is a single-terminal shunt reactor
(not currently supported by the converter).
comments:
- 'Terminal 2 structural mapping: equipment.Terminals[1].ConnectivityNode.name.
If absent, converter returns None (shunt reactor not supported).'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
related_mappings:
- cim:Terminal.ConnectivityNode
owner: Reactor
domain_of:
- Gicline
- Upfc
- Capacitor
- Line
- Reactor
- Fault
- Vsource
range: string
required: false
phases:
name: phases
annotations:
order:
tag: order
value: 3
description: Number of phases.
comments:
- 'Import: inferred from the bus1 node suffix via parse_bus_phases(); not stored
directly on CIM SeriesCompensator. Export: always written as 3 (the exporter
treats SeriesCompensator as a symmetric 3-phase element and does not recover
the original phase count).'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
owner: Reactor
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
kvar:
name: kvar
annotations:
order:
tag: order
value: 4
description: Total kvar, all phases. Used to derive reactance when X is not specified.
comments:
- 'Import fallback, only used when X is not given: X = kV² / kvar × 1000 (derived
reactance in ohms). Export: not written back; x is the authoritative CIM attribute
and is always exported via the X property directly.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
close_mappings:
- cim:SeriesCompensator.x
owner: Reactor
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
- Capacitor
- Reactor
range: float
required: false
kv:
name: kv
annotations:
order:
tag: order
value: 5
description: For 2, 3-phase, kV phase-phase. Used with kvar to derive reactance.
comments:
- Used only when deriving X from kvar (see kvar comments). Not stored directly
on CIM SeriesCompensator.
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
owner: Reactor
domain_of:
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Capacitor
- Reactor
range: float
required: false
conn:
name: conn
annotations:
order:
tag: order
value: 6
description: ={wye | delta |LN |LL} Default is wye, which is equivalent to LN.
comments:
- 'OpenDSS-only (N/A): CIM SeriesCompensator has no phaseConnection attribute;
it is a two-terminal series element.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
owner: Reactor
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Autotrans
- Capacitor
- Reactor
- Transformer
- Xfmrcode
- Sensor
range: string
required: false
Rmatrix:
name: Rmatrix
annotations:
order:
tag: order
value: 7
description: Resistance matrix, lower triangle, ohms at base frequency.
todos:
- Phase-impedance matrix path not yet implemented for Reactor.
comments:
- 'OpenDSS-only (N/A): matrix form not supported in the current converter. Use
R property for scalar resistance.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
rank: 1000
owner: Reactor
domain_of:
- Reactor
range: integer
required: false
Xmatrix:
name: Xmatrix
annotations:
order:
tag: order
value: 8
description: Reactance matrix, lower triangle, ohms at base frequency.
todos:
- Phase-impedance matrix path not yet implemented for Reactor.
comments:
- 'OpenDSS-only (N/A): matrix form not supported in the current converter. Use
X property for scalar reactance.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
rank: 1000
owner: Reactor
domain_of:
- Reactor
range: integer
required: false
Parallel:
name: Parallel
annotations:
order:
tag: order
value: 9
description: '{Yes | No} Default=No. If Yes, model as a parallel R-L combination
instead of series.'
comments:
- 'OpenDSS-only (N/A): circuit topology modifier; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
rank: 1000
owner: Reactor
domain_of:
- Reactor
range: boolean
required: false
R:
name: R
annotations:
order:
tag: order
value: 10
description: Resistance (in series with reactance), each phase, ohms.
comments:
- 'Import: SeriesCompensator.r = Resistance(R, ''ohm''); the zero-sequence resistance
r0 is also set equal to r, since the DSS Reactor has no separate zero-sequence
input. Export: R = r.to(''ohm''). CIM stores in ohm (SI base).'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
exact_mappings:
- cim:SeriesCompensator.r
owner: Reactor
domain_of:
- Gicline
- Capacitor
- Reactor
- Regcontrol
range: float
required: false
X:
name: X
annotations:
order:
tag: order
value: 11
description: Reactance, each phase, ohms at base frequency.
comments:
- 'Import: SeriesCompensator.x = Reactance(X, ''ohm''); the zero-sequence reactance
x0 is also set equal to x, since the DSS Reactor has no separate zero-sequence
input. Export: X = x.to(''ohm''). CIM stores in ohm (SI base).'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
exact_mappings:
- cim:SeriesCompensator.x
owner: Reactor
domain_of:
- Gicline
- Reactor
- Regcontrol
range: float
required: false
Rp:
name: Rp
annotations:
order:
tag: order
value: 12
description: Resistance in parallel with R and X (the entire branch). Represents
core loss equivalent.
comments:
- 'OpenDSS-only (N/A): parallel loss resistance; no CIM equivalent on SeriesCompensator
in the standard profile.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
rank: 1000
owner: Reactor
domain_of:
- Reactor
range: float
required: false
Z1:
name: Z1
annotations:
order:
tag: order
value: 13
description: Positive-sequence impedance, ohms, as a 2-element array [R, X].
todos:
- Converter does not currently consume Z1 as an R/X source; would need to be added
to the import fallback chain to roundtrip models that only set Z1.
comments:
- 'OpenDSS-only (N/A): alternate input form for R and X; the current converter
reads R and X directly and does not fall back to Z1.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
rank: 1000
owner: Reactor
domain_of:
- Reactor
- Vsource
range: float
required: false
Z2:
name: Z2
annotations:
order:
tag: order
value: 14
description: Negative-sequence impedance, ohms, as a 2-element array [R, X].
comments:
- 'OpenDSS-only (N/A): negative-sequence impedance input; no CIM equivalent on
SeriesCompensator (which is a symmetric series element).'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
rank: 1000
owner: Reactor
domain_of:
- Reactor
- Vsource
range: float
required: false
Z0:
name: Z0
annotations:
order:
tag: order
value: 15
description: Zero-sequence impedance, ohms, as a 2-element array [R, X].
todos:
- Converter does not read Z0; wiring it in would let r0/x0 reflect the DSS zero-sequence
input instead of defaulting to r/x.
comments:
- 'OpenDSS-only input, not currently consumed by the converter: r0/x0 are instead
defaulted to r/x on import (see R/X comments), so a Z0 value distinct from Z1
is silently dropped.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
related_mappings:
- cim:SeriesCompensator.r0
- cim:SeriesCompensator.x0
rank: 1000
owner: Reactor
domain_of:
- Reactor
- Vsource
range: float
required: false
Z:
name: Z
annotations:
order:
tag: order
value: 16
description: Alternative way of defining R and X properties as a complex array.
todos:
- Converter does not currently consume Z as an R/X source; would need to be added
to the import fallback chain to roundtrip models that only set Z.
comments:
- 'OpenDSS-only (N/A): alternate input form for R and X; the current converter
reads R and X directly and does not fall back to Z.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
rank: 1000
owner: Reactor
domain_of:
- Reactor
range: float
required: false
RCurve:
name: RCurve
annotations:
order:
tag: order
value: 17
description: Name of XYCurve object describing per-unit variation of phase resistance,
R, vs. frequency.
comments:
- 'OpenDSS-only (N/A): frequency-dependent resistance curve; no CIM equivalent
in the standard profile.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
rank: 1000
owner: Reactor
domain_of:
- Reactor
range: float
required: false
LCurve:
name: LCurve
annotations:
order:
tag: order
value: 18
description: Name of XYCurve object describing per-unit variation of phase inductance,
L=X/w, vs. frequency.
comments:
- 'OpenDSS-only (N/A): frequency-dependent inductance curve; no CIM equivalent
in the standard profile.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
rank: 1000
owner: Reactor
domain_of:
- Reactor
range: float
required: false
LmH:
name: LmH
annotations:
order:
tag: order
value: 19
description: Inductance, mH. Alternate way to specify X at base frequency.
todos:
- Converter does not currently consume LmH as an X source; would need to be added
to the import fallback chain to roundtrip models that only set LmH.
comments:
- 'OpenDSS-only (N/A): alternate way to specify X (formula: X = 2π × f × LmH ×
1e-3, mH → ohm) via basefreq f, but the current converter reads R and X directly
and does not fall back to LmH.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
rank: 1000
owner: Reactor
domain_of:
- Reactor
range: float
required: false
normamps:
name: normamps
annotations:
order:
tag: order
value: 20
description: Normal rated current.
todos:
- Converter not yet implemented. Should map to a CurrentLimit (limitType=normalOperating)
on an OperationalLimitSet for this equipment.
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
related_mappings:
- cim:CurrentLimit
owner: Reactor
domain_of:
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Cndata
- Linecode
- Linegeometry
- Tsdata
- Wiredata
- Fault
range: float
required: false
emergamps:
name: emergamps
annotations:
order:
tag: order
value: 21
description: Maximum or emerg current.
todos:
- Converter not yet implemented. Should map to a CurrentLimit (limitType=emergency)
on the OperationalLimitSet.
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
related_mappings:
- cim:CurrentLimit
owner: Reactor
domain_of:
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Cndata
- Linecode
- Linegeometry
- Tsdata
- Wiredata
- Fault
range: float
required: false
faultrate:
name: faultrate
annotations:
order:
tag: order
value: 22
description: Failure rate per year.
todos:
- Requires CIM extension to roundtrip.
comments:
- Reliability parameter; no CIM equivalent in the standard profile.
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
owner: Reactor
domain_of:
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Linecode
- Fault
range: string
required: false
pctperm:
name: pctperm
annotations:
order:
tag: order
value: 23
description: Percent of failures that become permanent.
todos:
- Requires CIM extension to roundtrip.
comments:
- Reliability parameter; no CIM equivalent in the standard profile.
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
owner: Reactor
domain_of:
- Autotrans
- Capacitor
- Gictransformer
- Reactor
- Linecode
- Fault
range: float
required: false
repair:
name: repair
annotations:
order:
tag: order
value: 24
description: Hours to repair.
todos:
- Requires CIM extension to roundtrip.
comments:
- Reliability parameter; no CIM equivalent in the standard profile.
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
owner: Reactor
domain_of:
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Linecode
- Fault
range: string
required: false
basefreq:
name: basefreq
annotations:
order:
tag: order
value: 25
description: Base Frequency for ratings.
comments:
- 'OpenDSS-only (N/A): not stored on CIM SeriesCompensator; base frequency is
a circuit-level property in CIM. Only relevant to the LmH → X formula (see LmH
comments), which the converter does not currently run.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
owner: Reactor
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: 26
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 object is created.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
owner: Reactor
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: 27
description: 'Make like another object, e.g.: New Reactor.R2 like=R1 ...'
comments:
- 'OpenDSS-only (N/A): DSS template/copy directive resolved at parse time; no
CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pde/reactor
owner: Reactor
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:Reactor