# NAG FL Interfacef11jcf (real_​symm_​solve_​ichol)

## 1Purpose

f11jcf solves a real sparse symmetric system of linear equations, represented in symmetric coordinate storage format, using a conjugate gradient or Lanczos method, with incomplete Cholesky preconditioning.

## 2Specification

Fortran Interface
 Subroutine f11jcf ( n, nnz, a, la, irow, icol, ipiv, istr, b, tol, x, itn, work,
 Integer, Intent (In) :: n, nnz, la, irow(la), icol(la), istr(n+1), maxitn, lwork Integer, Intent (Inout) :: ipiv(n), ifail Integer, Intent (Out) :: itn Real (Kind=nag_wp), Intent (In) :: a(la), b(n), tol Real (Kind=nag_wp), Intent (Inout) :: x(n) Real (Kind=nag_wp), Intent (Out) :: rnorm, work(lwork) Character (*), Intent (In) :: method
#include <nag.h>
 void f11jcf_ (const char *method, const Integer *n, const Integer *nnz, const double a[], const Integer *la, const Integer irow[], const Integer icol[], Integer ipiv[], const Integer istr[], const double b[], const double *tol, const Integer *maxitn, double x[], double *rnorm, Integer *itn, double work[], const Integer *lwork, Integer *ifail, const Charlen length_method)
The routine may be called by the names f11jcf or nagf_sparse_real_symm_solve_ichol.

## 3Description

f11jcf solves a real sparse symmetric linear system of equations
 $Ax=b,$
using a preconditioned conjugate gradient method (see Meijerink and Van der Vorst (1977)), or a preconditioned Lanczos method based on the algorithm SYMMLQ (see Paige and Saunders (1975)). The conjugate gradient method is more efficient if $A$ is positive definite, but may fail to converge for indefinite matrices. In this case the Lanczos method should be used instead. For further details see Barrett et al. (1994).
f11jcf uses the incomplete Cholesky factorization determined by f11jaf as the preconditioning matrix. A call to f11jcf must always be preceded by a call to f11jaf. Alternative preconditioners for the same storage scheme are available by calling f11jef.
The matrix $A$, and the preconditioning matrix $M$, are represented in symmetric coordinate storage (SCS) format (see Section 2.1.2 in the F11 Chapter Introduction) in the arrays a, irow and icol, as returned from f11jaf. The array a holds the nonzero entries in the lower triangular parts of these matrices, while irow and icol hold the corresponding row and column indices.

## 4References

Barrett R, Berry M, Chan T F, Demmel J, Donato J, Dongarra J, Eijkhout V, Pozo R, Romine C and Van der Vorst H (1994) Templates for the Solution of Linear Systems: Building Blocks for Iterative Methods SIAM, Philadelphia
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
Paige C C and Saunders M A (1975) Solution of sparse indefinite systems of linear equations SIAM J. Numer. Anal. 12 617–629
Salvini S A and Shaw G J (1995) An evaluation of new NAG Library solvers for large sparse symmetric linear systems NAG Technical Report TR1/95

## 5Arguments

1: $\mathbf{method}$Character(*) Input
On entry: specifies the iterative method to be used.
${\mathbf{method}}=\text{'CG'}$
${\mathbf{method}}=\text{'SYMMLQ'}$
Lanczos method (SYMMLQ).
Constraint: ${\mathbf{method}}=\text{'CG'}$ or $\text{'SYMMLQ'}$.
2: $\mathbf{n}$Integer Input
On entry: $n$, the order of the matrix $A$. This must be the same value as was supplied in the preceding call to f11jaf.
Constraint: ${\mathbf{n}}\ge 1$.
3: $\mathbf{nnz}$Integer Input
On entry: the number of nonzero elements in the lower triangular part of the matrix $A$. This must be the same value as was supplied in the preceding call to f11jaf.
Constraint: $1\le {\mathbf{nnz}}\le {\mathbf{n}}×\left({\mathbf{n}}+1\right)/2$.
4: $\mathbf{a}\left({\mathbf{la}}\right)$Real (Kind=nag_wp) array Input
On entry: the values returned in the array a by a previous call to f11jaf.
5: $\mathbf{la}$Integer Input
On entry: the dimension of the arrays a, irow and icol as declared in the (sub)program from which f11jcf is called. This must be the same value as was supplied in the preceding call to f11jaf.
Constraint: ${\mathbf{la}}\ge 2×{\mathbf{nnz}}$.
6: $\mathbf{irow}\left({\mathbf{la}}\right)$Integer array Input
7: $\mathbf{icol}\left({\mathbf{la}}\right)$Integer array Input
8: $\mathbf{ipiv}\left({\mathbf{n}}\right)$Integer array Input
9: $\mathbf{istr}\left({\mathbf{n}}+1\right)$Integer array Input
On entry: the values returned in arrays irow, icol, ipiv and istr by a previous call to f11jaf.
10: $\mathbf{b}\left({\mathbf{n}}\right)$Real (Kind=nag_wp) array Input
On entry: the right-hand side vector $b$.
11: $\mathbf{tol}$Real (Kind=nag_wp) Input
On entry: the required tolerance. Let ${x}_{k}$ denote the approximate solution at iteration $k$, and ${r}_{k}$ the corresponding residual. The algorithm is considered to have converged at iteration $k$ if
 $rk∞≤τ×b∞+A∞xk∞.$
If ${\mathbf{tol}}\le 0.0$, $\tau =\mathrm{max}\phantom{\rule{0.25em}{0ex}}\sqrt{\epsilon },10\epsilon ,\sqrt{n}\epsilon$ is used, where $\epsilon$ is the machine precision. Otherwise $\tau =\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left({\mathbf{tol}},10\epsilon ,\sqrt{n}\epsilon \right)$ is used.
Constraint: ${\mathbf{tol}}<1.0$.
12: $\mathbf{maxitn}$Integer Input
On entry: the maximum number of iterations allowed.
Constraint: ${\mathbf{maxitn}}\ge 1$.
13: $\mathbf{x}\left({\mathbf{n}}\right)$Real (Kind=nag_wp) array Input/Output
On entry: an initial approximation to the solution vector $x$.
On exit: an improved approximation to the solution vector $x$.
14: $\mathbf{rnorm}$Real (Kind=nag_wp) Output
On exit: the final value of the residual norm ${‖{r}_{k}‖}_{\infty }$, where $k$ is the output value of itn.
15: $\mathbf{itn}$Integer Output
On exit: the number of iterations carried out.
16: $\mathbf{work}\left({\mathbf{lwork}}\right)$Real (Kind=nag_wp) array Workspace
17: $\mathbf{lwork}$Integer Input
On entry: the dimension of the array work as declared in the (sub)program from which f11jcf is called.
Constraints:
• if ${\mathbf{method}}=\text{'CG'}$, ${\mathbf{lwork}}\ge 6×{\mathbf{n}}+120$;
• if ${\mathbf{method}}=\text{'SYMMLQ'}$, ${\mathbf{lwork}}\ge 7×{\mathbf{n}}+120$.
18: $\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{la}}=〈\mathit{\text{value}}〉$ and ${\mathbf{nnz}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{la}}\ge 2×{\mathbf{nnz}}$.
On entry, lwork is too small: ${\mathbf{lwork}}=〈\mathit{\text{value}}〉$. Minimum required value of ${\mathbf{lwork}}=〈\mathit{\text{value}}〉$.
On entry, ${\mathbf{maxitn}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{maxitn}}\ge 1$.
On entry, ${\mathbf{method}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{method}}=\text{'CG'}$ or $\text{'SYMMLQ'}$.
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{tol}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{tol}}<1.0$.
${\mathbf{ifail}}=2$
On entry, ${\mathbf{a}}\left(i\right)$ is out of order: $i=〈\mathit{\text{value}}〉$.
On entry, $i=〈\mathit{\text{value}}〉$, ${\mathbf{icol}}\left(i\right)=〈\mathit{\text{value}}〉$, ${\mathbf{irow}}\left(i\right)=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{icol}}\left(i\right)\ge 1$ and ${\mathbf{icol}}\left(i\right)\le {\mathbf{irow}}\left(i\right)$.
On entry, $i=〈\mathit{\text{value}}〉$, ${\mathbf{irow}}\left(i\right)=〈\mathit{\text{value}}〉$ and ${\mathbf{n}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{irow}}\left(i\right)\ge 1$ and ${\mathbf{irow}}\left(i\right)\le {\mathbf{n}}$.
On entry, the location (${\mathbf{irow}}\left(i\right),{\mathbf{icol}}\left(i\right)$) is a duplicate: $i=〈\mathit{\text{value}}〉$.
Check that a, irow, icol, ipiv and istr have not been corrupted between calls to f11jaf and f11jcf.
${\mathbf{ifail}}=3$
The SCS representation of the preconditioner is invalid.
Check that a, irow, icol, ipiv and istr have not been corrupted between calls to f11jaf and f11jcf.
${\mathbf{ifail}}=4$
The required accuracy could not be obtained. However a reasonable accuracy has been achieved.
${\mathbf{ifail}}=5$
The solution has not converged after $〈\mathit{\text{value}}〉$ iterations.
${\mathbf{ifail}}=6$
The preconditioner appears not to be positive definite. The computation cannot continue.
${\mathbf{ifail}}=7$
The matrix of the coefficients a appears not to be positive definite. The computation cannot continue.
${\mathbf{ifail}}=8$
A serious error has occurred in an internal call: ${\mathbf{ifail}}=〈\mathit{\text{value}}〉$. Check all subroutine calls and array sizes. Seek expert help.
A serious error has occurred in an internal call: $\mathrm{IREVCM}=〈\mathit{\text{value}}〉$. Check all subroutine calls and array sizes. Seek expert help.
${\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

On successful termination, the final residual ${r}_{k}=b-A{x}_{k}$, where $k={\mathbf{itn}}$, satisfies the termination criterion
 $rk∞≤τ×b∞+A∞xk∞.$
The value of the final residual norm is returned in rnorm.

## 8Parallelism and Performance

f11jcf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
f11jcf makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.
Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

The time taken by f11jcf for each iteration is roughly proportional to the value of nnzc returned from the preceding call to f11jaf. One iteration with the Lanczos method (SYMMLQ) requires a slightly larger number of operations than one iteration with the conjugate gradient method.
The number of iterations required to achieve a prescribed accuracy cannot be easily determined a priori, as it can depend dramatically on the conditioning and spectrum of the preconditioned matrix of the coefficients $\overline{A}={M}^{-1}A$.
Some illustrations of the application of f11jcf to linear systems arising from the discretization of two-dimensional elliptic partial differential equations, and to random-valued randomly structured symmetric positive definite linear systems, can be found in Salvini and Shaw (1995).

## 10Example

This example solves a symmetric positive definite system of equations using the conjugate gradient method, with incomplete Cholesky preconditioning.

### 10.1Program Text

Program Text (f11jcfe.f90)

### 10.2Program Data

Program Data (f11jcfe.d)

### 10.3Program Results

Program Results (f11jcfe.r)