NAG Library Routine Document

Integer, Intent (In)	::	n, la, irow(la), icol(la), istr(n+1)
Integer, Intent (Inout)	::	ipiv(n), ifail
Complex (Kind=nag_wp), Intent (In)	::	a(la), y(n)
Complex (Kind=nag_wp), Intent (Out)	::	x(n)
Character (1), Intent (In)	::	check

C Header Interface

#include <nagmk26.h>

void	f11jpf_ (const Integer n, const Complex a[], const Integer la, const Integer irow[], const Integer icol[], Integer ipiv[], const Integer istr[], const char check, const Complex y[], Complex x[], Integer ifail, const Charlen length_check)

3

Description

f11jpf solves a system of linear equations

M x = y

involving the preconditioning matrix

M = P L D L^{H} P^{T}

, corresponding to an incomplete Cholesky decomposition of a complex sparse Hermitian matrix stored in symmetric coordinate storage (SCS) format (see Section 2.1.2 in the F11 Chapter Introduction), as generated by f11jnf.

In the above decomposition

L

is a complex lower triangular sparse matrix with unit diagonal,

D

is a real diagonal matrix and

P

is a permutation matrix.

L

and

D

are supplied to f11jpf through the matrix

C = L + D^{- 1} - I

which is a lower triangular

n

n

complex sparse matrix, stored in SCS format, as returned by f11jnf. The permutation matrix

P

is returned from f11jnf via the array ipiv.

f11jpf may also be used in combination with f11jnf to solve a sparse complex Hermitian positive definite system of linear equations directly (see f11jnf). This is illustrated in Section 10.

4

References

None.

5

Arguments

1: $n$ – IntegerInput

On entry:

n

, the order of the matrix

M

. This must be the same value as was supplied in the preceding call to f11jnf.

Constraint:

n \geq 1

2: $a (la)$ – Complex (Kind=nag_wp) arrayInput

On entry: the values returned in the array a by a previous call to f11jnf.

3: $la$ – IntegerInput

On entry: the dimension of the arrays a, irow and icol as declared in the (sub)program from which f11jpf is called. This must be the same value supplied in the preceding call to f11jnf.

4: $irow (la)$ – Integer arrayInput

5: $icol (la)$ – Integer arrayInput

6: $ipiv (n)$ – Integer arrayInput

7: $istr (n + 1)$ – Integer arrayInput

On entry: the values returned in arrays irow, icol, ipiv and istr by a previous call to f11jnf.

8: $check$ – Character(1)Input

On entry: specifies whether or not the input data should be checked.

$check ='C'$: Checks are carried out on the values of n, irow, icol, ipiv and istr.
$check ='N'$: None of these checks are carried out.

Constraint:

check ='C'

'N'

9: $y (n)$ – Complex (Kind=nag_wp) arrayInput

On entry: the right-hand side vector

y

10: $x (n)$ – Complex (Kind=nag_wp) arrayOutput

On exit: the solution vector

x

11: $ifail$ – IntegerInput/Output

On entry: ifail must be set to

0

- 1 or 1

. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation for details.

For environments where it might be inappropriate to halt program execution when an error is detected, the value

- 1 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 argument, the recommended value is

0

. When the value $- 1 or 1$ is used it is essential to test the value of ifail on exit.

On exit:

ifail = 0

unless the routine detects an error or a warning has been flagged (see Section 6).

6

Error Indicators and Warnings

If on entry

ifail = 0

- 1

, explanatory error messages are output on the current error message unit (as defined by x04aaf).

Errors or warnings detected by the routine:

$ifail = 1$: On entry, $check = 〈value〉$ .
Constraint: $check ='C'$ or $'N'$ .

$ifail = 2$: On entry, $n = 〈value〉$ .
Constraint: $n \geq 1$ .

$ifail = 3$: On entry, $a (i)$ is out of order: $i = 〈value〉$ .

On entry, $I = 〈value〉$ , $icol (I) = 〈value〉$ and $irow (I) = 〈value〉$ .
Constraint: $icol (I) \geq 1$ and $icol (I) \leq irow (I)$ .

On entry, $i = 〈value〉$ , $ipiv (i) = 〈value〉$ , $n = 〈value〉$ .
Constraint: $ipiv (i) \geq 1$ and $ipiv (i) \leq n$ .

On entry, $i = 〈value〉$ , $irow (i) = 〈value〉$ and $n = 〈value〉$ .
Constraint: $irow (i) \geq 1$ and $irow (i) \leq n$ .

On entry, $ipiv (i)$ is a repeated value: $i = 〈value〉$ .

On entry, istr appears to be invalid.

On entry, $istr (i)$ is inconsistent with irow: $i = 〈value〉$ .

On entry, the location ( $irow (I), icol (I)$ ) is a duplicate: $I = 〈value〉$ .
Check that a, irow, icol, ipiv and istr have not been corrupted between calls to f11jnf and f11jpf.

$ifail = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.

$ifail = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 3.8 in How to Use the NAG Library and its Documentation for further information.

$ifail = - 999$: Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7

Accuracy

The computed solution

x

is the exact solution of a perturbed system of equations

(M + δ M) x = y

, where

|δ M| \leq c (n) ε P |L| |D| |L^{H}| P^{T},

c (n)

is a modest linear function of

n

, and

ε

is the machine precision.

8

Parallelism and Performance

f11jpf is not threaded in any implementation.

9

Further Comments

9.1

Timing

The time taken for a call to f11jpf is proportional to the value of nnzc returned from f11jnf.

10

Example

This example reads in a complex sparse Hermitian positive definite matrix

A

and a vector

y

. It then calls f11jnf, with

lfill = - 1

and

dtol = 0.0

, to compute the complete Cholesky decomposition of

A

A = P L D L^{H} P^{T} .

Finally it calls f11jpf to solve the system

P L D L^{H} P^{T} x = y .

NAG Library Routine Document

f11jpf (complex_herm_precon_ilu_solve)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

9.1 Timing

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

1

Purpose

2

Specification