elpa_cholesky_complex.3 3.61 KB
 Andreas Marek committed May 18, 2017 1 ``````.TH "elpa_cholesky_complex" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*- `````` Andreas Marek committed Jun 29, 2016 2 3 4 ``````.ad l .nh .SH NAME `````` Andreas Marek committed Jul 15, 2017 5 ``````elpa_cholesky_complex \- Cholesky factorization of a complex hermitian matrix (legacy interface) `````` Andreas Marek committed Jun 29, 2016 6 7 8 9 10 11 12 13 14 15 16 17 ``````.br .SH SYNOPSIS .br .SS FORTRAN INTERFACE use elpa1 .br .br .RI "success = \fBelpa_cholesky_complex\fP (na, a(lda,matrixCols), lda, nblk, matrixCols, mpi_comm_rows, mpi_comm_cols, wantDebug)" .br .RI " " .br `````` Andreas Marek committed Jul 15, 2017 18 ``````.RI "With the definitions of the input and output variables:" `````` Andreas Marek committed Jun 29, 2016 19 20 21 22 23 24 25 26 27 28 29 30 `````` .br .RI "integer, intent(in) \fBna\fP: global dimension of quadratic matrix \fBa\fP to solve" .br .RI "complex*16, intent(inout) \fBa\fP: locally distributed part of the matrix \fBa\fP. The local dimensions are \fBlda\fP x \fBmatrixCols\fP" .br .RI "integer, intent(in) \fBlda\fP: leading dimension of locally distributed matrix \fBa\fP" .br .RI "integer, intent(in) \fBnblk\fP: blocksize of cyclic distribution, must be the same in both directions" .br .RI "integer, intent(in) \fBmatrixCols\fP: number of columns of locally distributed matrices \fBa\fP and \fBq\fP" .br `````` Andreas Marek committed Oct 27, 2016 31 ``````.RI "integer, intent(in) \fBmpi_comm_rows\fP: communicator for communication in rows. Constructed with \fBelpa_get_communicators\fP(3)" `````` Andreas Marek committed Jun 29, 2016 32 ``````.br `````` Andreas Marek committed Oct 27, 2016 33 ``````.RI "integer, intent(in) \fBmpi_comm_cols\fP: communicator for communication in colums. Constructed with \fBelpa_get_communicators\fP(3)" `````` Andreas Marek committed Jun 29, 2016 34 35 36 37 38 39 ``````.br .RI "logical, intent(in) \fBwantDebug\fP: if .true. , print more debug information in case of an error" .RI "logical \fBsuccess\fP: return value indicating success or failure" .br .SS C INTERFACE `````` Andreas Marek committed May 18, 2017 40 ``````#include "elpa_legacy.h" `````` Andreas Marek committed Jun 29, 2016 41 42 43 44 45 46 47 48 ``````.br #include .br .RI "\fBint\fP success = \fBelpa_cholesky_complex\fP (\fBint\fP na, \fB double complex *\fPa, \fBint\fP lda, \fBint\fP nblk, \fBint\fP matrixCols, \fBint\fP mpi_comm_rows, \fBint\fP mpi_comm_cols, \fBint\fP wantDebug );" .br .RI " " .br `````` Andreas Marek committed Jul 15, 2017 49 ``````.RI "With the definitions of the input and output variables:" `````` Andreas Marek committed Jun 29, 2016 50 51 52 53 54 55 56 57 58 59 60 61 `````` .br .RI "int \fBna\fP: global dimension of quadratic matrix \fBa\fP to solve" .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 "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 `````` Andreas Marek committed Oct 27, 2016 62 ``````.RI "int \fBmpi_comm_rows\fP: communicator for communication in rows. Constructed with \fBelpa_get_communicators\fP(3)" `````` Andreas Marek committed Jun 29, 2016 63 ``````.br `````` Andreas Marek committed Oct 27, 2016 64 ``````.RI "int \fBmpi_comm_cols\fP: communicator for communication in colums. Constructed with \fBelpa_get_communicators\fP(3)" `````` Andreas Marek committed Jun 29, 2016 65 66 67 68 69 70 71 ``````.br .RI "int \fBwantDebug\fP: if 1, print more debug information in case of an error" .br .RI "int \fBsuccess\fP: return value indicating success (1) or failure (0) .SH DESCRIPTION `````` Andreas Marek committed Jul 15, 2017 72 ``````Does a Cholesky factorization of a complex, hermitian matrix. 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. `````` Andreas Marek committed Jun 29, 2016 73 ``````.br `````` Andreas Marek committed May 18, 2017 74 75 ``````This function is part of the legacy API of the ELPA library. Better use the current API. .br `````` Andreas Marek committed Jun 29, 2016 76 ``````.SH "SEE ALSO" `````` Andreas Marek committed May 18, 2017 77 78 ``````.br Old interface: `````` Andreas Marek committed Oct 27, 2016 79 ``````\fBelpa_get_communicators\fP(3) \fBelpa_cholesky_complex_double\fP(3) \fBelpa_cholesky_complex_single\fP(3) `````` Andreas Marek committed May 18, 2017 80 81 82 ``````.br Current interface: \fBelpa2_print_kernels\fP(1)``````