f12 Chapter Contents
f12 Chapter Introduction
NAG C Library Manual

# NAG Library Function Documentnag_complex_sparse_eigensystem_sol (f12aqc)

Note: this function uses optional arguments to define choices in the problem specification. If you wish to use default settings for all of the optional arguments, then the option setting routine nag_complex_sparse_eigensystem_option (f12arc) need not be called. If, however, you wish to reset some or all of the settings please refer to Section 10 in nag_complex_sparse_eigensystem_option (f12arc) for a detailed description of the specification of the optional arguments.

## 1  Purpose

nag_complex_sparse_eigensystem_sol (f12aqc) is a post-processing function in a suite of functions consisting of nag_complex_sparse_eigensystem_init (f12anc), nag_complex_sparse_eigensystem_iter (f12apc), nag_complex_sparse_eigensystem_sol (f12aqc), nag_complex_sparse_eigensystem_option (f12arc) and nag_complex_sparse_eigensystem_monit (f12asc), that must be called following a final exit from nag_complex_sparse_eigensystem_sol (f12aqc).

## 2  Specification

 #include #include
 void nag_complex_sparse_eigensystem_sol (Integer *nconv, Complex d[], Complex z[], Complex sigma, const Complex resid[], Complex v[], Complex comm[], Integer icomm[], NagError *fail)

## 3  Description

The suite of functions is designed to calculate some of the eigenvalues, $\lambda$, (and optionally the corresponding eigenvectors, $x$) of a standard eigenvalue problem $Ax=\lambda x$, or of a generalized eigenvalue problem $Ax=\lambda Bx$ of order $n$, where $n$ is large and the coefficient matrices $A$ and $B$ are sparse, complex and nonsymmetric. The suite can also be used to find selected eigenvalues/eigenvectors of smaller scale dense, complex and nonsymmetric problems.
Following a call to nag_complex_sparse_eigensystem_iter (f12apc), nag_complex_sparse_eigensystem_sol (f12aqc) returns the converged approximations to eigenvalues and (optionally) the corresponding approximate eigenvectors and/or an orthonormal basis for the associated approximate invariant subspace. The eigenvalues (and eigenvectors) are selected from those of a standard or generalized eigenvalue problem defined by complex nonsymmetric matrices. There is negligible additional cost to obtain eigenvectors; an orthonormal basis is always computed, but there is an additional storage cost if both are requested.
nag_complex_sparse_eigensystem_sol (f12aqc) is based on the function zneupd from the ARPACK package, which uses the Implicitly Restarted Arnoldi iteration method. The method is described in Lehoucq and Sorensen (1996) and Lehoucq (2001) while its use within the ARPACK software is described in great detail in Lehoucq et al. (1998). An evaluation of software for computing eigenvalues of sparse nonsymmetric matrices is provided in Lehoucq and Scott (1996). This suite of functions offers the same functionality as the ARPACK software for complex nonsymmetric problems, but the interface design is quite different in order to make the option setting clearer and to simplify some of the interfaces.
nag_complex_sparse_eigensystem_sol (f12aqc) is a post-processing function that must be called following a successful final exit from nag_complex_sparse_eigensystem_iter (f12apc). nag_complex_sparse_eigensystem_sol (f12aqc) uses data returned from nag_complex_sparse_eigensystem_iter (f12apc) and options set either by default or explicitly by calling nag_complex_sparse_eigensystem_option (f12arc), to return the converged approximations to selected eigenvalues and (optionally):
 – the corresponding approximate eigenvectors; – an orthonormal basis for the associated approximate invariant subspace; – both.

## 4  References

Lehoucq R B (2001) Implicitly restarted Arnoldi methods and subspace iteration SIAM Journal on Matrix Analysis and Applications 23 551–562
Lehoucq R B and Scott J A (1996) An evaluation of software for computing eigenvalues of sparse nonsymmetric matrices Preprint MCS-P547-1195 Argonne National Laboratory
Lehoucq R B and Sorensen D C (1996) Deflation techniques for an implicitly restarted Arnoldi iteration SIAM Journal on Matrix Analysis and Applications 17 789–821
Lehoucq R B, Sorensen D C and Yang C (1998) ARPACK Users' Guide: Solution of Large-scale Eigenvalue Problems with Implicitly Restarted Arnoldi Methods SIAM, Philidelphia

## 5  Arguments

