Description of idx

IDX_BRCH   Defines constants for named column indices to branch matrix.
   Example:

   [F_BUS, T_BUS, BR_R, BR_X, BR_B, RATE_A, RATE_B, RATE_C, ...
   TAP, SHIFT, BR_STATUS, PF, QF, PT, QT, MU_SF, MU_ST, ...
   ANGMIN, ANGMAX, MU_ANGMIN, MU_ANGMAX] = idx_brch;

   Some examples of usage, after defining the constants using the line above,
   are:

    branch(4, BR_STATUS) = 0;              % take branch 4 out of service
    Ploss = branch(:, PF) + branch(:, PT); % compute real power loss vector
 
   The index, name and meaning of each column of the branch matrix is given
   below:

   columns 1-11 must be included in input matrix (in case file)
    1  F_BUS       f, from bus number
    2  T_BUS       t, to bus number
    3  BR_R        r, resistance (p.u.)
    4  BR_X        x, reactance (p.u.)
    5  BR_B        b, total line charging susceptance (p.u.)
    6  RATE_A      rateA, MVA rating A (long term rating)
    7  RATE_B      rateB, MVA rating B (short term rating)
    8  RATE_C      rateC, MVA rating C (emergency rating)
    9  TAP         ratio, transformer off nominal turns ratio
    10 SHIFT       angle, transformer phase shift angle (degrees)
    11 BR_STATUS   initial branch status, 1 - in service, 0 - out of service
    12 ANGMIN      minimum angle difference, angle(Vf) - angle(Vt) (degrees)
    13 ANGMAX      maximum angle difference, angle(Vf) - angle(Vt) (degrees)
                   (The voltage angle difference is taken to be unbounded below
                    if ANGMIN < -360 and unbounded above if ANGMAX > 360.
                    If both parameters are zero, it is unconstrained.)

   columns 14-17 are added to matrix after power flow or OPF solution
   they are typically not present in the input matrix
    14 PF          real power injected at "from" bus end (MW)
    15 QF          reactive power injected at "from" bus end (MVAr)
    16 PT          real power injected at "to" bus end (MW)
    17 QT          reactive power injected at "to" bus end (MVAr)

   columns 18-21 are added to matrix after OPF solution
   they are typically not present in the input matrix
                   (assume OPF objective function has units, u)
    18 MU_SF       Kuhn-Tucker multiplier on MVA limit at "from" bus (u/MVA)
    19 MU_ST       Kuhn-Tucker multiplier on MVA limit at "to" bus (u/MVA)
    20 MU_ANGMIN   Kuhn-Tucker multiplier lower angle difference limit (u/degree)
    21 MU_ANGMAX   Kuhn-Tucker multiplier upper angle difference limit (u/degree)

   See also DEFINE_CONSTANTS.

