MATPOWER Reference Manual

[ PDF format ]

• 1. Introduction
• 2. Functions
  • 2.1. MATPOWER Installer
    • install_matpower
  • 2.2. Top-Level Simulation Functions
    • run_mp
    • run_pf
    • run_cpf
    • run_opf
  • 2.3. Other Functions
    • mp_table_class
• 3. Classes
  • 3.1. Task Classes
    • Core Task Classes
      • mp.task
      • mp.task_pf
      • mp.task_cpf
      • mp.task_opf
    • Legacy Task Classes
      • mp.task_pf_legacy
      • mp.task_cpf_legacy
      • mp.task_opf_legacy
      • mp.task_shared_legacy
  • 3.2. Data Model Classes
    • Containers
      • mp.data_model
      • mp.data_model_cpf
      • mp.data_model_opf
    • Elements
      • mp.dm_element
      • mp.dme_branch
      • mp.dme_branch_opf
      • mp.dme_bus
      • mp.dme_bus_opf
      • mp.dme_gen
      • mp.dme_gen_opf
      • mp.dme_load
      • mp.dme_load_cpf
      • mp.dme_load_opf
      • mp.dme_shunt_cpf
      • mp.dme_shunt
      • mp.dme_shunt_opf
    • Element Mixins
      • mp.dme_shared_opf
  • 3.3. Data Model Converter Classes
    • Containers
      • mp.dm_converter
      • mp.dm_converter_mpc2
      • mp.dm_converter_mpc2_legacy
    • Elements
      • mp.dmc_element
      • mp.dmce_branch_mpc2
      • mp.dmce_bus_mpc2
      • mp.dmce_gen_mpc2
      • mp.dmce_load_mpc2
      • mp.dmce_shunt_mpc2
  • 3.4. Network Model Classes
    • Containers
      • mp.form
      • mp.form_ac
      • mp.form_acc
      • mp.form_acp
      • mp.form_dc
      • mp.net_model
      • mp.net_model_ac
      • mp.net_model_acc
      • mp.net_model_acp
      • mp.net_model_dc
    • Elements
      • mp.nm_element
      • mp.nme_branch
      • mp.nme_branch_ac
      • mp.nme_branch_acc
      • mp.nme_branch_acp
      • mp.nme_branch_dc
      • mp.nme_bus
      • mp.nme_bus_acc
      • mp.nme_bus_acp
      • mp.nme_bus_dc
      • mp.nme_gen
      • mp.nme_gen_ac
      • mp.nme_gen_acc
      • mp.nme_gen_acp
      • mp.nme_gen_dc
      • mp.nme_load
      • mp.nme_load_ac
      • mp.nme_load_acc
      • mp.nme_load_acp
      • mp.nme_load_dc
      • mp.nme_shunt
      • mp.nme_shunt_ac
      • mp.nme_shunt_acc
      • mp.nme_shunt_acp
      • mp.nme_shunt_dc
  • 3.5. Mathematical Model Classes
    • Containers
      • mp.math_model
      • mp.math_model_pf
      • mp.math_model_pf_ac
      • mp.math_model_pf_acci
      • mp.math_model_pf_accs
      • mp.math_model_pf_acpi
      • mp.math_model_pf_acps
      • mp.math_model_pf_dc
      • mp.math_model_cpf_acc
      • mp.math_model_cpf_acci
      • mp.math_model_cpf_accs
      • mp.math_model_cpf_acp
      • mp.math_model_cpf_acpi
      • mp.math_model_cpf_acps
      • mp.math_model_opf
      • mp.math_model_opf_ac
      • mp.math_model_opf_acc
      • mp.math_model_opf_acci
      • mp.math_model_opf_acci_legacy
      • mp.math_model_opf_accs
      • mp.math_model_opf_accs_legacy
      • mp.math_model_opf_acp
      • mp.math_model_opf_acpi
      • mp.math_model_opf_acpi_legacy
      • mp.math_model_opf_acps
      • mp.math_model_opf_acps_legacy
      • mp.math_model_opf_dc
      • mp.math_model_opf_dc_legacy
    • Container Mixins
      • mp.mm_shared_pfcpf
      • mp.mm_shared_pfcpf_ac
      • mp.mm_shared_pfcpf_ac_i
      • mp.mm_shared_pfcpf_acc
      • mp.mm_shared_pfcpf_acci
      • mp.mm_shared_pfcpf_accs
      • mp.mm_shared_pfcpf_acp
      • mp.mm_shared_pfcpf_acpi
      • mp.mm_shared_pfcpf_acps
      • mp.mm_shared_pfcpf_dc
      • mp.mm_shared_opf_legacy
    • Elements
      • mp.mm_element
      • mp.mme_branch
      • mp.mme_branch_pf_ac
      • mp.mme_branch_pf_dc
      • mp.mme_branch_opf
      • mp.mme_branch_opf_ac
      • mp.mme_branch_opf_acc
      • mp.mme_branch_opf_acp
      • mp.mme_branch_opf_dc
      • mp.mme_bus
      • mp.mme_bus_pf_ac
      • mp.mme_bus_pf_dc
      • mp.mme_bus_opf_ac
      • mp.mme_bus_opf_acc
      • mp.mme_bus_opf_acp
      • mp.mme_bus_opf_dc
      • mp.mme_gen
      • mp.mme_gen_pf_ac
      • mp.mme_gen_pf_dc
      • mp.mme_gen_opf
      • mp.mme_gen_opf_ac
      • mp.mme_gen_opf_dc
      • mp.mme_load
      • mp.mme_load_pf_ac
      • mp.mme_load_pf_dc
      • mp.mme_load_cpf
      • mp.mme_shunt
      • mp.mme_shunt_pf_ac
      • mp.mme_shunt_pf_dc
      • mp.mme_shunt_cpf
  • 3.6. Miscellaneous Classes
    • mp_table
    • mp_table_subclass
    • mp.cost_table
    • mp.cost_table_utils
    • mp.element_container
    • mp.mapped_array
    • mp.NODE_TYPE
  • 3.7. MATPOWER Extension Classes
    • Base
      • mp.extension
    • OPF Fixed Zonal Reserves Extension
      • mp.xt_reserves
      • mp.dmce_reserve_gen_mpc2
      • mp.dmce_reserve_zone_mpc2
      • mp.dme_reserve_gen
      • mp.dme_reserve_zone
      • mp.mme_reserve_gen
      • mp.mme_reserve_zone
    • Three-Phase Prototype Extension
      • mp.xt_3p
      • mp.dmce_bus3p_mpc2
      • mp.dmce_gen3p_mpc2
      • mp.dmce_load3p_mpc2
      • mp.dmce_line3p_mpc2
      • mp.dmce_xfmr3p_mpc2
      • mp.dmce_buslink_mpc2
      • mp.dme_bus3p
      • mp.dme_gen3p
      • mp.dme_load3p
      • mp.dme_line3p
      • mp.dme_xfmr3p
      • mp.dme_buslink
      • mp.dme_bus3p_opf
      • mp.dme_gen3p_opf
      • mp.dme_load3p_opf
      • mp.dme_line3p_opf
      • mp.dme_xfmr3p_opf
      • mp.dme_buslink_opf
      • mp.nme_bus3p
      • mp.nme_bus3p_acc
      • mp.nme_bus3p_acp
      • mp.nme_gen3p
      • mp.nme_gen3p_acc
      • mp.nme_gen3p_acp
      • mp.nme_load3p
      • mp.nme_line3p
      • mp.nme_xfmr3p
      • mp.nme_buslink
      • mp.nme_buslink_acc
      • mp.nme_buslink_acp
      • mp.mme_bus3p
      • mp.mme_gen3p
      • mp.mme_line3p
      • mp.mme_xfmr3p
      • mp.mme_buslink
      • mp.mme_buslink_pf_ac
      • mp.mme_buslink_pf_acc
      • mp.mme_buslink_pf_acp
      • mp.mme_bus3p_opf_acc
      • mp.mme_bus3p_opf_acp
      • mp.mme_gen3p_opf
      • mp.mme_line3p_opf
      • mp.mme_xfmr3p_opf
      • mp.mme_buslink_opf
      • mp.mme_buslink_opf_acc
      • mp.mme_buslink_opf_acp
    • Legacy DC Line Extension
      • mp.xt_legacy_dcline
      • mp.dmce_legacy_dcline_mpc2
      • mp.dme_legacy_dcline
      • mp.dme_legacy_dcline_opf
      • mp.nme_legacy_dcline
      • mp.nme_legacy_dcline_ac
      • mp.nme_legacy_dcline_acc
      • mp.nme_legacy_dcline_acp
      • mp.nme_legacy_dcline_dc
      • mp.mme_legacy_dcline
      • mp.mme_legacy_dcline_pf_ac
      • mp.mme_legacy_dcline_pf_dc
      • mp.mme_legacy_dcline_opf
      • mp.mme_legacy_dcline_opf_ac
      • mp.mme_legacy_dcline_opf_dc
    • Example User Constraint Extension
      • mp.xt_oval_cap_curve
      • mp.mme_gen_opf_ac_oval
