# NAG FL Interfacef11jrf (complex_​herm_​precon_​ssor_​solve)

## ▸▿ Contents

Settings help

FL Name Style:

FL Specification Language:

## 1Purpose

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

## 2Specification

Fortran Interface
 Subroutine f11jrf ( n, nnz, a, irow, icol, y, x,
 Integer, Intent (In) :: n, nnz, irow(nnz), icol(nnz) Integer, Intent (Inout) :: ifail Integer, Intent (Out) :: iwork(n+1) Real (Kind=nag_wp), Intent (In) :: rdiag(n), omega Complex (Kind=nag_wp), Intent (In) :: a(nnz), y(n) Complex (Kind=nag_wp), Intent (Out) :: x(n) Character (1), Intent (In) :: check
#include <nag.h>
 void f11jrf_ (const Integer *n, const Integer *nnz, const Complex a[], const Integer irow[], const Integer icol[], const double rdiag[], const double *omega, const char *check, const Complex y[], Complex x[], Integer iwork[], Integer *ifail, const Charlen length_check)
The routine may be called by the names f11jrf or nagf_sparse_complex_herm_precon_ssor_solve.

## 3Description

f11jrf solves a system of equations
 $Mx=y$
involving the preconditioning matrix
 $M=1ω(2-ω) (D+ωL) D-1 (D+ωL)H$
corresponding to symmetric successive-over-relaxation (SSOR) (see Young (1971)) on a linear system $Ax=b$, where $A$ is a sparse complex Hermitian matrix stored in symmetric coordinate storage (SCS) format (see Section 2.1.2 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$ and $\omega$ is a user-defined relaxation parameter. Note that since $A$ is Hermitian the matrix $D$ is necessarily real.

## 4References

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

## 5Arguments

1: $\mathbf{n}$Integer Input
On entry: $n$, the order of the matrix $A$.
Constraint: ${\mathbf{n}}\ge 1$.
2: $\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$.
3: $\mathbf{a}\left({\mathbf{nnz}}\right)$Complex (Kind=nag_wp) array Input
On entry: the nonzero elements in 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.
4: $\mathbf{irow}\left({\mathbf{nnz}}\right)$Integer array Input
5: $\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 the following 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}}$.
6: $\mathbf{rdiag}\left({\mathbf{n}}\right)$Real (Kind=nag_wp) array Input
On entry: 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.
7: $\mathbf{omega}$Real (Kind=nag_wp) Input
On entry: the relaxation parameter $\omega$.
Constraint: $0.0<{\mathbf{omega}}<2.0$.
8: $\mathbf{check}$Character(1) Input
On entry: specifies whether or not the input data should be checked.
${\mathbf{check}}=\text{'C'}$
Checks are carried out 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'}$.
9: $\mathbf{y}\left({\mathbf{n}}\right)$Complex (Kind=nag_wp) array Input
On entry: the right-hand side vector $y$.
10: $\mathbf{x}\left({\mathbf{n}}\right)$Complex (Kind=nag_wp) array Output
On exit: the solution vector $x$.
11: $\mathbf{iwork}\left({\mathbf{n}}+1\right)$Integer array Workspace
12: $\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, ${\mathbf{check}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{check}}=\text{'C'}$ or $\text{'N'}$.
${\mathbf{ifail}}=2$
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$.
${\mathbf{ifail}}=3$
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}}⟩$, ${\mathbf{irow}}\left(\mathit{I}\right)=⟨\mathit{\text{value}}⟩$.
Constraint: $1\le {\mathbf{icol}}\left(i\right)\le {\mathbf{irow}}\left(i\right)$.
On entry, $\mathit{I}=⟨\mathit{\text{value}}⟩$, ${\mathbf{irow}}\left(\mathit{I}\right)=⟨\mathit{\text{value}}⟩$ and ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: $1\le {\mathbf{irow}}\left(\mathit{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}}=4$
The matrix $A$ has no diagonal entry in row $⟨\mathit{\text{value}}⟩$.
${\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

The computed solution $x$ is the exact solution of a perturbed system of equations $\left(M+\delta M\right)x=y$, where
 $|δM|≤c(n)ε|D+ωL||D-1||(D+ωL)T|,$
$c\left(n\right)$ is a modest linear function of $n$, and $\epsilon$ is the machine precision.

## 8Parallelism and Performance

f11jrf is not threaded in any implementation.

### 9.1Timing

The time taken for a call to f11jrf is proportional to nnz.

## 10Example

This example program solves the preconditioning equation $Mx=y$ for a $9×9$ sparse complex Hermitian matrix $A$, given in symmetric coordinate storage (SCS) format.

### 10.1Program Text

Program Text (f11jrfe.f90)

### 10.2Program Data

Program Data (f11jrfe.d)

### 10.3Program Results

Program Results (f11jrfe.r)