mpoption_info_most

MPOPTION_INFO_MOST  Returns MATPOWER option info for MOST.

   DEFAULT_OPTS = MPOPTION_INFO_MOST('D')
   VALID_OPTS   = MPOPTION_INFO_MOST('V')
   EXCEPTIONS   = MPOPTION_INFO_MOST('E')

   Returns a structure for MOST options for MATPOWER containing ...
   (1) default options,
   (2) valid options, or
   (3) NESTED_STRUCT_COPY exceptions for setting options
   ... depending on the value of the input argument.

   This function is used by MPOPTION to set default options, check validity
   of option names or modify option setting/copying behavior for this
   subset of optional MATPOWER options.

   See also MPOPTION.

0001 function opt = mpoption_info_most(selector)
0002 %MPOPTION_INFO_MOST  Returns MATPOWER option info for MOST.
0003 %
0004 %   DEFAULT_OPTS = MPOPTION_INFO_MOST('D')
0005 %   VALID_OPTS   = MPOPTION_INFO_MOST('V')
0006 %   EXCEPTIONS   = MPOPTION_INFO_MOST('E')
0007 %
0008 %   Returns a structure for MOST options for MATPOWER containing ...
0009 %   (1) default options,
0010 %   (2) valid options, or
0011 %   (3) NESTED_STRUCT_COPY exceptions for setting options
0012 %   ... depending on the value of the input argument.
0013 %
0014 %   This function is used by MPOPTION to set default options, check validity
0015 %   of option names or modify option setting/copying behavior for this
0016 %   subset of optional MATPOWER options.
0017 %
0018 %   See also MPOPTION.
0019 
0020 %   MOST
0021 %   Copyright (c) 2014-2020, Power Systems Engineering Research Center (PSERC)
0022 %   by Ray Zimmerman, PSERC Cornell
0023 %
0024 %   This file is part of MOST.
0025 %   Covered by the 3-clause BSD License (see LICENSE file for details).
0026 %   See https://github.com/MATPOWER/most for more info.
0027 
0028 if nargin < 1
0029     selector = 'D';
0030 end
0031 if have_feature('most')
0032     switch upper(selector)
0033         case {'D', 'V'}     %% default and valid options
0034             opt = struct(...
0035                 'most',   struct(...
0036                     'build_model',                  1, ...          %% was md.CreateQP
0037                     'solve_model',                  1, ...          %% was md.Solve
0038                     'resolve_new_cost',             0, ...          %% was md.ReSolveNewCoordCost
0039                     'dc_model',                     1, ...          %% was md.DCMODEL = []
0040                     'fixed_res',                    -1, ...         %% was md.IncludeFixedReserves = []
0041                     'q_coordination',               0, ...          %% was md.QCoordination
0042                     'security_constraints',         -1, ...         %% was md.SecurityConstrained = []
0043                     'storage',                      struct(...
0044                         'terminal_target',              -1, ...     %% was md.Storage.ForceExpectedTerminalStorage
0045                         'cyclic',                       0), ...     %% was md.Storage.ForceCyclicStorage
0046                     'uc',                           struct(...
0047                         'run',                          -1, ...     %% was missing
0048                         'cyclic',                       0), ...     %% was md.UC.CyclicCommitment
0049                     'alpha',                        0, ...          %% was md.alpha
0050                     'solver',                       'DEFAULT', ...  %% was md.QP.opt.alg
0051                     'skip_prices',                  0, ...          %% was md.QP.opt.skip_prices
0052                     'price_stage_warn_tol',         1e-7 ...
0053                 ) ...
0054             );
0055         case 'E'            %% exceptions used by nested_struct_copy() for applying
0056             opt = struct([]);   %% no exceptions
0057         otherwise
0058             error('mpoption_info_most: ''%s'' is not a valid input argument', selector);
0059     end
0060 else
0061     opt = struct([]);       %% MOST is not available
0062 end