NAG Library Function Document
nag_complex_sparse_eigensystem_sol (f12aqc)
Note: this function uses optional parameters to define choices in the problem specification. If you wish to use default
settings for all of the optional parameters, then the option setting function 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 11 in nag_complex_sparse_eigensystem_option (f12arc) for a detailed description of the specification of the optional parameters.
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 <nag.h> |
#include <nagf12.h> |
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, , (and optionally the corresponding eigenvectors, ) of a standard eigenvalue problem , or of a generalized eigenvalue problem of order , where is large and the coefficient matrices and 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:
– Integer *Output
-
On exit: the number of converged eigenvalues as found by
nag_complex_sparse_eigensystem_option (f12arc).
- 2:
– ComplexOutput
-
Note: the dimension,
dim, of the array
d
must be at least
(see
nag_complex_sparse_eigensystem_init (f12anc)).
On exit: the first
nconv locations of the array
d contain the converged approximate eigenvalues.
- 3:
– ComplexOutput
-
On exit: if the default option
(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:
– ComplexInput
-
On entry: if one of the
(see
nag_complex_sparse_eigensystem_option (f12arc)) modes has been selected then
sigma contains the shift used; otherwise
sigma is not referenced.
- 5:
– const ComplexInput
-
Note: the dimension,
dim, of the array
resid
must be at least
(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:
– ComplexInput/Output
-
The th element of the th basis vector is stored in location , for and .
On entry: the
ncv sections of
v, of length
, contain the Arnoldi basis vectors for
as constructed by
nag_complex_sparse_eigensystem_iter (f12apc).
On exit: if the option
or
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
, will contain approximate Schur vectors that span the desired invariant subspace.
- 7:
– ComplexCommunication Array
-
Note: the dimension,
dim, of the array
comm
must be at least
(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:
– IntegerCommunication Array
-
Note: the dimension,
dim, of the array
icomm
must be at least
(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:
– 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_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 had an illegal value.
- NE_INTERNAL_EIGVEC_FAIL
-
In calculating eigenvectors, an internal call returned with an error. The function returned with
. 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.
See
Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.
- NE_INVALID_OPTION
-
On entry, , but this is not yet implemented.
- 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_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
, number expected
. This usually indicates that a communication array has been altered or has become corrupted between calls to
nag_complex_sparse_eigensystem_iter (f12apc) and
nag_complex_sparse_eigensystem_sol (f12aqc).
- NE_SCHUR_EIG_FAIL
-
During calculation of a Schur form, there was a failure to compute eigenvalues in a total of iterations.
- NE_SCHUR_REORDER
-
The computed Schur form could not be reordered by an internal call. This function returned with
. Please contact
NAG.
- NE_ZERO_EIGS_FOUND
-
The number of eigenvalues found to sufficient accuracy, as communicated through the argument
icomm, is zero. You should experiment with different values of
nev and
ncv, or select a different computational mode or increase the maximum number of iterations prior to calling
nag_complex_sparse_eigensystem_iter (f12apc).
7
Accuracy
The relative accuracy of a Ritz value,
, is considered acceptable if its Ritz estimate
. The default
used is the
machine precision given by
nag_machine_precision (X02AJC).
8
Parallelism and Performance
nag_complex_sparse_eigensystem_sol (f12aqc) 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 function. Please also consult the
Users' Note for your implementation for any additional implementation-specific information.
None.
10
Example
This example solves in regular-invert mode, where and are derived from the standard central difference discretization of the one-dimensional convection-diffusion operator on , with zero Dirichlet boundary conditions.
10.1
Program Text
Program Text (f12aqce.c)
10.2
Program Data
Program Data (f12aqce.d)
10.3
Program Results
Program Results (f12aqce.r)