mp.extension
- class mp.extension
Bases:
handle
mp.extension
- Abstract base class for MATPOWER extensions.This class serves as the framework for the MATPOWER extension API, providing a way to bundle a set of class additions and modifications together into a single named package.
By default the methods in this class do nothing, but they can be overridden to customize essentially any aspect of a MATPOWER run. The first 5 methods are used to modify the default classes used to construct the task, data model converter, data, network, and/or mathematical model objects. The last 4 methods are used to add to or modify the classes used to construct the elements for each of the container types.
By convention, MATPOWER extension objects (or cell arrays of them) are named
mpx
and MATPOWER extension class names begin withmp.xt
.- mp.extension Methods:
task_class()
- return handle to constructor for task objectdmc_class()
- return handle to constructor for data model converter objectdm_class()
- return handle to constructor for data model objectnm_class()
- return handle to constructor for network model objectmm_class()
- return handle to constructor for mathematical objectdmc_element_classes()
- return element class modifiers for data model converter elementsdm_element_classes()
- return element class modifiers for data model elementsnm_element_classes()
- return element class modifiers for network model elementsmm_element_classes()
- return element class modifiers for mathematical model elements
See the Customizing and Extensions sections in the MATPOWER Developer’s Manual for more information, and specifically the Element Classes section and the Element Class Modifiers table for details on element class modifiers.
Example MATPOWER extensions:
mp.xt_reserves
- adds fixed zonal reserves to OPFmp.xt_3p
- adds example prototype unbalanced three-phase elements for AC PF, CPF, and OPF
See also
mp.task
,mp.dm_converter
,mp.data_model
,mp.net_model
,mp.math_model
,mp.dmc_element
,mp.dm_element
,mp.nm_element
,mp.mm_element
.- Method Summary
- task_class(task_class, mpopt)
Return handle to constructor for task object.
task_class = mpx.task_class(task_class, mpopt)
- Inputs:
task_class (function handle) – default task constructor
mpopt (struct) – MATPOWER options struct
- Output:
task_class (function handle) – updated task constructor
- dm_converter_class(dmc_class, fmt, mpopt)
Return handle to constructor for data model converter object.
dmc_class = mpx.dm_converter_class(dmc_class, fmt, mpopt)
- Inputs:
dmc_class (function handle) – default data model converter constructor
fmt (char array) – data format tag, e.g.
'mpc2'
mpopt (struct) – MATPOWER options struct
- Output:
dmc_class (function handle) – updated data model converter constructor
- data_model_class(dm_class, task_tag, mpopt)
Return handle to constructor for data model object.
dm_class = mpx.data_model_class(dm_class, task_tag, mpopt)
- Inputs:
dm_class (function handle) – default data model constructor
task_tag (char array) – task tag, e.g.
'PF'
,'CPF'
,'OPF'
mpopt (struct) – MATPOWER options struct
- Output:
dm_class (function handle) – updated data model constructor
- network_model_class(nm_class, task_tag, mpopt)
Return handle to constructor for network model object.
nm_class = mpx.network_model_class(nm_class, task_tag, mpopt)
- Inputs:
nm_class (function handle) – default network model constructor
task_tag (char array) – task tag, e.g.
'PF'
,'CPF'
,'OPF'
mpopt (struct) – MATPOWER options struct
- Output:
nm_class (function handle) – updated network model constructor
- math_model_class(mm_class, task_tag, mpopt)
Return handle to constructor for mathematical model object.
mm_class = mpx.math_model_class(mm_class, task_tag, mpopt)
- Inputs:
mm_class (function handle) – default math model constructor
task_tag (char array) – task tag, e.g.
'PF'
,'CPF'
,'OPF'
mpopt (struct) – MATPOWER options struct
- Output:
mm_class (function handle) – updated math model constructor
- dmc_element_classes(dmc_class, fmt, mpopt)
Return element class modifiers for data model converter elements.
dmc_elements = mpx.dmc_element_classes(dmc_class, fmt, mpopt)
- Inputs:
dmc_class (function handle) – data model converter constructor
fmt (char array) – data format tag, e.g.
'mpc2'
mpopt (struct) – MATPOWER options struct
- Output:
dmc_elements (cell array) – element class modifiers (see Element Class Modifiers in the MATPOWER Developer’s Manual)
- dm_element_classes(dm_class, task_tag, mpopt)
Return element class modifiers for data model elements.
dm_elements = mpx.dm_element_classes(dm_class, task_tag, mpopt)
- Inputs:
dm_class (function handle) – data model constructor
task_tag (char array) – task tag, e.g.
'PF'
,'CPF'
,'OPF'
mpopt (struct) – MATPOWER options struct
- Output:
dm_elements (cell array) – element class modifiers (see Element Class Modifiers in the MATPOWER Developer’s Manual)
- nm_element_classes(nm_class, task_tag, mpopt)
Return element class modifiers for network model elements.
nm_elements = mpx.nm_element_classes(nm_class, task_tag, mpopt)
- Inputs:
nm_class (function handle) – network model constructor
task_tag (char array) – task tag, e.g.
'PF'
,'CPF'
,'OPF'
mpopt (struct) – MATPOWER options struct
- Output:
nm_elements (cell array) – element class modifiers (see Element Class Modifiers in the MATPOWER Developer’s Manual)
- mm_element_classes(mm_class, task_tag, mpopt)
Return element class modifiers for mathematical model elements.
mm_elements = mpx.mm_element_classes(mm_class, task_tag, mpopt)
- Inputs:
mm_class (function handle) – mathematical model constructor
task_tag (char array) – task tag, e.g.
'PF'
,'CPF'
,'OPF'
mpopt (struct) – MATPOWER options struct
- Output:
mm_elements (cell array) – element class modifiers (see Element Class Modifiers in the MATPOWER Developer’s Manual)