NAG C Library Function Document

nag_sparse_nherm_precon_bdilu_solve (f11duc)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

1:    $\mathbf{method}$ – Nag_SparseNsym_MethodInput

On entry: specifies the iterative method to be used.

$\mathbf{method}=\mathrm{Nag\_SparseNsym\_RGMRES}$

Restarted generalized minimum residual method.

$\mathbf{method}=\mathrm{Nag\_SparseNsym\_CGS}$

Conjugate gradient squared method.

$\mathbf{method}=\mathrm{Nag\_SparseNsym\_BiCGSTAB}$

Bi-conjugate gradient stabilized ($\ell$) method.

$\mathbf{method}=\mathrm{Nag\_SparseNsym\_TFQMR}$

Transpose-free quasi-minimal residual method.

Constraint: $\mathbf{method}=\mathrm{Nag\_SparseNsym\_RGMRES}$, $\mathrm{Nag\_SparseNsym\_CGS}$, $\mathrm{Nag\_SparseNsym\_BiCGSTAB}$ or $\mathrm{Nag\_SparseNsym\_TFQMR}$.

2:    $\mathbf{n}$ – IntegerInput

3:    $\mathbf{nnz}$ – IntegerInput

4:    $\mathbf{a}\left[\mathbf{la}\right]$ – const ComplexInput

5:    $\mathbf{la}$ – IntegerInput

6:    $\mathbf{irow}\left[\mathbf{la}\right]$ – const IntegerInput

7:    $\mathbf{icol}\left[\mathbf{la}\right]$ – const IntegerInput

8:    $\mathbf{nb}$ – IntegerInput

9:    $\mathbf{istb}\left[\mathbf{nb}+1\right]$ – const IntegerInput

10:  $\mathbf{indb}\left[\mathbf{lindb}\right]$ – const IntegerInput

11:  $\mathbf{lindb}$ – IntegerInput

12:  $\mathbf{ipivp}\left[\mathbf{lindb}\right]$ – const IntegerInput

13:  $\mathbf{ipivq}\left[\mathbf{lindb}\right]$ – const IntegerInput

14:  $\mathbf{istr}\left[\mathbf{lindb}+1\right]$ – const IntegerInput

15:  $\mathbf{idiag}\left[\mathbf{lindb}\right]$ – const IntegerInput

On entry: the values returned in arrays a, irow, icol, ipivp, ipivq and idiag by a previous call to nag_sparse_nherm_precon_bdilu (f11dtc).

The arrays istb and indb together with the scalars n, nnz, la, nb and lindb must be the same values that were supplied in the preceding call to nag_sparse_nherm_precon_bdilu (f11dtc).

16:  $\mathbf{b}\left[\mathbf{n}\right]$ – const ComplexInput

On entry: the right-hand side vector $b$.

17:  $\mathbf{m}$ – IntegerInput

On entry: if $\mathbf{method}=\mathrm{Nag\_SparseNsym\_RGMRES}$, m is the dimension of the restart subspace.

If $\mathbf{method}=\mathrm{Nag\_SparseNsym\_BiCGSTAB}$, m is the order $\ell$ of the polynomial Bi-CGSTAB method.

Otherwise, m is not referenced.

Constraints:

• if $\mathbf{method}=\mathrm{Nag\_SparseNsym\_RGMRES}$, $0<\mathbf{m}\le \min \left(\mathbf{n},50\right)$;
• if $\mathbf{method}=\mathrm{Nag\_SparseNsym\_BiCGSTAB}$, $0<\mathbf{m}\le \min \left(\mathbf{n},10\right)$.

18:  $\mathbf{tol}$ – doubleInput

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

$${‖r_k‖}_{\infty }\le \tau \times \left({‖b‖}_{\infty }+{‖A‖}_{\infty }{‖x_k‖}_{\infty }\right)\text{.}$$

If $\mathbf{tol}\le 0.0$, $\tau =\max \left(\sqrt{\epsilon },\sqrt{n}\epsilon \right)$ is used, where $\epsilon$ is the machine precision. Otherwise $\tau =\max \left(\mathbf{tol},10\epsilon ,\sqrt{n}\epsilon \right)$ is used.

Constraint: $\mathbf{tol}<1.0$.

19:  $\mathbf{maxitn}$ – IntegerInput

On entry: the maximum number of iterations allowed.

Constraint: $\mathbf{maxitn}\ge 1$.

20:  $\mathbf{x}\left[\mathbf{n}\right]$ – ComplexInput/Output

On entry: an initial approximation to the solution vector $x$.

On exit: an improved approximation to the solution vector $x$.

21:  $\mathbf{rnorm}$ – double *Output

On exit: the final value of the residual norm ${‖r_k‖}_{\infty }$, where $k$ is the output value of itn.

22:  $\mathbf{itn}$ – Integer *Output

On exit: the number of iterations carried out.

23:  $\mathbf{fail}$ – NagError *Input/Output

The NAG error argument (see Section 3.7 in How to Use the NAG Library and its Documentation).

6

Error Indicators and Warnings

NE_ACCURACY

The required accuracy could not be obtained. However, a reasonable accuracy may have been achieved. You should check the output value of rnorm for acceptability. This error code usually implies that your problem has been fully and satisfactorily solved to within or close to the accuracy available on your system. Further iterations are unlikely to improve on this situation.

NE_ALG_FAIL

Algorithmic breakdown. A solution is returned, although it is possible that it is completely inaccurate.

NE_ALLOC_FAIL

