f12jgf is a setup routine in a suite of routines consisting of f12jaf,f12jbf,f12jgf,f12jkf,f12jsf,f12jtf,f12jufandf12jvf. It is used to find some of the eigenvalues, and the corresponding eigenvectors, of a standard, generalized or polynomial eigenvalue problem. The initialization routine f12jafmust have been called prior to calling f12jgf. In addition calls to f12jbf can be made to supply individual optional parameters to f12jgf.
The suite of routines is suitable for the solution of large sparse eigenproblems where only a few eigenvalues from a selected range of the spectrum are required.
The routine may be called by the names f12jgf or nagf_sparseig_feast_custom_contour.
3Description
The suite of routines is designed to calculate some of the eigenvalues, $\lambda $, and the corresponding eigenvectors, $x$, of a standard eigenvalue problem $Ax=\lambda x$, a generalized eigenvalue problem $Ax=\lambda Bx$, or a polynomial eigenvalue problem ${\sum}_{i}{\lambda}^{i}{A}_{i}x=0$, where the coefficient matrices are large and sparse. The suite can also be used to find selected eigenvalues/eigenvectors of smaller scale dense problems.
f12jgf is used to specify a closed contour in the complex plane within which eigenvalues will be sought. The contour can be made up of a combination of line segments and half ellipses. f12jgf uses this information to create a polygonal representation of the contour and to then define the integration nodes and weights to be used by the solvers f12jkf,f12jsf,f12jtf,f12juforf12jvf.
The arrays zedge, tedge and nedge are used to define the geometry of your contour. Each array is of size ccn, where ccn is the number of pieces that make up the contour. The entries in zedge specify the endpoints in the complex plane of each piece of the contour. The entries in tedge specify whether each piece of the contour is a line segment or a half ellipse. Finally, entries in nedge specify the number of integration points to use for each piece of the contour. See the individual argument descriptions in Section 5 for further details.
Prior to calling f12jgf, the option setting routine f12jbf can be called to specify various optional parameters for the solution of the eigenproblem. For details of the options available and how to set them see Section 11.1 in f12jbf.
4References
Polizzi E (2009) Density-Matrix-Based Algorithms for Solving Eigenvalue Problems Phys. Rev. B. 79 115112
5Arguments
1: $\mathbf{handle}$ – Type (c_ptr)Input
On entry: the handle to the internal data structure used by the NAG FEAST suite. It needs to be initialized by f12jaf. It must not be changed between calls to the NAG FEAST suite.
2: $\mathbf{ccn}$ – IntegerInput
On entry: the number of pieces that make up the contour.
On entry: ${\mathbf{tedge}}\left(i\right)$ specifies what shape the $i$th piece of the contour should be.
${\mathbf{tedge}}\left(i\right)=0$
The $i$th piece of the contour is straight.
${\mathbf{tedge}}\left(i\right)>0$
The $i$th piece of the contour is a (convex) half-ellipse, with ${\mathbf{tedge}}\left(i\right)/100=a/b$, where $a$ is the primary radius from the endpoints of the piece, and $b$ is the radius perpendicular to this. Thus, if ${\mathbf{tedge}}\left(i\right)=100$, then the $i$th piece of the contour is a semicircle.
Constraint:
${\mathbf{tedge}}\left(\mathit{i}\right)\ge 0$, for $\mathit{i}=1,2,\dots ,{\mathbf{ccn}}$.
On entry: zedge specifies the endpoints of the contour piece.
The $i$th piece has endpoints at ${\mathbf{zedge}}\left(i\right)$ and ${\mathbf{zedge}}\left(i+1\right)$, for $i=1,\dots ,{\mathbf{ccn}}-1$.
The last piece has endpoints at ${\mathbf{zedge}}\left({\mathbf{ccn}}\right)$ and ${\mathbf{zedge}}\left(1\right)$.
Note: the contour should be described in a clockwise direction..
6: $\mathbf{ifail}$ – IntegerInput/Output
On entry: ifail must be set to $0$, $\mathrm{-1}$ or $1$ to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of $0$ causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of $\mathrm{-1}$ means that an error message is printed while a value of $1$ means that it is not.
If halting is not appropriate, the value $\mathrm{-1}$ or $1$ is recommended. If message printing is undesirable, then the value $1$ is recommended. Otherwise, the value $0$ is recommended. When the value $-\mathbf{1}$ or $\mathbf{1}$ 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 $\mathrm{-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$
The supplied handle does not define a valid handle to the data structure used by the NAG FEAST suite. It has not been properly initialized or it has been corrupted.
${\mathbf{ifail}}=2$
On entry, ${\mathbf{ccn}}=\u27e8\mathit{\text{value}}\u27e9$. Constraint: ${\mathbf{ccn}}>1$.
${\mathbf{ifail}}=3$
On entry, one or more elements of nedge were less than or equal to zero.
${\mathbf{ifail}}=4$
On entry, one or more elements of tedge were negative.
${\mathbf{ifail}}=-99$
An unexpected error has been triggered by this routine. Please
contact NAG.
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.
7Accuracy
Not applicable.
8Parallelism and Performance
Background information to multithreading can be found in the Multithreading documentation.
f12jgf is not threaded in any implementation.
9Further Comments
The contour you specify must be convex and must not self-intersect. f12jgf does not explicitly test for either condition, but if the contour contains concave pieces or self-intersects then spurious eigenvalues may arise and stochastic estimation of the number of eigenvalues within the contour will not be accurate.
9.1Additional Licensor
Parts of the code for f12jgf are distributed under the BSD software License. Please refer to Library Licensors for further details.