Home > matpower5.1 > extras > sdp_pf > mpoption_info_sdp_pf.m

mpoption_info_sdp_pf

PURPOSE ^

MPOPTION_INFO_SDP_PF Returns MATPOWER option info for SDP_PF.

SYNOPSIS ^

function opt = mpoption_info_sdp_pf(selector)

DESCRIPTION ^

MPOPTION_INFO_SDP_PF  Returns MATPOWER option info for SDP_PF.

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

   Returns a structure for SDP_PF 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.

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function opt = mpoption_info_sdp_pf(selector)
0002 %MPOPTION_INFO_SDP_PF  Returns MATPOWER option info for SDP_PF.
0003 %
0004 %   DEFAULT_OPTS = MPOPTION_INFO_SDP_PF('D')
0005 %   VALID_OPTS   = MPOPTION_INFO_SDP_PF('V')
0006 %   EXCEPTIONS   = MPOPTION_INFO_SDP_PF('E')
0007 %
0008 %   Returns a structure for SDP_PF 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-2015 by Power System Engineering Research Center (PSERC)
0022 %   by Ray Zimmerman, PSERC Cornell
0023 %
0024 %   $Id: mpoption_info_sdp_pf.m 2644 2015-03-11 19:34:22Z ray $
0025 %
0026 %   This file is part of MATPOWER.
0027 %   Covered by the 3-clause BSD License (see LICENSE file for details).
0028 %   See http://www.pserc.cornell.edu/matpower/ for more info.
0029 
0030 
0031 
0032 if nargin < 1
0033     selector = 'D';
0034 end
0035 if have_fcn('sdp_pf')
0036     switch upper(selector)
0037         case {'D', 'V'}     %% default and valid options
0038             opt = struct(...
0039                 'sdp_pf',   struct(...
0040                     'max_number_of_cliques',    0.1, ...
0041                     'eps_r',                    1e-4, ...
0042                     'recover_voltage',          4, ...
0043                     'recover_injections',       2, ...
0044                     'min_Pgen_diff',            1, ...
0045                     'min_Qgen_diff',            1, ...
0046                     'max_line_limit',           9900, ...
0047                     'max_gen_limit',            99998, ...
0048                     'ndisplay',                 100, ...
0049                     'choldense',                10, ...
0050                     'cholaggressive',           1, ...
0051                     'bind_lagrange',            1e-3, ...
0052                     'zeroeval_tol',             1e-4, ...
0053                     'mineigratio_tol',          1e5, ...
0054                     'opts',                     [], ...
0055                     'opt_fname',                '' ...
0056                 ) ...
0057             );
0058         case 'E'            %% exceptions used by nested_struct_copy() for applying
0059             opt = struct([]);   %% no exceptions
0060         otherwise
0061             error('mpoption_info_sdp_pf: ''%s'' is not a valid input argument', selector);
0062     end
0063 else
0064     opt = struct([]);       %% SDP_PF is not available
0065 end

Generated on Fri 20-Mar-2015 18:23:34 by m2html © 2005