idx_bus

IDX_BUS   Defines constants for named column indices to bus matrix.
   Example:

   [PQ, PV, REF, NONE, BUS_I, BUS_TYPE, PD, QD, GS, BS, BUS_AREA, VM, ...
   VA, BASE_KV, ZONE, VMAX, VMIN, LAM_P, LAM_Q, MU_VMAX, MU_VMIN] = idx_bus;

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

    Pd = bus(4, PD);       % get the real power demand at bus 4
    bus(:, VMIN) = 0.95;   % set the min voltage magnitude to 0.95 at all buses
 
   The index, name and meaning of each column of the bus matrix is given
   below:

   columns 1-13 must be included in input matrix (in case file)
    1  BUS_I       bus number (positive integer)
    2  BUS_TYPE    bus type (1 = PQ, 2 = PV, 3 = ref, 4 = isolated)
    3  PD          Pd, real power demand (MW)
    4  QD          Qd, reactive power demand (MVAr)
    5  GS          Gs, shunt conductance (MW demanded at V = 1.0 p.u.)
    6  BS          Bs, shunt susceptance (MVAr injected at V = 1.0 p.u.)
    7  BUS_AREA    area number, (positive integer)
    8  VM          Vm, voltage magnitude (p.u.)
    9  VA          Va, voltage angle (degrees)
    10 BASE_KV     baseKV, base voltage (kV)
    11 ZONE        zone, loss zone (positive integer)
    12 VMAX        maxVm, maximum voltage magnitude (p.u.)
    13 VMIN        minVm, minimum voltage magnitude (p.u.)
   
   columns 14-17 are added to matrix after OPF solution
   they are typically not present in the input matrix
                   (assume OPF objective function has units, u)
    14 LAM_P       Lagrange multiplier on real power mismatch (u/MW)
    15 LAM_Q       Lagrange multiplier on reactive power mismatch (u/MVAr)
    16 MU_VMAX     Kuhn-Tucker multiplier on upper voltage limit (u/p.u.)
    17 MU_VMIN     Kuhn-Tucker multiplier on lower voltage limit (u/p.u.)
 
   additional constants, used to assign/compare values in the BUS_TYPE column
    1  PQ    PQ bus
    2  PV    PV bus
    3  REF   reference bus
    4  NONE  isolated bus

   See also DEFINE_CONSTANTS.

