NAG Library Routine Document
F11DRF
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
according to the value of the parameter
TRANS, where the matrix
corresponds to symmetric successive-over-relaxation (SSOR)
Young (1971) applied to a linear system
, where
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 given above is the diagonal part of , is the strictly lower triangular part of , is the strictly upper triangular part of , and 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 10. 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: – CHARACTER(1)Input
-
On entry: specifies whether or not the matrix
is transposed.
- is solved.
- is solved.
Constraint:
or .
- 2: – INTEGERInput
-
On entry: , the order of the matrix .
Constraint:
.
- 3: – INTEGERInput
-
On entry: the number of nonzero elements in the matrix .
Constraint:
.
- 4: – COMPLEX (KIND=nag_wp) arrayInput
-
On entry: the nonzero elements in the matrix
, 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: – INTEGER arrayInput
- 6: – 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):
- and , for ;
- either or both and , for .
- 7: – COMPLEX (KIND=nag_wp) arrayInput
-
On entry: the elements of the diagonal matrix , where is the diagonal part of .
- 8: – REAL (KIND=nag_wp)Input
-
On entry: the relaxation parameter .
Constraint:
.
- 9: – CHARACTER(1)Input
-
On entry: specifies whether or not the CS representation of the matrix
should be checked.
- Checks are carried on the values of N, NNZ, IROW, ICOL and OMEGA.
- None of these checks are carried out.
Constraint:
or .
- 10: – COMPLEX (KIND=nag_wp) arrayInput
-
On entry: the right-hand side vector .
- 11: – COMPLEX (KIND=nag_wp) arrayOutput
-
On exit: the solution vector .
- 12: – INTEGER arrayWorkspace
-
- 13: – INTEGERInput/Output
-
On entry:
IFAIL must be set to
,
. 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
is recommended. If the output of error messages is undesirable, then the value
is recommended. Otherwise, if you are not familiar with this parameter, the recommended value is
.
When the value is used it is essential to test the value of IFAIL on exit.
On exit:
unless the routine detects an error or a warning has been flagged (see
Section 6).
6 Error Indicators and Warnings
If on entry
or
, explanatory error messages are output on the current error message unit (as defined by
X04AAF).
Errors or warnings detected by the routine:
-
On entry, | or , |
or | or . |
-
On entry, | , |
or | , |
or | , |
or | OMEGA lies outside the interval , |
-
On entry, the arrays
IROW and
ICOL fail to satisfy the following constraints:
- and , for ;
- or and , for .
Therefore a nonzero element has been supplied which does not lie in the matrix
, is out of order, or has duplicate row and column indices. Call
F11ZNF to reorder and sum or remove duplicates.
-
On entry, the matrix has a zero diagonal element. The SSOR preconditioner is not appropriate for this problem.
An unexpected error has been triggered by this routine. Please
contact
NAG.
See
Section 3.8 in the Essential Introduction for further information.
Your licence key may have expired or may not have been installed correctly.
See
Section 3.7 in the Essential Introduction for further information.
Dynamic memory allocation failed.
See
Section 3.6 in the Essential Introduction for further information.
7 Accuracy
If
the computed solution
is the exact solution of a perturbed system of equations
, where
is a modest linear function of
, and
is the
machine precision. An equivalent result holds when
.
8 Parallelism and Performance
Not applicable.
The time taken for a call to F11DRF is proportional to
NNZ.
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
. In the interests of both reliability and efficiency, you are recommended to set
for the first of such calls, and
for all subsequent calls.
10 Example
This example solves a complex sparse linear system of equations
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 , a matrix-vector product is required. This is implemented by a call to F11XNF.
- If , a conjugate transposed matrix-vector product is required in the estimation of the norm of . This is implemented by a call to F11XNF.
- If , a solution of the preconditioning equation is required. This is achieved by a call to F11DRF.
- If , 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.
10.1 Program Text
Program Text (f11drfe.f90)
10.2 Program Data
Program Data (f11drfe.d)
10.3 Program Results
Program Results (f11drfe.r)