API

PowerFlowData.parse_network — Function

parse_network(source) -> Network

Read a PSS/E-format .raw Power Flow Data file and return a Network object.

The version of the PSS/E format can be specified with the v keyword, like v=33, or else it will be automatically detected when parsing the file.

The delimiter can be specified with the delim keyword, like delim=' ', or else it will be automatically detected when parsing the file.

source

Network

PowerFlowData.Network — Type

struct Network

Representation of a power network.

The PSS/E data format comprises 16 data categories of network and equipment elements, each of which requires a particular type of data.

Similarly, a Network stores the data from each category in its own dedicated structure.

Currently supported are:

CaseID data is a single row (in the Tables.jl-sense). You can access it like network.caseid and interact with it like a NamedTuple, or even convert it to a NamedTuple with NamedTuple(caseid).

All other records (buses, loads, etc.) can be accessed also via the fields, for example network.buses, and each is returned as lightweight table structure (again, in the Tables.jl-sense). That is, all structures implement the Tables.jl interface, so can be passed to any valid sink, such as a DataFrame like DataFrame(network.buses).

For more info on working with tables see Tables.jl, and for common table operations see TableOperations.jl.

Fields

version::Int8
Version of the PSS/E data version given or detected when parsing.
caseid::CaseID
Case identification data.
buses::Buses
Bus records.
loads::Loads
Load records.
fixed_shunts::Union{Nothing, FixedShunts}
Fixed Bus Shunt records.
generators::Generators
Generator records.
branches::Branches
Non-transformer Branch records.
transformers::Transformers
Transformer records.
area_interchanges::AreaInterchanges
Area Interchange records.
two_terminal_dc::TwoTerminalDCLines
Two-terminal DC Line records.
vsc_dc::VSCDCLines
Voltage Source Converter DC Line records.
switched_shunts::SwitchedShunts
Switched Shunt records.
impedance_corrections::ImpedanceCorrections
Transformer impedance correction records.
multi_terminal_dc::MultiTerminalDCLines
Multi-terminal DC Line records.
multi_section_lines::MultiSectionLineGroups
Multi-section line group records.
zones::Zones
Zone records.
area_transfers::InterAreaTransfers
Inter-area transfer records.
owners::Owners
Owner records.
facts::FACTSDevices
FACTS device records.

source

Case ID

PowerFlowData.CaseID — Type

struct CaseID <: PowerFlowData.IDRow

Case identification data.

Fields

ic::Int8
IC Change code: 0 - base case (i.e., clear the working case before adding data to it). 1 - add data to the working case.

sbase::Float64
System base MVA.
rev::Union{Missing, Int64}
PSSE revision number (if known).
xfrrat::Union{Missing, Int8}
Units of transformer ratings (see Transformers). xfrrat ≤ 0 for MVA. xfrrat > 0 for current expressed as MVA.

nxfrat::Union{Missing, Int8}
Units of ratings of non-transformer branches (refer to Non-Transformer Branch Data). nxfrat ≤ 0 for MVA. nxfrat > 0 for current expressed as MVA.

basfrq::Union{Missing, Float64}
System base frequency in Hertz.

source

Buses

PowerFlowData.Buses — Type

abstract type Buses <: PowerFlowData.Records

Each network bus to be represented in PSSE is introduced by a bus data record. The bus data record depends on the PSSE version:

See Buses30 for PSSE v30 files.
See Buses33 for PSSE v33 files.

source

PowerFlowData.Buses30 — Type

struct Buses30 <: Buses

Network bus data records (in PSSE v30 format).

Each bus data record includes not only data for the basic bus properties but also includes information on an optionally connected shunt admittance to ground. That admittance can represent a shunt capacitor or a shunt reactor (both with or without a real component) or a shunt resistor. It must not represent line connected admittance, loads, line charging or transformer magnetizing impedance, all of which are entered in other data categories.

Fields

i::Vector{Int32}
Bus number (1 to 999997).
name::Vector{InlineStrings.String15}
Alphanumeric identifier assigned to bus "I". The name may be up to twelve characters and must be enclosed in single quotes. NAME may contain any combination of blanks, uppercase letters, numbers and special characters, but the first character must not be a minus sign.

basekv::Vector{Float64}
Bus base voltage; entered in kV.
ide::Vector{Int8}
Bus type code: 1 - load bus or other bus without any generator boundary condition. 2 - generator or plant bus either regulating voltage or with a fixed reactive power (Mvar). A generator that reaches its reactive power limit will no longer control voltage but rather hold reactive power at its limit. 3 - swing bus or slack bus. It has no power or reactive limits and regulates voltage at a fixed reference angle. 4 - disconnected or isolated bus.

gl::Vector{Float64}
Active component of shunt admittance to ground; entered in MW at one per unit voltage. GL should not include any resistive admittance load, which is entered as part of load data.

bl::Vector{Float64}
Reactive component of shunt admittance to ground; entered in Mvar at one per unit voltage. BL should not include any reactive impedance load, which is entered as part of load data; line charging and line connected shunts, which are entered as part of non-transformer branch data; or transformer magnetizing admittance, which is entered as part of transformer data. BL is positive for a capacitor, and negative for a reactor or an inductive load.

area::Vector{Int16}
Area number. 1 through the maximum number of areas at the current size level.
zone::Vector{Int16}
Zone number. 1 through the maximum number of zones at the current size level. See Zones.

vm::Vector{Float64}
Bus voltage magnitude; entered in pu.
va::Vector{Float64}
Bus voltage phase angle; entered in degrees.
owner::Vector{Int16}
Owner number. 1 through the maximum number of owners at the current size level. See Owners.

source

PowerFlowData.Buses33 — Type

struct Buses33 <: Buses

Network bus data records (in PSSE v33 format).

Fields

i::Vector{Int32}
Bus number (1 to 999997).
name::Vector{InlineStrings.String15}
Alphanumeric identifier assigned to bus "I". The name may be up to twelve characters and must be enclosed in single quotes. NAME may contain any combination of blanks, uppercase letters, numbers and special characters, but the first character must not be a minus sign.

basekv::Vector{Float64}
Bus base voltage; entered in kV.
ide::Vector{Int8}
Bus type code: 1 - load bus or other bus without any generator boundary condition. 2 - generator or plant bus either regulating voltage or with a fixed reactive power (Mvar). A generator that reaches its reactive power limit will no longer control voltage but rather hold reactive power at its limit. 3 - swing bus or slack bus. It has no power or reactive limits and regulates voltage at a fixed reference angle. 4 - disconnected or isolated bus.

area::Vector{Int16}
Area number. 1 through the maximum number of areas at the current size level.
zone::Vector{Int16}
Zone number. 1 through the maximum number of zones at the current size level. See Zones.

owner::Vector{Int16}
Owner number. 1 through the maximum number of owners at the current size level. See Owners.

vm::Vector{Float64}
Bus voltage magnitude; entered in pu.
va::Vector{Float64}
Bus voltage phase angle; entered in degrees.
nvhi::Vector{Float64}
Normal voltage magnitude high limit; entered in pu. nvhi = 1.1 by default.
nvlo::Vector{Float64}
Normal voltage magnitude low limit, entered in pu. nvlo = 0.9 by default.
evhi::Vector{Float64}
Emergency voltage magnitude high limit; entered in pu. evhi = 1.1 by default.
evlo::Vector{Float64}
Emergency voltage magnitude low limit; entered in pu. evlo = 0.9 by default.

source

Loads

PowerFlowData.Loads — Type

struct Loads <: PowerFlowData.Records

Each network bus at which a load is to be represented must be specified in at least one load data record. If multiple loads are to be represented at a bus, they must be individually identified in a load data record for the bus with a different load identifier. Each load at a bus can be a mixture of loads with different characteristics.

Fields

i::Vector{Int32}
Buses number, or extended buses name enclosed in single quotes.
id::Vector{InlineStrings.String3}
One- or two-character uppercase non blank alphanumeric load identifier used to distinguish among multiple loads at bus "I". It is recommended that, at buses for which a single load is present, the load be designated as having the load identifier '1'.

status::Vector{Bool}
Initial load status of one for in-service and zero for out-of-service.
area::Vector{Int16}
Area to which the load is assigned (1 through the maximum number of areas at the current size level).
zone::Vector{Int16}
Zone to which the load is assigned (1 through the maximum number of zones at the current size level). See Zones.

pl::Vector{Float64}
Active power component of constant MVA load; entered in MW.
ql::Vector{Float64}
Reactive power component of constant MVA load; entered in Mvar.
ip::Vector{Float64}
Active power component of constant current load; entered in MW at one per unit voltage.
iq::Vector{Float64}
Reactive power component of constant current load; entered in Mvar at one per unit voltage.
yp::Vector{Float64}
Active power component of constant admittance load; entered in MW at one per unit voltage.
yq::Vector{Float64}
Reactive power component of constant admittance load; entered in Mvar at one per unit voltage. YQ is a negative quantity for an inductive load and positive for a capacitive load.

owner::Vector{Int16}
Owner to which the load is assigned. 1 through the maximum number of owners at the current size level. See Owners.

scale::Vector{Union{Missing, Bool}}
Load scaling flag of one for a scalable load and zero for a fixed load. scale = 1 by default.

intrpt::Vector{Union{Missing, Bool}}
Interruptible load flag of one for an interruptible load for zero for a non interruptible load. intrpt=0 by default.

source

Fixed Shunts

PowerFlowData.FixedShunts — Type

struct FixedShunts <: PowerFlowData.Records

Each network bus at which fixed bus shunt is to be represented must be specified in at least one fixed bus shunt data record. Multiple fixed bus shunts may be represented at a bus by specifying more than one fixed bus shunt data record for the bus, each with a different shunt identifier.

The admittance specified in the data record can represent a shunt capacitor or a shunt reactor (both with or without a real component) or a shunt resistor. It must not represent line connected admittance, switched shunts, loads, line charging or transformer magnetizing impedance, all of which are entered in other data categories.

Not present in v30 files

v30 files do not have FixedShunts; refer to Buses and SwitchedShunts.

source

Generators

PowerFlowData.Generators — Type

struct Generators <: PowerFlowData.Records

Each network bus to be represented as a generator or plant bus in PSS/E must be specified in a generator data record. In particular, each bus specified in the bus data input with a type code of two (2) or three (3) must have a generator data record entered for it.

Fields

i::Vector{Int32}
Bus number, or extended bus name enclosed in single quotes.
id::Vector{InlineStrings.String3}
One- or two-character uppercase non blank alphanumeric machine identifier used to distinguish among multiple machines at bus "I". It is recommended that, at buses for which a single machine is present, the machine be designated as having the machine identifier ’1’. ID = ’1’ by default.

pg::Vector{Float64}
Generator active power output; entered in MW. PG = 0.0 by default.
qg::Vector{Float64}
Generator reactive power output; entered in Mvar. QG needs to be entered only if the case, as read in, is to be treated as a solved case. QG = 0.0 by default.

qt::Vector{Float64}
Maximum generator reactive power output; entered in Mvar. For fixed output gen- erators (i.e., nonregulating), QT must be equal to the fixed Mvar output. QT = 9999.0 by default.

qb::Vector{Float64}
Minimum generator reactive power output; entered in Mvar. For fixed output generators, QB must be equal to the fixed Mvar output. QB = -9999.0 by default.

vs::Vector{Float64}
Regulated voltage setpoint; entered in pu. VS = 1.0 by default.
ireg::Vector{Int32}
Bus number, or extended bus name enclosed in single quotes, of a remote type 1 or 2 bus whose voltage is to be regulated by this plant to the value specified by VS. If bus IREG is other than a type 1 or 2 bus, bus "I" regulates its own voltage to the value specified by VS. IREG is entered as zero if the plant is to regulate its own voltage and must be zero for a type three (swing) bus. IREG = 0 by default.

mbase::Vector{Float64}
Total MVA base of the units represented by this machine; entered in MVA. This quantity is not needed in normal power flow and equivalent onstruction work, but is required for switching studies, fault analysis, and dynamic simulation. MBASE = system base MVA by default.

zr::Vector{Float64}
Complex machine impedance, ZSORCE; entered in pu on MBASE base. This data is not needed in normal power flow and equivalent construction work, but is required for switching studies, fault analysis, and dynamic simulation. For dynamic simulation, this impedance must be set equal to the unsaturated subtransient impedance for those generators to be modeled by subtransient level machine models, and to unsaturated transient impedance for those to be modeled by classical or transient level models. For short-circuit studies, the saturated subtransient or transient impedance should be used. ZR = 0.0 by default.

zx::Vector{Float64}
See zr. ZX = 1.0 by default.
rt::Vector{Float64}
Step-up transformer impedance, XTRAN; entered in pu on MBASE base. XTRAN should be entered as zero if the step-up transformer is explicitly modeled as a network branch and bus "I" is the terminal bus. RT+jXT = 0.0 by default.

xt::Vector{Float64}
See rt. RT+jXT = 0.0 by default.
gtap::Vector{Float64}
Step-up transformer off-nominal turns ratio; entered in pu. GTAP is used only if XTRAN is nonzero. GTAP = 1.0 by default.

stat::Vector{Bool}
Initial machine status of one for in-service and zero for out-of-service. STAT = 1 by default.

rmpct::Vector{Float64}
Percent of the total Mvar required to hold the voltage at the bus controlled by this bus "I" that are to be contributed by the generation at bus "I"; RMPCT must be positive. RMPCT is needed if IREG specifies a valid remote bus and there is more than one local or remote voltage controlling device (plant, switched shunt, FACTS device shunt element, or VSC DC line converter) controlling the voltage at bus IREG to a setpoint. RMPCT is needed also if bus "I" itself is being controlled locally or remotely by one or more other setpoint mode voltage controlling devices. RMPCT = 100.0 by default.