0001 function [PQ, PV, REF, NONE, BUS_I, BUS_TYPE, PD, QD, GS, BS, BUS_AREA, VM, ...
0002     VA, BASE_KV, ZONE, VMAX, VMIN, LAM_P, LAM_Q, MU_VMAX, MU_VMIN] = idx_bus
0003 %IDX_BUS   Defines constants for named column indices to bus matrix.
0004 %   Example:
0005 %
0006 %   [PQ, PV, REF, NONE, BUS_I, BUS_TYPE, PD, QD, GS, BS, BUS_AREA, VM, ...
0007 %   VA, BASE_KV, ZONE, VMAX, VMIN, LAM_P, LAM_Q, MU_VMAX, MU_VMIN] = idx_bus;
0008 %
0009 %   Some examples of usage, after defining the constants using the line above,
0010 %   are:
0011 %
0012 %    Pd = bus(4, PD);       % get the real power demand at bus 4
0013 %    bus(:, VMIN) = 0.95;   % set the min voltage magnitude to 0.95 at all buses
0014 %
0015 %   The index, name and meaning of each column of the bus matrix is given
0016 %   below:
0017 %
0018 %   columns 1-13 must be included in input matrix (in case file)
0019 %    1  BUS_I       bus number (positive integer)
0020 %    2  BUS_TYPE    bus type (1 = PQ, 2 = PV, 3 = ref, 4 = isolated)
0021 %    3  PD          Pd, real power demand (MW)
0022 %    4  QD          Qd, reactive power demand (MVAr)
0023 %    5  GS          Gs, shunt conductance (MW demanded at V = 1.0 p.u.)
0024 %    6  BS          Bs, shunt susceptance (MVAr injected at V = 1.0 p.u.)
0025 %    7  BUS_AREA    area number, (positive integer)
0026 %    8  VM          Vm, voltage magnitude (p.u.)
0027 %    9  VA          Va, voltage angle (degrees)
0028 %    10 BASE_KV     baseKV, base voltage (kV)
0029 %    11 ZONE        zone, loss zone (positive integer)
0030 %    12 VMAX        maxVm, maximum voltage magnitude (p.u.)
0031 %    13 VMIN        minVm, minimum voltage magnitude (p.u.)
0032 %
0033 %   columns 14-17 are added to matrix after OPF solution
0034 %   they are typically not present in the input matrix
0035 %                   (assume OPF objective function has units, u)
0036 %    14 LAM_P       Lagrange multiplier on real power mismatch (u/MW)
0037 %    15 LAM_Q       Lagrange multiplier on reactive power mismatch (u/MVAr)
0038 %    16 MU_VMAX     Kuhn-Tucker multiplier on upper voltage limit (u/p.u.)
0039 %    17 MU_VMIN     Kuhn-Tucker multiplier on lower voltage limit (u/p.u.)
0040 %
0041 %   additional constants, used to assign/compare values in the BUS_TYPE column
0042 %    1  PQ    PQ bus
0043 %    2  PV    PV bus
0044 %    3  REF   reference bus
0045 %    4  NONE  isolated bus
0046 %
0047 %   See also DEFINE_CONSTANTS.
0048 
0049 %   MATPOWER
0050 %   Copyright (c) 1996-2015 by Power System Engineering Research Center (PSERC)
0051 %   by Ray Zimmerman, PSERC Cornell
0052 %
0053 %   $Id: idx_bus.m 2644 2015-03-11 19:34:22Z ray $
0054 %
0055 %   This file is part of MATPOWER.
0056 %   Covered by the 3-clause BSD License (see LICENSE file for details).
0057 %   See http://www.pserc.cornell.edu/matpower/ for more info.
0058 
0059 %% define bus types
0060 PQ      = 1;
0061 PV      = 2;
0062 REF     = 3;
0063 NONE    = 4;
0064 
0065 %% define the indices
0066 BUS_I       = 1;    %% bus number (1 to 29997)
0067 BUS_TYPE    = 2;    %% bus type (1 - PQ bus, 2 - PV bus, 3 - reference bus, 4 - isolated bus)
0068 PD          = 3;    %% Pd, real power demand (MW)
0069 QD          = 4;    %% Qd, reactive power demand (MVAr)
0070 GS          = 5;    %% Gs, shunt conductance (MW at V = 1.0 p.u.)
0071 BS          = 6;    %% Bs, shunt susceptance (MVAr at V = 1.0 p.u.)
0072 BUS_AREA    = 7;    %% area number, 1-100
0073 VM          = 8;    %% Vm, voltage magnitude (p.u.)
0074 VA          = 9;    %% Va, voltage angle (degrees)
0075 BASE_KV     = 10;   %% baseKV, base voltage (kV)
0076 ZONE        = 11;   %% zone, loss zone (1-999)
0077 VMAX        = 12;   %% maxVm, maximum voltage magnitude (p.u.)      (not in PTI format)
0078 VMIN        = 13;   %% minVm, minimum voltage magnitude (p.u.)      (not in PTI format)
0079 
0080 %% included in opf solution, not necessarily in input
0081 %% assume objective function has units, u
0082 LAM_P       = 14;   %% Lagrange multiplier on real power mismatch (u/MW)
0083 LAM_Q       = 15;   %% Lagrange multiplier on reactive power mismatch (u/MVAr)
0084 MU_VMAX     = 16;   %% Kuhn-Tucker multiplier on upper voltage limit (u/p.u.)
0085 MU_VMIN     = 17;   %% Kuhn-Tucker multiplier on lower voltage limit (u/p.u.)