Package pypower :: Module run_userfcn
[hide private]
[frames] | no frames]

Module run_userfcn

source code

Runs the userfcn callbacks for a given stage.

Functions [hide private]
 
run_userfcn(userfcn, stage, *args)
Runs the userfcn callbacks for a given stage.
source code
Variables [hide private]
  __package__ = 'pypower'
Function Details [hide private]

run_userfcn(userfcn, stage, *args)

source code 

Runs the userfcn callbacks for a given stage.

Example:

   ppc = om.get_mpc()
   om = run_userfcn(ppc['userfcn'], 'formulation', om)
Parameters:
  • userfcn - the 'userfcn' field of ppc, populated by add_userfcn
  • stage - the name of the callback stage begin executed (additional arguments) some stages require additional arguments.

See Also: add_userfcn, remove_userfcn, toggle_reserves, toggle_iflims, runopf_w_res.

Authors:
Ray Zimmerman (PSERC Cornell), Richard Lincoln