F11 Chapter Contents
F11 Chapter Introduction
NAG Library Manual

# NAG Library Routine DocumentF11DRF

Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.

## 1  Purpose

F11DRF solves a system of linear equations involving the preconditioning matrix corresponding to SSOR applied to a complex sparse non-Hermitian matrix, represented in coordinate storage format.

## 2  Specification

 SUBROUTINE F11DRF ( TRANS, N, NNZ, A, IROW, ICOL, RDIAG, OMEGA, CHECK, Y, X, IWORK, IFAIL)
 INTEGER N, NNZ, IROW(NNZ), ICOL(NNZ), IWORK(2*N+1), IFAIL REAL (KIND=nag_wp) OMEGA COMPLEX (KIND=nag_wp) A(NNZ), RDIAG(N), Y(N), X(N) CHARACTER(1) TRANS, CHECK

## 3  Description

F11DRF solves a system of linear equations
 $Mx=y, or MHx=y,$
according to the value of the parameter TRANS, where the matrix
 $M=1ω2-ω D+ω L D-1 D+ω U$
corresponds to symmetric successive-over-relaxation (SSOR) Young (1971) applied to a linear system $Ax=b$, where $A$ is a complex sparse non-Hermitian matrix stored in coordinate storage (CS) format (see Section 2.1.1 in the F11 Chapter Introduction).
In the definition of $M$ given above $D$ is the diagonal part of $A$, $L$ is the strictly lower triangular part of $A$, $U$ is the strictly upper triangular part of $A$, and $\omega$ is a user-defined relaxation parameter.
It is envisaged that a common use of F11DRF will be to carry out the preconditioning step required in the application of F11BSF to sparse linear systems. For an illustration of this use of F11DRF see the example program given in Section 9. F11DRF is also used for this purpose by the Black Box routine F11DSF.

## 4  References

Young D (1971) Iterative Solution of Large Linear Systems Academic Press, New York

## 5  Parameters

1:     TRANS – CHARACTER(1)Input
On entry: specifies whether or not the matrix $M$ is transposed.
${\mathbf{TRANS}}=\text{'N'}$
$Mx=y$ is solved.
${\mathbf{TRANS}}=\text{'T'}$
${M}^{\mathrm{H}}x=y$ is solved.
Constraint: ${\mathbf{TRANS}}=\text{'N'}$ or $\text{'T'}$.
2:     N – INTEGERInput
On entry: $n$, the order of the matrix $A$.
Constraint: ${\mathbf{N}}\ge 1$.
3:     NNZ – INTEGERInput
On entry: the number of nonzero elements in the matrix $A$.
Constraint: $1\le {\mathbf{NNZ}}\le {{\mathbf{N}}}^{2}$.
4:     A(NNZ) – COMPLEX (KIND=nag_wp) arrayInput
On entry: the nonzero elements in 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 F11ZNF may be used to order the elements in this way.
5:     IROW(NNZ) – INTEGER arrayInput
6:     ICOL(NNZ) – INTEGER arrayInput
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 F11ZNF):
• $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}}$;
• either ${\mathbf{IROW}}\left(\mathit{i}-1\right)<{\mathbf{IROW}}\left(\mathit{i}\right)$ or both ${\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}}$.
7:     RDIAG(N) – COMPLEX (KIND=nag_wp) arrayInput
On entry: the elements of the diagonal matrix ${D}^{-1}$, where $D$ is the diagonal part of $A$.
8:     OMEGA – REAL (KIND=nag_wp)Input
On entry: the relaxation parameter $\omega$.
Constraint: $0.0<{\mathbf{OMEGA}}<2.0$.
9:     CHECK – CHARACTER(1)Input
On entry: specifies whether or not the CS representation of the matrix $M$ should be checked.
${\mathbf{CHECK}}=\text{'C'}$
Checks are carried on the values of N, NNZ, IROW, ICOL and OMEGA.
${\mathbf{CHECK}}=\text{'N'}$
None of these checks are carried out.
Constraint: ${\mathbf{CHECK}}=\text{'C'}$ or $\text{'N'}$.
10:   Y(N) – COMPLEX (KIND=nag_wp) arrayInput
On entry: the right-hand side vector $y$.
11:   X(N) – COMPLEX (KIND=nag_wp) arrayOutput
On exit: the solution vector $x$.
12:   IWORK($2×{\mathbf{N}}+1$) – INTEGER arrayWorkspace
13:   IFAIL – INTEGERInput/Output
On entry: IFAIL must be set to $0$, $-1\text{​ or ​}1$. If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value $-1\text{​ or ​}1$ is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, if you are not familiar with this parameter, the recommended value is $0$. When the value $-\mathbf{1}\text{​ 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).

