C.1 Mapping of Old-Style Options to New-Style Options

A Matpower options struct can be created from an old-style options vector simply by passing it to mpoption. The mapping of old-style options into the fields in the option struct are summarized in Table C-19. An old-style options vector can also be created from an options struct by calling mpoption with the struct and an empty second argument.

mpopt_struct = mpoption(mpopt_vector);
mpopt_vector = mpoption(mpopt_struct, []);

Table C-19:Old-Style to New-Style Option Mapping
idx

old option

new option

notes

1

PF_ALG

pf.alg

new option has string values

    

1    →    

'NR'

2    →    

'FDXB'

3    →    

'FDBX'

4    →    

'GS'

   →    
2

PF_TOL

pf.tol

3

PF_MAX_IT

pf.nr.max_it

4

PF_MAX_IT_FD

pf.fd.max_it

5

PF_MAX_IT_GS

pf.gs.max_it

6

ENFORCE_Q_LIMS

pf.enforce_q_lims

10

PF_DC

model

new option has string values

    

0    →    

'AC'

1    →    

'DC'

   →    
11

OPF_ALG

opf.ac.solver

new option has string values

    

0    →    

'DEFAULT'

500    →    

'MINOPF'

520    →    

'FMINCON'

540    →    

'PDIPM' (and pdipm.step_control = 0)

545    →    

'PDIPM' (and pdipm.step_control = 1)

550    →    

'TRALM'

560    →    

'MIPS' (and mips.step_control = 0)

565    →    

'MIPS' (and mips.step_control = 1)

580    →    

'IPOPT'

600    →    

'KNITRO'

   →    
16

OPF_VIOLATION

opf.violation

17

CONSTR_TOL_X

fmincon.tol_x, knitro.tol_x

support for constr has been removed

18

CONSTR_TOL_F

fmincon.tol_f, knitro.tol_f

support for constr has been removed

19

CONSTR_MAX_IT

fmincon.max_it

support for constr has been removed

24

OPF_FLOW_LIM

opf.flow_lim

new option has string values

    

0    →    

'S'

1    →    

'P'

2    →    

'I'

   →    
25

OPF_IGNORE_ANG_LIM

opf.ignore_angle_lim

26

OPF_ALG_DC

opf.dc.solver

new option has string values

    

0    →    

'DEFAULT'

100    →    

'BPMPD'

200    →    

'MIPS' (and mips.step_control = 0)

250    →    

'MIPS' (and mips.step_control = 1)

300    →    

'OT'

400    →    

'IPOPT'

500    →    

'CPLEX'

600    →    

'MOSEK'

700    →    

'GUROBI'

   →    
31

VERBOSE

verbose

32

OUT_ALL

out.all

33

OUT_SYS_SUM

out.sys_sum

34

OUT_AREA_SUM

out.area_sum

35

OUT_BUS

out.bug

36

OUT_BRANCH

out.branch

37

OUT_GEN

out.gen

38

OUT_ALL_LIM

out.lim.all

39

OUT_V_LIM

out.lim.v

40

OUT_LINE_LIM

out.lim.line

41

OUT_PG_LIM

out.lim.pg

42

OUT_QG_LIM

out.lim.qg

44

OUT_FORCE

out.force

52

RETURN_RAW_DER

opf.return_raw_der

55

FMC_ALG

fmincon.alg

58

KNITRO_OPT

knitro.opt

60

IPOPT_OPT

ipopt.opt

61

MNS_FEASTOL

minopf.feastol

62

MNS_ROWTOL

minopf.rowtol

63

MNS_XTOL

minopf.xtol

64

MNS_MAJDAMP

minopf.majdamp

65

MNS_MINDAMP

minopf.mindamp

66

MNS_PENALTY_PARM

minopf.penalty

67

MNS_MAJOR_IT

minopf.major_it

68

MNS_MINOR_IT

minopf.minor_it

69

MNS_MAX_IT

minopf.max_it

70

MNS_VERBOSITY

minopf.verbosity

71

MNS_CORE

minopf.core

72

MNS_SUPBASIC_LIM

minopf.supbasic_lim

73

MNS_MULT_PRICE

minopf.mult_price

80

FORCE_PC_EQ_P0

sopf.force_Pc_eq_P0

for c3sopf (not part of Matpower)

81

PDIPM_FEASTOL

mips.feastol, pdipm.feastol

82

PDIPM_GRADTOL

mips.gradtol, pdipm.gradtol

83

PDIPM_COMPTOL

mips.comptol, pdipm.comptol

84

PDIPM_COSTTOL

mips.costtol, pdipm.costtol

85

PDIPM_MAX_IT

mips.max_it, pdipm.max_it

86

SCPDIPM_RED_IT

mips.sc.red_it, pdipm.sc.red_it

87

TRALM_FEASTOL

tralm.feastol

88

TRALM_PRIMETOL

tralm.primaltol

89

TRALM_DUALTOL

tralm.dualtol

90

TRALM_COSTTOL

tralm.costtol

91

TRALM_MAJOR_IT

tralm.major_it

92

TRALM_MINOR_IT

tralm.minor_it

93

SMOOTHING_RATIO

tralm.smooth_ratio, pdipm.sc.smooth_ratio

95

CPLEX_LPMETHOD

cplex.lpmethod

98

CPLEX_QPMETHOD

cplex.qpmethod

97

CPLEX_OPT

cplex.opt

111

MOSEK_LP_ALG

mosek.lp_alg

112

MOSEK_MAX_IT

mosek.max_it

113

MOSEK_GAP_TOL

mosek.gap_tol

114

MOSEK_MAX_TIME

mosek.max_time

115

MOSEK_NUM_THREADS

mosek.num_threads

116

MOSEK_OPT

mosek.opt

121

GRB_METHOD

gurobi.method

122

GRB_TIMELIMIT

gurobi.timelimit

123

GRB_THREADS

gurobi.threads

124

GRB_OPT

gurobi.opt