pt::Vector{Float64}
Maximum generator active power output; entered in MW. PT = 9999.0 by default.
pb::Vector{Float64}
Minimum generator active power output; entered in MW. PB = -9999.0 by default.
o1::Vector{Int16}
Owner number (1 through the maximum number of owners at the current size level). Each machine may have up to four owners. See Owners. By default, o1 is the owner to which bus i is assigned and o2, o3, and o4 are zero.

f1::Vector{Union{Missing, Float64}}
Fraction of total ownership assigned to owner oi; each fi must be positive. The fi values are normalized such that they sum to 1.0 before they are placed in the working case. By default, each fi is 1.0.

o2::Vector{Union{Missing, Int16}}
f2::Vector{Union{Missing, Float64}}
o3::Vector{Union{Missing, Int16}}
f3::Vector{Union{Missing, Float64}}
o4::Vector{Union{Missing, Int16}}
f4::Vector{Union{Missing, Float64}}
wmod::Vector{Union{Missing, Int8}}
Wind machine control mode; wmod is used to indicate whether a machine is a wind machine, and, if it is, the type of reactive power limits to be imposed.
- 0 for a machine that is not a wind machine.
- 1 for a wind machine for which reactive power limits are specified by QT and QB.
- 2 for a wind machine for which reactive power limits are determined from the machine’s active power output and wpf; limits are of equal magnitude and opposite sign.
- 3 for a wind machine with a fixed reactive power setting determined from the machine’s active power output and wpf; when wpf is positive, the machine’s reactive power has the same sign as its active power; when wpf is negative, the machine’s reactive power has the opposite sign of its active power.
wmod = 0 by default.

wpf::Vector{Union{Missing, Float64}}
Power factor used in calculating reactive power limits or output when wmod is 2 or 3. wpf = 1.0 by default.

source

Branches

PowerFlowData.Branches — Type

abstract type Branches <: PowerFlowData.Records

The branches data record depends on the PSSE version:

See Branches30 for PSSE v30 files.
See Branches33 for PSSE v33 files.

source

PowerFlowData.Branches30 — Type

struct Branches30 <: Branches

In PSS/E, the basic transmission line model is an Equivalent Pi connected between network buses.

Data for shunt equipment units, such as reactors, which are connected to and switched with the line, are entered in the same data record.

Shunts connected to buses

In PSSE v30, to represent shunts connected to buses, that shunt data should be entered in the Buses data records.

Transformers

Branches to be modeled as transformers are not specified in this data category; rather, they are specified in the Transformers data category.

Fields

i::Vector{Int32}
Branch "from bus" number, or extended bus name enclosed in single quotes.
j::Vector{Int32}
Branch "to bus" number, or extended bus name enclosed in single quotes. "J" is entered as a negative number, or with a minus sign before the first character of the extended bus name, to designate it as the metered end; otherwise, bus "I" is assumed to be the metered end.

ckt::Vector{InlineStrings.String3}
One- or two-character uppercase nonblank alphanumeric branch circuit identifier; the first character of CKT must not be an ampersand "&". It is recommended that single circuit branches be designated as having the circuit identifier '1'. CKT = '1' by default.

r::Vector{Float64}
Branch resistance; entered in pu. A value of R must be entered for each branch.
x::Vector{Float64}
Branch reactance; entered in pu. A nonzero value of X must be entered for each branch.
b::Vector{Float64}
Total branch charging susceptance; entered in pu. B = 0.0 by default.
rate_a::Vector{Float64}
First loading rating; entered in MVA. If RATEA is set to 0.0, the default value, this branch will not be included in any examination of circuit loading.
Ratings are entered as: $MVA_{rated} = sqrt(3) × E_{base} × I_{rated} × 10^{-6}$ where:
- $E_{base}$ is the base line-to-line voltage in volts of the buses to which the terminal of the branch is connected.
- $I_{rated}$ is the branch rated phase current in amperes.

rate_b::Vector{Float64}
Second loading rating; entered in MVA. RATEB = 0.0 by default.
rate_c::Vector{Float64}
Third loading rating; entered in MVA. RATEC = 0.0 by default.
gi::Vector{Float64}
Complex admittance of the line shunt at the bus "I" end of the branch; entered in pu. BI is negative for a line connected reactor and positive for line connected capacitor. GI + jBI = 0.0 by default.

bi::Vector{Float64}
Complex admittance of the line shunt at the bus "I" end of the branch; entered in pu. BI is negative for a line connected reactor and positive for line connected capacitor. GI + jBI = 0.0 by default.

gj::Vector{Float64}
Complex admittance of the line shunt at the bus "J" end of the branch; entered in pu. BJ is negative for a line connected reactor and positive for line connected capacitor. GJ + jBJ = 0.0 by default.

bj::Vector{Float64}
Complex admittance of the line shunt at the bus "J" end of the branch; entered in pu. BJ is negative for a line connected reactor and positive for line connected capacitor. GJ + jBJ = 0.0 by default.

st::Vector{Bool}
Initial branch status where 1 designates in-service and 0 designates out-of-service. ST = 1 by default.

len::Vector{Float64}
Line length; entered in user-selected units. LEN = 0.0 by default.
o1::Vector{Int16}
Owner number; 1 through the maximum number of owners at the current size level. Each branch may have up to four owners. See Owners. By default, o1 is the owner to which bus i is assigned and o2, o3, and o4 are zero.

f1::Vector{Float64}
Fraction of total ownership assigned to owner $O_i$; each $F_i$ must be positive. The `fi values are normalized such that they sum to 1.0 before they are placed in the working case. By default, each fi is 1.0.

o2::Vector{Union{Missing, Int16}}
f2::Vector{Union{Missing, Float64}}
o3::Vector{Union{Missing, Int16}}
f3::Vector{Union{Missing, Float64}}
o4::Vector{Union{Missing, Int16}}
f4::Vector{Union{Missing, Float64}}

source

PowerFlowData.Branches33 — Type

struct Branches33 <: Branches

In PSS/E, the basic transmission line model is an Equivalent Pi connected between network buses.

Data for shunt equipment units, such as reactors, which are connected to and switched with the line, are entered in the same data record.

Shunts connected to buses

In PSSE v33, to represent shunts connected to buses, that shunt data should be entered in FixedShunts and/or SwitchedShunts data records.

Transformers

Branches to be modeled as transformers are not specified in this data category; rather, they are specified in the Transformers data category.

Fields

i::Vector{Int32}
Branch "from bus" number, or extended bus name enclosed in single quotes.
j::Vector{Int32}
Branch "to bus" number, or extended bus name enclosed in single quotes. "J" is entered as a negative number, or with a minus sign before the first character of the extended bus name, to designate it as the metered end; otherwise, bus "I" is assumed to be the metered end.

ckt::Vector{InlineStrings.String3}
One- or two-character uppercase nonblank alphanumeric branch circuit identifier; the first character of CKT must not be an ampersand "&". It is recommended that single circuit branches be designated as having the circuit identifier '1'. CKT = '1' by default.

r::Vector{Float64}
Branch resistance; entered in pu. A value of R must be entered for each branch.
x::Vector{Float64}
Branch reactance; entered in pu. A nonzero value of X must be entered for each branch.
b::Vector{Float64}
Total branch charging susceptance; entered in pu. B = 0.0 by default.
rate_a::Vector{Float64}
First loading rating; entered in MVA. If RATEA is set to 0.0, the default value, this branch will not be included in any examination of circuit loading.
Ratings are entered as: $MVA_{rated} = sqrt(3) × E_{base} × I_{rated} × 10^{-6}$ where:
- $E_{base}$ is the base line-to-line voltage in volts of the buses to which the terminal of the branch is connected.
- $I_{rated}$ is the branch rated phase current in amperes.

rate_b::Vector{Float64}
Second loading rating; entered in MVA. RATEB = 0.0 by default.
rate_c::Vector{Float64}
Third loading rating; entered in MVA. RATEC = 0.0 by default.
gi::Vector{Float64}
Complex admittance of the line shunt at the bus "I" end of the branch; entered in pu. BI is negative for a line connected reactor and positive for line connected capacitor. GI + jBI = 0.0 by default.

bi::Vector{Float64}
Complex admittance of the line shunt at the bus "I" end of the branch; entered in pu. BI is negative for a line connected reactor and positive for line connected capacitor. GI + jBI = 0.0 by default.

gj::Vector{Float64}
Complex admittance of the line shunt at the bus "J" end of the branch; entered in pu. BJ is negative for a line connected reactor and positive for line connected capacitor. GJ + jBJ = 0.0 by default.

bj::Vector{Float64}
Complex admittance of the line shunt at the bus "J" end of the branch; entered in pu. BJ is negative for a line connected reactor and positive for line connected capacitor. GJ + jBJ = 0.0 by default.

st::Vector{Bool}
Initial branch status where 1 designates in-service and 0 designates out-of-service. ST = 1 by default.

met::Vector{Int8}
Metered end flag.
- ≤1 to designate bus i as the metered end.
- ≥2 to designate bus j as the metered end.
met = 1 by default.

len::Vector{Float64}
Line length; entered in user-selected units. LEN = 0.0 by default.
o1::Vector{Int16}
Owner number; 1 through the maximum number of owners at the current size level. Each branch may have up to four owners. See Owners. By default, o1 is the owner to which bus i is assigned and o2, o3, and o4 are zero.

f1::Vector{Float64}
Fraction of total ownership assigned to owner $O_i$; each $F_i$ must be positive. The `fi values are normalized such that they sum to 1.0 before they are placed in the working case. By default, each fi is 1.0.

o2::Vector{Union{Missing, Int16}}
f2::Vector{Union{Missing, Float64}}
o3::Vector{Union{Missing, Int16}}
f3::Vector{Union{Missing, Float64}}
o4::Vector{Union{Missing, Int16}}
f4::Vector{Union{Missing, Float64}}

source

Transformers

PowerFlowData.Transformers — Type

struct Transformers <: PowerFlowData.Records

Each AC transformer to be represented in PSS/E is introduced through transformer data records that specify all the data required to model transformers in power flow calculations, with one exception.

That exception is a set of ancillary data, comprising transformer impedance correction records, which define the manner in which transformer impedance changes as off-nominal turns ratio or phase shift angle is adjusted. Those data records are described in Transformer Impedance Correction Records, ImpedanceCorrections.

Both two-winding and three-winding transformers are specified in the transformer data records. The data records for the two-winding transformer are common to the three-winding transformer; the data block for two-winding transformers is a subset of the data required for three-winding transformers.

Fields

i::Vector{Int32}
The bus number, or extended bus name enclosed in single quotes, of the bus to which the first winding is connected. The transformer’s magnetizing admittance is modeled on winding one. The first winding is the only winding of a two-winding transformer whose tap ratio or phase shift angle may be adjusted by the power flow solution activities; any winding(s) of a three-winding transformer may be adjusted. No default is allowed.

j::Vector{Int32}
The bus number, or extended bus name enclosed in single quotes, of the bus to which the second winding is connected. This winding may have a fixed, off-nominal tap ratio assigned to it. No default is allowed.

k::Vector{Int32}
The bus number, or extended bus name enclosed in single quotes, of the bus to which the third winding is connected. Zero is used to indicate that no third winding is present. Always equal to zero for a two-winding transformer.

ckt::Vector{InlineStrings.String3}
One- or two-character uppercase nonblank alphanumeric transformer circuit identifier; the first character of ckt must not be an ampersand ('&').

cw::Vector{Int8}
The winding data I/O code which defines the units in which the turns ratios windv1 and windv2 are specified (the units of rma1 and rmi1 are also governed by cw when |cod1| is 1 or 2):
- 1 for off-nominal turns ratio in pu of winding bus base voltage;
- 2 for winding voltage in kV.
cw = 1 by default.

cz::Vector{Int8}
The impedance data I/O code that defines the units in which the winding impedances r1_2 and x1_2 are specified:
- 1 for resistance and reactance in pu on system base quantities;
- 2 for resistance and reactance in pu on a specified base MVA and winding bus base voltage;
- 3 for transformer load loss in watts and impedance magnitude in pu on a specified base MVA and winding bus base voltage.
cz = 1 by default.

cm::Vector{Int8}
The magnetizing admittance I/O code that defines the units in which mag1 and mag2 are specified:
- 1 for complex admittance in pu on system base quantities;
- 2 for no load loss in watts and exciting current in pu on winding one to two base MVA and nominal voltage.
cm = 1 by default.

mag1::Vector{Float64}
When cm is 1, mag1 is the magnetizing conductance in pu on system base quantities; when cm is 2, mag1 is the no load loss in watts. mag1 = 0.0 by default.

mag2::Vector{Float64}
When cm is 1, mag2 is the magnetizing susceptance in pu on system base quantities; when cm is 2, mag2 is the exciting current in pu on winding one to two base MVA (sbase1_2) and nominal voltage (nomv1). mag2 = 0.0 by default.

nmetr::Vector{Int8}
The nonmetered end code of either:
- 1 (for the winding one bus), or
- 2 (for the winding two bus).
nmetr = 2 by default.

name::Vector{InlineStrings.String15}
An alphanumeric identifier assigned to the transformer. The name may be up to twelve characters. name may contain any combination of blanks, uppercase letters, numbers and special characters. name is twelve blanks by default.

stat::Vector{Bool}
The initial transformer status, where 1 designates in-service and 0 designates out-of-service. stat = 1 by default.

o1::Vector{Int16}
An owner number; (1 through the maximum number of owners at the current size level). Each transformer may have up to four owners. See Owners. By default, O1 is the owner to which bus "I" is assigned

