NAG Library Routine Document

F11DRF

1  Purpose

2  Specification

3  Description

4  References

5  Parameters

1:     $\mathrm{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:     $\mathrm{N}$ – INTEGERInput

On entry: $n$, the order of the matrix $A$.

Constraint: $\mathbf{N}\ge 1$.

3:     $\mathrm{NNZ}$ – INTEGERInput

On entry: the number of nonzero elements in the matrix $A$.

Constraint: $1\le \mathbf{NNZ}\le {\mathbf{N}}^2$.

4:     $\mathrm{A}\left(\mathbf{NNZ}\right)$ – 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:     $\mathrm{IROW}\left(\mathbf{NNZ}\right)$ – INTEGER arrayInput

6:     $\mathrm{ICOL}\left(\mathbf{NNZ}\right)$ – 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:     $\mathrm{RDIAG}\left(\mathbf{N}\right)$ – COMPLEX (KIND=nag_wp) arrayInput

On entry: the elements of the diagonal matrix $D^{-1}$, where $D$ is the diagonal part of $A$.

8:     $\mathrm{OMEGA}$ – REAL (KIND=nag_wp)Input

On entry: the relaxation parameter $\omega$.

Constraint: $0.0<\mathbf{OMEGA}<2.0$.

9:     $\mathrm{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.

See also Section 9.2.

Constraint: $\mathbf{CHECK}=\text{'C'}$ or $\text{'N'}$.

10:   $\mathrm{Y}\left(\mathbf{N}\right)$ – COMPLEX (KIND=nag_wp) arrayInput

On entry: the right-hand side vector $y$.

11:   $\mathrm{X}\left(\mathbf{N}\right)$ – COMPLEX (KIND=nag_wp) arrayOutput

On exit: the solution vector $x$.

12:   $\mathrm{IWORK}\left(2\times \mathbf{N}+1\right)$ – INTEGER arrayWorkspace

13:   $\mathrm{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

$\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.

$\mathbf{IFAIL}=-99$

An unexpected error has been triggered by this routine. Please contact NAG.

See Section 3.8 in the Essential Introduction for further information.

$\mathbf{IFAIL}=-399$

Your licence key may have expired or may not have been installed correctly.

See Section 3.7 in the Essential Introduction for further information.

$\mathbf{IFAIL}=-999$

Dynamic memory allocation failed.

See Section 3.6 in the Essential Introduction for further information.

7  Accuracy

8  Parallelism and Performance

9  Further Comments

9.1  Timing

9.2  Use of CHECK

10  Example

10.1  Program Text

Program Text (f11drfe.f90)

10.2  Program Data

Program Data (f11drfe.d)

10.3  Program Results

Program Results (f11drfe.r)