quartic2d.Interaction.converge#
- Interaction.converge(*, rtol=0.001, atol=0.0, subdivisions=(1, 2, 4, 8), n_values=(128, 256, 512, 1024), hstart=0.05, hdecrement=2.0, maxiter=15, apply=False)#
Refine the active interaction method at fixed transformed fields.
- Parameters:
rtol (float, default=1e-3) – Relative self-convergence threshold between successive interaction refinements.
atol (float, default=0) – Absolute self-convergence threshold used together with
rtol.subdivisions (iterable of int, default=(1, 2, 4, 8)) – Candidate subdivision counts for the finite-grid methods.
n_values (iterable of int, default=(128, 256, 512, 1024)) – Candidate FFTLog sequence lengths. The current
biasis held fixed during this search.hstart (float, default=0.05) – Initial Ogata resolution parameter.
hdecrement (float, default=2) – Factor controlling the Ogata resolution search.
maxiter (int, default=15) – Maximum number of Ogata search iterations for each harmonic pair.
apply (bool, default=False) – If
True, apply the selected parameters to this object and recompute the interaction.
- Returns:
Internal self-convergence record and selected parameters.
- Return type:
ConvergenceResult
- Raises:
RuntimeError – If
apply=Truebut the search does not produce converged parameters.ImportError – If the active method is
'ogata'and the optionalhankeldependency is unavailable.
Notes
FFTLog refines
nat fixedbias. Finite-grid methods refinesubdivisions. Ogata searchesNandhindependently for the retained harmonic pairs. This method does not modify the q support of the inputHarmonicTransformobjects. The reported error is an internal refinement diagnostic, not an independent reference error.