f1::Vector{Float64}
The fraction of total ownership assigned to owner Oi; each Fi must be positive. The Fi values are normalized such that they sum to 1.0 before they are placed in the working case. By default, each fi is 1.0.

o2::Vector{Union{Missing, Int16}}
f2::Vector{Union{Missing, Float64}}
o3::Vector{Union{Missing, Int16}}
f3::Vector{Union{Missing, Float64}}
o4::Vector{Union{Missing, Int16}}
f4::Vector{Union{Missing, Float64}}
vecgrp::Vector{Union{Missing, InlineStrings.String15}}
Alphanumeric identifier specifying vector group based on transformer winding connections and phase angles. vecgrp value is used for information purpose only. vecgrp is 12 blanks by default.

r1_2::Vector{Float64}
The measured impedance of the transformer between the buses to which its first and second windings are connected (see also x1_2).
- When cz is 1, r1_2 is the resistance in pu on system base quantities;
- when cz is 2, r1_2 is the resistance in pu on winding one to two base MVA (sbase1_2) and winding one bus base voltage;
- when cz is 3, r1_2 is the load loss in watts.
r1_2 = 0.0 by default.

x1_2::Vector{Float64}
The measured impedance of the transformer between the buses to which its first and second windings are connected (see also r1_2).
- When cz is 1, x1_2 is the reactance in pu on system base quantities;
- when cz is 2, x1_2 is the reactance in pu on winding one to two base MVA (sbase1_2) and winding one bus base voltage;
- when cz is 3, x1_2 is the impedance magnitude in pu on winding one to two base MVA (sbase1_2) and winding one bus base voltage.
x1_2 has no default.

sbase1_2::Vector{Float64}
The winding one to two base MVA of the transformer. sbase1_2 = sbase (the system base MVA) by default.

r2_3::Vector{Union{Missing, Float64}}
The measured impedance of a three-winding transformer between the buses to which its second and third windings are connected (see also x2_3).
- When cz is 1, r2_3 is the resistance in pu on system base quantities;
- when cz is 2, r2_3 is the resistance in pu on winding two to three base MVA (sbase2_3) and winding two bus base voltage;
- when cz is 3, r2_3 is the load loss in watts
r2_3 = 0.0 by default. Ignored for a two-winding transformer.

x2_3::Vector{Union{Missing, Float64}}
The measured impedance of a three-winding transformer between the buses to which its second and third windings are connected (see also x2_3).
- When cz is 1, x2_3 is the reactance in pu on system base quantities;
- when cz is 2, x2_3 is the reactance in pu on winding one to two base MVA (sbas2_3) and winding one bus base voltage;
- when cz is 3, x2_3 is the impedance magnitude in pu on winding two to three base MVA (sbase2_3) and winding two bus base voltage.
x2_3 has no default. Ignored for a two-winding transformer.

sbase2_3::Vector{Union{Missing, Float64}}
The winding two to three base MVA of a three-winding transformer; ignored for a two-winding transformer. sbase2_3 = sbase (the system base MVA) by default. Ignored for a two-winding transformer.

r3_1::Vector{Union{Missing, Float64}}
The measured impedance of a three-winding transformer between the buses to which its third and first windings are connected (see also x3_1).
- When cz is 1, r3_1 is the resistance in pu on system base quantities;
- when cz is 2, r3_1 is the resistance in pu on winding three to one base MVA (sbase3_1) and winding three bus base voltage;
- when cz is 3, r3_1 is the load loss in watts
r3_1 = 0.0 by default. Ignored for a two-winding transformer.

x3_1::Vector{Union{Missing, Float64}}
The measured impedance of a three-winding transformer between the buses to which its third and first windings are connected (see also x3_1).
- When cz is 1, x3_1 is the reactance in pu on system base quantities;
- when cz is 2, x3_1 is the reactance in pu on winding three to one base MVA (sbas3_1) and winding three bus base voltage;
- when cz is 3, x3_1 is the impedance magnitude in pu on winding three to one base MVA (sbase3_1) and winding three bus base voltage.
x3_1 has no default. Ignored for a two-winding transformer.

sbase3_1::Vector{Union{Missing, Float64}}
The winding three to one base MVA of a three-winding transformer. sbase3_1 = sbase (the system base MVA) by default. Ignored for a two-winding transformer.

vmstar::Vector{Union{Missing, Float64}}
The voltage magnitude at the hidden star point bus; entered in pu. vmstar = 1.0 by default. Ignored for a two-winding transformer.

anstar::Vector{Union{Missing, Float64}}
The bus voltage phase angle at the hidden star point bus; entered in degrees. anstar = 0.0 by default. Ignored for a two-winding transformer.

windv1::Vector{Float64}
When cw is 1, windv1 is the winding one off-nominal turns ratio in pu of winding one bus base voltage, and windv1 = 1.0 by default. When cw is 2, windv1 is the actual winding one voltage in kV, and windv1 is equal to the base voltage of bus "I" by default.

nomv1::Vector{Float64}
The nominal (rated) winding one voltage in kV, or zero to indicate that nominal winding one voltage is to be taken as the base voltage of bus "I". nomv1 is used only in converting magnetizing data between per unit admittance values and physical units when cm is 2. nomv1 = 0.0 by default.

ang1::Vector{Float64}
The winding one phase shift angle in degrees. ang1 is positive for a positive phase shift from the winding one side to the winding two side (for a two-winding transformer). ang1 must be greater than -180.0 and less than or equal to +180.0. ang1 = 0.0 by default.

rata1::Vector{Float64}
The first winding’s first rating entered in MVA (not current expressed in MVA).

ratb1::Vector{Float64}
The first winding’s second rating entered in MVA (not current expressed in MVA).

ratc1::Vector{Float64}
The first winding’s third rating entered in MVA (not current expressed in MVA).

cod1::Vector{Int8}
The transformer control mode for automatic adjustments of the winding one tap or phase shift angle during power flow solutions:
- 0 for no control (fixed tap and phase shift);
- ±1 for voltage control;
- ±2 for reactive power flow control;
- ±3 for active power flow control;
- ±4 for control of a DC line quantity.
If the control mode is entered as a positive number, automatic adjustment of this transformer winding is enabled when the corresponding adjustment is activated during power flow solutions; a negative control mode suppresses the automatic adjustment of this transformer winding. cod1 = 0 by default.

cont1::Vector{Int32}
The bus number, or extended bus name enclosed in single quotes, of the bus whose voltage is to be controlled by the transformer turns ratio adjustment option of the power flow solution activities when cod1 is 1.
cont1 should be non-zero only for voltage controlling transformer windings. cont1 may specify a bus other than "I", "J", or "K"; in this case, the sign of cont1 defines the location of the controlled bus relative to the transformer winding.
If cont1 is entered as a positive number, the ratio is adjusted as if bus cont1 is on the winding two side of the transformer; if cont1 is entered as a negative number, the ratio is adjusted as if bus |cont1| is on the winding one side of the transformer. cont1 = 0 by default.

rma1::Vector{Float64}
rma1 is the upper limit (and rmi1 the lower limit) of either:
- Off-nominal turns ratio in pu of winding one bus base voltage when |cod1| is 1 or 2 and cw is 1; rma1 = 1.1 and rmi1 = 0.9 by default.
- Actual winding one voltage in kV when |cod1| is 1 or 2 and cw is 2. No default is allowed.
- Phase shift angl e in degrees when |cod1| is 3. No default is allowed.
- Not used when |cod1| is 0 or 4;
rma1 = 1.1 and rmi1 = 0.9 by default.

rmi1::Vector{Float64}
The lower limit to rma1's upper limit. See rma1 for details.
vma1::Vector{Float64}
vma1 is the upper limit (and vmi1 the lower limit) of either:
- Voltage at the controlled bus (bus |cont1|) in pu when |cod1| is 1. vma1 = 1.1 and vmi1 = 0.9 by default.
- Reactive power flow into the transformer at the winding one bus end in Mvar when |cod1| is 2. no default is allowed.
- Active power flow into the transformer at the winding one bus end in MW when |cod1| is 3. no default is allowed.
- Not used when |cod1| is 0 or 4; vma1 = 1.1 and vmi1 = 0.9 by default.

vmi1::Vector{Float64}
The lower limit to vma1's upper limit. See vma1 for details.
ntp1::Vector{Int16}
The number of tap positions available; used when cod1 is 1 or 2. ntp1 must be between 2 and 9999. ntp1 = 33 by default.

tab1::Vector{Int64}
The number of a transformer impedance correction record if this transformer winding’s impedance is to be a function of either off-nominal turns ratio or phase shift angle, or 0 if no transformer impedance correction is to be applied to this transformer winding. See ImpedanceCorrections. tab1 = 0 by default.

cr1::Vector{Float64}
The load drop compensation impedance for voltage controlling transformers entered in pu on system base quantities; used when cod1 is 1. cr1 + jcx1 = 0.0 by default.

cx1::Vector{Float64}
See cr1 for details.
cnxa1::Vector{Union{Missing, Float64}}
Winding connection angle in degrees; used when cod1 is 5. There are no restrictions on the value specified for cnxa1; if it is outside of the range from -90.0 to +90.0, cnxa1 is normalized to within this range. cnxa1 = 0.0 by default.

windv2::Vector{Float64}
When cw is 1, windv2 is the winding two off-nominal turns ratio in pu of winding two bus base voltage, and windv2 = 1.0 by default. When cw is 2, windv2 is the actual winding two voltage in kV, and windv2 is equal to the base voltage of bus j by default.

nomv2::Vector{Float64}
The nominal (rated) winding two voltage in kV, or zero to indicate that nominal winding two voltage is to be taken as the base voltage of bus j. nomv2 is present for information purposes only; it is not used in any of the calculations for modeling the transformer. nomv2 = 0.0 by default.

ang2::Vector{Union{Missing, Float64}}
The winding two phase shift angle in degrees. ang2 is positive for a positive phase shift from the winding two side to the "T" (or star) point bus. ang2 must be greater than -180.0 and less than or equal to +180.0. ang2 = 0.0 by default. Ignored for a two-winding transformer.

rata2::Vector{Union{Missing, Float64}}
The second winding’s first rating entered in MVA (not current expressed in MVA). Ignored for a two-winding transformer.

ratb2::Vector{Union{Missing, Float64}}
The second winding’s second rating entered in MVA (not current expressed in MVA). Ignored for a two-winding transformer.

ratc2::Vector{Union{Missing, Float64}}
The second winding’s third rating entered in MVA (not current expressed in MVA). Ignored for a two-winding transformer.

cod2::Vector{Union{Missing, Int8}}
The transformer control mode for automatic adjustments of the winding two tap or phase shift angle during power flow solutions:
- 0 for no control (fixed tap and phase shift);
- ±1 for voltage control;
- ±2 for reactive power flow control;
- ±3 for active power flow control.
If the control mode is entered as a positive number, automatic adjustment of this transformer winding is enabled when the corresponding adjustment is activated during power flow solutions; a negative control mode suppresses the automatic adjustment of this transformer winding. cod2 = 0 by default. Ignored for a two-winding transformer.

cont2::Vector{Union{Missing, Int32}}
The bus number, or extended bus name enclosed in single quotes, of the bus whose voltage is to be controlled by the transformer turns ratio adjustment option of the power flow solution activities when cod2 is 1. cont2 should be nonzero only for voltage controlling transformer windings.
cont2 may specify a bus other than i, j, or k; in this case, the sign of cont2 defines the location of the controlled bus relative to the transformer winding. If cont2 is entered as a positive number, or a quoted extended bus name, the ratio is adjusted as if bus cont2 is on the winding one or winding three side of the transformer; if cont2 is entered as a negative number, or a quoted extended bus name with a minus sign preceding the first character, the ratio is adjusted as if bus |cont2| is on the winding two side of the transformer. cont2 = 0 by default. Ignored for a two-winding transformer.

rma2::Vector{Union{Missing, Float64}}
rma2 is the upper limit (and rmi2 the lower limit) of either:
- Off-nominal turns ratio in pu of winding two bus base voltage when |cod2| is 1 or 2 and cw is 1; rma2 = 1.1 and rmi2 = 0.9 by default.
- Actual winding one voltage in kV when |cod2| is 1 or 2 and cw is 2. No default is allowed.
- Phase shift angle in degrees when |cod2| is 3. No default is allowed.
- Not used when |cod2| is 0;
rma2 = 1.1 and rmi2 = 0.9 by default. Ignored for a two-winding transformer.

rmi2::Vector{Union{Missing, Float64}}
The lower limit to rma2's upper limit. See rma2 for details. Ignored for a two-winding transformer.

vma2::Vector{Union{Missing, Float64}}
vma2 is the upper limit (and vmi2 the lower limit) of either:
- Voltage at the controlled bus (bus |cont2|) in pu when |cod2| is 1. vma2 = 1.1 and vmi2 = 0.9 by default.
- Reactive power flow into the transformer at the winding two bus end in Mvar when |cod2| is 2. No default is allowed.
- Active power flow into the transformer at the winding two bus end in MW when |cod2| is 3. No default is allowed.
- Not used when |cod2| is 0; vma2 = 1.1 and vmi2 = 0.9 by default.
Ignored for a two-winding transformer.

vmi2::Vector{Union{Missing, Float64}}
The lower limit to vma1's upper limit. See vma1 for details. Ignored for a two-winding transformer.

ntp2::Vector{Union{Missing, Int16}}
The number of tap positions available; used when cod2 is 1 or 2. ntp2 must be between 2 and 9999. ntp2 = 33 by default. Ignored for a two-winding transformer.

