solve_evp_complex.3 3.57 KB
Newer Older
1
.TH "solve_evp_complex" 3 "Thu Mar 17 2016" "ELPA" \" -*- nroff -*-
Andreas Marek's avatar
Andreas Marek committed
2 3 4
.ad l
.nh
.SH NAME
5 6
solve_evp_complex \- solve the double-precision complex eigenvalue problem with the 1-stage ELPA solver.
This interface is old and deprecated. It is recommended to use \fBsolve_evp_complex_1stage_double\fP(3)
Andreas Marek's avatar
Andreas Marek committed
7 8 9 10 11 12 13 14
.br

.SH SYNOPSIS
.br
.SS FORTRAN INTERFACE
use elpa1
.br
.br
15
.RI  "success = \fBsolve_evp_complex\fP (na, nev, a(lda,matrixCols), ev(nev), q(ldq, matrixCols), ldq, nblk, matrixCols, mpi_comm_rows, mpi_comm_cols, mpi_comm_all, useGPU)"
Andreas Marek's avatar
Andreas Marek committed
16 17 18 19 20 21 22 23 24 25
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"

.br
.RI "integer,     intent(in)    \fBna\fP:            global dimension of quadratic matrix \fBa\fP to solve"
.br
.RI "integer,     intent(in)    \fBnev\fP:           number of eigenvalues to be computed; the first \fBnev\fP eigenvalules are calculated"
.br
26
.RI "complex*16,  intent(inout)    \fBa\fP:             locally distributed part of the matrix \fBa\fP. The local dimensions are \fBlda\fP x \fBmatrixCols\fP"
Andreas Marek's avatar
Andreas Marek committed
27
.br
28
.RI "integer,     intent(in)       \fBlda\fP:           leading dimension of locally distributed matrix \fBa\fP"
Andreas Marek's avatar
Andreas Marek committed
29
.br
30
.RI "real*8,      intent(inout)    \fBev\fP:            on output the first \fBnev\fP computed eigenvalues"
Andreas Marek's avatar
Andreas Marek committed
31
.br
32
.RI "complex*16,  intent(inout)    \fBq\fP:             on output the first \fBnev\fP computed eigenvectors"
Andreas Marek's avatar
Andreas Marek committed
33
.br
34
.RI "integer,     intent(in)       \fBldq\fP:           leading dimension of matrix \fBq\fP which stores the eigenvectors"
Andreas Marek's avatar
Andreas Marek committed
35
.br
36
.RI "integer,     intent(in)       \fBnblk\fP:          blocksize of block cyclic distributin, must be the same in both directions"
Andreas Marek's avatar
Andreas Marek committed
37
.br
38
.RI "integer,     intent(in)       \fBmatrixCols\fP:    number of columns of locally distributed matrices \fBa\fP and \fBq\fP"
Andreas Marek's avatar
Andreas Marek committed
39
.br
40
.RI "integer,     intent(in)       \fBmpi_comm_rows\fP: communicator for communication in rows. Constructed with \fBelpa_get_communicators\fP(3)"
Andreas Marek's avatar
Andreas Marek committed
41
.br
42 43 44 45 46
.RI "integer, intent(in)           \fBmpi_comm_cols\fP: communicator for communication in colums. Constructed with \fBelpa_get_communicators\fP(3)"
.br
.RI "integer, intent(in)           \fBmpi_comm_all\fP:  communicator for all MPI process used in ELPA"
.br
.RI "logical, optional, intent(in) \fBuseGPU\fP:        decide whether GPUs should be used or not"
Andreas Marek's avatar
Andreas Marek committed
47 48
.br

49
.RI "logical                       \fBsuccess\fP:       return value indicating success or failure"
Andreas Marek's avatar
Andreas Marek committed
50 51
.br
.SH DESCRIPTION
52
Old, deprecated interface, which will be deleted at some point. Use \fBsolve_evp_complex_1stage\fP(3) or \fBelpa_solve_evp_complex\fP(3).
53
Solve the complex eigenvalue problem with the 1-stage solver. 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.
Andreas Marek's avatar
Andreas Marek committed
54 55
.br
.SH "SEE ALSO"
56
\fBelpa_get_communicators\fP(3) \fBelpa_solve_evp_real_double\fP(3) \fBelpa_solve_evp_real_single\fP(3) \fBelpa_solve_evp_complex_double\fP(3) \fBelpa_solve_evp_complex_single\fP(3) \fBelpa_solve_evp_real_1stage_double\fP(3) \fBelpa_solve_evp_real_1stage_single\fP(3) \fBelpa_solve_evp_complex_1stage_single\fP(3) \fBelpa_solve_evp_real_2stage_double\fP(3) \fBelpa_solve_evp_real_2stage_single\fP(3) \fBelpa_solve_evp_complex_2stage_double\fP(3) \fBelpa_solve_evp_complex_2stage_single\fP(3) \fBelpa2_print_kernels\fP(1)