f11drc 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.
The function may be called by the names: f11drc, nag_sparse_complex_gen_precon_ssor_solve or nag_sparse_nherm_precon_ssor_solve.
3Description
f11drc solves a system of linear equations
according to the value of the argument 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 f11drc will be to carry out the preconditioning step required in the application of f11bsc to sparse linear systems. f11drc is also used for this purpose by the Black Box function f11dsc.
4References
Young D (1971) Iterative Solution of Large Linear Systems Academic Press, New York
5Arguments
1: – Nag_TransTypeInput
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: – const ComplexInput
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 function f11znc may be used to order the elements in this way.
5: – const IntegerInput
6: – const IntegerInput
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 f11znc):
and , for ;
either or both and , for .
7: – const ComplexInput
On entry: the elements of the diagonal matrix , where is the diagonal part of .
8: – doubleInput
On entry: the relaxation parameter .
Constraint:
.
9: – Nag_SparseNsym_CheckDataInput
On entry: specifies whether or not the CS representation of the matrix should be checked.
The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).
6Error Indicators and Warnings
A nonzero element has been supplied which does not lie in the matrix , is out of order, or has duplicate row and column indices. Consider calling f11znc to reorder and sum or remove duplicates.
The SSOR preconditioner is not appropriate for this problem.
NE_ALLOC_FAIL
Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
NE_BAD_PARAM
On entry, argument had an illegal value.
NE_INT
On entry, .
Constraint: .
On entry, .
Constraint: .
NE_INT_2
On entry, and .
Constraint: .
NE_INTERNAL_ERROR
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.
See Section 7.5 in the Introduction to the NAG Library CL Interface for further information.
NE_INVALID_CS
On entry, , and .
Constraint: and .
On entry, , and .
Constraint: and .
NE_NO_LICENCE
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library CL Interface for further information.
NE_NOT_STRICTLY_INCREASING
On entry, is out of order: .
On entry, the location () is a duplicate: .
NE_REAL
On entry, .
Constraint:
NE_ZERO_DIAG_ELEM
The matrix has no diagonal entry in row .
7Accuracy
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 .
8Parallelism and Performance
Background information to multithreading can be found in the Multithreading documentation.
f11drc is not threaded in any implementation.
9Further Comments
9.1Timing
The time taken for a call to f11drc is proportional to nnz.
It is expected that a common use of f11drc will be to carry out the preconditioning step required in the application of f11bsc to sparse linear systems. In this situation f11drc 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.
10Example
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 function f11bsc, which returns repeatedly to the calling program with various values of the argument irevcm. This argument indicates the action to be taken by the calling program.
If , a matrix-vector product is required. This is implemented by a call to f11xnc.
If , a conjugate transposed matrix-vector product is required in the estimation of the norm of . This is implemented by a call to f11xnc.
If , a solution of the preconditioning equation is required. This is achieved by a call to f11drc.
If , f11bsc has completed its tasks. Either the iteration has terminated, or an error condition has arisen.
For further details see the function document for f11bsc.