|
NAG[f11dac] NAG[nag_sparse_nsym_fac] - Incomplete factorization (nonsymmetric)
|
|
Calling Sequence
f11dac(nnz, a, la, irow, icol, lfill, dtol, milu, ipivp, ipivq, istr, idiag, nnzc, npivm, 'n'=n, 'pstrat'=pstrat, 'fail'=fail)
nag_sparse_nsym_fac(. . .)
Parameters
|
nnz - integer;
|
|
|
On entry: the number of non-zero elements in the matrix .
|
|
Constraint: . .
|
|
|
a - Vector(1..la, datatype=float[8]);
|
|
|
On entry: the non-zero 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 f11zac (nag_sparse_nsym_sort) may be used to order the elements in this way.
|
|
On exit: the first nnz entries of a contain the non-zero elements of and the next nnzc entries contain the elements of the matrix . Matrix elements are ordered by increasing row index, and by increasing column index within each row
|
|
|
la - assignable;
|
|
|
Note: On exit the variable la will have a value of type integer.
|
|
Default value: the dimension of the arrays a, irow, icol.
|
|
On entry: the first dimension of the arrays a, irow and icol as declared in the function from which nag_sparse_nsym_fac (f11dac) is called.
|
|
On exit: if internal allocation has taken place then la is set to , otherwise it remains unchanged.
|
|
Constraint: . .
|
|
|
irow - Vector(1..la, datatype=integer[kernelopts('wordsize')/8]);
icol - Vector(1..la, datatype=integer[kernelopts('wordsize')/8]);
|
|
|
On entry: the row and column indices of the non-zero elements supplied in a.
|
|
On exit: the row and column indices of the non-zero elements returned in a.
|
|
|
lfill - integer;
|
|
|
On entry: if its value is the maximum level of fill allowed in the decomposition (see Section [Control of Fill-in]). A negative value of lfill indicates that dtol will be used to control the fill instead.
|
|
|
dtol - float;
|
|
|
On entry: if then dtol is used as a drop tolerance to control the fill-in (see Section [Control of Fill-in]); otherwise dtol is not referenced.
|
|
Constraint: if , . .
|
|
|
milu - String;
|
|
|
On entry: indicates whether or not the factorization should be modified to preserve row sums (see Section [Choice of Arguments]):
|
|
if , the factorization is modified (MILU);
|
|
if , the factorization is not modified.
|
|
Constraint: "Nag_SparseNsym_ModFact" or "Nag_SparseNsym_UnModFact". .
|
|
|
ipivp - Vector(1..n, datatype=integer[kernelopts('wordsize')/8]);
ipivq - Vector(1..n, datatype=integer[kernelopts('wordsize')/8]);
|
|
|
Constraint: if , ipivp and ipivq must both hold valid permutations of the integers on .
|
|
|
istr - Vector(1.. , datatype=integer[kernelopts('wordsize')/8]);
|
|
|
|
idiag - Vector(1..n, datatype=integer[kernelopts('wordsize')/8]);
|
|
|
|
nnzc - assignable;
|
|
|
Note: On exit the variable nnzc will have a value of type integer.
|
|
On exit: the number of non-zero elements in the matrix .
|
|
|
npivm - assignable;
|
|
|
Note: On exit the variable npivm will have a value of type integer.
|
|
On exit: if it gives the number of pivots which were modified during the factorization to ensure that exists.
|
|
If no pivot modifications were required, but a local restart occurred (Section [Algorithmic Details]). The quality of the preconditioner will generally depend on the returned value of npivm. If npivm is large the preconditioner may not be satisfactory. In this case it may be advantageous to call nag_sparse_nsym_fac (f11dac) again with an increased value of lfill, a reduced value of dtol, or .
|
|
|
'n'=n - integer; (optional)
|
|
|
Default value: the first dimension of the arrays ipivp, ipivq, idiag.
|
|
On entry: the order of the matrix .
|
|
Constraint: . .
|
|
|
'pstrat'=pstrat - String; (optional)
|
|
|
On entry: specifies the pivoting strategy to be adopted as follows:
|
|
if , no pivoting is carried out;
|
|
if , pivoting is carried out according to the user-defined input value of ipivp and ipivq;
|
|
if , partial pivoting by columns for stability is carried out;
|
|
if , complete pivoting by rows for sparsity, and by columns for stability, is carried out.
|
|
Suggested value: (default: ).
|
|
Constraint: "Nag_SparseNsym_NoPiv", "Nag_SparseNsym_UserPiv", "Nag_SparseNsym_PartialPiv" or "Nag_SparseNsym_CompletePiv". .
|
|
|
'fail'=fail - table; (optional)
|
|
|
The NAG error argument, see the documentation for NagError.
|
|
|
|
Description
|
|
|
Purpose
|
|
nag_sparse_nsym_fac (f11dac) computes an incomplete factorization of a real sparse nonsymmetric matrix, represented in coordinate storage format. This factorization may be used as a preconditioner in combination with f11dcc (nag_sparse_nsym_fac_sol).
|
|
Description
|
|
nag_sparse_nsym_fac (f11dac) computes an incomplete factorization (Meijerink and Van der Vorst (1977) and Meijerink and Van der Vorst (1981)) of a real sparse nonsymmetric by matrix . The factorization is intended primarily for use as a preconditioner with the iterative solver f11dcc (nag_sparse_nsym_fac_sol).
The decomposition is written in the form
where
and is lower triangular with unit diagonal elements, is diagonal, is upper triangular with unit diagonals, and are permutation matrices, and is a remainder matrix.
The amount of fill-in occurring in the factorization can vary from zero to complete fill, and can be controlled by specifying either the maximum level of fill lfill, or the drop tolerance dtol.
The argument pstrat defines the pivoting strategy to be used. The options currently available are no pivoting, user-defined pivoting, partial pivoting by columns for stability, and complete pivoting by rows for sparsity and by columns for stability. The factorization may optionally be modified to preserve the row-sums of the original matrix.
The sparse matrix is represented in coordinate storage (CS) format (see Section [Symmetric coordinate storage (SCS) format] in the f11 Chapter Introduction). The array a stores all the non-zero elements of the matrix , while arrays irow and icol store the corresponding row and column indices respectively. Multiple non-zero elements may not be specified for the same row and column index.
The preconditioning matrix is returned in terms of the CS representation of the matrix
Further algorithmic details are given in Section [Algorithmic Details].
|
|
Error Indicators and Warnings
|
|
"NE_2_INT_ARG_LT"
On entry, while . These arguments must satisfy .
"NE_ALLOC_FAIL"
Dynamic memory allocation failed.
"NE_BAD_PARAM"
On entry, argument milu had an illegal value.
"NE_INT_2"
On entry, , . Constraint:
"NE_INT_ARG_LT"
On entry, n must not be less than 1: .
"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 consult NAG for assistance.
"NE_INVALID_ROWCOL_PIVOT"
On entry, , but one or both of the arrays ipivp and ipivq does not represent a valid permutation of the integers in . An input value of ipivp or ipivq is either out of range or repeated.
"NE_NONSYMM_MATRIX_DUP"
A non-zero matrix element has been supplied which does not lie within the matrix , is out of order or has duplicate row and column indices, i.e., one or more of the following constraints has been violated:
|
, or
|
Call f11zac (nag_sparse_nsym_sort) to reorder and sum or remove duplicates.
"NE_REAL_INT_ARG_CONS"
On entry, and . These arguments must satisfy if .
|
|
Accuracy
|
|
The accuracy of the factorization will be determined by the size of the elements that are dropped and the size of any modifications made to the pivot elements. If these sizes are small then the computed factors will correspond to a matrix close to . The factorization can generally be made more accurate by increasing lfill, or by reducing dtol with .
If nag_sparse_nsym_fac (f11dac) is used in combination with f11dcc (nag_sparse_nsym_fac_sol), the more accurate the factorization the fewer iterations will be required. However, the cost of the decomposition will also generally increase.
|
|
Further Comments
|
|
The time taken for a call to nag_sparse_nsym_fac (f11dac) is roughly proportional to .
|
Algorithmic Details
|
|
The factorization is constructed row by row. At each elimination stage a row index is chosen. In the case of complete pivoting this index is chosen in order to reduce fill-in. Otherwise the rows are treated in the order given, or some user-defined order.
The chosen row is copied from the original matrix and modified according to those previous elimination stages which affect it. During this process any fill-in elements are either dropped or kept according to the values of lfill or dtol. In the case of a modified factorization ( ) the sum of the dropped terms for the given row is stored.
Finally the pivot element for the row is chosen and the multipliers are computed for this elimination stage. For partial or complete pivoting the pivot element is chosen in the interests of stability as the element of largest absolute value in the row. Otherwise the pivot element is chosen in the order given, or some user-defined order.
If the factorization breaks down because the chosen pivot element is zero, or there is no non-zero pivot available, a local restart recovery process is implemented. The modification of the given pivot row according to previous elimination stages is repeated, but this time keeping all fill. Note that in this case the final factorization will include more fill than originally specified by the user-supplied value of lfill or dtol. The local restart usually results in a suitable non-zero pivot arising. The original criteria for dropping fill-in elements is then resumed for the next elimination stage (hence the local nature of the restart process). Should this restart process also fail to produce a non-zero pivot element an arbitrary unit pivot is introduced in an arbitrarily chosen column. nag_sparse_nsym_fac (f11dac) returns an integer argument npivm which gives the number of these arbitrary unit pivots introduced. If no pivots were modified but local restarts occurred is returned.
|
|
Choice of Arguments
|
|
There is unfortunately no choice of the various algorithmic arguments which is optimal for all types of matrix, and some experimentation will generally be required for each new type of matrix encountered.
If the matrix is not known to have any particular special properties the following strategy is recommended. Start with and . If the value returned for npivm is significantly larger than zero, i.e., a large number of pivot modifications were required to ensure that existed, the preconditioner is not likely to be satisfactory. In this case increase lfill until npivm falls to a value close to zero.
If has non-positive off-diagonal elements, is non-singular, and has only non-negative elements in its inverse, it is called an "M-matrix". It can be shown that no pivot modifications are required in the incomplete factorization of an M-matrix (Meijerink and Van der Vorst (1977)). In this case a good preconditioner can generally be expected by setting , and .
Some illustrations of the application of nag_sparse_nsym_fac (f11dac) to linear systems arising from the discretization of two-dimensional elliptic partial differential equations, and to random-valued randomly structured linear systems, can be found in Salvini and Shaw (1996).
|
|
|
|
Examples
|
|
>
|
n := 4:
nnz := 11:
la := 22:
lfill := 1:
dtol := 0:
pstrat := "Nag_SparseNsym_CompletePiv":
milu := "Nag_SparseNsym_UnModFact":
a := Vector[row](la,[1.0,1.0,-1.0,2.0,2.0,3.0,-2.0,1.0,-2.0,1.0,1.0],datatype=float[8]):
irow := Vector[row](22,[1,1,2,2,2,3,3,4,4,4,4],datatype=integer[kernelopts('wordsize')/8]):
icol := Vector[row](22,[2,3,1,3,4,1,4,1,2,3,4],datatype=integer[kernelopts('wordsize')/8]):
ipivp := Vector([0, 0, 0, 0], datatype=integer[kernelopts('wordsize')/8]):
ipivq := Vector([0, 0, 0, 0], datatype=integer[kernelopts('wordsize')/8]):
istr := Vector(5, datatype=integer[kernelopts('wordsize')/8]):
idiag := Vector(4, datatype=integer[kernelopts('wordsize')/8]):
NAG:-f11dac(nnz, a, la, irow, icol, lfill, dtol, milu, ipivp, ipivq, istr, idiag, nnzc, npivm, 'n' = n, 'pstrat' = pstrat):
|
|
|
See Also
|
|
Meijerink J and Van der Vorst H (1977) An iterative solution method for linear systems of which the coefficient matrix is a symmetric M-matrix Math. Comput. 31 148–162
Meijerink J and Van der Vorst H (1981) Guidelines for the usage of incomplete decompositions in solving sets of linear equations as they occur in practical problems J. Comput. Phys. 44 134–155
Salvini S A and Shaw G J (1996) An evaluation of new NAG Library solvers for large sparse unsymmetric linear systems NAG Technical Report TR2/96
f11 Chapter Introduction.
NAG Toolbox Overview.
NAG Web Site.
|
|