Module toggle_iflims

Enable or disable set of interface flow constraints.

Enables or disables a set of OPF userfcn callbacks to implement interface flow limits based on a DC flow model.

These callbacks expect to find an 'if' field in the input ppc, where ppc['if'] is a dict with the following fields:

• map n x 2, defines each interface in terms of a set of branch indices and directions. Interface I is defined by the set of rows whose 1st col is equal to I. The 2nd column is a branch index multiplied by 1 or -1 respectively for lines whose orientation is the same as or opposite to that of the interface.
• lims nif x 3, defines the DC model flow limits in MW for specified interfaces. The 2nd and 3rd columns specify the lower and upper limits on the (DC model) flow across the interface, respectively. Normally, the lower limit is negative, indicating a flow in the opposite direction.

The 'int2ext' callback also packages up results and stores them in the following output fields of results['if']:

• P - nif x 1, actual flow across each interface in MW
• mu.l - nif x 1, shadow price on lower flow limit, ($/MW)
• mu.u - nif x 1, shadow price on upper flow limit, ($/MW)

This is the 'ext2int' stage userfcn callback that prepares the input data for the formulation stage. It expects to find an 'if' field in ppc as described above. The optional args are not currently used.

This is the 'formulation' stage userfcn callback that defines the user costs and constraints for interface flow limits. It expects to find an 'if' field in the ppc stored in om, as described above. The optional args are not currently used.

This is the 'int2ext' stage userfcn callback that converts everything back to external indexing and packages up the results. It expects to find an 'if' field in the results dict as described for ppc above. It also expects the results to contain solved branch flows and linear constraints named 'iflims' which are used to populate output fields in results['if']. The optional args are not currently used.

This is the 'printpf' stage userfcn callback that pretty-prints the results. It expects a results dict, a file descriptor and a PYPOWER options vector. The optional args are not currently used.

This is the 'savecase' stage userfcn callback that prints the Python file code to save the 'if' field in the case file. It expects a PYPOWER case dict (ppc), a file descriptor and variable prefix (usually 'ppc'). The optional args are not currently used.