InteractionConvergenceResult#

InteractionConvergenceResult is the reusable output of Interaction.converge_parameters(). It records the selected method-specific parameters and the complete interaction-level refinement history without conflating that self-convergence record with an independent reference error.

class quartic2d.InteractionConvergenceResult(search, method, interpolator, rtol, atol)#

Calibration result returned by Interaction.converge_parameters().

The result stores the complete interaction-level refinement search and the parameters selected for production use. Convergence is measured on the assembled interaction over the supplied displacement set. It is an internal self-convergence statement for those represented inputs, not an independent reference-error guarantee.

Finite-grid methods may additionally use known-order and Richardson checks. FFTLog requires stability in both resolution and the configured local bias window. Ogata is calibrated in its coupled (N, h) parameter space. When automatically sampled HarmonicTransform inputs are supplied, the calibration can also probe sensitivity to the finite upstream q boundary.

Parameters:

  • search (object) – Structured method-specific interaction convergence record.

  • method (str) – Interaction integration method that was calibrated.

  • interpolator (str) – Momentum-space interpolator used during calibration.

  • rtol (float) – Relative and absolute self-convergence thresholds.

  • atol (float) – Relative and absolute self-convergence thresholds.

converged#

Whether the configured interaction-level criteria were satisfied.

Type:

bool

parameters#

Constructor keyword arguments selected for a production Interaction.

Type:

dict

Notes

Use interaction() to construct a production interaction without rerunning calibration. Use to_dict() to retain the search record with numerical results or provenance metadata.

Common operations#

plot_convergence([title])

Plot method-specific interaction self-convergence diagnostics.

interaction(deltas, field1, field2, U_q)

Build a production interaction from the selected parameters.

to_dict(*[, include_values])

Return a JSON-serializable calibration record.

The result object keeps interaction calibration separate from production evaluation and provides the natural public surface for serialization and convergence diagnostics.