elpa_solve_evp_complex_double.3 6.14 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
.TH "elpa_solve_evp_complex_double" 3 "Mon Oct 10 2015" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_solve_evp_complex_double \- solve the complex eigenvalue problem with either the 1-satge or the 2-stage ELPA solver
.br

.SH SYNOPSIS
.br
.SS FORTRAN INTERFACE
use elpa
.br
.br
14
.RI  "success = \fBelpa_solve_evp_complex_double\fP (na, nev, a(lda,matrixCols), ev(nev), q(ldq, matrixCols), ldq, nblk, matrixCols, mpi_comm_rows, mpi_comm_cols, mpi_comm_all, THIS_COMPLEX_ELPA_KERNEL, useGPU, method)"
15
16
17
18
19
20
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"

.br
21
.RI "integer,     intent(in)       \fBna\fP:                       global dimension of quadratic matrix \fBa\fP to solve"
22
.br
23
.RI "integer,     intent(in)       \fBnev\fP:                      number of eigenvalues to be computed; the first \fBnev\fP eigenvalules are calculated"
24
.br
25
.RI "complex*16,  intent(inout)    \fBa\fP:                        locally distributed part of the matrix \fBa\fP. The local dimensions are \fBlda\fP x \fBmatrixCols\fP"
26
.br
27
.RI "integer,     intent(in)       \fBlda\fP:                      leading dimension of locally distributed matrix \fBa\fP"
28
.br
29
.RI "real*8,      intent(inout)    \fBev\fP:                       on output the first \fBnev\fP computed eigenvalues"
30
.br
31
.RI "complex*16,  intent(inout)    \fBq\fP:                        on output the first \fBnev\fP computed eigenvectors"
32
.br
33
.RI "integer,     intent(in)       \fBldq\fP:                      leading dimension of matrix \fBq\fP which stores the eigenvectors"
34
.br
35
.RI "integer,     intent(in)       \fBnblk\fP:                     blocksize of block cyclic distributin, must be the same in both directions"
36
.br
37
.RI "integer,     intent(in)       \fBmatrixCols\fP:               number of columns of locally distributed matrices \fBa\fP and \fBq\fP"
38
.br
39
.RI "integer,     intent(in)       \fBmpi_comm_rows\fP:            communicator for communication in rows. Constructed with \fBelpa_get_communicators\fP(3)"
40
.br
41
.RI "integer,     intent(in)       \fBmpi_comm_cols\fP:            communicator for communication in colums. Constructed with \fBelpa_get_communicators\fP(3)"
42
.br
43
.RI "integer,     intent(in)       \fBmpi_comm_all\fP:             communicator for all processes in the processor set involved in ELPA"
44
.br
45
.RI "int                           \fBTHIS_ELPA_COMPLEX_KERNEL\fp: choose the compute kernel for 2-stage solver"
46
.br
47
48
49
.RI "logical, optional, intent(in) \fBuseGPU\fP:                   specify whether GPUs should be used or not used"
.br
.RI "character(*), optional        \fBmethod\fP:                   use 1stage solver if "1stage", use 2stage solver if "2stage", (at the moment) use 2stage solver if "auto" "
50

51
.RI "logical                       \fBsuccess\fP:                  return value indicating success or failure"
52
53
54
55
56
57
58
.br
.SS C INTERFACE
#include "elpa.h"
.br
#include <complex.h>

.br
59
.RI "success = \fBelpa_solve_evp_complex_double\fP (\fBint\fP na, \fBint\fP nev, \fB double complex *\fPa, \fBint\fP lda, \fB double *\fPev, \fBdouble complex *\fPq, \fBint\fP ldq, \fBint\fP nblk, \fBint\fP matrixCols, \fBint\fP mpi_comm_rows, \fBint\fP mpi_comm_cols, \fBint\fP mpi_comm_all, \fBint\fP THIS_ELPA_COMPLEX_KERNEL, \fBint\fP useGPU, \fB char *\fPmethod);"
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"

.br
.RI "int             \fBna\fP:                       global dimension of quadratic matrix \fBa\fP to solve"
.br
.RI "int             \fBnev\fP:                      number of eigenvalues to be computed; the first \fBnev\fP eigenvalules are calculated"
.br
.RI "double complex *\fBa\fP:                        pointer to locally distributed part of the matrix \fBa\fP. The local dimensions are \fBlda\fP x \fBmatrixCols\fP"
.br
.RI "int             \fBlda\fP:                      leading dimension of locally distributed matrix \fBa\fP"
.br
.RI "double         *\fBev\fP:                       pointer to memory containing on output the first \fBnev\fP computed eigenvalues"
.br
.RI "double complex *\fBq\fP:                        pointer to memory containing on output the first \fBnev\fP computed eigenvectors"
.br
.RI "int             \fBldq\fP:                      leading dimension of matrix \fBq\fP which stores the eigenvectors"
.br
.RI "int             \fBnblk\fP:                     blocksize of block cyclic distributin, must be the same in both directions"
.br
.RI "int             \fBmatrixCols\fP:               number of columns of locally distributed matrices \fBa\fP and \fBq\fP"
.br
.RI "int             \fBmpi_comm_rows\fP:            communicator for communication in rows. Constructed with \fBelpa_get_communicators\fP(3)"
.br
.RI "int             \fBmpi_comm_cols\fP:            communicator for communication in colums. Constructed with \fBelpa_get_communicators\fP(3)"
.br
.RI "int             \fBmpi_comm_all\fP:             communicator for all processes in the processor set involved in ELPA"
.br
.RI "int             \fBTHIS_ELPA_COMPLEX_KERNEL\fp: choose the compute kernel for 2-stage solver"
.br
92
93
.RI "int             \fBuseGPU\fP:                   specify whether GPUS should be used or not
.br
94
95
96
97
98
99
100
101
102
.RI "char           *\fBmethod\fP:                   use 1stage solver if "1stage", use 2stage solver if "2stage", (at the moment) use 2stage solver if "auto" "

.RI "int             \fBsuccess\fP:                  return value indicating success (1) or failure (0)

.SH DESCRIPTION
Solve the complex eigenvalue problem. The value of \fBmethod\fP desides whether the 1stage or 2stage solver is used. The ELPA communicators \fBmpi_comm_rows\fP and \fBmpi_comm_cols\fP are obtained with the \fBelpa_get_communicators\fP(3) function. The distributed quadratic marix \fBa\fP has global dimensions \fBna\fP x \fBna\fP, and a local size \fBlda\fP x \fBmatrixCols\fP. The solver will compute the first \fBnev\fP eigenvalues, which will be stored on exit in \fBev\fP. The eigenvectors corresponding to the eigenvalues will be stored in \fBq\fP. All memory of the arguments must be allocated outside the call to the solver.
.br
.SH "SEE ALSO"
\fBelpa_get_communicators\fP(3) \fBelpa_solve_evp_real_double\fP(3) \fBelpa_solve_evp_real_single\fP(3) \fBelpa_solve_evp_complex_single\fP(3) \fBelpa2_print_kernels\fP(1)