aoclsparse_itsol_rci_job - 5.2 English - 68552

AOCL API Guide (68552)

Document ID
68552
Release Date
2025-12-29
Version
5.2 English
enum aoclsparse_itsol_rci_job#

Values of ircomm used by the iterative solver reverse communication interface (RCI) aoclsparse_itsol_d_rci_solve and aoclsparse_itsol_s_rci_solve to communicate back to the user which operation is required.

Values:

enumerator aoclsparse_rci_interrupt#

if set by the user, signals the solver to terminate. This is never set by the solver. Terminate.

enumerator aoclsparse_rci_stop#

found a solution within specified tolerance (see options “cg rel tolerance”, “cg abs tolerance”, “gmres rel tolerance”, and “gmres abs tolerance” in Options). Terminate, vector x contains the solution.

enumerator aoclsparse_rci_start#

initial value of the ircomm flag, no action required. Call solver.

enumerator aoclsparse_rci_mv#

perform the matrix-vector product \( v = Au\). Return control to solver.

enumerator aoclsparse_rci_precond#

perform a preconditioning step on the vector \(u\) and store in \(v\). If the preconditioner \(M\) has explicit matrix form, then applying the preconditioner would result in the operations \( v=Mu \) or \(v=M^{-1}u\). The latter would be performed by solving the linear system of equations \(Mv=u\). Return control to solver.

enumerator aoclsparse_rci_stopping_criterion#

perform a monitoring step and check for custom stopping criteria. If using a positive tolerance value for the convergence options (see aoclsparse_rci_stop), then this step can be ignored and control can be returned to solver.