tab2::Vector{Union{Missing, Int64}}
The number of a transformer impedance correction record if this transformer winding’s impedance is to be a function of either off-nominal turns ratio or phase shift angle, or 0 if no transformer impedance correction is to be applied to this transformer winding. See ImpedanceCorrections. tab2 = 0 by default. Ignored for a two-winding transformer.

cr2::Vector{Union{Missing, Float64}}
The load drop compensation impedance for voltage controlling transformers entered in pu on system base quantities; used when cod2 is 1. cr2 + jcx2 = 0.0 by default. Ignored for a two-winding transformer.

cx2::Vector{Union{Missing, Float64}}
See cr2 for details. Ignored for a two-winding transformer.

cnxa2::Vector{Union{Missing, Float64}}
Winding connection angle in degrees; used when cod2 is 5. There are no restrictions on the value specified for cnxa2; if it is outside of the range from -90.0 to +90.0, cnxa2 is normalized to within this range. cnxa2 = 0.0 by default.

windv3::Vector{Union{Missing, Float64}}
When cw is 1, windv3 is the winding three off-nominal turns ratio in pu of winding three bus base voltage, and windv3 = 1.0 by default. When cw is 2, windv3 is the actual winding three voltage in kV, and windv3 is equal to the base voltage of bus k by default. Ignored for a two-winding transformer.

nomv3::Vector{Union{Missing, Float64}}
The nominal (rated) winding three voltage in kV, or zero to indicate that nominal winding two voltage is to be taken as the base voltage of bus j. nomv3 is present for information purposes only; it is not used in any of the calculations for modeling the transformer. nomv3 = 0.0 by default. Ignored for a two-winding transformer.

ang3::Vector{Union{Missing, Float64}}
The winding three phase shift angle in degrees. ang3 is positive for a positive phase shift from the winding two side to the "T" (or star) point bus. ang3 must be greater than -180.0 and less than or equal to +180.0. ang3 = 0.0 by default. Ignored for a two-winding transformer.

rata3::Vector{Union{Missing, Float64}}
The third winding’s first rating entered in MVA (not current expressed in MVA). Ignored for a two-winding transformer.

ratb3::Vector{Union{Missing, Float64}}
The third winding’s second rating entered in MVA (not current expressed in MVA). Ignored for a two-winding transformer.

ratc3::Vector{Union{Missing, Float64}}
The third winding’s third rating entered in MVA (not current expressed in MVA). Ignored for a two-winding transformer.

cod3::Vector{Union{Missing, Int8}}
The transformer control mode for automatic adjustments of the winding three tap or phase shift angle during power flow solutions:
- 0 for no control (fixed tap and phase shift);
- ±1 for voltage control;
- ±2 for reactive power flow control;
- ±3 for active power flow control.
If the control mode is entered as a positive number, automatic adjustment of this transformer winding is enabled when the corresponding adjustment is activated during power flow solutions; a negative control mode suppresses the automatic adjustment of this transformer winding. cod3 = 0 by default. Ignored for a two-winding transformer.

cont3::Vector{Union{Missing, Int32}}
The bus number, or extended bus name enclosed in single quotes, of the bus whose voltage is to be controlled by the transformer turns ratio adjustment option of the power flow solution activities when cod3 is 1. cont3 should be nonzero only for voltage controlling transformer windings.
cont3 may specify a bus other than i, j, or k; in this case, the sign of cont3 defines the location of the controlled bus relative to the transformer winding. If cont3 is entered as a positive number, or a quoted extended bus name, the ratio is adjusted as if bus cont3 is on the winding one or winding two side of the transformer; if cont3 is entered as a negative number, or a quoted extended bus name with a minus sign preceding the first character, the ratio is adjusted as if bus |cont3| is on the winding three side of the transformer. cont3 = 0 by default. Ignored for a two-winding transformer.

rma3::Vector{Union{Missing, Float64}}
rma3 is the upper limit (and rmi3 the lower limit) of either:
- Off-nominal turns ratio in pu of winding three bus base voltage when |cod3| is 1 or 2 and cw is 1; rma3 = 1.1 and rmi3 = 0.9 by default.
- Actual winding one voltage in kV when |cod3| is 1 or 2 and cw is 2. No default is allowed.
- Phase shift angle in degrees when |cod3| is 3. No default is allowed.
- Not used when |cod3| is 0;
rma3 = 1.1 and rmi3 = 0.9 by default. Ignored for a two-winding transformer.

rmi3::Vector{Union{Missing, Float64}}
The lower limit to rma3's upper limit. See rma3 for details. Ignored for a two-winding transformer.

vma3::Vector{Union{Missing, Float64}}
vma3 is the upper limit (and vmi3 the lower limit) of either:
- Voltage at the controlled bus (bus |cont3|) in pu when |cod3| is 1. vma3 = 1.1 and vmi3 = 0.9 by default.
- Reactive power flow into the transformer at the winding three bus end in Mvar when |cod3| is 2. No default is allowed.
- Active power flow into the transformer at the winding two bus end in MW when |cod3| is 3. No default is allowed.
- Not used when |cod3| is 0; vma3 = 1.1 and vmi3 = 0.9 by default.
Ignored for a two-winding transformer.

vmi3::Vector{Union{Missing, Float64}}
The lower limit to vma3's upper limit. See vma3 for details. Ignored for a two-winding transformer.

ntp3::Vector{Union{Missing, Int16}}
The number of tap positions available; used when cod3 is 1 or 2. ntp3 must be between 2 and 9999. ntp3 = 33 by default. Ignored for a two-winding transformer.

tab3::Vector{Union{Missing, Int64}}
The number of a transformer impedance correction record if this transformer winding’s impedance is to be a function of either off-nominal turns ratio or phase shift angle, or 0 if no transformer impedance correction is to be applied to this transformer winding. See ImpedanceCorrections. tab3 = 0 by default. Ignored for a two-winding transformer.

cr3::Vector{Union{Missing, Float64}}
The load drop compensation impedance for voltage controlling transformers entered in pu on system base quantities; used when cod3 is 1. cr3 + jcx3 = 0.0 by default. Ignored for a two-winding transformer.

cx3::Vector{Union{Missing, Float64}}
See cr3 for details. Ignored for a two-winding transformer.

cnxa3::Vector{Union{Missing, Float64}}
Winding connection angle in degrees; used when cod3 is 5. There are no restrictions on the value specified for cnxa3; if it is outside of the range from -90.0 to +90.0, cnxa3 is normalized to within this range. cnxa3 = 0.0 by default.

source

Area Interchanges

PowerFlowData.AreaInterchanges — Type

struct AreaInterchanges <: PowerFlowData.Records

Area interchange is a required net export of power from, or net import of power to, a specific area. This does not imply that the power is destined to be transferred to or from any other specific area. To specify transfers between specific pairs of areas see InterAreaTransfers.

Fields

i::Vector{Int16}
Area number (1 through the maximum number of areas at the current size level)

isw::Vector{Int32}
Bus number, or extended bus name enclosed in single quotes, of the area slack bus for area interchange control. The bus must be a generator (type two) bus in the specified area. Any area containing a system swing bus (type three) must have either that swing bus or a bus number of zero specified for its area slack bus number. isw = 0 by default.

pdes::Vector{Float64}
Desired net interchange leaving the area (export); entered in MW. pdes = 0.0 by default.

ptol::Vector{Float64}
Interchange tolerance bandwidth; entered in MW. ptol = 10.0 by default.

arname::Vector{InlineStrings.String15}
Alphanumeric identifier assigned to area I. The name may contain up to twelve characters. arname is set to twelve blanks by default.

source

Two-Terminal DC Lines

PowerFlowData.TwoTerminalDCLines — Type

abstract type TwoTerminalDCLines <: PowerFlowData.Records

The TwoTerminalDCLines data record depends on the PSSE version:

See TwoTerminalDCLines30 for PSSE v30 files.
See TwoTerminalDCLines33 for PSSE v33 files.

source

PowerFlowData.TwoTerminalDCLines30 — Type

struct TwoTerminalDCLines30 <: TwoTerminalDCLines

The two-terminal DC transmission line model is used to simulate either a point-to-point system with rectifier and inverter separated by a bipolar or mono-polar transmission system or a Back-to-Back system where the rectifier and inverter are physically located at the same site and separated only by a short bus-bar.

The data requirements fall into three groups:

Control parameters and set-points
Converter transformers
The DC line characteristics

The steady-state model comprising this data enables not only power flow analysis but also establishes the initial steady-state for dynamic analysis.

Fields

i::Vector{Int16}
The DC line number.
mdc::Vector{Int8}
Control mode:
- 0 for blocked,
- 1 for power,
- 2 for current.
mdc = 0 by default.

rdc::Vector{Float64}
The DC line resistance; entered in ohms. No default.

setvl::Vector{Float64}
Current (amps) or power (MW) demand. When mdc is 1, a positive value of setvl specifies desired power at the rectifier and a negative value specifies desired inverter power. No default.

vschd::Vector{Float64}
Scheduled compounded DC voltage; entered in kV. No default.

vcmod::Vector{Float64}
Mode switch DC voltage; entered in kV. When the inverter DC voltage falls below this value and the line is in power control mode (i.e. mdc = 1), the line switches to current control mode with a desired current corresponding to the desired power at scheduled DC voltage. vcmod = 0.0 by default.

rcomp::Vector{Float64}
Compounding resistance; entered in ohms. Gamma and/or TAPI is used to attempt to hold the compounded voltage ($vdci + dccur ∗ rcomp$) at vschd.
- To control the inverter end DC voltage VDCI, set rcomp to zero;
- to control the rectifier end DC voltage VDCR, set rcomp to the DC line resistance, rdc;
- otherwise, set rcomp to the appropriate fraction of rdc.
rcomp = 0.0 by default.

delti::Vector{Float64}
Margin entered in per unit of desired DC power or current. This is the fraction by which the order is reduced when alpha is at its minimum (alfmn) and the inverter is controlling the line current. delti = 0.0 by default.

meter::Vector{InlineStrings.String1}
Metered end code of either "R" (for rectifier) or "I" (for inverter). meter = "I" by default.

dcvmin::Vector{Float64}
Minimum compounded DC voltage; entered in kV. Only used in constant gamma operation (i.e. when gammx = gammn) when TAPI is held constant and an AC transformer tap is adjusted to control DC voltage (i.e. when ifi, iti, and idi specify a two-winding transformer). dcvmin = 0.0 by default.

cccitmx::Vector{Int32}
Iteration limit for capacitor commutated two-terminal DC line Newton solution procedure. cccitmx = 20 by default.

cccacc::Vector{Float64}
Acceleration factor for capacitor commutated two-terminal DC line Newton solution procedure. cccacc = 1.0 by default.

ipr::Vector{Int32}
Rectifier converter bus number, or extended bus name enclosed in single quotes. No default.

nbr::Vector{Int32}
Number of bridges in series (rectifier). No default.

alfmx::Vector{Float64}
Nominal maximum rectifier firing angle; entered in degrees. No default.

alfmn::Vector{Float64}
Minimum steady-state rectifier firing angle; entered in degrees. No default.

rcr::Vector{Float64}
Rectifier commutating transformer resistance per bridge; entered in ohms. No default allowed.

xcr::Vector{Float64}
Rectifier commutating transformer reactance per bridge; entered in ohms. No default allowed.

ebasr::Vector{Float64}
Rectifier primary base AC voltage; entered in kV. No default.

trr::Vector{Float64}
Rectifier transformer ratio. trr = 1.0 by default.

tapr::Vector{Float64}
Rectifier tap setting. tapr = 1.0 by default.

tmxr::Vector{Float64}
Maximum rectifier tap setting. tmxr = 1.5 by default.

tmnr::Vector{Float64}
Minimum rectifier tap setting. tmnr = 0.51 by default.

stpr::Vector{Float64}
Rectifier tap step; must be positive. stpr = 0.00625 by default.

icr::Vector{Int32}
Rectifier firing angle measuring bus number, or extended bus name enclosed in single quotes. The firing angle and angle limits used inside the DC model are adjusted by the difference between the phase angles at this bus and the AC/DC interface (i.e. the converter bus, ipr). icr = 0 by default.

ifr::Vector{Int32}
Winding one side "from bus" number, or extended bus name enclosed in single quotes, of a two-winding transformer. ifr = 0 by default.

itr::Vector{Int32}
Winding two side "to bus" number, or extended bus name enclosed in single quotes, of a two-winding transformer. itr = 0 by default.

idr::Vector{InlineStrings.String3}
Circuit identifier; the branch described by ifr, itr, and idr must have been entered as a two-winding transformer; an AC transformer may control at most only one DC converter. idr = '1' by default.
If no branch is specified, tapr is adjusted to keep alpha within limits; otherwise, tapr is held fixed and this transformer’s tap ratio is adjusted. The adjustment logic assumes that the rectifier converter bus is on the winding two side of the transformer. The limits tmxr and tmnr specified here are used; except for the transformer control mode flag (cod of Transformers), the AC tap adjustment data is ignored.

xcapr::Vector{Float64}
Commutating capacitor reactance magnitude per bridge; entered in ohms. xcapr = 0.0 by default.

ipi::Vector{Int32}
Inverter converter bus number, or extended bus name enclosed in single quotes.

nbi::Vector{Int32}
Number of bridges in series (inverter).

gammx::Vector{Float64}
Nominal maximum inverter firing angle; entered in degrees.

gammn::Vector{Float64}
Minimum steady-state inverter firing angle; entered in degrees.

rci::Vector{Float64}
Inverter commutating transformer resistance per bridge; entered in ohms.

xci::Vector{Float64}
Inverter commutating transformer reactance per bridge; entered in ohms.

ebasi::Vector{Float64}
Inverter primary base AC voltage; entered in kV.

tri::Vector{Float64}
Inverter transformer ratio.

