Class: Upfc¶
A Upfc object in OpenDSS.
URI: dss:Upfc
classDiagram
class Upfc
click Upfc href "../Upfc/"
Upfc : basefreq
Upfc : bus1
Upfc : bus2
Upfc : CLimit
Upfc : Element
Upfc : enabled
Upfc : frequency
Upfc : kvarLimit
Upfc : like
Upfc : LossCurve
Upfc : Mode
Upfc : name
Upfc : pf
Upfc : phases
Upfc : refkv
Upfc : refkv2
Upfc : spectrum
Upfc : Tol1
Upfc : VHLimit
Upfc : VLLimit
Upfc : VpqMax
Upfc : Xs
Class Properties¶
| Property | Value |
|---|---|
| Class URI | dss:Upfc |
Slots¶
| Name | Cardinality and Range | Description | Inheritance |
|---|---|---|---|
| name | 1 String |
Object name | direct |
| bus1 | 0..1 Float |
Name of bus to which the input terminal (1) is connected | direct |
| bus2 | 0..1 Float |
Name of bus to which the output terminal (2) is connected | direct |
| refkv | 0..1 Float |
Base Voltage expected at the output of the UPFC"refkv=0 | direct |
| pf | 0..1 Float |
Power factor target at the input terminal | direct |
| frequency | 0..1 String |
UPFC working frequency | direct |
| phases | 0..1 Integer |
Number of phases | direct |
| Xs | 0..1 Float |
Reactance of the series transformer of the UPFC, ohms (default=0 | direct |
| Tol1 | 0..1 Float |
Tolerance in pu for the series PI controllerTol1=0 | direct |
| Mode | 0..1 Integer |
Integer used to define the control mode of the UPFC: 0 = Off, 1 = Voltage reg... | direct |
| VpqMax | 0..1 Float |
Maximum voltage (in volts) delivered by the series voltage source (Default = ... | direct |
| LossCurve | 0..1 Float |
Name of the XYCurve for describing the losses behavior as a function of the v... | direct |
| VHLimit | 0..1 Float |
High limit for the voltage at the input of the UPFC, if the voltage is above ... | direct |
| VLLimit | 0..1 Float |
low limit for the voltage at the input of the UPFC, if voltage is below this ... | direct |
| CLimit | 0..1 Float |
Current Limit for the UPFC, if the current passing through the UPFC is higher... | direct |
| refkv2 | 0..1 Float |
Base Voltage expected at the output of the UPFC for control modes 4 and 5 | direct |
| kvarLimit | 0..1 Float |
Maximum amount of reactive power (kvar) that can be absorved by the UPFC (Def... | direct |
| Element | 0..1 Float |
The name of the PD element monitored when operating with reactive power compe... | direct |
| spectrum | 0..1 String |
Name of harmonic spectrum for this source | 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 |
Identifier and Mapping Information¶
Schema Source¶
- from schema: https://gridappsd.github.io/dss-graph/opendss
Mappings¶
| Mapping Type | Mapped Value |
|---|---|
| self | dss:Upfc |
| native | dss:Upfc |
LinkML Source¶
Direct¶
name: Upfc
description: A Upfc object in OpenDSS.
from_schema: https://gridappsd.github.io/dss-graph/opendss
attributes:
name:
name: name
description: Object name. Must be unique per object type.
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
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 bus to which the input terminal (1) is connected
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Windgen
- Capacitor
- Line
- Reactor
- Fault
- Isource
- Vsource
range: float
required: false
bus2:
name: bus2
annotations:
order:
tag: order
value: 2
description: Name of bus to which the output terminal (2) is connected
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
domain_of:
- Gicline
- Upfc
- Capacitor
- Line
- Reactor
- Fault
- Vsource
range: float
required: false
refkv:
name: refkv
annotations:
order:
tag: order
value: 3
description: Base Voltage expected at the output of the UPFC"refkv=0
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
rank: 1000
domain_of:
- Upfc
range: float
required: false
pf:
name: pf
annotations:
order:
tag: order
value: 4
description: Power factor target at the input terminal
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Upfc
range: float
required: false
frequency:
name: frequency
annotations:
order:
tag: order
value: 5
description: UPFC working frequency
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
domain_of:
- Gicline
- Upfc
- Gicsource
- Isource
- Vsource
range: string
required: false
phases:
name: phases
annotations:
order:
tag: order
value: 6
description: Number of phases
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
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
Xs:
name: Xs
annotations:
order:
tag: order
value: 7
description: Reactance of the series transformer of the UPFC, ohms (default=0
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
rank: 1000
domain_of:
- Upfc
range: float
required: false
Tol1:
name: Tol1
annotations:
order:
tag: order
value: 8
description: Tolerance in pu for the series PI controllerTol1=0
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
rank: 1000
domain_of:
- Upfc
range: float
required: false
Mode:
name: Mode
annotations:
order:
tag: order
value: 9
description: 'Integer used to define the control mode of the UPFC: 0 = Off, 1
= Voltage regulator, 2 = Phase angle regulator, 3 = Dual mode4 = It is a control
mode where the user can set two different set ...'
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
rank: 1000
domain_of:
- Upfc
- Invcontrol
- Loadshape
range: integer
required: false
VpqMax:
name: VpqMax
annotations:
order:
tag: order
value: 10
description: Maximum voltage (in volts) delivered by the series voltage source
(Default = 24 V)
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
rank: 1000
domain_of:
- Upfc
range: float
required: false
LossCurve:
name: LossCurve
annotations:
order:
tag: order
value: 11
description: Name of the XYCurve for describing the losses behavior as a function
of the voltage at the input of the UPFC
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
rank: 1000
domain_of:
- Upfc
range: float
required: false
VHLimit:
name: VHLimit
annotations:
order:
tag: order
value: 12
description: High limit for the voltage at the input of the UPFC, if the voltage
is above this value the UPFC turns off
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
rank: 1000
domain_of:
- Upfc
range: float
required: false
VLLimit:
name: VLLimit
annotations:
order:
tag: order
value: 13
description: low limit for the voltage at the input of the UPFC, if voltage is
below this value the UPFC turns off
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
rank: 1000
domain_of:
- Upfc
range: float
required: false
CLimit:
name: CLimit
annotations:
order:
tag: order
value: 14
description: Current Limit for the UPFC, if the current passing through the UPFC
is higher than this value the UPFC turns off
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
rank: 1000
domain_of:
- Upfc
range: float
required: false
refkv2:
name: refkv2
annotations:
order:
tag: order
value: 15
description: Base Voltage expected at the output of the UPFC for control modes
4 and 5
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
rank: 1000
domain_of:
- Upfc
range: float
required: false
kvarLimit:
name: kvarLimit
annotations:
order:
tag: order
value: 16
description: Maximum amount of reactive power (kvar) that can be absorved by the
UPFC (Default = 5)
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
rank: 1000
domain_of:
- Upfc
range: float
required: false
Element:
name: Element
annotations:
order:
tag: order
value: 17
description: The name of the PD element monitored when operating with reactive
power compensation
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
rank: 1000
domain_of:
- Upfc
- Espvlcontrol
- Gendispatcher
- Storagecontroller
range: float
required: false
spectrum:
name: spectrum
annotations:
order:
tag: order
value: 18
description: Name of harmonic spectrum for this source
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Gicsource
- Isource
- Vsource
range: string
required: false
basefreq:
name: basefreq
annotations:
order:
tag: order
value: 19
description: Base Frequency for ratings
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
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
description: '{Yes|No or True|False} Indicates whether this element is enabled'
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
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
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
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:Upfc
Induced¶
name: Upfc
description: A Upfc object in OpenDSS.
from_schema: https://gridappsd.github.io/dss-graph/opendss
attributes:
name:
name: name
description: Object name. Must be unique per object type.
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
identifier: true
owner: Upfc
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 bus to which the input terminal (1) is connected
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
owner: Upfc
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Windgen
- Capacitor
- Line
- Reactor
- Fault
- Isource
- Vsource
range: float
required: false
bus2:
name: bus2
annotations:
order:
tag: order
value: 2
description: Name of bus to which the output terminal (2) is connected
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
owner: Upfc
domain_of:
- Gicline
- Upfc
- Capacitor
- Line
- Reactor
- Fault
- Vsource
range: float
required: false
refkv:
name: refkv
annotations:
order:
tag: order
value: 3
description: Base Voltage expected at the output of the UPFC"refkv=0
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
rank: 1000
owner: Upfc
domain_of:
- Upfc
range: float
required: false
pf:
name: pf
annotations:
order:
tag: order
value: 4
description: Power factor target at the input terminal
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
owner: Upfc
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Upfc
range: float
required: false
frequency:
name: frequency
annotations:
order:
tag: order
value: 5
description: UPFC working frequency
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
owner: Upfc
domain_of:
- Gicline
- Upfc
- Gicsource
- Isource
- Vsource
range: string
required: false
phases:
name: phases
annotations:
order:
tag: order
value: 6
description: Number of phases
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
owner: Upfc
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
Xs:
name: Xs
annotations:
order:
tag: order
value: 7
description: Reactance of the series transformer of the UPFC, ohms (default=0
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
rank: 1000
owner: Upfc
domain_of:
- Upfc
range: float
required: false
Tol1:
name: Tol1
annotations:
order:
tag: order
value: 8
description: Tolerance in pu for the series PI controllerTol1=0
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
rank: 1000
owner: Upfc
domain_of:
- Upfc
range: float
required: false
Mode:
name: Mode
annotations:
order:
tag: order
value: 9
description: 'Integer used to define the control mode of the UPFC: 0 = Off, 1
= Voltage regulator, 2 = Phase angle regulator, 3 = Dual mode4 = It is a control
mode where the user can set two different set ...'
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
rank: 1000
owner: Upfc
domain_of:
- Upfc
- Invcontrol
- Loadshape
range: integer
required: false
VpqMax:
name: VpqMax
annotations:
order:
tag: order
value: 10
description: Maximum voltage (in volts) delivered by the series voltage source
(Default = 24 V)
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
rank: 1000
owner: Upfc
domain_of:
- Upfc
range: float
required: false
LossCurve:
name: LossCurve
annotations:
order:
tag: order
value: 11
description: Name of the XYCurve for describing the losses behavior as a function
of the voltage at the input of the UPFC
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
rank: 1000
owner: Upfc
domain_of:
- Upfc
range: float
required: false
VHLimit:
name: VHLimit
annotations:
order:
tag: order
value: 12
description: High limit for the voltage at the input of the UPFC, if the voltage
is above this value the UPFC turns off
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
rank: 1000
owner: Upfc
domain_of:
- Upfc
range: float
required: false
VLLimit:
name: VLLimit
annotations:
order:
tag: order
value: 13
description: low limit for the voltage at the input of the UPFC, if voltage is
below this value the UPFC turns off
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
rank: 1000
owner: Upfc
domain_of:
- Upfc
range: float
required: false
CLimit:
name: CLimit
annotations:
order:
tag: order
value: 14
description: Current Limit for the UPFC, if the current passing through the UPFC
is higher than this value the UPFC turns off
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
rank: 1000
owner: Upfc
domain_of:
- Upfc
range: float
required: false
refkv2:
name: refkv2
annotations:
order:
tag: order
value: 15
description: Base Voltage expected at the output of the UPFC for control modes
4 and 5
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
rank: 1000
owner: Upfc
domain_of:
- Upfc
range: float
required: false
kvarLimit:
name: kvarLimit
annotations:
order:
tag: order
value: 16
description: Maximum amount of reactive power (kvar) that can be absorved by the
UPFC (Default = 5)
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
rank: 1000
owner: Upfc
domain_of:
- Upfc
range: float
required: false
Element:
name: Element
annotations:
order:
tag: order
value: 17
description: The name of the PD element monitored when operating with reactive
power compensation
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
rank: 1000
owner: Upfc
domain_of:
- Upfc
- Espvlcontrol
- Gendispatcher
- Storagecontroller
range: float
required: false
spectrum:
name: spectrum
annotations:
order:
tag: order
value: 18
description: Name of harmonic spectrum for this source
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
owner: Upfc
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Gicsource
- Isource
- Vsource
range: string
required: false
basefreq:
name: basefreq
annotations:
order:
tag: order
value: 19
description: Base Frequency for ratings
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
owner: Upfc
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
description: '{Yes|No or True|False} Indicates whether this element is enabled'
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
owner: Upfc
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
from_schema: https://gridappsd.github.io/dss-graph/pce/upfc
owner: Upfc
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:Upfc