NAG FL Interfacef11bff (real_​gen_​basic_​diag)

1Purpose

f11bff is the third in a suite of three routines for the iterative solution of a real general (nonsymmetric) system of simultaneous linear equations (see Golub and Van Loan (1996)). f11bff returns information about the computations during an iteration and/or after this has been completed. The first routine of the suite, f11bdf, is a setup routine; the second routine, f11bef, is the iterative solver itself.
These three routines are suitable for the solution of large sparse general (nonsymmetric) systems of equations.

2Specification

Fortran Interface
 Subroutine f11bff ( itn, work,
 Integer, Intent (In) :: lwork Integer, Intent (Inout) :: ifail Integer, Intent (Out) :: itn Real (Kind=nag_wp), Intent (In) :: work(lwork) Real (Kind=nag_wp), Intent (Out) :: stplhs, stprhs, anorm, sigmax
#include <nag.h>
 void f11bff_ (Integer *itn, double *stplhs, double *stprhs, double *anorm, double *sigmax, const double work[], const Integer *lwork, Integer *ifail)
The routine may be called by the names f11bff or nagf_sparse_real_gen_basic_diag.

3Description

f11bff returns information about the solution process. It can be called either during a monitoring step of f11bef or after f11bef has completed its tasks. Calling f11bff at any other time will result in an error condition being raised.
For further information you should read the documentation for f11bdf and f11bef.

4References

Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore

5Arguments

1: $\mathbf{itn}$Integer Output
On exit: the number of iterations carried out by f11bef.
2: $\mathbf{stplhs}$Real (Kind=nag_wp) Output
On exit: the current value of the left-hand side of the termination criterion used by f11bef.
3: $\mathbf{stprhs}$Real (Kind=nag_wp) Output
On exit: the current value of the right-hand side of the termination criterion used by f11bef.
4: $\mathbf{anorm}$Real (Kind=nag_wp) Output
On exit: if ${\mathbf{iterm}}=1$ in the previous call to f11bdf, then anorm contains ${‖A‖}_{p}$, where $p=1$, $2$ or $\infty$, either supplied or, in the case of $1$ or $\infty$, estimated by f11bef; otherwise ${\mathbf{anorm}}=0.0$.
5: $\mathbf{sigmax}$Real (Kind=nag_wp) Output
On exit: if ${\mathbf{iterm}}=2$ in the previous call to f11bdf, the current estimate of the largest singular value ${\sigma }_{1}\left(\overline{A}\right)$ of the preconditioned iteration matrix, either when it has been supplied to f11bdf or it has been estimated by f11bef (see also Sections 3 and 5 in f11bdf); otherwise, ${\mathbf{sigmax}}=0.0$ is returned.
6: $\mathbf{work}\left({\mathbf{lwork}}\right)$Real (Kind=nag_wp) array Communication Array
On entry: the array work as returned by f11bef (see also Sections 3 and 5 in f11bef).
7: $\mathbf{lwork}$Integer Input
On entry: the dimension of the array work as declared in the (sub)program from which f11bff is called (see also Section 5 in f11bdf).
Constraint: ${\mathbf{lwork}}\ge 100$.
Note: although the minimum value of lwork ensures the correct functioning of f11bff, a larger value is required by the iterative solver f11bef (see also Section 5 in f11bdf).
8: $\mathbf{ifail}$Integer Input/Output
On entry: ifail must be set to $0$, . If you are unfamiliar with this argument you should refer to Section 4 in the Introduction to the NAG Library FL Interface for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value 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 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$
f11bff has been called out of sequence.
${\mathbf{ifail}}=-7$
On entry, ${\mathbf{lwork}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{lwork}}\ge 100$.
${\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.

Not applicable.

8Parallelism and Performance

f11bff is not threaded in any implementation.