tapi::Vector{Float64}
Inverter tap setting.

tmxi::Vector{Float64}
Maximum inverter tap setting.

tmni::Vector{Float64}
Minimum inverter tap setting.

stpi::Vector{Float64}
Inverter tap step; must be positive.

ici::Vector{Int32}
Inverter firing angle measuring bus number, or extended bus name enclosed in single quotes.

ifi::Vector{Int32}
Winding one side "from bus" number, or extended bus name enclosed in single quotes, of a two-winding transformer.

iti::Vector{Int32}
Winding two side "to bus" number, or extended bus name enclosed in single quotes, of a two-winding transformer.

idi::Vector{InlineStrings.String3}
Circuit identifier; the branch described by ifr, itr, and idr must have been entered as a two-winding transformer; an AC transformer may control at most only one DC converter.

xcapi::Vector{Float64}
Commutating capacitor reactance magnitude per bridge; entered in ohms.

source

PowerFlowData.TwoTerminalDCLines33 — Type

struct TwoTerminalDCLines33 <: TwoTerminalDCLines

The data requirements fall into three groups:

Control parameters and set-points
Converter transformers
The DC line characteristics

The steady-state model comprising this data enables not only power flow analysis but also establishes the initial steady-state for dynamic analysis.

Fields

name::Vector{InlineStrings.String15}
The non-blank alphanumeric identifier assigned to this DC line. Each two-terminal DC line must have a unique name.name` may be up to twelve characters and may contain any combination of blanks, uppercase letters, numbers and special characters. name must be enclosed in single or double quotes if it contains any blanks or special characters. No default allowed.

mdc::Vector{Int8}
Control mode:
- 0 for blocked,
- 1 for power,
- 2 for current.
mdc = 0 by default.

rdc::Vector{Float64}
The DC line resistance; entered in ohms. No default.

setvl::Vector{Float64}
Current (amps) or power (MW) demand. When mdc is 1, a positive value of setvl specifies desired power at the rectifier and a negative value specifies desired inverter power. No default.

vschd::Vector{Float64}
Scheduled compounded DC voltage; entered in kV. No default.

vcmod::Vector{Float64}
Mode switch DC voltage; entered in kV. When the inverter DC voltage falls below this value and the line is in power control mode (i.e. mdc = 1), the line switches to current control mode with a desired current corresponding to the desired power at scheduled DC voltage. vcmod = 0.0 by default.

rcomp::Vector{Float64}
Compounding resistance; entered in ohms. Gamma and/or TAPI is used to attempt to hold the compounded voltage ($vdci + dccur ∗ rcomp$) at vschd.
- To control the inverter end DC voltage VDCI, set rcomp to zero;
- to control the rectifier end DC voltage VDCR, set rcomp to the DC line resistance, rdc;
- otherwise, set rcomp to the appropriate fraction of rdc.
rcomp = 0.0 by default.

delti::Vector{Float64}
Margin entered in per unit of desired DC power or current. This is the fraction by which the order is reduced when alpha is at its minimum (alfmn) and the inverter is controlling the line current. delti = 0.0 by default.

meter::Vector{InlineStrings.String1}
Metered end code of either "R" (for rectifier) or "I" (for inverter). meter = "I" by default.

dcvmin::Vector{Float64}
Minimum compounded DC voltage; entered in kV. Only used in constant gamma operation (i.e. when gammx = gammn) when TAPI is held constant and an AC transformer tap is adjusted to control DC voltage (i.e. when ifi, iti, and idi specify a two-winding transformer). dcvmin = 0.0 by default.

cccitmx::Vector{Int32}
Iteration limit for capacitor commutated two-terminal DC line Newton solution procedure. cccitmx = 20 by default.

cccacc::Vector{Float64}
Acceleration factor for capacitor commutated two-terminal DC line Newton solution procedure. cccacc = 1.0 by default.

ipr::Vector{Int32}
Rectifier converter bus number, or extended bus name enclosed in single quotes. No default.

nbr::Vector{Int32}
Number of bridges in series (rectifier). No default.

alfmx::Vector{Float64}
Nominal maximum rectifier firing angle; entered in degrees. No default.

alfmn::Vector{Float64}
Minimum steady-state rectifier firing angle; entered in degrees. No default.

rcr::Vector{Float64}
Rectifier commutating transformer resistance per bridge; entered in ohms. No default allowed.

xcr::Vector{Float64}
Rectifier commutating transformer reactance per bridge; entered in ohms. No default allowed.

ebasr::Vector{Float64}
Rectifier primary base AC voltage; entered in kV. No default.

trr::Vector{Float64}
Rectifier transformer ratio. trr = 1.0 by default.

tapr::Vector{Float64}
Rectifier tap setting. tapr = 1.0 by default.

tmxr::Vector{Float64}
Maximum rectifier tap setting. tmxr = 1.5 by default.

tmnr::Vector{Float64}
Minimum rectifier tap setting. tmnr = 0.51 by default.

stpr::Vector{Float64}
Rectifier tap step; must be positive. stpr = 0.00625 by default.

icr::Vector{Int32}
Rectifier firing angle measuring bus number, or extended bus name enclosed in single quotes. The firing angle and angle limits used inside the DC model are adjusted by the difference between the phase angles at this bus and the AC/DC interface (i.e. the converter bus, ipr). icr = 0 by default.

ifr::Vector{Int32}
Winding one side "from bus" number, or extended bus name enclosed in single quotes, of a two-winding transformer. ifr = 0 by default.

itr::Vector{Int32}
Winding two side "to bus" number, or extended bus name enclosed in single quotes, of a two-winding transformer. itr = 0 by default.

idr::Vector{InlineStrings.String3}
Circuit identifier; the branch described by ifr, itr, and idr must have been entered as a two-winding transformer; an AC transformer may control at most only one DC converter. idr = '1' by default.
If no branch is specified, tapr is adjusted to keep alpha within limits; otherwise, tapr is held fixed and this transformer’s tap ratio is adjusted. The adjustment logic assumes that the rectifier converter bus is on the winding two side of the transformer. The limits tmxr and tmnr specified here are used; except for the transformer control mode flag (cod of Transformers), the AC tap adjustment data is ignored.

xcapr::Vector{Float64}
Commutating capacitor reactance magnitude per bridge; entered in ohms. xcapr = 0.0 by default.

ipi::Vector{Int32}
Inverter converter bus number, or extended bus name enclosed in single quotes.

nbi::Vector{Int32}
Number of bridges in series (inverter).

gammx::Vector{Float64}
Nominal maximum inverter firing angle; entered in degrees.

gammn::Vector{Float64}
Minimum steady-state inverter firing angle; entered in degrees.

rci::Vector{Float64}
Inverter commutating transformer resistance per bridge; entered in ohms.

xci::Vector{Float64}
Inverter commutating transformer reactance per bridge; entered in ohms.

ebasi::Vector{Float64}
Inverter primary base AC voltage; entered in kV.

tri::Vector{Float64}
Inverter transformer ratio.

tapi::Vector{Float64}
Inverter tap setting.

tmxi::Vector{Float64}
Maximum inverter tap setting.

tmni::Vector{Float64}
Minimum inverter tap setting.

stpi::Vector{Float64}
Inverter tap step; must be positive.

ici::Vector{Int32}
Inverter firing angle measuring bus number, or extended bus name enclosed in single quotes.

ifi::Vector{Int32}
Winding one side "from bus" number, or extended bus name enclosed in single quotes, of a two-winding transformer.

iti::Vector{Int32}
Winding two side "to bus" number, or extended bus name enclosed in single quotes, of a two-winding transformer.

idi::Vector{InlineStrings.String3}
Circuit identifier; the branch described by ifr, itr, and idr must have been entered as a two-winding transformer; an AC transformer may control at most only one DC converter.

xcapi::Vector{Float64}
Commutating capacitor reactance magnitude per bridge; entered in ohms.

source

VSC DC Lines

PowerFlowData.VSCDCLines — Type

struct VSCDCLines <: PowerFlowData.Records

Voltage source converter (VSC) DC lines.

Defines line quantities and control parameters, and the converter buses (converter 1 and converter 2), along with their data quantities and control parameters.

Fields

name::Vector{InlineStrings.String15}
The non-blank alphanumeric identifier assigned to this VSC DC line. Each VSC DC line must have a unique name. The name may be up to twelve characters and must be enclosed in single quotes. name may contain any combination of blanks, uppercase letters, numbers and special characters. No default.

mdc::Vector{Int8}
Control mode:
- 0 for out-of-service,
- 1 for in-service.
mdc = 1 by default.

rdc::Vector{Float64}
The DC line resistance entered in ohms. rdc must be positive. No default.

o1::Vector{Int16}
An owner number; (1 through the maximum number of owners at the current size level). Each VSC DC line may have up to four owners. See Owners. By default, 01 is 1, and O2, O3 and O4 are zero.

f1::Vector{Float64}
The fraction of total ownership assigned to owner o1; each Fi must be positive. The Fi values are normalized such that they sum to 1.0 before they are placed in the working case. By default, each F_i is 1.0.

o2::Vector{Int16}
An owner number; (1 through the maximum number of owners at the current size level). See Owners. By default, o2 is zero.

f2::Vector{Float64}
The fraction of total ownership assigned to owner o2; must be positive. By default, f2 is 1.0.

o3::Vector{Int16}
An owner number; (1 through the maximum number of owners at the current size level). By default, o3 is zero.

f3::Vector{Float64}
The fraction of total ownership assigned to owner o2; must be positive. By default, f3 is 1.0.

o4::Vector{Int16}
An owner number; (1 through the maximum number of owners at the current size level). By default, o4 is zero.

f4::Vector{Float64}
The fraction of total ownership assigned to owner o2; must be positive. By default, f4 is 1.0.

ibus1::Vector{Int32}
Converter 1 bus number, or extended bus name enclosed in single quotes. No default.
type1::Vector{Int8}
Code for the type of converter 1 DC control:
- 0 for converter out-of-service,
- 1 for DC voltage control,
- 2 for MW control.
When both converters are in-service, exactly one converter of each VSC DC line must be type 1. No default.

mode1::Vector{Int8}
Converter 1 AC control mode:
- 1 for AC voltage control,
- 2 for fixed AC power factor.
mode = 1 by default.

docet1::Vector{Float64}
Converter 1 DC setpoint.
- For type = 1, dcset is the scheduled DC voltage on the DC side of the converter bus; entered in kV.
- For type = 2, dcset is the power demand, where a positive value specifies that the converter is feeding active power into the AC network at bus ibus, and a negative value specifies that the converter is withdrawing active power from the AC network at bus ibus; entered in MW.
No default .

acset1::Vector{Float64}
Converter 1 AC setpoint.
- For mode = 1, acset is the regulated AC voltage setpoint; entered in pu.
- For mode = 2, acset is the power factor setpoint.
acset = 1.0 by default.

aloss1::Vector{Float64}
Coefficients of the linear equation used to calculate converter 1 losses: $KW_{conv loss} = A_{loss} + I_{dc} * B_{loss}$ aloss is entered in kW. aloss = bloss = 0.0 by default.

bloss1::Vector{Float64}
Coefficients of the linear equation used to calculate converter 1 losses: $KW_{conv loss} = A_{loss} + I_{dc} * B_{loss}$ bloss is entered in kW/amp. aloss = bloss = 0.0 by default.

minloss1::Vector{Float64}
Minimum converter 1 losses; entered in kW. minloss = 0.0 by default.
smax1::Vector{Float64}
Converter 1 MVA rating; entered in MVA. smax = 0.0 to allow unlimited converter MVA loading. smax = 0.0 by default.

imax1::Vector{Float64}
Converter 1 AC current rating; entered in amps. imax = 0.0 to allow unlimited converter current loading. If a positive imax is specified, the base voltage assigned to bus ibus must be positive. imax = 0.0 by default.

pwf1::Vector{Float64}
Power weighting factor fraction (0.0 < pwf < 1.0) used in reducing the active power order and either the reactive power order (when mode is 2) or the reactive power limits (when mode is 1) when the converter MVA or current rating is violated. When pwf is 0.0, only the active power is reduced; when PWF is 1.0, only the reactive power is reduced; otherwise, a weighted reduction of both active and reactive power is applied. pwf = 1.0 by default.

maxq1::Vector{Float64}
Reactive power upper limit; entered in Mvar. A positive value of reactive power indicates reactive power flowing into the AC network from the converter; a negative value of reactive power indicates reactive power withdrawn from the AC network. Not used if mode = 2. maxq = 9999.0 by default.

minq1::Vector{Float64}
Reactive power lower limit; entered in Mvar. A positive value of reactive power indicates reactive power flowing into the AC network from the converter; a negative value of reactive power indicates reactive power withdrawn from the AC network. Not used if mode = 2. minq = -9999.0 by default.

remot1::Vector{Int32}
Bus number, or extended bus name enclosed in single quotes, of a remote type 1 or 2 bus whose voltage is to be regulated by this converter to the value specified by acset. If bus remot is other than a type 1 or 2 bus, bus ibus regulates its own voltage to the value specified by acset. remot is entered as zero if the converter is to regulate its own voltage. Not used if mode = 2. remot = 0 by default.

rmpct1::Vector{Float64}
Percent of the total Mvar required to hold the voltage at the bus controlled by bus ibus that are to be contributed by this VSC; rmpct must be positive. rmpct is needed only if remot specifies a valid remote bus and there is more than one local or remote voltage controlling device (plant, switched shunt, FACTS device shunt element, or VSC DC line converter) controlling the voltage at bus remot to a setpoint, or remot is zero but bus ibus is the controlled bus, local or remote, of one or more other setpoint mode voltage controlling devices. Not used if mode = 2. rmpct = 100.0 by default.

ibus2::Vector{Int32}
Converter 2 bus number, or extended bus name enclosed in single quotes. No default.
type2::Vector{Int8}
Code for the type of converter 2 DC control
mode2::Vector{Int8}
Converter 2 AC control mode
docet2::Vector{Float64}
Converter 2 DC setpoint.
acset2::Vector{Float64}
Converter 2 AC setpoint.
aloss2::Vector{Float64}
Coefficient $A_{loss}$ of the linear equation used to calculate converter 2 losses.
bloss2::Vector{Float64}
Coefficient $B_{loss}$ of the linear equation used to calculate converter 2 losses.
minloss2::Vector{Float64}
Minimum converter 2 losses; entered in kW. minloss = 0.0 by default.
smax2::Vector{Float64}
Converter 2 MVA rating; entered in MVA.
imax2::Vector{Float64}
Converter 2 AC current rating; entered in amps.
pwf2::Vector{Float64}
Power weighting factor fraction (0.0 < pwf < 1.0) for converter 2.
maxq2::Vector{Float64}
Reactive power upper limit for converter 2; entered in Mvar.
minq2::Vector{Float64}
Reactive power lower limit for converter 2; entered in Mvar.
remot2::Vector{Int32}
Bus number to be regulated by converter 2 to the value specified by acset2.
rmpct2::Vector{Float64}

source

Switched Shunts

PowerFlowData.SwitchedShunts — Type

abstract type SwitchedShunts <: PowerFlowData.Records

The SwitchedShunts data record depends on the PSSE version:

See SwitchedShunts30 for PSSE v30 files.
See SwitchedShunts33 for PSSE v33 files.

source

PowerFlowData.SwitchedShunts30 — Type

struct SwitchedShunts30 <: SwitchedShunts

Represents switched shunt devices, in the form of capacitors and/or reactors on a network bus.

The switched shunt elements at a bus may consist entirely of blocks of shunt reactors (each Bi is a negative quantity) or entirely of blocks of capacitor banks (each Bi is a positive quantity). Any bus can have both switched capacitors and reactors.

Each network bus to be represented in PSS/E with switched shunt admittance devices must have a switched shunt data record specified for it. The switched shunts are represented with up to eight blocks of admittance, each one of which consists of up to nine steps of the specified block admittance.

Fields

i::Vector{Int32}
Bus number, or extended bus name enclosed in single quotes.

modsw::Vector{Int8}
Control mode:
- 0 - fixed
- 1 - discrete adjustment, controlling voltage locally or at bus swrem
- 2 - continuous adjustment, controlling voltage locally or at bus swrem
- 3 - discrete adjustment, controlling reactive power output of the plant at bus swrem
- 4 - discrete adjustment, controlling reactive power output of the VSC DC line converter
at bus swrem of the VSC DC line whose name is specified as rmidnt
- 5 - discrete adjustment, controlling admittance setting of the switched shunt at bus swrem
modsw = 1 by default.

vswhi::Vector{Float64}
When modsw is 1 or 2, the controlled voltage upper limit; entered in pu. When modsw is 3, 4 or 5, the controlled reactive power range upper limit; entered in pu of the total reactive power range of the controlled voltage controlling device. vswhi is not used when modsw is 0. vswhi = 1.0 by default.

vswlo::Vector{Float64}
When modsw is 1 or 2, the controlled voltage lower limit; entered in pu. When modsw is 3, 4 or 5, the controlled reactive power range lower limit; entered in pu of the total reactive power range of the controlled voltage controlling device. vswlo is not used when modsw is 0. vswlo = 1.0 by default.

swrem::Vector{Int32}
Bus number, or extended bus name enclosed in single quotes, of the bus whose voltage or connected equipment reactive power output is controlled by this switched shunt.
- When modsw is 1 or 2, swrem is entered as 0 if the switched shunt is to regulate its own voltage;
otherwise, swrem specifies the remote type one or two bus whose voltage is to be regulated by this switched shunt.
- When modsw is 3, swrem specifies the type two or three bus whose plant reactive power output is to be regulated by this switched shunt.
Set swrem to "I" if the switched shunt and the plant which it controls are connected to the same bus.
- When modsw is 4, swrem specifies the converter bus of a VSC dc line whose converter reactive power output is to be regulated by this switched shunt.
Set swrem to "I" if the switched shunt and the VSC dc line converter which it controls are connected to the same bus.
- When modsw is 5, swrem specifies the remote bus to which the switched shunt whose admittance setting is to be regulated by this switched shunt is connected.
- swrem is not used when modsw is 0.
swrem = 0 by default.

rmpct::Vector{Float64}
Percent of the total Mvar required to hold the voltage at the bus controlled by bus I that are to be contributed by this switched shunt; rmpct must be positive.
rmpct is needed only if swrem specifies a valid remote bus and there is more than one local or remote voltage controlling device (plant, switched shunt, FACTS device shunt element, or VSC DC line converter) controlling the voltage at bus swrem to a setpoint, or swrem is zero but bus I is the controlled bus, local or remote, of one or more other setpoint mode voltage controlling devices. Only used if modsw = 1 or 2. rmpct = 100.0 by default.

rmidnt::Vector{InlineStrings.String15}
When modsw is 4, the name of the VSC DC line whose converter bus is specified in swrem. rmidnt is not used for other values of modsw. rmidnt is a blank name by default.

binit::Vector{Float64}
Initial switched shunt admittance; entered in Mvar at unity voltage. binit = 0.0 by default.

n1::Vector{Int32}
Number of steps for block i. The first zero value of Ni or Bi is interpreted as the end of the switched shunt blocks for bus I. ni = 0 by default.

b1::Vector{Float64}
Admittance increment for each of N_i steps in block i; entered in Mvar at unity voltage. bi = 0.0 by default.

n2::Vector{Int32}
b2::Vector{Float64}
n3::Vector{Int32}
b3::Vector{Float64}
n4::Vector{Int32}
b4::Vector{Float64}
n5::Vector{Int32}
b5::Vector{Float64}
n6::Vector{Int32}
b6::Vector{Float64}
n7::Vector{Int32}
b7::Vector{Float64}
n8::Vector{Int32}
b8::Vector{Float64}

source

PowerFlowData.SwitchedShunts33 — Type

struct SwitchedShunts33 <: SwitchedShunts

Represents switched shunt devices, in the form of capacitors and/or reactors on a network bus.

Fields

i::Vector{Int32}
Bus number, or extended bus name enclosed in single quotes.

modsw::Vector{Int8}
Control mode:
- 0 - fixed
- 1 - discrete adjustment, controlling voltage locally or at bus swrem
- 2 - continuous adjustment, controlling voltage locally or at bus swrem
- 3 - discrete adjustment, controlling reactive power output of the plant at bus swrem
- 4 - discrete adjustment, controlling reactive power output of the VSC DC line converter
at bus swrem of the VSC DC line whose name is specified as rmidnt
- 5 - discrete adjustment, controlling admittance setting of the switched shunt at bus swrem
modsw = 1 by default.

adjm::Vector{Bool}
Adjustment method:
- 0 - steps and blocks are switched on in input order, and off in reverse input order; this adjustment method was the only method available prior to PSS®E-32.0.
- 1 - steps and blocks are switched on and off such that the next highest (or lowest, as appropriate) total admittance is achieved.
adjm = 0 by default.

stat::Vector{Bool}
Initial switched shunt status of one for in-service and zero for out-of-service. stat = 1 by default.

vswhi::Vector{Float64}
When modsw is 1 or 2, the controlled voltage upper limit; entered in pu. When modsw is 3, 4 or 5, the controlled reactive power range upper limit; entered in pu of the total reactive power range of the controlled voltage controlling device. vswhi is not used when modsw is 0. vswhi = 1.0 by default.

vswlo::Vector{Float64}
When modsw is 1 or 2, the controlled voltage lower limit; entered in pu. When modsw is 3, 4 or 5, the controlled reactive power range lower limit; entered in pu of the total reactive power range of the controlled voltage controlling device. vswlo is not used when modsw is 0. vswlo = 1.0 by default.

swrem::Vector{Int32}
Bus number, or extended bus name enclosed in single quotes, of the bus whose voltage or connected equipment reactive power output is controlled by this switched shunt.
- When modsw is 1 or 2, swrem is entered as 0 if the switched shunt is to regulate its own voltage;
otherwise, swrem specifies the remote type one or two bus whose voltage is to be regulated by this switched shunt.
- When modsw is 3, swrem specifies the type two or three bus whose plant reactive power output is to be regulated by this switched shunt.
Set swrem to "I" if the switched shunt and the plant which it controls are connected to the same bus.
- When modsw is 4, swrem specifies the converter bus of a VSC dc line whose converter reactive power output is to be regulated by this switched shunt.
Set swrem to "I" if the switched shunt and the VSC dc line converter which it controls are connected to the same bus.
- When modsw is 5, swrem specifies the remote bus to which the switched shunt whose admittance setting is to be regulated by this switched shunt is connected.
- swrem is not used when modsw is 0.
swrem = 0 by default.

rmpct::Vector{Float64}
Percent of the total Mvar required to hold the voltage at the bus controlled by bus I that are to be contributed by this switched shunt; rmpct must be positive.
rmpct is needed only if swrem specifies a valid remote bus and there is more than one local or remote voltage controlling device (plant, switched shunt, FACTS device shunt element, or VSC DC line converter) controlling the voltage at bus swrem to a setpoint, or swrem is zero but bus I is the controlled bus, local or remote, of one or more other setpoint mode voltage controlling devices. Only used if modsw = 1 or 2. rmpct = 100.0 by default.

rmidnt::Vector{InlineStrings.String15}
When modsw is 4, the name of the VSC DC line whose converter bus is specified in swrem. rmidnt is not used for other values of modsw. rmidnt is a blank name by default.

binit::Vector{Float64}
Initial switched shunt admittance; entered in Mvar at unity voltage. binit = 0.0 by default.

n1::Vector{Int32}
Number of steps for block i. The first zero value of Ni or Bi is interpreted as the end of the switched shunt blocks for bus I. ni = 0 by default.

b1::Vector{Float64}
Admittance increment for each of N_i steps in block i; entered in Mvar at unity voltage. bi = 0.0 by default.

n2::Vector{Int32}
b2::Vector{Float64}
n3::Vector{Int32}
b3::Vector{Float64}
n4::Vector{Int32}
b4::Vector{Float64}
n5::Vector{Int32}
b5::Vector{Float64}
n6::Vector{Int32}
b6::Vector{Float64}
n7::Vector{Int32}
b7::Vector{Float64}
n8::Vector{Int32}
b8::Vector{Float64}

source

Transformer Impedance Corrections

PowerFlowData.ImpedanceCorrections — Type

struct ImpedanceCorrections <: PowerFlowData.Records

Transformer impedance corrections are used to model a change of transformer impedance as off-nominal turns ratio or phase shift angle is adjusted.

The $T_i$ values on a transformer impedance correction record must all be either tap ratios or phase shift angles. They must be entered in strictly ascending order; i.e. for each $i$, $T_{i+1} > T_i$. Each $F_i$ entered must be greater than zero.

On each record, at least 2 pairs of values must be specified and up to 11 may be entered.

The $T_i$ values that are a function of tap ratio (rather than phase shift angle) are in units of the controlling winding’s off-nominal turns ratio in pu of the controlling winding’s bus base voltage.

Although a transformer winding is assigned to an impedance correction record, each record may be shared among many transformer windings. If the first $T$ in a record is less than 0.5 or the last $T$ entered is greater than 1.5, $T$ is assumed to be the phase shift angle and the impedance of each transformer winding assigned to the record is treated as a function of phase shift angle. Otherwise, the impedances of the transformer windings assigned to the record are made sensitive to off-nominal turns ratio.

Fields

i::Vector{Int16}
Impedance correction record number.
t1::Vector{Float64}
Either off-nominal turns ratio in pu or phase shift angle in degrees. ti = 0.0 by default.

f1::Vector{Float64}
Scaling factor by which transformer nominal impedance is to be multiplied to obtain the actual transformer impedance for the corresponding ti. fi = 0.0 by default.

t2::Vector{Float64}
f2::Vector{Float64}
t3::Vector{Float64}
f3::Vector{Float64}
t4::Vector{Float64}
f4::Vector{Float64}
t5::Vector{Float64}
f5::Vector{Float64}
t6::Vector{Float64}
f6::Vector{Float64}
t7::Vector{Float64}
f7::Vector{Float64}
t8::Vector{Float64}
f8::Vector{Float64}
t9::Vector{Float64}
f9::Vector{Float64}
t10::Vector{Float64}
f10::Vector{Float64}
t11::Vector{Float64}
f11::Vector{Float64}

source

Multi-Terminal DC Lines

PowerFlowData.MultiTerminalDCLines — Type

struct MultiTerminalDCLines{I<:DCLineID} <: PowerFlowData.Records

PSS/E allows the representation of up to 12 converter stations on one multi-terminal DC line. Further, it allows the modelling of multi-terminal networks of up to 20 buses including the AC convertor buses and the DC network buses.

Notes

The following are notes on multi-terminal links:

Conventional two-terminal and multi-terminal DC lines are stored separately. Therefore, there may simultaneously exist, for example, a two-terminal DC line identified as DC line number 1 along with a multi-terminal line numbered 1.
Multi-terminal lines should have at least three converter terminals; conventional DC lines consisting of two terminals should be modeled as two-terminal lines (see TwoTerminalDCLines.
AC converter buses may be type one, two, or three buses. Generators, loads, fixed and switched shunt elements, other DC line converters, and FACTS device sending ends are permitted at converter buses.
Each multi-terminal DC line is treated as a subnetwork of DC buses and DC links connecting its AC converter buses. For each multi-terminal DC line, the DC buses must be numbered 1 through ndcbs.
Each AC converter bus must be specified as ib on exactly one DC bus record; there may be DC buses connected only to other DC buses by DC links but not to any AC converter bus.
AC converter bus ib may be connected to a DC bus idc, which is connected directly to ground. ib is specified on the DC bus record for DC bus idc; the idc2 field is specified as zero.
Alternatively, AC converter bus ib may be connected to two DC buses idc and idc2, the second of which is connected to ground through a specified resistance. ib and idc2 are specified on the DC bus record for DC bus idc; on the DC bus record for bus idc2, the AC converter bus and second DC bus fields (ib and idc2, respectively) must be specified as zero and the grounding resistance is specified as rgrnd.
The same DC bus may be specified as the second DC bus for more than one AC converter bus.
All DC buses within a multi-terminal DC line must be reachable from any other point within the subnetwork.
The area number assigned to DC buses and the metered end designation of DC links are used in calculating area interchange and assigning losses as well as in the interchange control option of the power flow solution activities. Similarly, the zone assignment and metered end specification are used in Zonal reporting activities.

Fields

lines::Vector{MultiTerminalDCLine}

source

PowerFlowData.MultiTerminalDCLine — Type

struct MultiTerminalDCLine

Each multi-terminal DC line record defines the number of converters, number of DC buses and number of DC links as well as related bus numbers and control mode (see DCLineID), then data for:

each converter (see ACConverters)
each DC bus (see DCBuses)
each DC link (see DCLinks)

Fields

line_id::DCLineID
High-level data about this line.
converters::ACConverters
line.nconv converter records.
buses::DCBuses
line.ndcbs DC bus records.
links::DCLinks
line.ndcln DC link records.

source

PowerFlowData.DCLineID — Type

abstract type DCLineID <: PowerFlowData.IDRow

The DCLineID data record depends on the PSSE version:

See DCLineID30 for PSSE v30 files.
See DCLineID33 for PSSE v33 files.

source

PowerFlowData.DCLineID30 — Type

struct DCLineID30 <: DCLineID

Fields

i::Int16
Multi-terminal DC line number.
nconv::Int8
Number of AC converter station buses in multi-terminal DC line i. No default.
ndcbs::Int8
Number of DC buses in multi-terminal DC line i (nconv < ndcbs). No default.
ndcln::Int64
Number of DC links in multi-terminal DC line i. No default.
mdc::Int8
Control mode
- 0 - blocked
- 1 - power
- 2 - current
mdc = 0 by default.

vconv::Int32
Bus number, or extended bus name enclosed in single quotes, of the AC converter station bus that controls DC voltage on the positive pole of multi-terminal DC line i. Bus vconv must be a positive pole inverter. No default.

vcmod::Float64
Mode switch DC voltage; entered in kV. When any inverter DC voltage magnitude falls below this value and the line is in power control mode (i.e. mdc = 1), the line switches to current control mode with converter current setpoints corresponding to their desired powers at scheduled DC voltage. vcmod = 0.0 by default.

vconvn::Int32
Bus number, or extended bus name enclosed in single quotes, of the AC converter station bus that controls DC voltage on the negative pole of multi-terminal DC line i. If any negative pole converters are specified (see below), bus vconvn must be a negative pole inverter. If the negative pole is not being modeled, vconvn must be specified as zero. vconvn = 0 by default.

source

PowerFlowData.DCLineID33 — Type

struct DCLineID33 <: DCLineID

Fields

name::InlineStrings.String15
The non-blank alphanumeric identifier assigned to this DC line. Each multi-terminal DC line must have a unique name.name` may be up to twelve characters and may contain any combination of blanks, uppercase letters, numbers and special characters. name must be enclosed in single or double quotes if it contains any blanks or special characters. No default allowed.

