Home > matpower5.0 > rundcpf.m

rundcpf

PURPOSE ^

RUNDCPF Runs a DC power flow.

SYNOPSIS ^

function varargout = rundcpf(casedata, mpopt, fname, solvedcase)

DESCRIPTION ^

RUNDCPF  Runs a DC power flow.
   [RESULTS, SUCCESS] = RUNDCPF(CASEDATA, MPOPT, FNAME, SOLVEDCASE)

   Runs a DC power flow, optionally returning a RESULTS struct and
   SUCCESS flag.

   Inputs (all are optional):
       CASEDATA : either a MATPOWER case struct or a string containing
           the name of the file with the case data (default is 'case9')
           (see also CASEFORMAT and LOADCASE)
       MPOPT : MATPOWER options struct to override default options
           can be used to specify the solution algorithm, output options
           termination tolerances, and more (see also MPOPTION).
       FNAME : name of a file to which the pretty-printed output will
           be appended
       SOLVEDCASE : name of file to which the solved case will be saved
           in MATPOWER case format (M-file will be assumed unless the
           specified name ends with '.mat')

   Outputs (all are optional):
       RESULTS : results struct, with the following fields:
           (all fields from the input MATPOWER case, i.e. bus, branch,
               gen, etc., but with solved voltages, power flows, etc.)
           order - info used in external <-> internal data conversion
           et - elapsed time in seconds
           success - success flag, 1 = succeeded, 0 = failed
       SUCCESS : the success flag can additionally be returned as
           a second output argument

   Calling syntax options:
       results = rundcpf;
       results = rundcpf(casedata);
       results = rundcpf(casedata, mpopt);
       results = rundcpf(casedata, mpopt, fname);
       results = rundcpf(casedata, mpopt, fname, solvedcase);
       [results, success] = rundcpf(...);

       Alternatively, for compatibility with previous versions of MATPOWER,
       some of the results can be returned as individual output arguments:

       [baseMVA, bus, gen, branch, success, et] = rundcpf(...);

   Example:
       results = rundcpf('case30');

   See also RUNPF.

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function varargout = rundcpf(casedata, mpopt, fname, solvedcase)
0002 %RUNDCPF  Runs a DC power flow.
0003 %   [RESULTS, SUCCESS] = RUNDCPF(CASEDATA, MPOPT, FNAME, SOLVEDCASE)
0004 %
0005 %   Runs a DC power flow, optionally returning a RESULTS struct and
0006 %   SUCCESS flag.
0007 %
0008 %   Inputs (all are optional):
0009 %       CASEDATA : either a MATPOWER case struct or a string containing
0010 %           the name of the file with the case data (default is 'case9')
0011 %           (see also CASEFORMAT and LOADCASE)
0012 %       MPOPT : MATPOWER options struct to override default options
0013 %           can be used to specify the solution algorithm, output options
0014 %           termination tolerances, and more (see also MPOPTION).
0015 %       FNAME : name of a file to which the pretty-printed output will
0016 %           be appended
0017 %       SOLVEDCASE : name of file to which the solved case will be saved
0018 %           in MATPOWER case format (M-file will be assumed unless the
0019 %           specified name ends with '.mat')
0020 %
0021 %   Outputs (all are optional):
0022 %       RESULTS : results struct, with the following fields:
0023 %           (all fields from the input MATPOWER case, i.e. bus, branch,
0024 %               gen, etc., but with solved voltages, power flows, etc.)
0025 %           order - info used in external <-> internal data conversion
0026 %           et - elapsed time in seconds
0027 %           success - success flag, 1 = succeeded, 0 = failed
0028 %       SUCCESS : the success flag can additionally be returned as
0029 %           a second output argument
0030 %
0031 %   Calling syntax options:
0032 %       results = rundcpf;
0033 %       results = rundcpf(casedata);
0034 %       results = rundcpf(casedata, mpopt);
0035 %       results = rundcpf(casedata, mpopt, fname);
0036 %       results = rundcpf(casedata, mpopt, fname, solvedcase);
0037 %       [results, success] = rundcpf(...);
0038 %
0039 %       Alternatively, for compatibility with previous versions of MATPOWER,
0040 %       some of the results can be returned as individual output arguments:
0041 %
0042 %       [baseMVA, bus, gen, branch, success, et] = rundcpf(...);
0043 %
0044 %   Example:
0045 %       results = rundcpf('case30');
0046 %
0047 %   See also RUNPF.
0048 
0049 %   MATPOWER
0050 %   $Id: rundcpf.m 2229 2013-12-11 01:28:09Z ray $
0051 %   by Ray Zimmerman, PSERC Cornell
0052 %   Copyright (c) 1996-2010 by Power System Engineering Research Center (PSERC)
0053 %
0054 %   This file is part of MATPOWER.
0055 %   See http://www.pserc.cornell.edu/matpower/ for more info.
0056 %
0057 %   MATPOWER is free software: you can redistribute it and/or modify
0058 %   it under the terms of the GNU General Public License as published
0059 %   by the Free Software Foundation, either version 3 of the License,
0060 %   or (at your option) any later version.
0061 %
0062 %   MATPOWER is distributed in the hope that it will be useful,
0063 %   but WITHOUT ANY WARRANTY; without even the implied warranty of
0064 %   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
0065 %   GNU General Public License for more details.
0066 %
0067 %   You should have received a copy of the GNU General Public License
0068 %   along with MATPOWER. If not, see <http://www.gnu.org/licenses/>.
0069 %
0070 %   Additional permission under GNU GPL version 3 section 7
0071 %
0072 %   If you modify MATPOWER, or any covered work, to interface with
0073 %   other modules (such as MATLAB code and MEX-files) available in a
0074 %   MATLAB(R) or comparable environment containing parts covered
0075 %   under other licensing terms, the licensors of MATPOWER grant
0076 %   you additional permission to convey the resulting work.
0077 
0078 %% default arguments
0079 if nargin < 4
0080     solvedcase = '';                %% don't save solved case
0081     if nargin < 3
0082         fname = '';                 %% don't print results to a file
0083         if nargin < 2
0084             mpopt = mpoption;       %% use default options
0085             if nargin < 1
0086                 casedata = 'case9'; %% default data file is 'case9.m'
0087             end
0088         end
0089     end
0090 end
0091 
0092 mpopt = mpoption(mpopt, 'model', 'DC');
0093 [varargout{1:nargout}] = runpf(casedata, mpopt, fname, solvedcase);

Generated on Mon 26-Jan-2015 15:21:31 by m2html © 2005