0001 function [F_BUS, T_BUS, BR_R, BR_X, BR_B, RATE_A, RATE_B, ...
0002     RATE_C, TAP, SHIFT, BR_STATUS, PF, QF, PT, QT, MU_SF, MU_ST, ...
0003     ANGMIN, ANGMAX, MU_ANGMIN, MU_ANGMAX] = idx_brch
0004 %IDX_BRCH   Defines constants for named column indices to branch matrix.
0005 %   Example:
0006 %
0007 %   [F_BUS, T_BUS, BR_R, BR_X, BR_B, RATE_A, RATE_B, RATE_C, ...
0008 %   TAP, SHIFT, BR_STATUS, PF, QF, PT, QT, MU_SF, MU_ST, ...
0009 %   ANGMIN, ANGMAX, MU_ANGMIN, MU_ANGMAX] = idx_brch;
0010 %
0011 %   Some examples of usage, after defining the constants using the line above,
0012 %   are:
0013 %
0014 %    branch(4, BR_STATUS) = 0;              % take branch 4 out of service
0015 %    Ploss = branch(:, PF) + branch(:, PT); % compute real power loss vector
0016 %
0017 %   The index, name and meaning of each column of the branch matrix is given
0018 %   below:
0019 %
0020 %   columns 1-11 must be included in input matrix (in case file)
0021 %    1  F_BUS       f, from bus number
0022 %    2  T_BUS       t, to bus number
0023 %    3  BR_R        r, resistance (p.u.)
0024 %    4  BR_X        x, reactance (p.u.)
0025 %    5  BR_B        b, total line charging susceptance (p.u.)
0026 %    6  RATE_A      rateA, MVA rating A (long term rating)
0027 %    7  RATE_B      rateB, MVA rating B (short term rating)
0028 %    8  RATE_C      rateC, MVA rating C (emergency rating)
0029 %    9  TAP         ratio, transformer off nominal turns ratio
0030 %    10 SHIFT       angle, transformer phase shift angle (degrees)
0031 %    11 BR_STATUS   initial branch status, 1 - in service, 0 - out of service
0032 %    12 ANGMIN      minimum angle difference, angle(Vf) - angle(Vt) (degrees)
0033 %    13 ANGMAX      maximum angle difference, angle(Vf) - angle(Vt) (degrees)
0034 %                   (The voltage angle difference is taken to be unbounded below
0035 %                    if ANGMIN < -360 and unbounded above if ANGMAX > 360.
0036 %                    If both parameters are zero, it is unconstrained.)
0037 %
0038 %   columns 14-17 are added to matrix after power flow or OPF solution
0039 %   they are typically not present in the input matrix
0040 %    14 PF          real power injected at "from" bus end (MW)
0041 %    15 QF          reactive power injected at "from" bus end (MVAr)
0042 %    16 PT          real power injected at "to" bus end (MW)
0043 %    17 QT          reactive power injected at "to" bus end (MVAr)
0044 %
0045 %   columns 18-21 are added to matrix after OPF solution
0046 %   they are typically not present in the input matrix
0047 %                   (assume OPF objective function has units, u)
0048 %    18 MU_SF       Kuhn-Tucker multiplier on MVA limit at "from" bus (u/MVA)
0049 %    19 MU_ST       Kuhn-Tucker multiplier on MVA limit at "to" bus (u/MVA)
0050 %    20 MU_ANGMIN   Kuhn-Tucker multiplier lower angle difference limit (u/degree)
0051 %    21 MU_ANGMAX   Kuhn-Tucker multiplier upper angle difference limit (u/degree)
0052 %
0053 %   See also DEFINE_CONSTANTS.
0054 
0055 %   MATPOWER
0056 %   Copyright (c) 1996-2015 by Power System Engineering Research Center (PSERC)
0057 %   by Ray Zimmerman, PSERC Cornell
0058 %
0059 %   $Id: idx_brch.m 2644 2015-03-11 19:34:22Z ray $
0060 %
0061 %   This file is part of MATPOWER.
0062 %   Covered by the 3-clause BSD License (see LICENSE file for details).
0063 %   See http://www.pserc.cornell.edu/matpower/ for more info.
0064 
0065 %% define the indices
0066 F_BUS       = 1;    %% f, from bus number
0067 T_BUS       = 2;    %% t, to bus number
0068 BR_R        = 3;    %% r, resistance (p.u.)
0069 BR_X        = 4;    %% x, reactance (p.u.)
0070 BR_B        = 5;    %% b, total line charging susceptance (p.u.)
0071 RATE_A      = 6;    %% rateA, MVA rating A (long term rating)
0072 RATE_B      = 7;    %% rateB, MVA rating B (short term rating)
0073 RATE_C      = 8;    %% rateC, MVA rating C (emergency rating)
0074 TAP         = 9;    %% ratio, transformer off nominal turns ratio
0075 SHIFT       = 10;   %% angle, transformer phase shift angle (degrees)
0076 BR_STATUS   = 11;   %% initial branch status, 1 - in service, 0 - out of service
0077 ANGMIN      = 12;   %% minimum angle difference, angle(Vf) - angle(Vt) (degrees)
0078 ANGMAX      = 13;   %% maximum angle difference, angle(Vf) - angle(Vt) (degrees)
0079 
0080 %% included in power flow solution, not necessarily in input
0081 PF          = 14;   %% real power injected at "from" bus end (MW)       (not in PTI format)
0082 QF          = 15;   %% reactive power injected at "from" bus end (MVAr) (not in PTI format)
0083 PT          = 16;   %% real power injected at "to" bus end (MW)         (not in PTI format)
0084 QT          = 17;   %% reactive power injected at "to" bus end (MVAr)   (not in PTI format)
0085 
0086 %% included in opf solution, not necessarily in input
0087 %% assume objective function has units, u
0088 MU_SF       = 18;   %% Kuhn-Tucker multiplier on MVA limit at "from" bus (u/MVA)
0089 MU_ST       = 19;   %% Kuhn-Tucker multiplier on MVA limit at "to" bus (u/MVA)
0090 MU_ANGMIN   = 20;   %% Kuhn-Tucker multiplier lower angle difference limit (u/degree)
0091 MU_ANGMAX   = 21;   %% Kuhn-Tucker multiplier upper angle difference limit (u/degree)

idx_brch

PURPOSE

SYNOPSIS

DESCRIPTION

CROSS-REFERENCE INFORMATION

SOURCE CODE