nconv::Int8
Number of AC converter station buses in multi-terminal DC line i. No default.
ndcbs::Int8
Number of DC buses in multi-terminal DC line i (nconv < ndcbs). No default.
ndcln::Int64
Number of DC links in multi-terminal DC line i. No default.
mdc::Int8
Control mode
- 0 - blocked
- 1 - power
- 2 - current
mdc = 0 by default.

vconv::Int32
Bus number, or extended bus name enclosed in single quotes, of the AC converter station bus that controls DC voltage on the positive pole of multi-terminal DC line i. Bus vconv must be a positive pole inverter. No default.

vcmod::Float64
Mode switch DC voltage; entered in kV. When any inverter DC voltage magnitude falls below this value and the line is in power control mode (i.e. mdc = 1), the line switches to current control mode with converter current setpoints corresponding to their desired powers at scheduled DC voltage. vcmod = 0.0 by default.

vconvn::Int32
Bus number, or extended bus name enclosed in single quotes, of the AC converter station bus that controls DC voltage on the negative pole of multi-terminal DC line i. If any negative pole converters are specified (see below), bus vconvn must be a negative pole inverter. If the negative pole is not being modeled, vconvn must be specified as zero. vconvn = 0 by default.

source

PowerFlowData.ACConverters — Type

struct ACConverters <: PowerFlowData.Records

