pyinterp.fill.gauss_seidel

Contents

pyinterp.fill.gauss_seidel#

pyinterp.fill.gauss_seidel(grid, config=None, *, max_iterations=None, epsilon=None, relaxation=None, first_guess=None, is_periodic=None, num_threads=None)[source]#

Fill missing values using Gauss-Seidel relaxation.

Parameters:

  • grid (_FloatArrayT) – 2D grid with missing values (NaN)

  • config (GaussSeidel | None) – Configuration object (if provided, keyword args are ignored)

  • max_iterations (int | None) – Maximum number of iterations

  • epsilon (float | None) – Convergence criterion

  • relaxation (float | None) – Relaxation parameter (0 < relaxation <= 2)

  • first_guess (Literal['zero', 'zonal_average'] | None) – Initial guess method

  • is_periodic (bool | None) – Whether to assume periodic boundaries

  • num_threads (int | None) – Number of threads (0 = auto)

Returns:

Tuple of (number of iterations, final residual)

Return type:

tuple[int, float]

Examples

>>> iterations, residual = gauss_seidel(
...     grid, max_iterations=1000, epsilon=1e-4, relaxation=1.5
... )
Contents