runuopf

runuopf(casedata, mpopt, fname, solvedcase)

runuopf() - Runs an optimal power flow with unit-decommitment heuristic.

[RESULTS, SUCCESS] = RUNUOPF(CASEDATA, MPOPT, FNAME, SOLVEDCASE)

Runs an optimal power flow (AC OPF by default) 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 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 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 = runuopf;
    results = runuopf(casedata);
    results = runuopf(casedata, mpopt);
    results = runuopf(casedata, mpopt, fname);
    results = runuopf(casedata, mpopt, fname, solvedcase);
    [results, success] = runuopf(...);

    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] = runuopf(...);

Example:
    results = runuopf('case30');

See also runopf(), runduopf().