Class: Capacitor¶
A Capacitor object in OpenDSS representing a shunt or series capacitor bank connected to the distribution system.
URI: dss:Capacitor
classDiagram
class Capacitor
click Capacitor href "../Capacitor/"
Capacitor : basefreq
Capacitor : bus1
Capacitor : bus2
Capacitor : cmatrix
Capacitor : conn
Capacitor --> "0..1" ConnectionType : conn
click ConnectionType href "../ConnectionType/"
Capacitor : cuf
Capacitor : emergamps
Capacitor : enabled
Capacitor : faultrate
Capacitor : Harm
Capacitor : kv
Capacitor : kvar
Capacitor : like
Capacitor : name
Capacitor : normamps
Capacitor : Numsteps
Capacitor : pctperm
Capacitor : phases
Capacitor : R
Capacitor : repair
Capacitor : states
Capacitor : XL
Class Properties¶
| Property | Value |
|---|---|
| Class URI | dss:Capacitor |
Slots¶
| Name | Cardinality and Range | Description | Inheritance |
|---|---|---|---|
| name | 1 String |
Object name | direct |
| bus1 | 0..1 String |
Name of first bus of 2-terminal capacitor | direct |
| bus2 | 0..1 String |
Name of 2nd bus | direct |
| phases | 0..1 Integer |
Number of phases | direct |
| kvar | * Float |
Total kvar, if one step, or ARRAY of kvar ratings for each step | direct |
| kv | 0..1 Float |
For 2, 3-phase, kV phase-phase | direct |
| conn | 0..1 ConnectionType |
={wye | delta |
| cmatrix | * Float |
Nodal cap | direct |
| cuf | * Float |
ARRAY of Capacitance, each phase, for each step, microfarads | direct |
| R | * Float |
ARRAY of series resistance in each phase (line), ohms | direct |
| XL | * Float |
ARRAY of series inductive reactance(s) in each phase (line) for filter, ohms ... | direct |
| Harm | * Float |
ARRAY of harmonics to which each step is tuned | direct |
| Numsteps | 0..1 Integer |
Number of steps in this capacitor bank | direct |
| states | * Integer |
ARRAY of integers {1 | 0} states representing the state of each step (on |
| 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 Capacitor maps to CIM LinearShuntCompensator. Per-phase susceptance information is carried on LinearShuntCompensatorPhase collections. This schema in pde/ is the PDE-side counterpart of pce/capacitor.yaml; both map to the same CIM class.
Identifier and Mapping Information¶
Schema Source¶
- from schema: https://gridappsd.github.io/dss-graph/opendss
Mappings¶
| Mapping Type | Mapped Value |
|---|---|
| self | dss:Capacitor |
| native | dss:Capacitor |
| exact | cim:LinearShuntCompensator |
LinkML Source¶
Direct¶
name: Capacitor
description: A Capacitor object in OpenDSS representing a shunt or series capacitor
bank connected to the distribution system.
comments:
- OpenDSS Capacitor maps to CIM LinearShuntCompensator. Per-phase susceptance information
is carried on LinearShuntCompensatorPhase collections. This schema in pde/ is the
PDE-side counterpart of pce/capacitor.yaml; both map to the same CIM class.
from_schema: https://gridappsd.github.io/dss-graph/opendss
exact_mappings:
- cim:LinearShuntCompensator
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/capacitor
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 of 2-terminal capacitor. If only one bus specified,
Bus2 defaults to this bus, Node 0 (Yg shunt bank).
comments:
- 'Structural mapping via traversal: equipment.Terminals[0].ConnectivityNode.name.
Phase suffix reconstructed from LinearShuntCompensatorPhase objects ordered
by SinglePhaseKind (A=1, B=2, C=3).'
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
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. Defaults to all phases connected to first bus, node
0.
comments:
- N/A for CIM roundtrip. OpenDSS shunt capacitors are single-terminal in CIM (LinearShuntCompensator
has one Terminal; neutral is implicit via grounded=True). Bus2 is meaningful
only for two-terminal series capacitor configurations.
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
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 bus phase specification in bus1 via parse_bus_phases().
Export: derived as len(shunt.ShuntCompensatorPhase).'
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
related_mappings:
- cim:LinearShuntCompensatorPhase
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, if one step, or ARRAY of kvar ratings for each step.
Evenly divided among phases.
comments:
- 'Import: bPerSection = 0.001 × kvar_total / kV² / Numsteps (kvar → siemens).
Export: kvar_total = bPerSection × kV² × 1000 × Numsteps. Same physical concept;
CIM stores susceptance per section in SI (siemens).'
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
close_mappings:
- cim:LinearShuntCompensator.bPerSection
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
- Capacitor
- Reactor
range: float
required: false
multivalued: true
minimum_value: 0.0
kv:
name: kv
annotations:
order:
tag: order
value: 5
description: For 2, 3-phase, kV phase-phase. Otherwise specify actual can rating.
comments:
- 'Unit conversion: kV ↔ V (CIM stores SI base units via cim.Voltage).'
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
exact_mappings:
- cim:LinearShuntCompensator.nomU
domain_of:
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Capacitor
- Reactor
range: float
required: false
minimum_value: 0.0
conn:
name: conn
annotations:
order:
tag: order
value: 6
description: ={wye | delta |LN |LL} Default is wye, which is equivalent to LN.
comments:
- 'Import: wye → PhaseShuntConnectionKind.Y (grounded=True, b0PerSection=bPerSection);
delta → PhaseShuntConnectionKind.D (grounded=False, b0PerSection=0). Export:
PhaseShuntConnectionKind.Y → wye; D → delta.'
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
exact_mappings:
- cim:LinearShuntCompensator.phaseConnection
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Autotrans
- Capacitor
- Reactor
- Transformer
- Xfmrcode
- Sensor
range: ConnectionType
required: false
cmatrix:
name: cmatrix
annotations:
order:
tag: order
value: 7
dss_format:
tag: dss_format
value: matrix
description: Nodal cap. matrix, lower triangle, microfarads. All steps are assumed
the same if this property is used.
comments:
- 'Lossy roundtrip: CIM stores only per-phase susceptance (diagonal elements);
off-diagonal coupling terms are discarded. Diagonal index for phase i: i*(i+1)/2
+ i. Conversion: B = 2π × 60 × C_µF × 1e-6 (siemens).'
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
related_mappings:
- cim:LinearShuntCompensatorPhase.bPerSection
rank: 1000
domain_of:
- Capacitor
- Line
- Linecode
range: float
required: false
multivalued: true
cuf:
name: cuf
annotations:
order:
tag: order
value: 8
description: ARRAY of Capacitance, each phase, for each step, microfarads.
todos:
- 'Exporter: B → µF per-phase path not yet implemented; cuf is not written on
export.'
comments:
- 'Import: flat per-phase µF array converted to per-phase bPerSection. B = 2π
× 60 × C_µF × 1e-6 (siemens).'
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
related_mappings:
- cim:LinearShuntCompensatorPhase.bPerSection
rank: 1000
domain_of:
- Capacitor
range: float
required: false
multivalued: true
R:
name: R
annotations:
order:
tag: order
value: 9
description: ARRAY of series resistance in each phase (line), ohms. Default is
0.0.
todos:
- Requires CIM extension (e.g. cim:LinearShuntCompensator.seriesR) to roundtrip.
comments:
- OpenDSS filter-capacitor feature (series R for harmonic filter tuning); no CIM
equivalent in the standard profile.
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
domain_of:
- Gicline
- Capacitor
- Reactor
- Regcontrol
range: float
required: false
multivalued: true
XL:
name: XL
annotations:
order:
tag: order
value: 10
description: ARRAY of series inductive reactance(s) in each phase (line) for filter,
ohms at base frequency. Default is 0.0.
todos:
- Requires CIM extension (e.g. cim:LinearShuntCompensator.seriesXL) to roundtrip.
comments:
- OpenDSS harmonic filter tuning parameter; no CIM equivalent in the standard
profile.
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
rank: 1000
domain_of:
- Capacitor
range: float
required: false
multivalued: true
Harm:
name: Harm
annotations:
order:
tag: order
value: 11
description: ARRAY of harmonics to which each step is tuned. Zero = no filter.
todos:
- Requires CIM extension (e.g. cim:LinearShuntCompensator.filterHarmonic) to roundtrip.
comments:
- OpenDSS harmonic filter tuning parameter; no CIM equivalent in the standard
profile.
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
rank: 1000
domain_of:
- Capacitor
range: float
required: false
multivalued: true
Numsteps:
name: Numsteps
annotations:
order:
tag: order
value: 12
dss_default:
tag: dss_default
value: int(1)
description: Number of steps in this capacitor bank. Default = 1.
comments:
- 'Import: mapped to both normalSections and maximumSections. Export: read from
maximumSections.'
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
exact_mappings:
- cim:LinearShuntCompensator.maximumSections
rank: 1000
domain_of:
- Capacitor
range: integer
required: false
states:
name: states
annotations:
order:
tag: order
value: 13
description: ARRAY of integers {1|0} states representing the state of each step
(on|off).
comments:
- 'Import: count of on steps (states[i] > 0) stored as sections (float). Export:
sections → [1]*current_sections + [0]*(Numsteps - current_sections).'
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
close_mappings:
- cim:LinearShuntCompensator.sections
rank: 1000
domain_of:
- Capacitor
range: integer
required: false
multivalued: true
normamps:
name: normamps
annotations:
order:
tag: order
value: 14
description: Normal rated current.
todos:
- Converter not yet implemented; requires OperationalLimitSet + CurrentLimit creation.
comments:
- 'Intended target: a normal-rating CurrentLimit on an OperationalLimitSet attached
to this equipment''s terminal.'
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
related_mappings:
- cim:OperationalLimit
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: 15
description: Maximum or emerg current.
todos:
- Converter not yet implemented; requires OperationalLimitSet + CurrentLimit creation.
comments:
- 'Intended target: an emergency-rating CurrentLimit on an OperationalLimitSet
attached to this equipment''s terminal.'
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
related_mappings:
- cim:OperationalLimit
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: 16
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/capacitor
domain_of:
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Linecode
- Fault
range: string
required: false
pctperm:
name: pctperm
annotations:
order:
tag: order
value: 17
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/capacitor
domain_of:
- Autotrans
- Capacitor
- Gictransformer
- Reactor
- Linecode
- Fault
range: float
required: false
repair:
name: repair
annotations:
order:
tag: order
value: 18
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/capacitor
domain_of:
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Linecode
- Fault
range: string
required: false
basefreq:
name: basefreq
annotations:
order:
tag: order
value: 19
description: Base Frequency for ratings.
todos:
- Extract base frequency from circuit-level CIM attributes for non-60Hz systems.
comments:
- Not stored on CIM LinearShuntCompensator; base frequency is a circuit-level
property in CIM. The µF ↔ susceptance conversion uses 60 Hz hardcoded; a non-60-Hz
capacitor would need this from circuit context.
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
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: 20
dss_default:
tag: dss_default
value: 'true'
description: '{Yes|No or True|False} Indicates whether this element is enabled.'
comments:
- 'OpenDSS-only (N/A): if False, converter returns None. All CIM LinearShuntCompensator
objects are assumed enabled.'
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
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: 21
description: 'Make like another object, e.g.: New Capacitor.C2 like=c1 ...'
comments:
- 'OpenDSS-only (N/A): DSS template inheritance resolved at parser time; no CIM
equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
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:Capacitor
Induced¶
name: Capacitor
description: A Capacitor object in OpenDSS representing a shunt or series capacitor
bank connected to the distribution system.
comments:
- OpenDSS Capacitor maps to CIM LinearShuntCompensator. Per-phase susceptance information
is carried on LinearShuntCompensatorPhase collections. This schema in pde/ is the
PDE-side counterpart of pce/capacitor.yaml; both map to the same CIM class.
from_schema: https://gridappsd.github.io/dss-graph/opendss
exact_mappings:
- cim:LinearShuntCompensator
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/capacitor
exact_mappings:
- cim:IdentifiedObject.name
identifier: true
owner: Capacitor
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 of 2-terminal capacitor. If only one bus specified,
Bus2 defaults to this bus, Node 0 (Yg shunt bank).
comments:
- 'Structural mapping via traversal: equipment.Terminals[0].ConnectivityNode.name.
Phase suffix reconstructed from LinearShuntCompensatorPhase objects ordered
by SinglePhaseKind (A=1, B=2, C=3).'
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
related_mappings:
- cim:Terminal.ConnectivityNode
owner: Capacitor
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. Defaults to all phases connected to first bus, node
0.
comments:
- N/A for CIM roundtrip. OpenDSS shunt capacitors are single-terminal in CIM (LinearShuntCompensator
has one Terminal; neutral is implicit via grounded=True). Bus2 is meaningful
only for two-terminal series capacitor configurations.
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
owner: Capacitor
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 bus phase specification in bus1 via parse_bus_phases().
Export: derived as len(shunt.ShuntCompensatorPhase).'
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
related_mappings:
- cim:LinearShuntCompensatorPhase
owner: Capacitor
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, if one step, or ARRAY of kvar ratings for each step.
Evenly divided among phases.
comments:
- 'Import: bPerSection = 0.001 × kvar_total / kV² / Numsteps (kvar → siemens).
Export: kvar_total = bPerSection × kV² × 1000 × Numsteps. Same physical concept;
CIM stores susceptance per section in SI (siemens).'
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
close_mappings:
- cim:LinearShuntCompensator.bPerSection
owner: Capacitor
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
- Capacitor
- Reactor
range: float
required: false
multivalued: true
minimum_value: 0.0
kv:
name: kv
annotations:
order:
tag: order
value: 5
description: For 2, 3-phase, kV phase-phase. Otherwise specify actual can rating.
comments:
- 'Unit conversion: kV ↔ V (CIM stores SI base units via cim.Voltage).'
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
exact_mappings:
- cim:LinearShuntCompensator.nomU
owner: Capacitor
domain_of:
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Capacitor
- Reactor
range: float
required: false
minimum_value: 0.0
conn:
name: conn
annotations:
order:
tag: order
value: 6
description: ={wye | delta |LN |LL} Default is wye, which is equivalent to LN.
comments:
- 'Import: wye → PhaseShuntConnectionKind.Y (grounded=True, b0PerSection=bPerSection);
delta → PhaseShuntConnectionKind.D (grounded=False, b0PerSection=0). Export:
PhaseShuntConnectionKind.Y → wye; D → delta.'
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
exact_mappings:
- cim:LinearShuntCompensator.phaseConnection
owner: Capacitor
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Autotrans
- Capacitor
- Reactor
- Transformer
- Xfmrcode
- Sensor
range: ConnectionType
required: false
cmatrix:
name: cmatrix
annotations:
order:
tag: order
value: 7
dss_format:
tag: dss_format
value: matrix
description: Nodal cap. matrix, lower triangle, microfarads. All steps are assumed
the same if this property is used.
comments:
- 'Lossy roundtrip: CIM stores only per-phase susceptance (diagonal elements);
off-diagonal coupling terms are discarded. Diagonal index for phase i: i*(i+1)/2
+ i. Conversion: B = 2π × 60 × C_µF × 1e-6 (siemens).'
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
related_mappings:
- cim:LinearShuntCompensatorPhase.bPerSection
rank: 1000
owner: Capacitor
domain_of:
- Capacitor
- Line
- Linecode
range: float
required: false
multivalued: true
cuf:
name: cuf
annotations:
order:
tag: order
value: 8
description: ARRAY of Capacitance, each phase, for each step, microfarads.
todos:
- 'Exporter: B → µF per-phase path not yet implemented; cuf is not written on
export.'
comments:
- 'Import: flat per-phase µF array converted to per-phase bPerSection. B = 2π
× 60 × C_µF × 1e-6 (siemens).'
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
related_mappings:
- cim:LinearShuntCompensatorPhase.bPerSection
rank: 1000
owner: Capacitor
domain_of:
- Capacitor
range: float
required: false
multivalued: true
R:
name: R
annotations:
order:
tag: order
value: 9
description: ARRAY of series resistance in each phase (line), ohms. Default is
0.0.
todos:
- Requires CIM extension (e.g. cim:LinearShuntCompensator.seriesR) to roundtrip.
comments:
- OpenDSS filter-capacitor feature (series R for harmonic filter tuning); no CIM
equivalent in the standard profile.
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
owner: Capacitor
domain_of:
- Gicline
- Capacitor
- Reactor
- Regcontrol
range: float
required: false
multivalued: true
XL:
name: XL
annotations:
order:
tag: order
value: 10
description: ARRAY of series inductive reactance(s) in each phase (line) for filter,
ohms at base frequency. Default is 0.0.
todos:
- Requires CIM extension (e.g. cim:LinearShuntCompensator.seriesXL) to roundtrip.
comments:
- OpenDSS harmonic filter tuning parameter; no CIM equivalent in the standard
profile.
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
rank: 1000
owner: Capacitor
domain_of:
- Capacitor
range: float
required: false
multivalued: true
Harm:
name: Harm
annotations:
order:
tag: order
value: 11
description: ARRAY of harmonics to which each step is tuned. Zero = no filter.
todos:
- Requires CIM extension (e.g. cim:LinearShuntCompensator.filterHarmonic) to roundtrip.
comments:
- OpenDSS harmonic filter tuning parameter; no CIM equivalent in the standard
profile.
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
rank: 1000
owner: Capacitor
domain_of:
- Capacitor
range: float
required: false
multivalued: true
Numsteps:
name: Numsteps
annotations:
order:
tag: order
value: 12
dss_default:
tag: dss_default
value: int(1)
description: Number of steps in this capacitor bank. Default = 1.
comments:
- 'Import: mapped to both normalSections and maximumSections. Export: read from
maximumSections.'
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
exact_mappings:
- cim:LinearShuntCompensator.maximumSections
rank: 1000
owner: Capacitor
domain_of:
- Capacitor
range: integer
required: false
states:
name: states
annotations:
order:
tag: order
value: 13
description: ARRAY of integers {1|0} states representing the state of each step
(on|off).
comments:
- 'Import: count of on steps (states[i] > 0) stored as sections (float). Export:
sections → [1]*current_sections + [0]*(Numsteps - current_sections).'
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
close_mappings:
- cim:LinearShuntCompensator.sections
rank: 1000
owner: Capacitor
domain_of:
- Capacitor
range: integer
required: false
multivalued: true
normamps:
name: normamps
annotations:
order:
tag: order
value: 14
description: Normal rated current.
todos:
- Converter not yet implemented; requires OperationalLimitSet + CurrentLimit creation.
comments:
- 'Intended target: a normal-rating CurrentLimit on an OperationalLimitSet attached
to this equipment''s terminal.'
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
related_mappings:
- cim:OperationalLimit
owner: Capacitor
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: 15
description: Maximum or emerg current.
todos:
- Converter not yet implemented; requires OperationalLimitSet + CurrentLimit creation.
comments:
- 'Intended target: an emergency-rating CurrentLimit on an OperationalLimitSet
attached to this equipment''s terminal.'
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
related_mappings:
- cim:OperationalLimit
owner: Capacitor
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: 16
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/capacitor
owner: Capacitor
domain_of:
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Linecode
- Fault
range: string
required: false
pctperm:
name: pctperm
annotations:
order:
tag: order
value: 17
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/capacitor
owner: Capacitor
domain_of:
- Autotrans
- Capacitor
- Gictransformer
- Reactor
- Linecode
- Fault
range: float
required: false
repair:
name: repair
annotations:
order:
tag: order
value: 18
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/capacitor
owner: Capacitor
domain_of:
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Linecode
- Fault
range: string
required: false
basefreq:
name: basefreq
annotations:
order:
tag: order
value: 19
description: Base Frequency for ratings.
todos:
- Extract base frequency from circuit-level CIM attributes for non-60Hz systems.
comments:
- Not stored on CIM LinearShuntCompensator; base frequency is a circuit-level
property in CIM. The µF ↔ susceptance conversion uses 60 Hz hardcoded; a non-60-Hz
capacitor would need this from circuit context.
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
owner: Capacitor
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: 20
dss_default:
tag: dss_default
value: 'true'
description: '{Yes|No or True|False} Indicates whether this element is enabled.'
comments:
- 'OpenDSS-only (N/A): if False, converter returns None. All CIM LinearShuntCompensator
objects are assumed enabled.'
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
owner: Capacitor
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: 21
description: 'Make like another object, e.g.: New Capacitor.C2 like=c1 ...'
comments:
- 'OpenDSS-only (N/A): DSS template inheritance resolved at parser time; no CIM
equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pde/capacitor
owner: Capacitor
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:Capacitor