Fields

ib::Vector{Int32}
AC converter bus number, or extended bus name enclosed in single quotes. No default.

n::Vector{Int8}
Number of bridges in series. No default.
angmx::Vector{Float64}
Nominal maximum ALPHA or GAMMA angle; entered in degrees. No default.
angmn::Vector{Float64}
Minimum steady-state ALPHA or GAMMA angle; entered in degrees. No default.
rc::Vector{Float64}
Commutating resistance per bridge; entered in ohms. No default.
xc::Vector{Float64}
Commutating reactance per bridge; entered in ohms. No default.
ebas::Vector{Float64}
Primary base AC voltage; entered in kV. No default.
tr::Vector{Float64}
Actual transformer ratio. tr = 1.0 by default.
tap::Vector{Float64}
Tap setting. tap = 1.0 by default.
tpmx::Vector{Float64}
Maximum tap setting. tpmx = 1.5 by default.
tpmn::Vector{Float64}
Minimum tap setting. tpmx = 0.51 by default.
tstp::Vector{Float64}
Tap step; must be a positive number. tstp = 0.00625 by default.
setvl::Vector{Float64}
Converter setpoint. When ib is equal to vconv or vconvn, setvl specifies the scheduled DC voltage magnitude, entered in kV, across the converter. For other converter buses, setvl contains the converter current (amps) or power (MW) demand; a positive value of setvl indicates that bus ib is a rectifier, and a negative value indicates an inverter. No default.

