runduopf

RUNDUOPF  Runs a DC optimal power flow with unit-decommitment heuristic.
   [RESULTS, SUCCESS] = RUNDUOPF(CASEDATA, MPOPT, FNAME, SOLVEDCASE)

   Runs a DC optimal power flow with a heuristic which allows it to shut
   down "expensive" generators 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
           (additional OPF fields, see OPF for details)
       SUCCESS : the success flag can additionally be returned as
           a second output argument

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

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

       [baseMVA, bus, gen, gencost, branch, f, success, et] = runduopf(...);

   Example:
       results = runduopf('case30');

   See also RUNDCOPF, RUNUOPF.

0001 function varargout = runduopf(casedata, mpopt, fname, solvedcase)
0002 %RUNDUOPF  Runs a DC optimal power flow with unit-decommitment heuristic.
0003 %   [RESULTS, SUCCESS] = RUNDUOPF(CASEDATA, MPOPT, FNAME, SOLVEDCASE)
0004 %
0005 %   Runs a DC optimal power flow with a heuristic which allows it to shut
0006 %   down "expensive" generators optionally returning a RESULTS struct and
0007 %   SUCCESS flag.
0008 %
0009 %   Inputs (all are optional):
0010 %       CASEDATA : either a MATPOWER case struct or a string containing
0011 %           the name of the file with the case data (default is 'case9')
0012 %           (see also CASEFORMAT and LOADCASE)
0013 %       MPOPT : MATPOWER options struct to override default options
0014 %           can be used to specify the solution algorithm, output options
0015 %           termination tolerances, and more (see also MPOPTION).
0016 %       FNAME : name of a file to which the pretty-printed output will
0017 %           be appended
0018 %       SOLVEDCASE : name of file to which the solved case will be saved
0019 %           in MATPOWER case format (M-file will be assumed unless the
0020 %           specified name ends with '.mat')
0021 %
0022 %   Outputs (all are optional):
0023 %       RESULTS : results struct, with the following fields:
0024 %           (all fields from the input MATPOWER case, i.e. bus, branch,
0025 %               gen, etc., but with solved voltages, power flows, etc.)
0026 %           order - info used in external <-> internal data conversion
0027 %           et - elapsed time in seconds
0028 %           success - success flag, 1 = succeeded, 0 = failed
0029 %           (additional OPF fields, see OPF for details)
0030 %       SUCCESS : the success flag can additionally be returned as
0031 %           a second output argument
0032 %
0033 %   Calling syntax options:
0034 %       results = runduopf;
0035 %       results = runduopf(casedata);
0036 %       results = runduopf(casedata, mpopt);
0037 %       results = runduopf(casedata, mpopt, fname);
0038 %       results = runduopf(casedata, mpopt, fname, solvedcase);
0039 %       [results, success] = runduopf(...);
0040 %
0041 %       Alternatively, for compatibility with previous versions of MATPOWER,
0042 %       some of the results can be returned as individual output arguments:
0043 %
0044 %       [baseMVA, bus, gen, gencost, branch, f, success, et] = runduopf(...);
0045 %
0046 %   Example:
0047 %       results = runduopf('case30');
0048 %
0049 %   See also RUNDCOPF, RUNUOPF.
0050 
0051 %   MATPOWER
0052 %   Copyright (c) 1996-2016, Power Systems Engineering Research Center (PSERC)
0053 %   by Ray Zimmerman, PSERC Cornell
0054 %
0055 %   This file is part of MATPOWER.
0056 %   Covered by the 3-clause BSD License (see LICENSE file for details).
0057 %   See https://matpower.org for more info.
0058 
0059 %% default arguments
0060 if nargin < 4
0061     solvedcase = '';                %% don't save solved case
0062     if nargin < 3
0063         fname = '';                 %% don't print results to a file
0064         if nargin < 2
0065             mpopt = mpoption;       %% use default options
0066             if nargin < 1
0067                 casedata = 'case9'; %% default data file is 'case9.m'
0068             end
0069         end
0070     end
0071 end
0072 
0073 mpopt = mpoption(mpopt, 'model', 'DC');
0074 [varargout{1:nargout}] = runuopf(casedata, mpopt, fname, solvedcase);