Skip to content

OpenDSS Complete Schema

Complete LinkML schema for all OpenDSS component types. This schema imports all individual component schemas from their respective categories.

URI: https://gridappsd.github.io/dss-graph/opendss

Name: opendss

Classes

Class Description
Autotrans A Autotrans object in OpenDSS representing an auto-transformer where the seri...
Capacitor A Capacitor object in OpenDSS representing a shunt or series capacitor bank c...
Capcontrol A Capcontrol object in OpenDSS representing a capacitor bank control that mon...
Cndata A Cndata object in OpenDSS
Dynamicexp A Dynamicexp object in OpenDSS
Energymeter A Energymeter object in OpenDSS
Espvlcontrol A Espvlcontrol object in OpenDSS
Expcontrol A Expcontrol object in OpenDSS
Fault A Fault object in OpenDSS
Fmonitor A Fmonitor object in OpenDSS
Fuse A Fuse object in OpenDSS
Gendispatcher A Gendispatcher object in OpenDSS
Generator A Generator object in OpenDSS representing a power generator connected to a b...
Generic5 A Generic5 object in OpenDSS
Gicline A Gicline object in OpenDSS
Gicsource A Gicsource object in OpenDSS
Gictransformer A Gictransformer object in OpenDSS
Growthshape A Growthshape object in OpenDSS
Indmach012 A Indmach012 object in OpenDSS
Invcontrol A Invcontrol object in OpenDSS
Isource A Isource object in OpenDSS
Line A Line object in OpenDSS representing a power delivery line connecting two bu...
Linecode A Linecode object in OpenDSS defining per-unit-length impedance data shared b...
Linegeometry A Linegeometry object in OpenDSS
Linespacing A Linespacing object in OpenDSS defining the physical arrangement (XY coordin...
Load A Load object in OpenDSS representing an energy consumer connected to a bus i...
Loadshape A Loadshape object in OpenDSS
Monitor A Monitor object in OpenDSS
Priceshape A Priceshape object in OpenDSS
Pvsystem A Pvsystem object in OpenDSS representing a photovoltaic generator with inver...
Pycontrol A Pycontrol object in OpenDSS
Reactor A Reactor object in OpenDSS representing a series or shunt impedance branch
Recloser A Recloser object in OpenDSS
Regcontrol A Regcontrol object in OpenDSS representing a voltage regulator control that ...
Relay A Relay object in OpenDSS
Sensor A Sensor object in OpenDSS
Spectrum A Spectrum object in OpenDSS
Storage A Storage object in OpenDSS representing a battery energy storage system with...
Storagecontroller A Storagecontroller object in OpenDSS
Swtcontrol A Swtcontrol object in OpenDSS
TccCurve A TccCurve object in OpenDSS
Transformer A Transformer object in OpenDSS representing a multi-winding transformer conn...
Tsdata A Tsdata object in OpenDSS
Tshape A Tshape object in OpenDSS
Upfc A Upfc object in OpenDSS
Upfccontrol A Upfccontrol object in OpenDSS
Vccs A Vccs object in OpenDSS
Vsconverter A Vsconverter object in OpenDSS
Vsource A Vsource object in OpenDSS representing an ideal voltage source (slack bus) ...
Windgen A Windgen object in OpenDSS
Wiredata A Wiredata object in OpenDSS defining physical conductor properties (resistan...
Xfmrcode A Xfmrcode object in OpenDSS representing a transformer library entry (catalo...
Xycurve A Xycurve object in OpenDSS

Slots

Slot Description
Action DEPRECATED
action DEPRECATED
ActivePChangeTolerance Required for VOLTWATT
Ag Gearbox ratio (Default 1/90)
allocationfactor Allocation factor for allocating loads based on connected kVA at a bus
AmpLimit Is the current limiter per phase for the IBR when operating in GFM mode
AmpLimitGain Use it for fine tunning the current limiter when active, by default is 0
amps Magnitude of current source, each phase, in Amps
Angle Phase angle in degrees of first phase
angle Array of phase angle values, degrees
APCFlg 1 to enable active power control
ArGraHiV Required for the dynamic reactive current mode (DYNAMICREACCURR), and default...
ArGraLowV Required for the dynamic reactive current mode (DYNAMICREACCURR), and default...
attack_defense Define attack and defense: attack_defense = {atk , dfs , atk_time , atk_node...
AvgNeutralHeight Average height of neutral conductors
AvgPhaseHeight Average height of phase conductors
avgwindowlen Required for VOLTVAR mode and VOLTWATT mode, and defaults to 0 seconds (0s)
B0 Alternate way to specify C0
B1 Alternate way to specify C1
b_Curt_Ctrl b_Curt_Ctrl:set P curtailment on/off;b_Curt_Ctrl=True: P curtailment will be ...
Balanced For Model=7, force balanced current only for 3-phase generators
band Bandwidth in VOLTS for the controlled bus (full bandwidth)
bank Name of the bank this transformer is part of, for CIM, MultiSpeak, and other ...
basefreq Base Frequency for ratings
baseFreq Frequency at which impedances are specified
basekv Base Source kV, usually phase-phase (L-L) unless positive-sequence or single-...
baseMVA Base MVA for converting per-unit impedances
bp1 XYCurve defining the input piece-wise linear block
bp2 XYCurve defining the output piece-wise linear block
Breakertime Fixed delay time (sec) added to relay time
bus Bus connection spec for the active winding (set by wdg property)
bus1 Bus to which the load is connected
Bus1 Name of converter bus, containing both AC and DC conductors
bus2 Name of bus to which 2nd terminal is connected
Bus2 Name of bus to which 2nd terminal is connected
buses Use this to specify all the bus connections at once using an array
BusH Name of High-side(H) bus
BusNH Name of Neutral bus for H, or first, winding
BusNX Name of Neutral bus for X, or Second, winding
BusX Name of Low-side(X) bus, if type=Auto or YY
C Value of line blocking capacitance in microfarads
C0 Zero-sequence capacitance, nf per unit length
C1 Positive-sequence capacitance, nf per unit length
C_array Array of current (or voltage) values corresponding to time values (see help o...
CAIDI (Read only) Makes CAIDI result available via return on query (? energymeter
capacitor Name of Capacitor element which the CapControl controls
Capradius Equivalent conductor radius for capacitance calcs
CC_Switch CC_Switch: default value is false
Cfactor Factor relating average kW to peak kW
ChargeTrigger Dispatch trigger value for charging the Storage
class_class An arbitrary integer number representing the class of PVSystem element
clear { Yes
CLimit Current Limit for the UPFC, if the current passing through the UPFC is higher...
Cluster_num Cluster_num: has to be coincident with Fmonitor attached
cmatrix Nodal cap
cncable Code from CNData
cncables Array of CNData names for use in a cable constants calculation
Cogen {Yes
CombiMode Combination of smart inverter functions in which the InvControl will control ...
Comm_hide Comm_hide={
Comm_node_hide Comm_node_hide={
CommDelayVector CommDelayVector of this FMonitor
CommVector CommVector of this FMonitor
cond Set this = number of the conductor you wish to define
conductors Array of conductor names for use in line constants calculation
conn Connection type
conns Use this to specify all the Winding connections at once using an array
ControlMode Defines the control mode for the inverter
ControlModel Integer defining the method for moving across the control curve
ControlSignal Name of the load shape used for controlling the connection/disconnection of t...
Core {Shell*
Cp Turbine performance coefficient (deafult 0
csvfile Switch input of growth curve data to a csv file containing (year, mult) point...
CSVFile File of spectrum points with (harmonic, magnitude-percent, angle-degrees) val...
CTPhase Number of the phase being monitored for CURRENT control or one of {AVG
CTprim Rating, in Amperes, of the primary CT rating for which the line amps convert ...
CTratio Ratio of the CT from line amps to control ampere setting for current and kvar...
ctrl_mode ctrl mode: /// contrl mode /// ctrl_mode =0; phases = 3; // pos a...
cuf ARRAY of Capacitance, each phase, for each step, microfarads
currents Array of Currents (amps) measured by the current sensor
CustInterrupts (Read only) Makes Total Customer Interrupts value result available via return...
CVRcurve Curve describing both watt and var factors as a function of time
CVRvars Percent reduction in reactive power per 1% reduction in voltage from 100% rat...
CVRwatts Percent reduction in active power per 1% reduction in voltage from 100% rated
D Damping constant
d0 Fixed or initial value of the power angle in degrees
daily LOADSHAPE object name for daily simulations
Daily LOADSHAPE object to use for daily simulations
dblfile Switch input of growth curve data to a binary file of doubles containing (yea...
DbVMax Required for the dynamic reactive current mode (DYNAMICREACCURR), and default...
DbVMin Required for the dynamic reactive current mode (DYNAMICREACCURR), and default...
DeadTime Dead time after capacitor is turned OFF before it can be turned back ON
debugtrace Turn this on to capture the progress of the generator model for each iteratio...
Debugtrace [Yes
DebugTrace {Yes/True*
Delay Time delay, in seconds, from when the control is armed before it sends the sw...
delay Time delay, in seconds, from when the voltage goes out of band to when tap ch...
DelayOFF Time delay, in seconds, for control to turn OFF when present state is ON
delt0 User defined internal simulation step
Deltadirection {1 or -1} Default is 1: 1-2, 2-3, 3-1
deltaP_Factor Required for the VOLTWATT mode
DeltaQ_factor Convergence parameter; Defaults to 0
deltaQ_Factor Required for the VOLTVAR and DYNAMICREACCURR modes
DERList Alternative to PVSystemList for CIM export and import
detailed {Yes/True
DiaCable Diameter over cable; same units as radius; no default
DiaIns Diameter over insulation layer; same units as radius; no default
diam Diameter; Alternative method for entering radius
DiaShield Diameter over tape shield; same units as radius; no default
DiaStrand Diameter of a concentric neutral strand; same units as core conductor radius;...
DischargeTrigger Dispatch trigger value for discharging the Storage
DispFactor Defaults to 1 (disabled)
dispmode Dispatch mode
DispMode {DEFAULT
dispvalue Dispatch value
DistReverse {Yes/True*
DOC_DelayInner Trip time delay (sec) for operation in inner region for DOC relay, defined wh...
DOC_P1Blocking {Yes/True*
DOC_PhaseCurveInner Name of the TCC Curve object that determines the phase trip for operation in ...
DOC_PhaseTripInner Multiplier for the "DOC_PhaseCurveInner" TCC curve
DOC_TDPhaseInner Time dial for "DOC_PhaseCurveInner" TCC curve
DOC_TiltAngleHigh Tilt angle for high-current trip line
DOC_TiltAngleLow Tilt angle for low-current trip line
DOC_TripSettingHigh Resistive trip setting for high-current line
DOC_TripSettingLow Resistive trip setting for low-current line
DOC_TripSettingMag Trip setting for current magnitude (defines a circle in the relay characteris...
Domain It is the domain for which the equation is defined, it can be one of [time*, ...
droop droop type: integer: 2- Q = kcq_drp2 * (1-v_dg)
duty LOADSHAPE object name for duty cycle simulations
Duty LOADSHAPE object to use for duty cycle simulations
DutyStart Starting time offset [hours] into the duty cycle shape
DynaData String that gets passed to the user-written dynamics model Edit function
DynaDLL Name of DLL containing user-written dynamics model for Dynamics-mode simulati...
DynamicEq Name of the dynamic equation (DynamicExp) for defining the dynamic behavior o...
DynOut Name of the variables within the Dynamic equation for governing generator dyn...
DynReacavgwindowlen Required for the dynamic reactive current mode (DYNAMICREACCURR), and default...
EarthModel Earth model to use for impedance calculations
EE Eastward Electric field (V/km)
EffCurve An XYCurve object, previously defined, that describes the PER UNIT efficiency...
EGen EGen = {kVA_fm, M_fm, D_fm, Tau_fm, Ki_fm,init_time}where equations are:(1):d...
Element The name of the PD element monitored when operating with reactive power compe...
element Full object name of the circuit element (typically a line or transformer) to ...
ElementList Array list of Storage elements to be controlled
ElemTableLine ElemTableLine of the each node within this cluster
emergamps Maximum or emerg current
emerghkVA Emergency (contingency) kVA rating of H winding (winding 1+2)
EN Northward Electric field (V/km)
enabled Indicates whether this element is enabled
EpsR Insulation layer relative permittivity; default is 2
EpsRmedium Relative Permittivity of the medium
EqDistPhN Equivalent distance between phase and neutral conductors
EqDistPhPh Equivalent distance between phase conductors
EventLog {Yes/True*
expression It is the differential expression using OpenDSS RPN syntax
faultrate Failure rate per year
filter XYCurve defining the digital filter coefficients (x numerator, y denominator)
flrise Temperature rise, deg C, for full load
forceon Forces generator ON despite requirements of other dispatch modes
Forecast Loadshape object containing daily forecast
frequency Source frequency
fsample Sample frequency [Hz} for the digital filter
FuelkWh Nominal level of fuel for the generator (kWh)
FuseCurve Name of the TCC Curve object that determines the fuse blowing
gen_class An arbitrary integer number representing the class of Generator
GenList Array list of generators to be dispatched
geometry Geometry code for LineGeometry Object
Gmatrix Use this to specify a nodal conductance (G) matrix to represent some arbitrar...
GMRac GMR at 60 Hz
GmrStrand Geometric mean radius of a concentric neutral strand; same units as core cond...
GMRunits Units for GMR: {mi
Groundcurve Name of the TCC Curve object that determines the ground trip
GroundDelayed Name of the TCC Curve object that determines the Ground Delayed trip
GroundFast Name of the TCC Curve object that determines the Ground Fast trip
GroundInst Actual amps for instantaneous ground trip which is assumed to happen in 0
GroundTrip Multiplier or actual ground amps (3I0) for the ground TCC curve
growth Growthshape object name to use for growth factors by years
H Per unit mass constant of the machine
h Height of conductor
Harm ARRAY of harmonics to which each step is tuned
harmonic Array of harmonic values
HeightOffset Average Height (or depth) offset to be applied on top of coordinates of geome...
HeightUnit Height offset Units
hour Array of hour values
hs Per-conductor h (height) coordinates (populated from inline cond= blocks)
hsrise Hot spot temperature rise, deg C
hysteresis_offset Required for VOLTVAR mode, and defaults to 0
Iacmax Maximum value of AC line current, per-unit of nominal
Idcmax Maximum value of DC current, per-unit of nominal
idle {Yes
idleForward {Yes
idleReverse {Yes
imaxpu Maximum output current in per-unit of rated; defaults to 1
InhibitTime Hours (integer) to inhibit Discharging after going into Charge mode
InsLayer Insulation layer thickness; same units as radius; no default
Int_Duration Average annual duration, in hr, of interruptions for head of the meter zone (...
Int_Rate Average number of annual interruptions for head of the meter zone (source sid...
Interpolation {AVG*
interval Time interval for fixed interval data, hrs
inversetime {Yes
irmstau Time constant in producing Irms from the PLL; defaults to 0
irradiance Get/set the present irradiance value in kW/sq-m
Isc1 Alternate method of defining source impedance via single-phase fault current ...
Isc3 Alternate method of defining source impedance via 3-phase fault current (kA)
K Mvar K factor
k Number of concentric neutral strands; default is 2
kcd kcd: Idi control gain
kcq kcq: Iqi control gain to delta V
kcq_drp2 kcq_drp2
Kp It is the proportional gain for the PI controller within the inverter
kqi kqi: Iqi control gain to delta Q
Kron Kron = Y/N
kV Nominal rated (1
kv Nominal rated (1
kVA Specify base Load in kVA (and power factor)
kVac Nominal AC line-neutral voltage in kV
kVAemerg Upper limit on kVA load in the zone, Emergency configuration
kVAnormal Upper limit on kVA load in the zone, Normal configuration
kvar Base kvar for specifying load as kW & kvar
kvarLimit Maximum amount of reactive power (kvar) that can be absorved by the UPFC (Def...
kvarlimit Max kvar to be delivered through the element
kvarMax Maximum reactive power GENERATION (un-signed, kvar) for the inverter
kvarMaxAbs Maximum reactive power ABSORPTION (un-signed, kvar) for the inverter
kvars Array of Reactive power (kvar) measurements at the sensor
kVAs Use this to specify the kVA ratings of all windings at once using an array
kvbase Voltage base (kV) for the relay
kVDC Indicates the rated voltage (kV) at the input of the inverter at the peak of ...
kVdc Nominal DC voltage in kV
KVLL1 Optional
KVLL2 Optional
kVs Use this to specify the kV ratings of all windings at once using an array
kW Total base kW for the load
kWActual (Read only)
kWBand Bandwidth (kW) of the dead band around the target limit
kWBandLow Alternative way of specifying the bandwidth
kwh kWh billed for this period
kWhActual (Read only)
kwhdays Length of kWh billing period in days (24 hr days)
kWhrated Rated Storage capacity in kWh
kWhstored Present amount of energy stored, kWh
kWhTotal (Read only)
kWLimit kW Limit for the monitored element
kWneed (Read only)
kWrated kW rating of power output
kWs Array of Active power (kW) measurements at the sensor
kWTarget kW/kamps target for Discharging
kWTargetLow kW/kamps target for Charging
kWThreshold Threshold, kW, for Follow mode
kWTotal (Read only)
Lamda Tip speed ratio (Default 7
Lat1 Latitude of Bus1 (degrees)
Lat2 Latitude of Bus2 (degrees)
LCurve Name of XYCurve object describing per-unit variation of phase inductance, L=X...
LDC_Z Z value for Beckwith LDC_Z control option
LeadLag {Lead
length Length of line
like Make like another object, e
LimitCurrent Limits current magnitude to Vminpu value for both 1-phase and 3-phase PVSyste...
linecode Name of linecode object describing line impedances
LineLosses {Yes
LineType Code designating the type of line
LmH Inductance, mH
load_class An arbitrary integer number representing the class of load so that load value...
LocalControlList Array list of ESPVLControl local controller objects to be dispatched by Syste...
LocalControlWeights Array of proportional weights corresponding to each ESPVLControl local contro...
LocalOnly {Yes
Lock {Yes
Lon1 Longitude of Bus1 (degrees)
Lon2 Longitude of Bus2 (degrees)
LossCurve Name of the XYCurve for describing the losses behavior as a function of the v...
Losses {Yes
LPFTau Not required
m m Exponent for thermal properties in IEEE C57
m0 Fixed or initial value of the modulation index
Mask Mask for adding registers whenever all meters are totalized
maxkvar Maximum kvar limit for Model = 3
MaxLocalMem MaxLocalMem: the max number of local memory siza
MaxSlip Max slip value to allow
MaxTap Max per unit tap for the active winding
maxtapchange Maximum allowable tap change per control iteration in STATIC control mode
mean Mean of the active power multipliers
MemoryMapping {Yes
Mground Ground reach multiplier in per-unit for Distance and TD21 functions
MinAmps Minimum amps that can sustain a temporary fault
minkvar Minimum kvar limit for Model = 3
MinTap Min per unit tap for the active winding
minterval Specify fixed interval in MINUTES
Mmax Maximum value of modulation index
Mmin Minimum value of modulation index
Mode Integer used to define the control mode of the UPFC: 0 = Off, 1 = Voltage reg...
mode Bitmask integer designating the values the monitor is to capture: 0 = Voltage...
ModeCharge {Loadshape
ModeDischarge {PeakShave*
model Integer code for the model to use for load variation with voltage
Model {Thevenin*
monBus Name of monitored bus used by the voltage-dependente control modes
MonBusesVbase Array list of rated voltages of the buses and their nodes presented in the mo...
MonitoredObj Full object name of the circuit element, typically a line, transformer, load,...
MonitoredTerm Number of the terminal of the circuit element to which the Fuse is connected
MonPhase Number of the phase being monitored or one of {AVG
monVoltageCalc Number of the phase being monitored or one of {AVG
Mphase Phase reach multiplier in per-unit for Distance and TD21 functions
mult Array of growth multiplier values, or a text file spec, corresponding to the ...
MVA MVA rating of electrical machine
MVAsc1 MVA Short Circuit, 1-phase fault
MVAsc3 MVA Short circuit, 3-phase fault
n n Exponent for thermal properties in IEEE C57
N_WTG Number of WTG in aggregation
name Object name
nconds Number of conductors in this geometry
Ndc Number of DC conductors
neg_seq_46_base_amps Base current, Amps, for 46 relay (neg seq current)
neg_seq_46_isqt Negative Sequence I-squared-t trip value for 46 relay (neg seq current)
neutral Designates which conductor is the neutral conductor that will be eliminated b...
Node_num Node_numAssign a node number within a cluster
Nodes Nodes connected to this FMonitor
Normal ARRAY of strings {Open
normamps Normal rated current
normhkVA Normal maximum kVA rating of H winding (winding 1+2)
nphases Number of phases in the line this line code data represents
npts Number of points to expect in subsequent vector
NumCust Number of customers, this load
NumFast Number of Fast (fuse saving) operations
NumHarm Number of frequencies in this spectrum
Numsteps Number of steps in this capacitor bank
NumTaps Total number of taps between min and max tap
nvariables (Int) Number of state variables to be considered in the differential equation
OFFsetting Value at which the control arms to switch the capacitor OFF
ONsetting Value at which the control arms to switch the capacitor ON (or ratchet up a s...
ONtime Time (sec) at which the fault is established for time varying simulations
option Enter a string ARRAY of any combination of the following
overtrip Trip setting (high value) for Generic relay variable
Overvoltcurve TCC Curve object to use for overvoltage relay
P Number of pole pairs of the induction generator (Default 2)
P_TCurve An XYCurve object, previously defined, that describes the PV array PER UNIT P...
P_Mode 0 = real Power controlled by each p_ref on each DG1 = real Power on MeteredEl...
P_ref1kW P_ref1kW = 10, goes to P_ref1, unit kW, 1st phase set power
P_ref2kW P_ref2kW = 10, goes to P_ref2, unit kW, 2nd phase set power
P_ref3kW P_ref3kW = 10, goes to P_ref3, unit kW, 3rd phase set power
P_refkW P_refkW = 10, goes to P_ref
P_Sensor P_SensorEnable power sensor
P_trans_ref P_trans_ref: P ref value for metered element(unit kW)
Pacref Reference total AC real power, Watts
Parallel {Yes
Pbase Base P value for normalization
PbiaskW Pbias = -0
pct_46_pickup Percent pickup current for 46 relay (neg seq current)
pct_47_pickup Percent voltage pickup for 47 relay (Neg seq voltage)
pct_Charge Charging rate (input power) in percentage of rated kW
pct_Cutin % cut-in power -- % of kVA rating of inverter
pct_Cutout % cut-out power -- % of kVA rating of inverter
pct_Discharge Discharge rate (output power) in percentage of rated kW
pct_EffCharge Percentage efficiency for CHARGING the Storage element
pct_EffDischarge Percentage efficiency for DISCHARGING the Storage element
pct_Error Assumed percent error in the measurement
pct_Fuel Current amount of fuel available in percentage of FuelkWh (0-100)
pct_Idlingkvar Deprecated
pct_IdlingkW Percentage of rated kW consumed by idling losses
pct_imag Percent magnetizing current
pct_kWBand Bandwidth (% of Target kW/kamps) of the dead band around the kW/kamps target ...
pct_kWBandLow Bandwidth (% of kWTargetLow) of the dead band around the kW/kamps low target ...
pct_kWrated Upper limit on active power as a percentage of kWrated
pct_loadloss Percent load loss at full load
pct_mag Array of magnitude values, assumed to be in PERCENT
pct_mean Percent mean value for load to use for monte carlo studies if no loadshape is...
pct_noloadloss Percent no load losses at rated excitation voltage
pct_perm Percent of failures that become permanent
pct_PminkvarMax Minimum active power as percentage of Pmpp that allows the inverter to produc...
pct_PminNoVars Minimum active power as percentage of Pmpp under which there is no vars produ...
pct_Pmpp Upper limit on active power as a percentage of Pmpp
pct_R Equivalent percent internal resistance, ohms
pct_R1 Optional
pct_R2 Optional
pct_RateCharge Sets the kW charging rate in % of rated capacity for each element of the flee...
pct_RatekW Sets the kW discharge rate in % of rated capacity for each element of the fle...
pct_Reserve Reserve level in percentage of FuelkWh (0-100)
pct_reserve Percentage of rated kWh Storage capacity to be held in reserve for normal ope...
pct_Rs Use this property to specify all the winding ac %resistances using an array
pct_SeriesRL Percent of load that is series R-L for Harmonic studies
pct_stddev Percent Std deviation value for load to use for monte carlo studies if no loa...
pct_stored Present amount of energy stored, % of rated kWh
pct_X Equivalent percent internal reactance, ohms
pctMinkvar For PF control option, min percent of total bank kvar at which control will c...
pctperm Percent of failures that become permanent
pd Air density in kg/m3 (Default 1
peakcurrent ARRAY of current magnitudes representing the peak currents measured at this l...
pf Load power factor
PF WindGen power factor
Pfctr1 Pfctr1 = 0
Pfctr2 Pfctr2 = 1, 1 by default, see PmppkW
Pfctr3 Pfctr3 = 1, 1 by default, see PmppkW
Pfctr4 Pfctr4= 1, 1 by default, see PmppkW
Pfctr5 Pfctr5 =1, 1 by default, see PmppkW
Pfctr6 Pfctr6 = 1, 1 by default, see PmppkW
PFPriority {Yes/No*/True/False} Set inverter to operate with PF priority when in constan...
Phasecurve Name of the TCC Curve object that determines the phase trip
PhaseDelayed Name of the TCC Curve object that determines the Phase Delayed trip
PhaseFast Name of the TCC Curve object that determines the Phase Fast trip
PhaseInst Actual amps for instantaneous phase trip which is assumed to happen in 0
phases Number of Phases, this load
PhaseTrip Multiplier or actual phase amps for the phase TCC curve
PhaseVoltageReport {Yes
PITol It is the tolerance (%) for the closed loop controller of the inverter
PLoss Name of the XYCurve object describing the active power losses in pct versus t...
Pmax kW value at the time of max power
PmaxkW PmaxkW = 100, goes to Pmax, unit kW, set max active power output; Operation l...
PminkW PminkW = 10, goes to Pmin, unit kW; Operation limit of active power for DG
Pmpp Get/set the rated max power of the PV array for 1
PmppkW PmppkW = 100, goes to Pmpp, unit kW, input Pmpp to calculate kW; kW := (Pmpp...
Pmult Synonym for "mult"
Points One way to enter the points in a curve
ppct Steady-state operating output, in percent of rated
ppm_antifloat ppm (parts per million) anti-float factor
PPolar {Yes/True
PQCSVFile Switch input to a CSV text file containing (active, reactive) power (P, Q) mu...
PQpriority PQpriority, goes to PQpriority, define how to set Qmax
prated Total rated power, in Watts
PreferQ {Yes/True*
price Array of Price values
Pss Steady state output real power
PTPhase Number of the phase being monitored for VOLTAGE control or one of {AVG
PTphase For multi-phase transformers, the number of the phase being monitored or one ...
PTratio Ratio of the PT that converts the monitored voltage to the control voltage
ptratio Ratio of the PT that converts the controlled winding voltage to the regulator...
pu Per unit of the base voltage that the source is actually operating at
puRr Per unit rotor resistance
puRs Per unit stator resistance
puXharm Special reactance, pu (based on kVA, kV properties), for the series impedance...
puXm Per unit magnetizing reactance
puXr Per unit rotor leakage reactance
puXs Per unit stator leakage reactance
puZ0 Zero-sequence impedance in per-unit
puZ1 Positive-sequence impedance in per-unit on source kVA base
puZ2 Negative-sequence impedance in per-unit
puZideal Per-unit series impedance when Model=Ideal
pvfactor Deceleration factor for P-V generator model (Model=3)
PVSystemList Array list of PVSystem objects to be dispatched by a Local Controller
PVSystemWeights Array of proportional weights corresponding to each PVSystem in the PVSystemL...
pyScript This is the path to the controller script, it is expected to be a python scri...
Q_ref1kVAr Q_ref1kVAr=10
Q_ref2kVAr Q_ref2kVAr=10
Q_ref3kVAr Q_ref3kVAr=10
Q_refkVAr Q_refkVAr=10
Qacref Reference total AC reactive power, Vars
Qbase Base Q value for normalization
Qbias Equilibrium per-unit reactive power when V=Vreg; defaults to 0
QFlg 1 to enable reactive power and voltage control
Qmax kvar value at the time of max kW power
QmaxLag Limit on lagging (capacitive) reactive power injection, in per-unit of base k...
QmaxLead Limit on leading (inductive) reactive power injection, in per-unit of base kv...
QMode Q control mode (0:Q, 1:PF, 2:VV)
qmult Array of multiplier values for reactive power (Q)
Qss Steady state output reactive power
QV_flag QV_flag : 0-Q_ref mode; 1- V_ref mode
R Resistance of line, ohms of impedance in series with GIC voltage source
r Resistance, each phase, ohms
r0 Zero-sequence Resistance, ohms per unit length
R0 Zero-sequence resistance, ohms
R1 Resistance, each phase, ohms for H winding, (Series winding, if Auto)
r1 Positive-sequence Resistance, ohms per unit length
R2 Resistance, each phase, ohms for X winding, (Common winding, if Auto)
Rac AC resistance (ohms) for the converter transformer, plus any series reactors
Rad Rotor radius in meters (Default 40)
radius Outside radius of conductor
radunits Units for outside radius: {mi
RatedCurrent Multiplier or actual phase amps for the phase TCC curve
RateofChangeMode Required for VOLTWATT and VOLTVAR mode
Ratings An array of ratings to be used when the seasonal ratings flag is True
RCurve Name of XYCurve object describing per-unit variation of phase resistance, R, ...
Rdc dc Resistance, ohms per unit length (see Runits)
Rdcohms Winding dc resistance in OHMS
RdcOhms Winding dc resistance in OHMS
RecloseIntervals Array of reclose intervals
reduce {Yes
refkv Base Voltage expected at the output of the UPFC"refkv=0
refkv2 Base Voltage expected at the output of the UPFC for control modes 4 and 5
RefReactivePower Required for any mode that has VOLTVAR, DYNAMICREACCURR and WATTVAR
Refuel Boolean value to manually refuel the generator when needed
RelWeight Relative weighting factor for reliability calcs
RemotePTRatio PT ratio required to convert actual voltage at the remote bus to control volt...
repair Hours to repair
Reset {Yes
ResetLevel The level of charge required for allowing the storage to discharge again afte...
residual {Yes/True
rev_Z Reverse Z value for Beckwith LDC_Z control option
revband Bandwidth for operating in the reverse direction
revDelay Time Delay in seconds for executing the reversing action once the threshold f...
reversible {Yes
revNeutral {Yes
revR R line drop compensator setting for reverse direction
revThreshold kW reverse power threshold for reversing the direction of the regulator
revvreg Voltage setting in volts for operation in the reverse direction
revX X line drop compensator setting for reverse direction
Rg Carson earth return resistance per unit length used to compute impedance valu...
rho Earth resitivity used to compute earth correction factor
RiseFallLimit Not required
rmatrix Resistance matrix, lower triangle, ohms per unit length
Rmatrix Resistance matrix, lower triangle, ohms at base frequency
rmsmode True if only Hz is used to represent a phase-locked loop (PLL), ignoring the ...
Rneut Neutral resistance of wye-connected load in actual ohms
Rp Resistance in parallel with R and X (the entire branch)
Rstrand AC resistance of a concentric neutral strand; same units as core conductor re...
Rthev per unit Thevenin equivalent R
Runits Length units for resistance: ohms per {mi
SafeMode (Read only) Indicates whether the inverter entered (Yes) or not (No) into Saf...
SafeVoltage Indicates the voltage level (%) respect to the base voltage level for which t...
SAIDI (Read only) Makes SAIDI result available via return on query (? energymeter
SAIFI (Read only) Makes SAIFI result available via return on query (? energymeter
SAIFIkW (Read only) Makes SAIFIkW result available via return on query (? energymeter
scantype {pos*
ScanType {pos*
Seasons Defines the number of ratings to be defined for the wire, to be used only whe...
SeasonTargets An array of doubles specifying the targets to be used during a QSTS simulatio...
SeasonTargetsLow An array of doubles specifying the targets to be used during a QSTS simulatio...
SemiconLayer {Yes/True
SeqLosses {Yes
sequence {pos*
Sequence {pos*
ShaftData String that gets passed to user-written shaft dynamic model
ShaftModel Name of user-written DLL containing a Shaft model
Shots Total Number of fast and delayed shots to lockout
SimMechFlg 1 to simulate mechanical system
sinterval Specify fixed interval in SECONDS
Slip Initial slip value
SlipOption Option for slip model
Slope Per-unit reactive power injection / per-unit voltage deviation from Vreg; def...
sngfile Switch input of growth curve data to a binary file of singles containing (yea...
spacing Reference to a LineSpacing for use in a line constants calculation
spectrum Name of harmonic current spectrum for this load
State {idling
states ARRAY of integers {1
status Load status
stddev Standard deviation of active power multipliers
StorageList Array list of Storage objects to be dispatched by Local Controller
StorageWeights Array of proportional weights corresponding to each Storage object in the Sto...
sub ={Yes
subname Substation Name
Switch Designates this line as a switch for graphics and algorithmic purposes
SwitchedObj Name of circuit element switch that the Fuse controls
SwitchedTerm Number of the terminal of the controlled element in which the switch is contr...
T_array Array of time values in sec
T_intvl_smpl T_intvl_smpl: The imformation of each agent will be sampled at each T_comm ti...
tap Per unit tap that this winding is on
tapdelay Delay in sec between tap changes
TapeLap Tape Lap in percent; default 20
TapeLayer Tape shield thickness; same units as radius; no default
TapNum An integer number indicating the tap position that the controlled transformer...
taps Use this to specify the per-unit tap positions of all windings at once
tapwinding Winding containing the actual taps, if different than the WINDING property
Tdaily Temperature shape to use for daily simulations
TDGrDelayed Time dial for Ground Delayed trip curve
TDGrFast Time dial for Ground Fast trip curve
TDGround Time dial for Ground trip curve
Tdn Duration, hrs, of downramp part for SCHEDULE mode
TDPhase Time dial for Phase trip curve
TDPhDelayed Time dial for Phase Delayed trip curve
TDPhFast Time dial for Phase Fast trip curve
Tduty Temperature shape to use for duty cycle dispatch simulations
temp Array of temperature values
Temperature Get/set the present Temperature (deg C) for the P-T curve
temporary {Yes
terminal Number of the terminal of the circuit element to which the CapControl is conn...
Terminal Number of the terminal of the circuit element to which the ESPVLControl contr...
TFlat Duration, hrs, of flat part for SCHEDULE mode
thermal Thermal time constant of the AutoTrans in hours
three_phase_losses {Yes
TimeChargeTrig Time of day in fractional hours (0230 = 2
TimeChargeTrigger Default time of day (hr) for initiating charging in Time control mode
TimeDischargeTrigger Default time of day (hr) for initiating Discharging of the fleet
Tol1 Tolerance in pu for the series PI controllerTol1=0
Total_Clusters Total_Clusters
transformer Name of Transformer or AutoTrans element to which the RegControl is connected
Tresponse Open-loop response time for changes in Q
tscable Code from TSData
tscables Array of TSData names for use in a cable constants calculation
Tup Duration, hrs, of upramp part for SCHEDULE mode
Tyearly Temperature shape to use for yearly simulations
Type Type of transformer: {GSU*
type {Current
undertrip Trip setting (low value) for Generic relay variable
Undervoltcurve TCC Curve object to use for undervoltage relay
units Length Units
up_dly up_dly: delay time to upper level
UPFCList The list of all the UPFC devices to be controlled by this controller, If left...
UseActual {Yes
UseFuel Activates the use of fuel for the operation of the generator
UserData String that gets passed to user-written model
UserModel Name of DLL containing user-written model for Dynamics studies
V_ref1kVLN V_ref1kVLN = 2
V_ref2kVLN V_ref2kVLN = 2
V_ref3kVLN V_ref3kVLN = 2
V_refkVLN V_refkVLN = 2
V_Sensor V_SensorEnable voltage sensor
Vacref Reference AC line-to-neutral voltage, RMS Volts
var (String) Activates the state variable using the given name
VarChangeTolerance Required for VOLTVAR and DYNAMICREACCURR modes
VarCurve Optional
VarFollowInverter Boolean variable (Yes
Variable Name of variable in PC Elements being monitored
varidx (Int) read-only, returns the index of the active state variable
varnames ([String]) Array of strings with the names of the state variables
VbaseLosses {Yes
VBus Name of bus to use for voltage override function
VCutIn Cut-in speed for the wind generator (m/s - default 5)
VCutOut Cut-out speed for the wind generator (m/s - default 23)
Vdcref Reference DC voltage, Volts
VHLimit High limit for the voltage at the input of the UPFC, if the voltage is above ...
VIPolar {Yes/True
virtual_ld_node which node talks to upper level
vlimit Voltage Limit for bus to which regulated winding is connected
VLLimit low limit for the voltage at the input of the UPFC, if voltage is below this ...
Vlowpu Per unit voltage at which the model switches to constant Z model (model=2)
Vmax Maximum voltage, in volts, above which control is forced ON regardless of con...
Vmaxpu Maximum per unit voltage for which the MODEL is assumed to apply
Vmin Minimum voltage, in volts, below which control is forced OFF regardless of co...
Vminemerg Minimum per unit voltage for load UE evaluations, Emergency limit
Vminnorm Minimum per unit voltage for load EEN evaluations, Normal limit
Vminpu Minimum per unit voltage for which the MODEL is assumed to apply
Volt_limits_pu Volt_limits_pu: exmaple "Volt_limits_pu={a0,a1, a2}"a0: the phase number, 0 m...
Volt_Trhd Volt_Trhd
voltage_curvex_ref Required for VOLTVAR and VOLTWATT modes, and defaults to rated
VoltageChangeTolerance Defaults to 0
VoltOverride {Yes
Volts Voltage magnitude, in volts, of the GIC voltage induced across this line
voltwatt_curve Required for VOLTWATT mode
voltwattCH_curve Required for VOLTWATT mode for Storage element in CHARGING state
VoltwattYAxis Required for VOLTWATT mode
VpqMax Maximum voltage (in volts) delivered by the series voltage source (Default = ...
Vpu Per Unit voltage set point for Model = 3
vrated Rated line-to-line voltage, in Volts
Vreg Per-unit voltage at which reactive power is zero; defaults to 1
vreg Voltage regulator setting, in VOLTS, for the winding being controlled
VregMax Upper limit on adaptive Vreg; defaults to 1
VregMin Lower limit on adaptive Vreg; defaults to 0
VregTau Time constant for adaptive Vreg
vrmstau Time constant in sensing Vrms for the PLL; defaults to 0
VscMode Control Mode (Fixed
Vsetpoint Required for Active Voltage Regulation (AVR)
Vss Steady state voltage magnitude
VV_Curve Name of the XY curve defining the control curve for implementing Vol-var cont...
VV_RefReactivePower Deprecated, use RefReactivePower instead
vvc_curve1 Required for VOLTVAR mode
vwind Wind speed in m/s
wattpf_curve Required for WATTPF mode
WattPriority {Yes/No*/True/False} Set inverter to watt priority instead of the default var...
wattvar_curve Required for WATTVAR mode
wdg Set this = to the number of the winding you wish to define
WdgCurrents (Read only) Makes winding currents available via return on query
Weight Weighting factor: Default is 1
Weights Array of proportional weights corresponding to each Storage element in the El...
winding Number of the winding of the transformer element that the RegControl is monit...
windings Number of windings, this AutoTrans
wire Code from WireData
wires Array of WireData names for use in an overhead line constants calculation
X Reactance at base frequency, ohms
x x coordinate
x0 Zero-sequence Reactance, ohms per unit length
X0 Zero-sequence reactance, ohms
x0r0 Zero-sequence X/R ratio
x1 Positive-sequence Reactance, ohms per unit length
X1 Positive-sequence reactance, ohms
X12 Alternative to XHL for specifying the percent reactance from winding 1 to win...
X13 Alternative to XHT for specifying the percent reactance from winding 1 to win...
x1r1 Positive-sequence X/R ratio
X23 Alternative to XLT for specifying the percent reactance from winding 2 to win...
Xac AC reactance (ohms) for the converter transformer, plus any series reactors
Xarray Alternate way to enter X values
Xd Per unit synchronous reactance of machine
Xdp Per unit transient reactance of the machine
Xdpp Per unit subtransient reactance of the machine
xfkVA Rated kVA of service transformer for allocating loads based on connected kVA ...
XfmrCode Name of a library entry for transformer properties
XfmrLosses {Yes
Xg Carson earth return reactance per unit length used to compute impedance value...
XHL Percent reactance, H-L (winding 1 to winding 2)
Xhl Use this to specify the percent reactance, H-L (winding 1 to winding 2)
XHT Use this to specify the percent reactance, H-T (winding 1 to winding 3)
Xht Use this to specify the percent reactance, H-T (winding 1 to winding 3)
XHX Use this to specify the percent reactance, H-L (winding 1 to winding 2)
XL ARRAY of series inductive reactance(s) in each phase (line) for filter, ohms ...
XLT Percent reactance, L-T (winding 2 to winding 3)
Xlt Use this to specify the percent reactance, L-T (winding 2 to winding 3)
xmatrix Reactance matrix, lower triangle, ohms per unit length
Xmatrix Reactance matrix, lower triangle, ohms at base frequency
Xneut Neutral reactance of wye-connected load in actual ohms
XRConst ={Yes
XRdp X/R ratio for Xdp property for FaultStudy and Dynamic modes
XRharm X/R ratio of the special harmonics mode reactance specified by the puXHARM pr...
Xs Reactance of the series transformer of the UPFC, ohms (default=0
xs Per-conductor x coordinates (populated from inline cond= blocks)
Xscale Scale X property values (in/out) by this factor
XSCarray Use this to specify the percent reactance between all pairs of windings as an...
Xscarray Percent reactance between all pairs of windings as an array
Xshift Shift X property values (in/out) by this amount of offset
Xthev per unit Thevenin equivalent X
XXT Use this to specify the percent reactance, L-T (winding 2 to winding 3)
y Enter a value and then retrieve the interpolated X value from the X property
Yarray Alternate way to enter Y values
year Array of year values, or a text file spec, corresponding to the multipliers
yearly LOADSHAPE object name for yearly simulations
Yearly LOADSHAPE object to use for yearly simulations
Yscale Scale Y property values (in/out) by this factor
Yshift Shift Y property values (in/out) by this amount of offset
Z Alternative way of defining R and X properties as a complex array
Z0 Zero-sequence impedance, ohms, as a 2-element array [R, X]
Z0ang Zero sequence reach impedance angle in degrees for Distance and TD21 function...
Z0mag Zero sequence reach impedance in primary ohms for Distance and TD21 functions
Z1 Positive-sequence impedance, ohms, as a 2-element array [R, X]
Z1ang Positive sequence reach impedance angle in degrees for Distance and TD21 func...
Z1mag Positive sequence reach impedance in primary ohms for Distance and TD21 funct...
Z2 Negative-sequence impedance, ohms, as a 2-element array [R, X]
ZIPV Array of 7 coefficients for ZIP load model
Zonelist ARRAY of full element names for this meter's zone

Enumerations

Enumeration Description
ConnectionType Electrical connection topology
CoreType Transformer core type for GIC analysis
DispatchMode Generator dispatch mode
EarthModelType Earth model for impedance calculations
GeneratorModel Integer code for generation variation model with voltage
GenStatus Generator dispatch status
LeadLagType Phase shift designation for Delta-Wye connections
LengthUnit Units of length measurement
LineTypeCode Code designating the type of line
LoadModel Integer code for load variation model with voltage
LoadStatus Load participation in multiplier adjustments
SwitchState Discrete state of switchable capacitor step

Types

Type Description
Boolean A binary (true or false) value
Curie a compact URI
Date a date (year, month and day) in an idealized calendar
DateOrDatetime Either a date or a datetime
Datetime The combination of a date and time
Decimal A real number with arbitrary precision that conforms to the xsd:decimal speci...
Double A real number that conforms to the xsd:double specification
Float A real number that conforms to the xsd:float specification
Integer An integer
Jsonpath A string encoding a JSON Path
Jsonpointer A string encoding a JSON Pointer
Ncname Prefix part of CURIE
Nodeidentifier A URI, CURIE or BNODE that represents a node in a model
Objectidentifier A URI or CURIE that represents an object in the model
Sparqlpath A string encoding a SPARQL Property Path
String A character string
Time A time object represents a (local) time of day, independent of any particular...
Uri a complete URI
Uriorcurie a URI or a CURIE

Subsets

Subset Description