mpoption_info_mips

MPOPTION_INFO_MIPS  Returns MATPOWER option info for MIPS (optional fields).

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

   Returns a structure for MIPS 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_mips(selector)
0002 %MPOPTION_INFO_MIPS  Returns MATPOWER option info for MIPS (optional fields).
0003 %
0004 %   DEFAULT_OPTS = MPOPTION_INFO_MIPS('D')
0005 %   VALID_OPTS   = MPOPTION_INFO_MIPS('V')
0006 %   EXCEPTIONS   = MPOPTION_INFO_MIPS('E')
0007 %
0008 %   Returns a structure for MIPS 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 %   MATPOWER
0021 %   Copyright (c) 2014-2016, Power Systems Engineering Research Center (PSERC)
0022 %   by Ray Zimmerman, PSERC Cornell
0023 %
0024 %   This file is part of MATPOWER.
0025 %   Covered by the 3-clause BSD License (see LICENSE file for details).
0026 %   See https://matpower.org for more info.
0027 
0028 if nargin < 1
0029     selector = 'D';
0030 end
0031 switch upper(selector)
0032     case 'D'            %% default options
0033         opt = struct([]);   %% no default options
0034     case 'V'            %% valid options
0035         opt = struct(...
0036             'mips', struct(...
0037                 'xi', 0.99995, ...
0038                 'sigma', 0.1, ...
0039                 'z0', 1, ...
0040                 'alpha_min', 1e-8, ...
0041                 'rho_min', 0.95, ...
0042                 'rho_max', 1.05, ...
0043                 'mu_threshold', 1e-5, ...
0044                 'max_stepsize', 1e10 ...
0045             ) ...
0046         );
0047     case 'E'            %% exceptions used by nested_struct_copy() for applying
0048         opt = struct([]);   %% no exceptions
0049     otherwise
0050         error('mpoption_info_mips: ''%s'' is not a valid input argument', selector);
0051 end