Module ppoption

source code

Used to set and retrieve a PYPOWER options vector.

Functions

[hide private]

ppoption(ppopt=None, **kw_args)
Used to set and retrieve a PYPOWER options vector.

source code

Variables

[hide private]

PF_OPTIONS = [('pf_alg', 1, 'power flow algorithm:\n1 - Newton...

OPF_OPTIONS = [('opf_alg', 0, 'algorithm to use for OPF:\n0 - ...

OUTPUT_OPTIONS = [('verbose', 1, 'amount of progress info prin...

PDIPM_OPTIONS = [('pdipm_feastol', 0, 'feasibility (equality) ...

__package__ = None

Function Details

[hide private]

ppoption(ppopt=None, **kw_args)

source code

Used to set and retrieve a PYPOWER options vector.

opt = ppoption() returns the default options vector

opt = ppoption(NAME1=VALUE1, NAME2=VALUE2, ...) returns the default options vector with new values for the specified options, NAME# is the name of an option, and VALUE# is the new value.

opt = ppoption(OPT, NAME1=VALUE1, NAME2=VALUE2, ...) same as above except it uses the options vector OPT as a base instead of the default options vector.

Examples:

   opt = ppoption(PF_ALG=2, PF_TOL=1e-4);
   opt = ppoption(opt, OPF_ALG=565, VERBOSE=2)

Authors:: Ray Zimmerman (PSERC Cornell), Richard Lincoln

Variables Details

[hide private]

PF_OPTIONS

Value:

[('pf_alg',
  1,
  '''power flow algorithm:
1 - Newton\'s method,
2 - Fast-Decoupled (XB version),
3 - Fast-Decoupled (BX version),
4 - Gauss Seidel'''),
 ('pf_tol', 1e-08, 'termination tolerance on per unit P & Q mismatch')
...

OPF_OPTIONS

Value:

[('opf_alg',
  0,
  '''algorithm to use for OPF:
0 - choose best default solver available in the
following order, 500, 540, 520 then 100/200
Otherwise the first digit specifies the problem
formulation and the second specifies the solver,
as follows, (see the User\'s Manual for more details)
...

OUTPUT_OPTIONS

Value:

[('verbose',
  1,
  '''amount of progress info printed:
0 - print no progress info,
1 - print a little progress info,
2 - print a lot of progress info,
3 - print all progress info'''),
 ('out_all', -1, 'controls printing of results:\n-1 - individual flags
...

PDIPM_OPTIONS

Value:

[('pdipm_feastol',
  0,
  '''feasibility (equality) tolerance
for Primal-Dual Interior Points Methods, set
to value of OPF_VIOLATION by default'''),
 ('pdipm_gradtol',
  1e-06,
  '''gradient tolerance for
...