1:     nconvInteger *Output
On exit: the number of converged eigenvalues as found by nag_complex_sparse_eigensystem_option (f12arc).
2:     d[$\mathit{dim}$]ComplexOutput
Note: the dimension, dim, of the array d must be at least ${\mathbf{ncv}}$ (see nag_complex_sparse_eigensystem_init (f12anc)).
On exit: the first nconv locations of the array d contain the converged approximate eigenvalues.
3:     z[${\mathbf{n}}×{\mathbf{ncv}}$]ComplexOutput
On exit: if the default option ${\mathbf{Vectors}}=\mathrm{RITZ}$ (see nag_real_sparse_eigensystem_option (f12adc)) has been selected then z contains the final set of eigenvectors corresponding to the eigenvalues held in d. The complex eigenvector associated with an eigenvalue is stored in the corresponding array section of z.
4:     sigmaComplexInput
On entry: if one of the ${\mathbf{Shifted Inverse}}$ (see nag_complex_sparse_eigensystem_option (f12arc)) modes has been selected then sigma contains the shift used; otherwise sigma is not referenced.
5:     resid[$\mathit{dim}$]const ComplexInput
Note: the dimension, dim, of the array resid must be at least ${\mathbf{n}}$ (see nag_complex_sparse_eigensystem_init (f12anc)).
On entry: must not be modified following a call to nag_complex_sparse_eigensystem_iter (f12apc) since it contains data required by nag_complex_sparse_eigensystem_sol (f12aqc).
6:     v[$\mathit{dim}$]ComplexInput/Output
Note: the dimension, dim, of the array v must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{ncv}}\right)$ (see nag_complex_sparse_eigensystem_init (f12anc)).
The $\mathit{i}$th element of the $\mathit{j}$th basis vector is stored in location ${\mathbf{v}}\left[{\mathbf{n}}×\left(\mathit{j}-1\right)+\mathit{i}-1\right]$, for $\mathit{i}=1,2,\dots ,{\mathbf{n}}$ and $\mathit{j}=1,2,\dots ,{\mathbf{ncv}}$.
On entry: the ncv sections of v, of length $n$, contain the Arnoldi basis vectors for $\mathrm{OP}$ as constructed by nag_complex_sparse_eigensystem_iter (f12apc).
On exit: if the option ${\mathbf{Vectors}}=\mathrm{SCHUR}$ or $\mathrm{RITZ}$ has been set and a separate array z has been passed (i.e., z does not equal v), then the first nconv sections of v, of length $n$, will contain approximate Schur vectors that span the desired invariant subspace.
7:     comm[$\mathit{dim}$]ComplexCommunication Array
Note: the dimension, dim, of the array comm must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{lcomm}}\right)$ (see nag_complex_sparse_eigensystem_init (f12anc)).
On initial entry: must remain unchanged from the prior call to nag_complex_sparse_eigensystem_init (f12anc).
On exit: contains data on the current state of the solution.
8:     icomm[$\mathit{dim}$]IntegerCommunication Array
Note: the dimension, dim, of the array icomm must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{licomm}}\right)$ (see nag_complex_sparse_eigensystem_init (f12anc)).
On initial entry: must remain unchanged from the prior call to nag_complex_sparse_eigensystem_init (f12anc).
On exit: contains data on the current state of the solution.
9:     failNagError *Input/Output
The NAG error argument (see Section 3.6 in the Essential Introduction).

## 6  Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
On entry, argument $〈\mathit{\text{value}}〉$ had an illegal value.
NE_INTERNAL_EIGVEC_FAIL
In calculating eigenvectors, an internal call returned with an error. The function returned with ${\mathbf{fail}}\mathbf{.}\mathbf{code}=〈\mathit{\text{value}}〉$. Please contact NAG.
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.
NE_INVALID_OPTION
On entry, ${\mathbf{Vectors}}=\text{Select}$, but this is not yet implemented.
NE_RITZ_COUNT
Got a different count of the number of converged Ritz values than the value passed to it through the argument icomm: number counted $=〈\mathit{\text{value}}〉$, number expected $=〈\mathit{\text{value}}〉$.
NE_SCHUR_EIG_FAIL
During calculation of a Schur form, there was a failure to compute $〈\mathit{\text{value}}〉$ eigenvalues in a total of $〈\mathit{\text{value}}〉$ iterations.
NE_SCHUR_REORDER
The computed Schur form could not be reordered by an internal call. This function returned with ${\mathbf{fail}}\mathbf{.}\mathbf{code}=〈\mathit{\text{value}}〉$. Please contact NAG.
NE_ZERO_EIGS_FOUND
The number of eigenvalues found to sufficient accuracy, as communicated through the argument icomm, is zero.

## 7  Accuracy

The relative accuracy of a Ritz value, $\lambda$, is considered acceptable if its Ritz estimate $\le {\mathbf{Tolerance}}×\left|\lambda \right|$. The default ${\mathbf{Tolerance}}$ used is the machine precision given by nag_machine_precision (X02AJC).

None.

## 9  Example

This example solves $Ax=\lambda Bx$ in regular-invert mode, where $A$ and $B$ are derived from the standard central difference discretization of the one-dimensional convection-diffusion operator $\frac{{d}^{2}u}{d{x}^{2}}+\rho \frac{du}{dx}$ on $\left[0,1\right]$, with zero Dirichlet boundary conditions.

### 9.1  Program Text

Program Text (f12aqce.c)

### 9.2  Program Data

Program Data (f12aqce.d)

### 9.3  Program Results

Program Results (f12aqce.r)