# NAG FL Interfacef11def (real_​gen_​solve_​jacssor)

## ▸▿ Contents

Settings help

FL Name Style:

FL Specification Language:

## 1Purpose

f11def solves a real sparse nonsymmetric system of linear equations, represented in coordinate storage format, using a restarted generalized minimal residual (RGMRES), conjugate gradient squared (CGS), stabilized bi-conjugate gradient (Bi-CGSTAB), or transpose-free quasi-minimal residual (TFQMR) method, without preconditioning, with Jacobi, or with SSOR preconditioning.

## 2Specification

Fortran Interface
 Subroutine f11def ( n, nnz, a, irow, icol, b, m, tol, x, itn, work,
 Integer, Intent (In) :: n, nnz, irow(nnz), icol(nnz), m, maxitn, lwork Integer, Intent (Inout) :: ifail Integer, Intent (Out) :: itn, iwork(2*n+1) Real (Kind=nag_wp), Intent (In) :: a(nnz), omega, b(n), tol Real (Kind=nag_wp), Intent (Inout) :: x(n) Real (Kind=nag_wp), Intent (Out) :: rnorm, work(lwork) Character (*), Intent (In) :: method Character (1), Intent (In) :: precon
#include <nag.h>
 void f11def_ (const char *method, const char *precon, const Integer *n, const Integer *nnz, const double a[], const Integer irow[], const Integer icol[], const double *omega, const double b[], const Integer *m, const double *tol, const Integer *maxitn, double x[], double *rnorm, Integer *itn, double work[], const Integer *lwork, Integer iwork[], Integer *ifail, const Charlen length_method, const Charlen length_precon)
The routine may be called by the names f11def or nagf_sparse_real_gen_solve_jacssor.

## 3Description

f11def solves a real sparse nonsymmetric system of linear equations
 $Ax=b,$
using an RGMRES (see Saad and Schultz (1986)), CGS (see Sonneveld (1989)), Bi-CGSTAB($\ell$) (see Van der Vorst (1989) and Sleijpen and Fokkema (1993)), or TFQMR (see Freund and Nachtigal (1991) and Freund (1993)) method.
The routine allows the following choices for the preconditioner:
• no preconditioning;
• Jacobi preconditioning (see Young (1971));
• symmetric successive-over-relaxation (SSOR) preconditioning (see Young (1971)).
For incomplete $LU$ (ILU) preconditioning see f11dcf.
The matrix $A$ is represented in coordinate storage (CS) format (see Section 2.1.1 in the F11 Chapter Introduction) in the arrays a, irow and icol. The array a holds the nonzero entries in the matrix, while irow and icol hold the corresponding row and column indices.
f11def is a Black Box routine which calls f11bdf, f11bef and f11bff. If you wish to use an alternative storage scheme, preconditioner, or termination criterion, or require additional diagnostic information, you should call these underlying routines directly.

## 4References

Freund R W (1993) A transpose-free quasi-minimal residual algorithm for non-Hermitian linear systems SIAM J. Sci. Comput. 14 470–482
Freund R W and Nachtigal N (1991) QMR: a Quasi-Minimal Residual Method for Non-Hermitian Linear Systems Numer. Math. 60 315–339
Saad Y and Schultz M (1986) GMRES: a generalized minimal residual algorithm for solving nonsymmetric linear systems SIAM J. Sci. Statist. Comput. 7 856–869
Sleijpen G L G and Fokkema D R (1993) BiCGSTAB$\left(\ell \right)$ for linear equations involving matrices with complex spectrum ETNA 1 11–32
Sonneveld P (1989) CGS, a fast Lanczos-type solver for nonsymmetric linear systems SIAM J. Sci. Statist. Comput. 10 36–52
Van der Vorst H (1989) Bi-CGSTAB, a fast and smoothly converging variant of Bi-CG for the solution of nonsymmetric linear systems SIAM J. Sci. Statist. Comput. 13 631–644
Young D (1971) Iterative Solution of Large Linear Systems Academic Press, New York

## 5Arguments

1: $\mathbf{method}$Character(*) Input
On entry: the iterative method to be used.
${\mathbf{method}}=\text{'RGMRES'}$
Restarted generalized minimum residual method.
${\mathbf{method}}=\text{'CGS'}$
${\mathbf{method}}=\text{'BICGSTAB'}$
Bi-conjugate gradient stabilized ($\ell$) method.
${\mathbf{method}}=\text{'TFQMR'}$
Transpose-free quasi-minimal residual method.
Constraint: ${\mathbf{method}}=\text{'RGMRES'}$, $\text{'CGS'}$, $\text{'BICGSTAB'}$ or $\text{'TFQMR'}$.
2: $\mathbf{precon}$Character(1) Input
On entry: specifies the type of preconditioning to be used.
${\mathbf{precon}}=\text{'N'}$
No preconditioning.
${\mathbf{precon}}=\text{'J'}$
Jacobi.
${\mathbf{precon}}=\text{'S'}$
Symmetric successive-over-relaxation.
Constraint: ${\mathbf{precon}}=\text{'N'}$, $\text{'J'}$ or $\text{'S'}$.
3: $\mathbf{n}$Integer Input
On entry: $n$, the order of the matrix $A$.
Constraint: ${\mathbf{n}}\ge 1$.
4: $\mathbf{nnz}$Integer Input
On entry: the number of nonzero elements in the matrix $A$.
Constraint: $1\le {\mathbf{nnz}}\le {{\mathbf{n}}}^{2}$.
5: $\mathbf{a}\left({\mathbf{nnz}}\right)$Real (Kind=nag_wp) array Input
On entry: the nonzero elements of the matrix $A$, ordered by increasing row index, and by increasing column index within each row. Multiple entries for the same row and column indices are not permitted. The routine f11zaf may be used to order the elements in this way.
6: $\mathbf{irow}\left({\mathbf{nnz}}\right)$Integer array Input
7: $\mathbf{icol}\left({\mathbf{nnz}}\right)$Integer array Input
On entry: the row and column indices of the nonzero elements supplied in a.
Constraints:
irow and icol must satisfy the following constraints (which may be imposed by a call to f11zaf):
• $1\le {\mathbf{irow}}\left(\mathit{i}\right)\le {\mathbf{n}}$ and $1\le {\mathbf{icol}}\left(\mathit{i}\right)\le {\mathbf{n}}$, for $\mathit{i}=1,2,\dots ,{\mathbf{nnz}}$;
• ${\mathbf{irow}}\left(\mathit{i}-1\right)<{\mathbf{irow}}\left(\mathit{i}\right)$ or ${\mathbf{irow}}\left(\mathit{i}-1\right)={\mathbf{irow}}\left(\mathit{i}\right)$ and ${\mathbf{icol}}\left(\mathit{i}-1\right)<{\mathbf{icol}}\left(\mathit{i}\right)$, for $\mathit{i}=2,3,\dots ,{\mathbf{nnz}}$.
8: $\mathbf{omega}$Real (Kind=nag_wp) Input
On entry: if ${\mathbf{precon}}=\text{'S'}$, omega is the relaxation parameter $\omega$ to be used in the SSOR method. Otherwise omega need not be initialized and is not referenced.
Constraint: $0.0<{\mathbf{omega}}<2.0$.
9: $\mathbf{b}\left({\mathbf{n}}\right)$Real (Kind=nag_wp) array Input
On entry: the right-hand side vector $b$.
10: $\mathbf{m}$Integer Input
On entry: if ${\mathbf{method}}=\text{'RGMRES'}$, m is the dimension of the restart subspace.
If ${\mathbf{method}}=\text{'BICGSTAB'}$, m is the order $\ell$ of the polynomial Bi-CGSTAB method.
Otherwise, m is not referenced.
Constraints:
• if ${\mathbf{method}}=\text{'RGMRES'}$, $0<{\mathbf{m}}\le \mathrm{min}\phantom{\rule{0.125em}{0ex}}\left({\mathbf{n}},50\right)$;
• if ${\mathbf{method}}=\text{'BICGSTAB'}$, $0<{\mathbf{m}}\le \mathrm{min}\phantom{\rule{0.125em}{0ex}}\left({\mathbf{n}},10\right)$.
11: $\mathbf{tol}$Real (Kind=nag_wp) Input
On entry: the required tolerance. Let ${x}_{k}$ denote the approximate solution at iteration $k$, and ${r}_{k}$ the corresponding residual. The algorithm is considered to have converged at iteration $k$ if
 $‖rk‖∞≤τ×(‖b‖∞+‖A‖∞‖xk‖∞).$
If ${\mathbf{tol}}\le 0.0$, $\tau =\mathrm{max}\phantom{\rule{0.25em}{0ex}}\sqrt{\epsilon },10\epsilon ,\sqrt{n}\epsilon$ is used, where $\epsilon$ is the machine precision. Otherwise $\tau =\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left({\mathbf{tol}},10\epsilon ,\sqrt{n}\epsilon \right)$ is used.
Constraint: ${\mathbf{tol}}<1.0$.
12: $\mathbf{maxitn}$Integer Input
On entry: the maximum number of iterations allowed.
Constraint: ${\mathbf{maxitn}}\ge 1$.
13: $\mathbf{x}\left({\mathbf{n}}\right)$Real (Kind=nag_wp) array Input/Output
On entry: an initial approximation to the solution vector $x$.
On exit: an improved approximation to the solution vector $x$.
14: $\mathbf{rnorm}$Real (Kind=nag_wp) Output
On exit: the final value of the residual norm ${‖{r}_{k}‖}_{\infty }$, where $k$ is the output value of itn.
15: $\mathbf{itn}$Integer Output
On exit: the number of iterations carried out.
16: $\mathbf{work}\left({\mathbf{lwork}}\right)$Real (Kind=nag_wp) array Workspace
17: $\mathbf{lwork}$Integer Input
On entry: the dimension of the array work as declared in the (sub)program from which f11def is called.
Constraints:
• if ${\mathbf{method}}=\text{'RGMRES'}$, ${\mathbf{lwork}}\ge 4×{\mathbf{n}}+{\mathbf{m}}×\left({\mathbf{m}}+{\mathbf{n}}+5\right)+\mathit{\nu }+101$;
• if ${\mathbf{method}}=\text{'CGS'}$, ${\mathbf{lwork}}\ge 8×{\mathbf{n}}+\mathit{\nu }+100$;
• if ${\mathbf{method}}=\text{'BICGSTAB'}$, ${\mathbf{lwork}}\ge 2×{\mathbf{n}}×\left({\mathbf{m}}+3\right)+{\mathbf{m}}×\left({\mathbf{m}}+2\right)+\mathit{\nu }+100$;
• if ${\mathbf{method}}=\text{'TFQMR'}$, ${\mathbf{lwork}}\ge 11×{\mathbf{n}}+\mathit{\nu }+100$.
where $\mathit{\nu }={\mathbf{n}}$ for ${\mathbf{precon}}=\text{'J'}$ or $\text{'S'}$, and $0$ otherwise
18: $\mathbf{iwork}\left(2×{\mathbf{n}}+1\right)$Integer array Workspace
19: $\mathbf{ifail}$Integer Input/Output
On entry: ifail must be set to $0$, $-1$ or $1$ to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of $0$ causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of $-1$ means that an error message is printed while a value of $1$ means that it is not.
If halting is not appropriate, the value $-1$ or $1$ is recommended. If message printing is undesirable, then the value $1$ is recommended. Otherwise, the value $0$ is recommended. When the value $-\mathbf{1}$ or $\mathbf{1}$ is used it is essential to test the value of ifail on exit.
On exit: ${\mathbf{ifail}}={\mathbf{0}}$ unless the routine detects an error or a warning has been flagged (see Section 6).

## 6Error Indicators and Warnings

If on entry ${\mathbf{ifail}}=0$ or $-1$, explanatory error messages are output on the current error message unit (as defined by x04aaf).
Errors or warnings detected by the routine:
${\mathbf{ifail}}=1$
On entry, lwork is too small: ${\mathbf{lwork}}=⟨\mathit{\text{value}}⟩$. Minimum required value of ${\mathbf{lwork}}=⟨\mathit{\text{value}}⟩$.
On entry, ${\mathbf{m}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{m}}\ge 1$ and ${\mathbf{m}}\le \mathrm{MIN}\left({\mathbf{n}},⟨\mathit{\text{value}}⟩\right)$.
On entry, ${\mathbf{maxitn}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{maxitn}}\ge 1$.
On entry, ${\mathbf{method}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{method}}=\text{'RGMRES'}$, $\text{'CGS'}$ or $\text{'BICGSTAB'}$.
On entry, ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{n}}\ge 1$.
On entry, ${\mathbf{nnz}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{nnz}}\ge 1$.
On entry, ${\mathbf{nnz}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{nnz}}\le {{\mathbf{n}}}^{2}$.
On entry, ${\mathbf{omega}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{omega}}>0.0$ and ${\mathbf{omega}}<2.0$.
On entry, ${\mathbf{precon}}\ne \text{'N'}$, $\text{'J'}$ or $\text{'S'}$: ${\mathbf{precon}}=⟨\mathit{\text{value}}⟩$.
On entry, ${\mathbf{tol}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{tol}}<1.0$.
${\mathbf{ifail}}=2$
On entry, ${\mathbf{a}}\left(i\right)$ is out of order: $i=⟨\mathit{\text{value}}⟩$.
On entry, $i=⟨\mathit{\text{value}}⟩$, ${\mathbf{icol}}\left(i\right)=⟨\mathit{\text{value}}⟩$ and ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{icol}}\left(i\right)\ge 1$ and ${\mathbf{icol}}\left(i\right)\le {\mathbf{n}}$.
On entry, $i=⟨\mathit{\text{value}}⟩$, ${\mathbf{irow}}\left(i\right)=⟨\mathit{\text{value}}⟩$ and ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{irow}}\left(i\right)\ge 1$ and ${\mathbf{irow}}\left(i\right)\le {\mathbf{n}}$.
On entry, the location (${\mathbf{irow}}\left(\mathit{I}\right),{\mathbf{icol}}\left(\mathit{I}\right)$) is a duplicate: $\mathit{I}=⟨\mathit{\text{value}}⟩$.
${\mathbf{ifail}}=3$
The matrix $A$ has a zero diagonal entry in row $⟨\mathit{\text{value}}⟩$.
The matrix $A$ has no diagonal entry in row $⟨\mathit{\text{value}}⟩$.
Jacobi and SSOR preconditioners are not appropriate for this problem.
${\mathbf{ifail}}=4$
The required accuracy could not be obtained. However, a reasonable accuracy may have been achieved.
This error code usually implies that your problem has been fully and satisfactorily solved to within or close to the accuracy available on your system. Further iterations are unlikely to improve on this situation.
${\mathbf{ifail}}=5$
The solution has not converged after $⟨\mathit{\text{value}}⟩$ iterations.
${\mathbf{ifail}}=6$
Algorithmic breakdown. A solution is returned, although it is possible that it is completely inaccurate.
${\mathbf{ifail}}=7$
A serious error has occurred in an internal call: ${\mathbf{ifail}}=⟨\mathit{\text{value}}⟩$. Check all subroutine calls and array sizes. Seek expert help.
A serious error has occurred in an internal call: $\mathrm{IREVCM}=⟨\mathit{\text{value}}⟩$. Check all subroutine calls and array sizes. Seek expert help.
${\mathbf{ifail}}=-99$
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
${\mathbf{ifail}}=-399$
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.
${\mathbf{ifail}}=-999$
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

## 7Accuracy

On successful termination, the final residual ${r}_{k}=b-A{x}_{k}$, where $k={\mathbf{itn}}$, satisfies the termination criterion
 $‖rk‖∞≤τ×(‖b‖∞+‖A‖∞‖xk‖∞).$
The value of the final residual norm is returned in rnorm.

## 8Parallelism and Performance

f11def is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
f11def makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.
Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

The time taken by f11def for each iteration is roughly proportional to nnz.
The number of iterations required to achieve a prescribed accuracy cannot be easily determined a priori, as it can depend dramatically on the conditioning and spectrum of the preconditioned coefficient matrix $\overline{A}={{\mathbf{m}}}^{-1}A$.

## 10Example

This example solves a sparse nonsymmetric system of equations using the RGMRES method, with SSOR preconditioning.

### 10.1Program Text

Program Text (f11defe.f90)

### 10.2Program Data

Program Data (f11defe.d)

### 10.3Program Results

Program Results (f11defe.r)