iwfm.diagnostics.detect_convergence_trouble

iwfm.diagnostics.detect_convergence_trouble(convergence, iter_threshold=40, diffmax_threshold=0.1)[source]

Extract trouble timesteps from ConvergenceSummary.

Parameters:

  • convergence (ConvergenceSummary) – From read_convergence_hdf.

  • iter_threshold (int) – Flag timesteps with iterations >= this.

  • diffmax_threshold (float) – Flag timesteps with abs(DIFFMAX) >= this.

Returns:

[{timestep_index, diffmax, iterations, node, layer}]

Return type:

list of dict