pwrs.core.cpf_default_callback#

pwrs.core.cpf_default_callback.cpf_default_callback(k, nx, cx, px, done, rollback, evnts, cb_data, cb_args, results=None)[source]#

Default CPF callback for result accumulation and plotting.

Mirrors MATPOWER’s default CPF callback behavior by storing predictor and corrector trajectories across continuation steps, finalizing the CPF result arrays, and optionally updating the default CPF plot.

Parameters:
  • k (int) – Current continuation step index. Negative values indicate the callback finalization pass.

  • nx (dict) – Next-step CPF state struct.

  • cx (dict) – Current-step CPF state struct.

  • px (dict) – Previous-step CPF state struct.

  • done (dict) – CPF completion flag/message struct.

  • rollback (bool) – Whether the current step is being rolled back.

  • evnts (dict or list of dict) – Detected CPF events for the current step.

  • cb_data (dict) – CPF callback data struct.

  • cb_args (dict) – Callback arguments struct.

  • results (dict, optional) – CPF results accumulator.

Returns:

Updated (nx, cx, done, rollback, evnts, cb_data, results).

Return type:

tuple