• 4. Tests
  • 4.1. MATPOWER Tests
    • test_matpower
    • t_mp_mapped_array
    • t_mp_table
    • t_mp_data_model
    • t_dmc_element
    • t_mp_dm_converter_mpc2
    • t_nm_element
    • t_port_inj_current_acc
    • t_port_inj_current_acp
    • t_port_inj_power_acc
    • t_port_inj_power_acp
    • t_node_test
    • t_run_mp
    • t_run_mp_3p
    • t_run_opf_default
    • t_pretty_print
    • t_mpxt_legacy_dcline
    • t_mpxt_reserves
  • 4.2. MATPOWER Test Data
    • mp_foo_table
    • t_case3p_a
    • t_case3p_b
    • t_case3p_c
    • t_case3p_d
    • t_case3p_e
    • t_case3p_f
    • t_case3p_g
    • t_case3p_h
    • t_case9_gizmo
• 5. Legacy
  • 5.1. Legacy Class
    • opf_model
  • 5.2. Legacy Functions
    • Top-Level Simulation Functions
      • runpf
      • runcpf
      • runopf
      • runuopf
      • rundcpf
      • rundcopf
      • runduopf
      • runopf_w_res
    • Input/Output Functions
      • caseformat
      • cdf2mpc
      • loadcase
      • mpoption
      • printpf
      • psse2mpc
      • save2psse
      • savecase
      • savechgtab
    • Data Conversion Functions
      • ext2int
      • e2i_data
      • e2i_field
      • int2ext
      • i2e_data
      • i2e_field
      • get_reorder
      • set_reorder
    • Power Flow Functions
      • calc_v_i_sum
      • calc_v_pq_sum
      • calc_v_y_sum
      • dcpf
      • fdpf
      • gausspf
      • make_vcorr
      • make_zpv
      • newtonpf
      • newtonpf_I_cart
      • newtonpf_I_hybrid
      • newtonpf_I_polar
      • newtonpf_S_cart
      • newtonpf_S_hybrid
      • order_radial
      • pfsoln
      • radial_pf
      • zgausspf
    • Continuation Power Flow Functions
      • cpf_corrector
      • cpf_current_mpc
      • cpf_default_callback
      • cpf_detect_events
      • cpf_flim_event
      • cpf_flim_event_cb
      • cpf_nose_event
      • cpf_nose_event_cb
      • cpf_p
      • cpf_p_jac
      • cpf_plim_event
      • cpf_plim_event_cb
      • cpf_predictor
      • cpf_qlim_event
      • cpf_qlim_event_cb
      • cpf_register_callback
      • cpf_register_event
      • cpf_tangent
      • cpf_target_lam_event
      • cpf_target_lam_event_cb
      • cpf_vlim_event
      • cpf_vlim_event_cb
    • OPF and Wrapper Functions
      • opf
      • dcopf
      • fmincopf
      • uopf
    • Other OPF Functions
      • dcopf_solver
      • nlpopf_solver
      • makeAang
      • makeApq
      • makeAvl
      • makeAy
      • margcost
      • opf_args
      • opf_setup
      • opf_execute
      • opf_branch_ang_fcn
      • opf_branch_ang_hess
      • opf_branch_flow_fcn
      • opf_branch_flow_hess
      • opf_current_balance_fcn
      • opf_current_balance_hess
      • opf_gen_cost_fcn
      • opf_legacy_user_cost_fcn
      • opf_power_balance_fcn
      • opf_power_balance_hess
      • opf_veq_fcn
      • opf_veq_hess
      • opf_vlim_fcn
      • opf_vlim_hess
      • opf_vref_fcn
      • opf_vref_hess
      • totcost
      • update_mupq
    • OPF User Callback Functions
      • add_userfcn
      • remove_userfcn
      • run_userfcn
      • toggle_dcline
      • toggle_iflims
      • toggle_reserves
      • toggle_softlims
    • Power Flow Derivative Functions
      • dIbr_dV
      • dSbr_dV
      • dAbr_dV
      • dImis_dV
      • dSbus_dV
      • d2Ibr_dV2
      • d2Sbr_dV2
      • d2Abr_dV2
      • d2Imis_dV2
      • d2Imis_dVdSg
      • d2Sbus_dV2
    • LP, QP, MILP & MIQP Solver Functions
      • miqps_matpower
      • qps_matpower
    • Matrix Building Functions
      • makeB
      • makeBdc
      • makeJac
      • makeLODF
      • makePTDF
      • makeSbus
      • makeSdzip
      • makeYbus
    • Utility Functions
      • apply_changes
      • bustypes
      • calc_branch_angle
      • case_info
      • compare_case
      • define_constants
      • extract_islands
      • feval_w_path
      • find_bridges
      • find_islands
      • genfuels
      • gentypes
      • get_losses
      • hasPQcap
      • idx_brch
      • idx_bus
      • idx_cost
      • idx_ct
      • idx_dcline
      • idx_gen
      • isload
      • load2disp
      • loadshed
      • modcost
      • mpver
      • poly2pwl
      • polycost
      • pqcost
      • scale_load
      • total_load
    • Private Feature Detection Functions
      • have_feature_e4st
      • have_feature_minopf
      • have_feature_most
      • have_feature_mp_core
      • have_feature_pdipmopf
      • have_feature_regexp_split
      • have_feature_scpdipmopf
      • have_feature_sdp_pf
      • have_feature_smartmarket
      • have_feature_syngrid
      • have_feature_table
      • have_feature_tralmopf
    • Other Functions
      • connected_components
      • mpoption_info_clp
      • mpoption_info_cplex
      • mpoption_info_fmincon
      • mpoption_info_glpk
      • mpoption_info_gurobi
      • mpoption_info_intlinprog
      • mpoption_info_ipopt
      • mpoption_info_knitro
      • mpoption_info_linprog
      • mpoption_info_mips
      • mpoption_info_mosek
      • mpoption_info_osqp
      • mpoption_info_quadprog
      • mpoption_old
      • psse_convert
      • psse_convert_hvdc
      • psse_convert_xfmr
      • psse_parse
      • psse_parse_line
      • psse_parse_section
      • psse_read
  • 5.3. Legacy Tests
    • Legacy MATPOWER Tests
      • t_apply_changes
      • t_auction_minopf
      • t_auction_mips
      • t_auction_tspopf_pdipm
      • t_chgtab
      • t_cpf
      • t_dcline
      • t_ext2int2ext
      • t_feval_w_path
      • t_get_losses
      • t_hasPQcap
      • t_hessian
      • t_islands
      • t_jacobian
      • t_load2disp
      • t_loadcase
      • t_makeLODF
      • t_makePTDF
      • t_margcost
      • t_miqps_matpower
      • t_modcost
      • t_mpoption
      • t_mpoption_ov
      • t_off2case
      • t_opf_dc_bpmpd
      • t_opf_dc_clp
      • t_opf_dc_cplex
      • t_opf_dc_default
      • t_opf_dc_glpk
      • t_opf_dc_gurobi
      • t_opf_dc_ipopt
      • t_opf_dc_mips
      • t_opf_dc_mips_sc
      • t_opf_dc_mosek
      • t_opf_dc_osqp
      • t_opf_dc_ot
      • t_opf_default
      • t_opf_fmincon
      • t_opf_ipopt
      • t_opf_knitro
      • t_opf_minopf
      • t_opf_mips
      • t_opf_model
      • t_opf_softlims
      • t_opf_tspopf_pdipm
      • t_opf_tspopf_scpdipm
      • t_opf_tspopf_tralm
      • t_opf_userfcns
      • t_pf_ac
      • t_pf_dc
      • t_pf_radial
      • t_printpf
      • t_psse
      • t_qps_matpower
      • t_runmarket
      • t_runopf_w_res
      • t_scale_load
      • t_total_load
      • t_totcost
      • t_vdep_load
    • Legacy MATPOWER Test Data
      • opf_nle_fcn1
      • opf_nle_hess1
      • t_auction_case
      • t_case30_userfcns
      • t_case9_dcline
      • t_case9_opf
      • t_case9_opfv2
      • t_case9_pf
      • t_case9_pfv2
      • t_case9_save2psse
      • t_case_ext
      • t_case_int
      • t_cpf_cb1
      • t_cpf_cb2
• 6. Previous Versions