## 6  Error Indicators and Warnings

If on entry ${\mathbf{IFAIL}}={\mathbf{0}}$ or $-{\mathbf{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, ${\mathbf{TRANS}}\ne \text{'N'}$ or $\text{'T'}$, or ${\mathbf{CHECK}}\ne \text{'C'}$ or $\text{'N'}$.
${\mathbf{IFAIL}}=2$
 On entry, ${\mathbf{N}}<1$, or ${\mathbf{NNZ}}<1$, or ${\mathbf{NNZ}}>{{\mathbf{N}}}^{2}$, or OMEGA lies outside the interval $\left(0.0,2.0\right)$,
${\mathbf{IFAIL}}=3$
On entry, the arrays IROW and ICOL fail to satisfy the following constraints:
• $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(i-1\right)<{\mathbf{IROW}}\left(i\right)$ or ${\mathbf{IROW}}\left(i-1\right)={\mathbf{IROW}}\left(i\right)$ and ${\mathbf{ICOL}}\left(i-1\right)<{\mathbf{ICOL}}\left(i\right)$, for $i=2,3,\dots ,{\mathbf{NNZ}}$.
Therefore a nonzero element has been supplied which does not lie in the matrix $A$, is out of order, or has duplicate row and column indices. Call F11ZNF to reorder and sum or remove duplicates.
${\mathbf{IFAIL}}=4$
On entry, the matrix $A$ has a zero diagonal element. The SSOR preconditioner is not appropriate for this problem.

## 7  Accuracy

If ${\mathbf{TRANS}}=\text{'N'}$ the computed solution $x$ is the exact solution of a perturbed system of equations $\left(M+\delta M\right)x=y$, where
 $δM≤cnεD+ωLD-1D+ωU,$
$c\left(n\right)$ is a modest linear function of $n$, and $\epsilon$ is the machine precision. An equivalent result holds when ${\mathbf{TRANS}}=\text{'T'}$.

### 8.1  Timing

The time taken for a call to F11DRF is proportional to NNZ.

### 8.2  Use of CHECK

It is expected that a common use of F11DRF will be to carry out the preconditioning step required in the application of F11BSF to sparse linear systems. In this situation F11DRF is likely to be called many times with the same matrix $M$. In the interests of both reliability and efficiency, you are recommended to set ${\mathbf{CHECK}}=\text{'C'}$ for the first of such calls, and ${\mathbf{CHECK}}=\text{'N'}$ for all subsequent calls.

## 9  Example

This example solves a complex sparse linear system of equations
 $Ax=b,$
using RGMRES with SSOR preconditioning.
The RGMRES algorithm itself is implemented by the reverse communication routine F11BSF, which returns repeatedly to the calling program with various values of the parameter IREVCM. This parameter indicates the action to be taken by the calling program.
• If ${\mathbf{IREVCM}}=1$, a matrix-vector product $v=Au$ is required. This is implemented by a call to F11XNF.
• If ${\mathbf{IREVCM}}=-1$, a conjugate transposed matrix-vector product $v={A}^{\mathrm{H}}u$ is required in the estimation of the norm of $A$. This is implemented by a call to F11XNF.
• If ${\mathbf{IREVCM}}=2$, a solution of the preconditioning equation $Mv=u$ is required. This is achieved by a call to F11DRF.
• If ${\mathbf{IREVCM}}=4$, F11BSF has completed its tasks. Either the iteration has terminated, or an error condition has arisen.
For further details see the routine document for F11BSF.

### 9.1  Program Text

Program Text (f11drfe.f90)

### 9.2  Program Data

Program Data (f11drfe.d)

### 9.3  Program Results

Program Results (f11drfe.r)