Home > matpower4.1 > idx_area.m

idx_area

PURPOSE ^

------------------------------ deprecated ------------------------------

SYNOPSIS ^

function [AREA_I, PRICE_REF_BUS] = idx_area

DESCRIPTION ^

------------------------------  deprecated  ------------------------------
   AREA matrix is not used by MATPOWER.
--------------------------------------------------------------------------
IDX_AREA   Defines constants for named column indices to areas matrix.
   Example:

   [AREA_I, PRICE_REF_BUS] = idx_area;

   The index, name and meaning of each column of the areas matrix is given
   below:
 
   columns 1-2
    1  AREA_I          area number
    2  PRICE_REF_BUS   price reference bus for this area

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function [AREA_I, PRICE_REF_BUS] = idx_area
0002 %------------------------------  deprecated  ------------------------------
0003 %   AREA matrix is not used by MATPOWER.
0004 %--------------------------------------------------------------------------
0005 %IDX_AREA   Defines constants for named column indices to areas matrix.
0006 %   Example:
0007 %
0008 %   [AREA_I, PRICE_REF_BUS] = idx_area;
0009 %
0010 %   The index, name and meaning of each column of the areas matrix is given
0011 %   below:
0012 %
0013 %   columns 1-2
0014 %    1  AREA_I          area number
0015 %    2  PRICE_REF_BUS   price reference bus for this area
0016 
0017 %   MATPOWER
0018 %   $Id: idx_area.m,v 1.11 2010/04/26 19:45:26 ray Exp $
0019 %   by Ray Zimmerman, PSERC Cornell
0020 %   Copyright (c) 1996-2010 by Power System Engineering Research Center (PSERC)
0021 %
0022 %   This file is part of MATPOWER.
0023 %   See http://www.pserc.cornell.edu/matpower/ for more info.
0024 %
0025 %   MATPOWER is free software: you can redistribute it and/or modify
0026 %   it under the terms of the GNU General Public License as published
0027 %   by the Free Software Foundation, either version 3 of the License,
0028 %   or (at your option) any later version.
0029 %
0030 %   MATPOWER is distributed in the hope that it will be useful,
0031 %   but WITHOUT ANY WARRANTY; without even the implied warranty of
0032 %   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
0033 %   GNU General Public License for more details.
0034 %
0035 %   You should have received a copy of the GNU General Public License
0036 %   along with MATPOWER. If not, see <http://www.gnu.org/licenses/>.
0037 %
0038 %   Additional permission under GNU GPL version 3 section 7
0039 %
0040 %   If you modify MATPOWER, or any covered work, to interface with
0041 %   other modules (such as MATLAB code and MEX-files) available in a
0042 %   MATLAB(R) or comparable environment containing parts covered
0043 %   under other licensing terms, the licensors of MATPOWER grant
0044 %   you additional permission to convey the resulting work.
0045 
0046 %% define the indices
0047 AREA_I          = 1;    %% area number
0048 PRICE_REF_BUS   = 2;    %% price reference bus for this area

Generated on Mon 26-Jan-2015 15:00:13 by m2html © 2005