Dynamic memory allocation failed.
See Section 2.3.1.2 in How to Use the NAG Library and its Documentation for further information.

NE_BAD_PARAM

On entry, argument $〈\mathit{\text{value}}〉$ had an illegal value.

NE_CONVERGENCE

The solution has not converged after $〈\mathit{\text{value}}〉$ iterations.

NE_INT

On entry, $\mathbf{istb}\left[0\right]=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{istb}\left[0\right]\ge 1$.

On entry, $\mathbf{maxitn}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{maxitn}\ge 1$.

On entry, $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{n}\ge 1$.

On entry, $\mathbf{nnz}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{nnz}\ge 1$.

NE_INT_2

On entry, $\mathbf{la}=〈\mathit{\text{value}}〉$ and $\mathbf{nnz}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{la}\ge 2\times \mathbf{nnz}$.

On entry, $\mathbf{nb}=〈\mathit{\text{value}}〉$ and $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $1\le \mathbf{nb}\le \mathbf{n}$.

On entry, $\mathbf{nnz}=〈\mathit{\text{value}}〉$ and $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{nnz}\le {\mathbf{n}}^2$.

NE_INT_3

On entry, $\mathbf{lindb}=〈\mathit{\text{value}}〉$, $\mathbf{istb}\left[\mathbf{nb}\right]-1=〈\mathit{\text{value}}〉$ and $\mathbf{nb}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{lindb}\ge \mathbf{istb}\left[\mathbf{nb}\right]-1$.

On entry, $\mathbf{m}=〈\mathit{\text{value}}〉$ and $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: if $\mathbf{method}=\mathrm{Nag\_SparseNsym\_RGMRES}$, $1\le \mathbf{m}\le \min \left(\mathbf{n},〈\mathit{\text{value}}〉\right)$.
If $\mathbf{method}=\mathrm{Nag\_SparseNsym\_BiCGSTAB}$, $1\le \mathbf{m}\le \min \left(\mathbf{n},〈\mathit{\text{value}}〉\right)$.

NE_INT_ARRAY

On entry, $\mathbf{indb}\left[〈\mathit{\text{value}}〉\right]=〈\mathit{\text{value}}〉$ and $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $1\le \mathbf{indb}\left[m-1\right]\le \mathbf{n}$, for $m=\mathbf{istb}\left[0\right],\mathbf{istb}\left[0\right]+1,\dots ,\mathbf{istb}\left[\mathbf{nb}\right]-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 contact NAG for assistance.
See Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.

NE_INVALID_CS

On entry, $\mathbf{icol}\left[〈\mathit{\text{value}}〉\right]=〈\mathit{\text{value}}〉$ and $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $1\le \mathbf{icol}\left[\mathit{i}-1\right]\le \mathbf{n}$, for $\mathit{i}=1,2,\dots ,\mathbf{nnz}$.
Check that a, irow, icol, ipivp, ipivq, istr and idiag have not been corrupted between calls to nag_sparse_nherm_precon_bdilu (f11dtc) and nag_sparse_nherm_precon_bdilu_solve (f11duc).

On entry, $\mathbf{irow}\left[〈\mathit{\text{value}}〉\right]=〈\mathit{\text{value}}〉$ and $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $1\le \mathbf{irow}\left[\mathit{i}-1\right]\le \mathbf{n}$, for $\mathit{i}=1,2,\dots ,\mathbf{nnz}$.
Check that a, irow, icol, ipivp, ipivq, istr and idiag have not been corrupted between calls to nag_sparse_nherm_precon_bdilu (f11dtc) and nag_sparse_nherm_precon_bdilu_solve (f11duc).

NE_INVALID_CS_PRECOND

The CS representation of the preconditioner is invalid.
Check that a, irow, icol, ipivp, ipivq, istr and idiag have not been corrupted between calls to nag_sparse_nherm_precon_bdilu (f11dtc) and nag_sparse_nherm_precon_bdilu_solve (f11duc).

NE_NO_LICENCE

Your licence key may have expired or may not have been installed correctly.
See Section 2.7.5 in How to Use the NAG Library and its Documentation for further information.

NE_NOT_STRICTLY_INCREASING

On entry, element $〈\mathit{\text{value}}〉$ of a was out of order.
Check that a, irow, icol, ipivp, ipivq, istr and idiag have not been corrupted between calls to nag_sparse_nherm_precon_bdilu (f11dtc) and nag_sparse_nherm_precon_bdilu_solve (f11duc).

On entry, for $b=〈\mathit{\text{value}}〉$, $\mathbf{istb}\left[b\right]=〈\mathit{\text{value}}〉$ and $\mathbf{istb}\left[b-1\right]=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{istb}\left[\mathit{b}\right]>\mathbf{istb}\left[\mathit{b}-1\right]$, for $\mathit{b}=1,2,\dots ,\mathbf{nb}$.

On entry, location $〈\mathit{\text{value}}〉$ of $\left(\mathbf{irow},\mathbf{icol}\right)$ was a duplicate.
Check that a, irow, icol, ipivp, ipivq, istr and idiag have not been corrupted between calls to nag_sparse_nherm_precon_bdilu (f11dtc) and nag_sparse_nherm_precon_bdilu_solve (f11duc).

NE_REAL

On entry, $\mathbf{tol}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{tol}<1.0$.

7

Accuracy

8

Parallelism and Performance

9

Further Comments

10

Example

10.1

Program Text

Program Text (f11duce.c)

10.2

Program Data

Program Data (f11duce.d)

10.3

Program Results

Program Results (f11duce.r)