Skip to content

auto_select#

Includes method to auto-select the best wave function solver.

Functions:

auto_select_solver #

auto_select_solver(matrix_type: str, matrix_view: str) -> WFSolver

Auto-selects the solver based on the matrix type.

On GPU, cuDSS is the preferred solver if available. If cuDSS is not available, SuperLU is used as a fallback.

On CPU, PARDISO is the preferred solver if available. If PARDISO is not available, MUMPS is used as a fallback. If MUMPS is also not available, SuperLU is used as a final fallback.

If the matrix type is symmetric or Hermitian, only cuDSS on GPU and PARDISO on CPU are supported. If these solvers are not available, an error is raised.

Parameters:

  • matrix_type (str) –

    The type of the matrix.

  • matrix_view (str) –

    The view of the matrix.

Returns:

  • WFSolver –

    The selected wavefunction solver instance.