# NAG FL Interfacef11jsf (complex_​herm_​solve_​jacssor)

## 1Purpose

f11jsf solves a complex sparse Hermitian system of linear equations, represented in symmetric coordinate storage format, using a conjugate gradient or Lanczos method, without preconditioning, with Jacobi or with SSOR preconditioning.

## 2Specification

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

## 3Description

f11jsf solves a complex sparse Hermitian linear system of equations
 $Ax=b,$
using a preconditioned conjugate gradient method (see Barrett et al. (1994)), or a preconditioned Lanczos method based on the algorithm SYMMLQ (see Paige and Saunders (1975)). The conjugate gradient method is more efficient if $A$ is positive definite, but may fail to converge for indefinite matrices. In this case the Lanczos method should be used instead. For further details see Barrett et al. (1994).
f11jsf 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 Cholesky (IC) preconditioning see f11jqf.
The matrix $A$ is represented in symmetric coordinate storage (SCS) format (see Section 2.1.2 in the F11 Chapter Introduction) in the arrays a, irow and icol. The array a holds the nonzero entries in the lower triangular part of the matrix, while irow and icol hold the corresponding row and column indices.

## 4References

Barrett R, Berry M, Chan T F, Demmel J, Donato J, Dongarra J, Eijkhout V, Pozo R, Romine C and Van der Vorst H (1994) Templates for the Solution of Linear Systems: Building Blocks for Iterative Methods SIAM, Philadelphia
Paige C C and Saunders M A (1975) Solution of sparse indefinite systems of linear equations SIAM J. Numer. Anal. 12 617–629
Young D (1971) Iterative Solution of Large Linear Systems Academic Press, New York

## 5Arguments

1: $\mathbf{method}$Character(*) Input
On entry: specifies the iterative method to be used.
${\mathbf{method}}=\text{'CG'}$
${\mathbf{method}}=\text{'SYMMLQ'}$
Lanczos method (SYMMLQ).
Constraint: ${\mathbf{method}}=\text{'CG'}$ or $\text{'SYMMLQ'}$.
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 (SSOR).
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 lower triangular part of the matrix $A$.
Constraint: $1\le {\mathbf{nnz}}\le {\mathbf{n}}×\left({\mathbf{n}}+1\right)/2$.
5: $\mathbf{a}\left({\mathbf{nnz}}\right)$Complex (Kind=nag_wp) array Input
On entry: the nonzero elements of the lower triangular part 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 f11zpf 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 array a.
Constraints:
irow and icol must satisfy these constraints (which may be imposed by a call to f11zpf):
• $1\le {\mathbf{irow}}\left(\mathit{i}\right)\le {\mathbf{n}}$ and $1\le {\mathbf{icol}}\left(\mathit{i}\right)\le {\mathbf{irow}}\left(\mathit{i}\right)$, 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.
Constraint: $0.0<{\mathbf{omega}}<2.0$.
9: $\mathbf{b}\left({\mathbf{n}}\right)$Complex (Kind=nag_wp) array Input
On entry: the right-hand side vector $b$.
10: $\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$.
11: $\mathbf{maxitn}$Integer Input
On entry: the maximum number of iterations allowed.
Constraint: ${\mathbf{maxitn}}\ge 1$.
12: $\mathbf{x}\left({\mathbf{n}}\right)$Complex (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$.
13: $\mathbf{rnorm}$Real (Kind=nag_wp) Output
On exit: the final value of the residual norm $‖{r}_{k}‖$, where $k$ is the output value of itn.
14: $\mathbf{itn}$Integer Output
On exit: the number of iterations carried out.
15: $\mathbf{rdiag}\left({\mathbf{n}}\right)$Real (Kind=nag_wp) array Output
On exit: the elements of the diagonal matrix ${D}^{-1}$, where $D$ is the diagonal part of $A$. Note that since $A$ is Hermitian the elements of ${D}^{-1}$ are necessarily real.
16: $\mathbf{work}\left({\mathbf{lwork}}\right)$Complex (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 f11jsf is called.
Constraints:
• if ${\mathbf{method}}=\text{'CG'}$, ${\mathbf{lwork}}\ge 6×{\mathbf{n}}+120$;
• if ${\mathbf{method}}=\text{'SYMMLQ'}$, ${\mathbf{lwork}}\ge 7×{\mathbf{n}}+120$.
18: $\mathbf{iwork}\left({\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{maxitn}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{maxitn}}\ge 1$.
On entry, ${\mathbf{method}}\ne \text{'CG'}$ or $\text{'SYMMLQ'}$: ${\mathbf{method}}=〈\mathit{\text{value}}〉$.
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}}×\left({\mathbf{n}}+1\right)/2$
On entry, ${\mathbf{omega}}=〈\mathit{\text{value}}〉$.
Constraint: $0.0<{\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, $\mathit{I}=〈\mathit{\text{value}}〉$, ${\mathbf{icol}}\left(\mathit{I}\right)=〈\mathit{\text{value}}〉$ and ${\mathbf{irow}}\left(\mathit{I}\right)=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{icol}}\left(\mathit{I}\right)\ge 1$ and ${\mathbf{icol}}\left(\mathit{I}\right)\le {\mathbf{irow}}\left(\mathit{I}\right)$.
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}}〉$.
A nonzero element has been supplied which does not lie in the lower triangular part of $A$, is out of order, or has duplicate row and column indices. Consider calling f11zpf to reorder and sum or remove duplicates.
${\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}}〉$.
${\mathbf{ifail}}=4$
The required accuracy could not be obtained. However, a reasonable accuracy has been achieved and further iterations could not improve the result.
${\mathbf{ifail}}=5$
The solution has not converged after $〈\mathit{\text{value}}〉$ iterations.
${\mathbf{ifail}}=6$
The preconditioner appears not to be positive definite. The computation cannot continue.
${\mathbf{ifail}}=7$
The matrix of the coefficients a appears not to be positive definite. The computation cannot continue.
${\mathbf{ifail}}=8$
A serious error, code $〈\mathit{\text{value}}〉$, has occurred in an internal call. Check all subroutine calls and array sizes. Seek expert help.
${\mathbf{ifail}}=9$
The matrix $A$ has a non-real diagonal entry in row $〈\mathit{\text{value}}〉$.
${\mathbf{ifail}}=-99$
An unexpected error has been triggered by this routine. Please contact NAG.
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

f11jsf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
f11jsf 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 f11jsf for each iteration is roughly proportional to nnz. One iteration with the Lanczos method (SYMMLQ) requires a slightly larger number of operations than one iteration with the conjugate gradient method.
The number of iterations required to achieve a prescribed accuracy cannot easily be determined a priori, as it can depend dramatically on the conditioning and spectrum of the preconditioned matrix of the coefficients $\overline{A}={M}^{-1}A$.

## 10Example

This example solves a complex sparse Hermitian positive definite system of equations using the conjugate gradient method, with SSOR preconditioning.

### 10.1Program Text

Program Text (f11jsfe.f90)

### 10.2Program Data

Program Data (f11jsfe.d)

### 10.3Program Results

Program Results (f11jsfe.r)