dcpf::Vector{Float64}
Converter participation factor. When the order at any rectifier in the multi-terminal DC line is reduced, either to maximum current or margin, the orders at the remaining converters on the same pole are modified according to their $DCPF$s to: $SETVL + (DCPF/SUM)∗R$whereSUMis the sum of theDCPFs at the unconstrained converte rs on the same pole as the constrained rectifier, andRis the order reduction at the constrained rectifier.dcpf` = 1. by default.

marg::Vector{Float64}
Rectifier margin entered in per unit of desired DC power or current. The converter order reduced by this fraction, $(1.0 - MARG) ∗ SETVL$, defines the minimum order for this rectifier. marg is used only at rectifiers. marg = 0.0 by default.

cnvcod::Vector{Int8}
Converter code. A positive value or zero must be entered if the converter is on the positive pole of multi-terminal DC line i. A negative value must be entered for negative pole converters. cnvcod = 1 by default.

source

PowerFlowData.DCBuses — Type

struct DCBuses <: PowerFlowData.Records

Fields

idc::Vector{Int32}
DC bus number (1 to NDCBS). The DC buses are used internally within each multi-terminal DC line and must be numbered 1 through ndcbs. no default.

ib::Vector{Int32}
AC converter bus number, or extended bus name enclosed in single quotes, or zero. Each converter station bus specified in a converter record must be specified as ib in exactly one DC bus record. DC buses that are connected only to other DC buses by DC links and not to any AC converter buses must have a zero specified for ib. A DC bus specified as idc2 on one or more other DC bus records must have a zero specified for ib on its own DC bus record. ib = 0 by default.

ia::Vector{Int16}
Area number (1 through the maximum number of areas at the current size level). ia = 1 by default.

zone::Vector{Int16}
Zone number (1 through the maximum number of zones at the current size level). zone = 1 by default.

name::Vector{InlineStrings.String15}
Alphanumeric identifier assigned to DC bus idc. The name may be up to twelve characters and must be enclosed in single quotes. name may contain any combination of blanks, uppercase letters, numbers, and special characters. name is twelve blanks by default.

idc2::Vector{Int32}
rgrnd::Vector{Float64}
Second DC bus to which converter ib is connected, or zero if the converter is connected directly to ground.
- For voltage controlling converters, this is the DC bus with the lower DC voltage magnitude and setvl specifies the voltage difference between buses idc and idc2.
- For rectifiers, DC buses should be specified such that power flows from bus idc2 to bus idc.
- For inverters, DC buses should be specified such that power flows from bus idc to bus idc2.
idc2 is ignored on those dc bus records that have ib specified as zero. idc2 = 0 by default.

owner::Vector{Int16}
Owner number (1 through the maximum number of owners at the current size level). owner = 1 by default.

source

PowerFlowData.DCLinks — Type

struct DCLinks <: PowerFlowData.Records

Fields

idc::Vector{Int32}
Branch "from bus" DC bus number.
jdc::Vector{Int32}
Branch "to bus" DC bus number. jdc is entered as a negative number to designate it as the metered end for area and zone interchange calculations. Otherwise, bus idc is assumed to be the metered end.

dcckt::Vector{InlineStrings.String1}
One-character uppercase alphanumeric branch circuit identifier. It is recommended that single circuit branches be designated as having the circuit identifier "1". dcckt = "1" by default.

rdc::Vector{Float64}
DC link resistance, entered in ohms. No default.
ldc::Vector{Float64}
DC link inductance, entered in mH. ldc is not used by the power flow solution activities but is available to multi-terminal DC line dynamics models. ldc = 0.0 by default.

source

Multi-Section Line Groups

PowerFlowData.MultiSectionLineGroups — Type

abstract type MultiSectionLineGroups <: PowerFlowData.Records

The MultiSectionLineGroups data record depends on the PSSE version:

See MultiSectionLineGroups30 for PSSE v30 files.
See MultiSectionLineGroups33 for PSSE v33 files.

source

PowerFlowData.MultiSectionLineGroups30 — Type

struct MultiSectionLineGroups30 <: MultiSectionLineGroups

Multi-section line groups.

Transmission lines commonly have a series of sections with varying physical structures. The section might have different tower configurations, conductor types and bundles or various combinations of these. The physical differences can result in the sections having different resistance, reactance and charging.

A transmission line with several distinct sections can be represented as one multi-section line group.

The DUM_i values on each record define the branches connecting bus i to bus j, and are entered so as to trace the path from bus i to bus j.

Example

For a multi-section line grouping consisting of three line sections (and hence two dummy buses):

From	To	Circuit
I	D1	C1
D1	D2	C2
D2	J	C3

If this multi-section line grouping is to be assigned the line identifier id "&1", the corresponding multi-section line grouping data record is given by:

I, J, '&1', D1, D2

Or in v33 (and if I is the metered end):

I, J, '&1', 1, D1, D2

Notes

The following notes apply to multi-section line groups:

Up to 10 line sections (and hence 9 dummy buses) may be defined in each multi-section line grouping.

A branch may be a line section of at most one multi-section line grouping.

Each dummy bus must have exactly two branches connected to it,

both of which must be members of the same multi-section line grouping. A multi-section line dummy bus may not be a converter bus of a DC transmission line. A FACTS control device may not be connected to a multi-section line dummy bus.

The status of line sections and type codes of dummy buses are set such that the multi-section

line is treated as a single entity with regards to its service status.

Fields

i::Vector{Int32}
"From bus" number, or extended bus name enclosed in single quotes.
j::Vector{Int32}
"To bus" number, or extended bus name enclosed in single quotes. j is entered as a negative number or with a minus sign before the first character of the extended bus name to designate it as the metered end; otherwise, bus i is assumed to be the metered end.

id::Vector{InlineStrings.String3}
Two-character upper-case alphanumeric multi-section line grouping identifier. The first character must be an ampersand ("&"). id = "&1" by default.

dum1::Vector{Int32}
Bus numbers, or extended bus names enclosed in single quotes, of the dummy buses connected by the branches that comprise this multi-section line grouping. No defaults.

dum2::Vector{Union{Missing, Int32}}
dum3::Vector{Union{Missing, Int32}}
dum4::Vector{Union{Missing, Int32}}
dum5::Vector{Union{Missing, Int32}}
dum6::Vector{Union{Missing, Int32}}
dum7::Vector{Union{Missing, Int32}}
dum8::Vector{Union{Missing, Int32}}
dum9::Vector{Union{Missing, Int32}}

source

PowerFlowData.MultiSectionLineGroups33 — Type

struct MultiSectionLineGroups33 <: MultiSectionLineGroups

Multi-section line groups.

A transmission line with several distinct sections can be represented as one multi-section line group.

The DUM_i values on each record define the branches connecting bus i to bus j, and are entered so as to trace the path from bus i to bus j.

Example

For a multi-section line grouping consisting of three line sections (and hence two dummy buses):

From	To	Circuit
I	D1	C1
D1	D2	C2
D2	J	C3

If this multi-section line grouping is to be assigned the line identifier id "&1", the corresponding multi-section line grouping data record is given by:

I, J, '&1', D1, D2

Or in v33 (and if I is the metered end):

I, J, '&1', 1, D1, D2

Notes

The following notes apply to multi-section line groups:

Up to 10 line sections (and hence 9 dummy buses) may be defined in each multi-section line grouping.

A branch may be a line section of at most one multi-section line grouping.

Each dummy bus must have exactly two branches connected to it,

The status of line sections and type codes of dummy buses are set such that the multi-section

line is treated as a single entity with regards to its service status.

Fields

i::Vector{Int32}
"From bus" number, or extended bus name enclosed in single quotes.
j::Vector{Int32}
"To bus" number, or extended bus name enclosed in single quotes. j is entered as a negative number or with a minus sign before the first character of the extended bus name to designate it as the metered end; otherwise, bus i is assumed to be the metered end.

id::Vector{InlineStrings.String3}
Two-character upper-case alphanumeric multi-section line grouping identifier. The first character must be an ampersand ("&"). id = "&1" by default.

met::Vector{Int8}
Metered end flag.
- ≤1 to designate bus i as the metered end.
- ≥2 to designate bus j as the metered end.
met = 1 by default.

dum1::Vector{Int32}
Bus numbers, or extended bus names enclosed in single quotes, of the dummy buses connected by the branches that comprise this multi-section line grouping. No defaults.

dum2::Vector{Union{Missing, Int32}}
dum3::Vector{Union{Missing, Int32}}
dum4::Vector{Union{Missing, Int32}}
dum5::Vector{Union{Missing, Int32}}
dum6::Vector{Union{Missing, Int32}}
dum7::Vector{Union{Missing, Int32}}
dum8::Vector{Union{Missing, Int32}}
dum9::Vector{Union{Missing, Int32}}

source

Zones

PowerFlowData.Zones — Type

struct Zones <: PowerFlowData.Records

All buses (AC and DC) and loads can be assigned to reside in a zone of the network. To enable this facility, each zone should be assigned a name and number. Specifically, the zone number is entered as part of the data records for the Buses and Loads. The use of zones enables the user to develop reports and to check results on the basis of zones and, consequently be highly specific when reporting and interpreting analytical results.

Fields

i::Vector{Int16}
Zone number (1 through the maximum number of zones at the current size level)
zoname::Vector{InlineStrings.String15}
Alphanumeric identifier assigned to zone i. The name may contain up to twelve characters and must be enclosed in single quotes. zoname may be any combination of blanks, uppercase letters, numbers, and special characters. zoname is set to twelve blanks by default.

source

Inter-Area Transfers

PowerFlowData.InterAreaTransfers — Type

struct InterAreaTransfers <: PowerFlowData.Records

Using PSS/E, the user has the capability to identify in which area each bus or load resides. Further, the user can schedule active power transfers between pairs of areas.

See AreaInterchanges for desired net interchange.

Fields

arfrom::Vector{Int16}
"From area" number (1 through the maximum number of areas at the current size level).
arto::Vector{Int16}
"To area" number (1 through the maximum number of areas at the current size level).
trid::Vector{InlineStrings.String1}
Single-character (0 through 9 or A through Z) upper-case interarea transfer identifier used to distinguish among multiple transfers between areas arfrom and arto. trid = "1" by default.

ptran::Vector{Float64}
MW comprising this transfer. A positive ptran indicates that area arfrom is selling to area arto. ptran = 0.0 by default.

source

Owners

PowerFlowData.Owners — Type

struct Owners <: PowerFlowData.Records

PSS/E allows the user to identify which organization or utility actually owns a facility, a piece of equipment, or a load. Major network elements can have up to four different owners. This facilitates interpretation of results and reporting of results on the basis of ownership.

# Fields

i::Vector{Int16}
Owner number (1 through the maximum number of owners at the current size level).
owname::Vector{InlineStrings.String15}
Alphanumeric identifier assigned to owner i. The name may contain up to twelve characters and must be enclosed in single quotes. owname may be any combination of blanks, uppercase letters, numbers, and special characters. owname is set to twelve blanks by default.

source

FACTS Devices

PowerFlowData.FACTSDevices — Type

abstract type FACTSDevices <: PowerFlowData.Records

The FACTSDevices data record depends on the PSSE version:

See FACTSDevices30 for PSSE v30 files.
See FACTSDevices33 for PSSE v33 files.

source

PowerFlowData.FACTSDevices30 — Type

struct FACTSDevices30 <: FACTSDevices

Flexible AC Transmission System devices.

There is a multiplicity of Flexible AC Transmission System devices currently available comprising shunt devices, such as the Static Compensator (STATCOM), series devices such as the Static Synchronous Series Compensator (SSSC), combined devices such as the Unified Power Flow Controller (UPFC) and the Interline Power Flow Controllers (IPFC), of which the latter are parallel series devices.

Fields

n::Vector{Int16}
FACTS device number.
i::Vector{Int32}
Sending end bus number, or extended bus name enclosed in single quotes. No default.

j::Vector{Int32}
Terminal end bus number, or extended bus name enclosed in single quotes. 0 for a STATCON. j = 0 by default.

mode::Vector{Int8}
Control mode:
- 0 - out-of-service (i.e., series and shunt links open).
- 1 - series and shunt links operating.
- 2 - series link bypassed (i.e., like a zero impedance line) and shunt link operating as a STATCON.
- 3 - series and shunt links operating with series link at constant series impedance.
- 4 - series and shunt links operating with series link at constant series voltage.
- 5 - master device of an IPFC with P and Q setpoints specified; FACTS device N+1 must be the slave device (i.e., its mode is 6 or 8) of this IPFC.
- 6 - slave device of an IPFC with P and Q setpoints specified; FACTS device N-1 must be the master device (i.e., its mode is 5 or 7) of this IPFC. The Q setpoint is ignored as the master device dictates the active power exchanged between the two devices.
- 7 - master device of an IPFC with constant series voltage setpoints specified; FACTS device N+1 must be the slave device (i.e., its mode is 6 or 8) of this IPFC.
- 8 - slave device of an IPFC with constant series voltage setpoints specified; FACTS device N-1 must be the master device (i.e., its mode is 5 or 7) of this IPFC. The complex $V_d + j V_q$ setpoint is modified during power flow solutions to reflect the active power exchange determined by the master device.
If j is specified as 0, mode must be either 0 or 1. mode = 1 by default.

pdes::Vector{Float64}
Desired active power flow arriving at the terminal end bus; entered in MW. pdes = 0.0 by default.

qdes::Vector{Float64}
Desired reactive power flow arriving at the terminal end bus; entered in MVAR. qdes = 0.0 by default.

vset::Vector{Float64}
Voltage setpoint at the sending end bus; entered in pu. vset = 1.0 by default.
shmx::Vector{Float64}
Maximum shunt current at the sending end bus; entered in MVA at unity voltage. shmx = 9999.0 by default.

trmx::Vector{Float64}
Maximum bridge active power transfer; entered in MW. trmx = 9999.0 by default.
vtmn::Vector{Float64}
Minimum voltage at the terminal end bus; entered in pu. vtmn = 0.9 by default.
vtmx::Vector{Float64}
Maximum voltage at the terminal end bus; entered in pu. vtmx = 1.1 by default.
vsmx::Vector{Float64}
Maximum series voltage; entered in pu. vsmx = 1.0 by default.
imx::Vector{Float64}
Maximum series current, or zero for no series current limit; entered in MVA at unity voltage. imx = 0.0 by default.

linx::Vector{Float64}
Reactance of the dummy series element used during model solution; entered in pu. linx = 0.05 by default.

rmpct::Vector{Float64}
Percent of the total Mvar required to hold the voltage at bus i that are to be contributed by the shunt element of this FACTS device; rmpct must be positive. rmpct is needed only if there is more than one local or remote voltage controlling device (plant, switched shunt, FACTS device shunt element, or VSC dc line converter) controlling the voltage at bus i to a setpoint. rmpct = 100.0 by default.

owner::Vector{Int16}
Owner number (1 through the maximum number of owners at the current size level). owner = 1 by default.

set1::Vector{Float64}
If mode is 3, resistance and reactance respectively of the constant impedance, entered in pu; if mode is 4, the magnitude (in pu) and angle (in degrees) of the constant series voltage with respect to the quantity indicated by vsref; if mode is 7 or 8, the real (vd) and imaginary (vq) components (in pu) of the constant series voltage with respect to the quantity indicated by vsref; for other values of mode, set1 and set2 are read, but not saved or used during power flow solutions. set1 = 0.0 by default.

set2::Vector{Float64}
See set1. set2 = 0.0 by default.
vsref::Vector{Int8}
Series voltage reference code to indicate the series voltage reference of set1 and set2 when mode is 4, 7 or 8: 0 for sending end voltage, 1 for series current. vsref = 0 by default.

source

PowerFlowData.FACTSDevices33 — Type

struct FACTSDevices33 <: FACTSDevices

Flexible AC Transmission System devices.

Fields

name::Vector{InlineStrings.String15}
The non-blank alphanumeric identifier assigned to this FACTS device. Each FACTS device must have a unique name.name` may be up to twelve characters and may contain any combination of blanks, uppercase letters, numbers and special characters. name must be enclosed in single or double quotes if it contains any blanks or special characters. No default allowed.

i::Vector{Int32}
Sending end bus number, or extended bus name enclosed in single quotes. No default.

j::Vector{Int32}
Terminal end bus number, or extended bus name enclosed in single quotes. 0 for a STATCON. j = 0 by default.

mode::Vector{Int8}
Control mode:
- 0 - out-of-service (i.e., series and shunt links open).
- 1 - series and shunt links operating.
- 2 - series link bypassed (i.e., like a zero impedance line) and shunt link operating as a STATCON.
- 3 - series and shunt links operating with series link at constant series impedance.
- 4 - series and shunt links operating with series link at constant series voltage.
- 5 - master device of an IPFC with P and Q setpoints specified; FACTS device N+1 must be the slave device (i.e., its mode is 6 or 8) of this IPFC.
- 6 - slave device of an IPFC with P and Q setpoints specified; FACTS device N-1 must be the master device (i.e., its mode is 5 or 7) of this IPFC. The Q setpoint is ignored as the master device dictates the active power exchanged between the two devices.
- 7 - master device of an IPFC with constant series voltage setpoints specified; FACTS device N+1 must be the slave device (i.e., its mode is 6 or 8) of this IPFC.
- 8 - slave device of an IPFC with constant series voltage setpoints specified; FACTS device N-1 must be the master device (i.e., its mode is 5 or 7) of this IPFC. The complex $V_d + j V_q$ setpoint is modified during power flow solutions to reflect the active power exchange determined by the master device.
If j is specified as 0, mode must be either 0 or 1. mode = 1 by default.

pdes::Vector{Float64}
Desired active power flow arriving at the terminal end bus; entered in MW. pdes = 0.0 by default.

qdes::Vector{Float64}
Desired reactive power flow arriving at the terminal end bus; entered in MVAR. qdes = 0.0 by default.

vset::Vector{Float64}
Voltage setpoint at the sending end bus; entered in pu. vset = 1.0 by default.
shmx::Vector{Float64}
Maximum shunt current at the sending end bus; entered in MVA at unity voltage. shmx = 9999.0 by default.

trmx::Vector{Float64}
Maximum bridge active power transfer; entered in MW. trmx = 9999.0 by default.
vtmn::Vector{Float64}
Minimum voltage at the terminal end bus; entered in pu. vtmn = 0.9 by default.
vtmx::Vector{Float64}
Maximum voltage at the terminal end bus; entered in pu. vtmx = 1.1 by default.
vsmx::Vector{Float64}
Maximum series voltage; entered in pu. vsmx = 1.0 by default.
imx::Vector{Float64}
Maximum series current, or zero for no series current limit; entered in MVA at unity voltage. imx = 0.0 by default.

linx::Vector{Float64}
Reactance of the dummy series element used during model solution; entered in pu. linx = 0.05 by default.

rmpct::Vector{Float64}
Percent of the total Mvar required to hold the voltage at bus i that are to be contributed by the shunt element of this FACTS device; rmpct must be positive. rmpct is needed only if there is more than one local or remote voltage controlling device (plant, switched shunt, FACTS device shunt element, or VSC dc line converter) controlling the voltage at bus i to a setpoint. rmpct = 100.0 by default.

owner::Vector{Int16}
Owner number (1 through the maximum number of owners at the current size level). owner = 1 by default.

set1::Vector{Float64}
If mode is 3, resistance and reactance respectively of the constant impedance, entered in pu; if mode is 4, the magnitude (in pu) and angle (in degrees) of the constant series voltage with respect to the quantity indicated by vsref; if mode is 7 or 8, the real (vd) and imaginary (vq) components (in pu) of the constant series voltage with respect to the quantity indicated by vsref; for other values of mode, set1 and set2 are read, but not saved or used during power flow solutions. set1 = 0.0 by default.

set2::Vector{Float64}
See set1. set2 = 0.0 by default.
vsref::Vector{Int8}
Series voltage reference code to indicate the series voltage reference of set1 and set2 when mode is 4, 7 or 8: 0 for sending end voltage, 1 for series current. vsref = 0 by default.

remot::Vector{Int32}
Bus number, or extended bus name enclosed in single quotes, of a remote Type 1 or 2 bus where voltage is to be regulated by the shunt element of this FACTS device to the value specified by vset. if bus remot is other than a type 1 or 2 bus, the shunt element regulates voltage at the sending end bus to the value specified by vset. remot is entered as zero if the shunt element is to regulate voltage at the sending end bus and must be zero if the sending end bus is a type 3 (swing) bus. remot = 0 by default.

mname::Vector{InlineStrings.String15}
The name of the FACTS device that is the IPFC master device when this FACTS device is the "slave" device of an IPFC (i.e., its mode is specified as 6 or 8). mname must be enclosed in single or double quotes if it contains any blanks or special characters. mname is blank by default.

source