elpa_invert_trm_complex.3 3.28 KB
Newer Older
1
.TH "elpa_invert_trm_complex" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*-
2
3
4
.ad l
.nh
.SH NAME
5
elpa_invert_trm_complex \- Invert a upper triangular matrix (legacy interface)
6
7
8
9
10
11
12
13
.br

.SH SYNOPSIS
.br
.SS FORTRAN INTERFACE
use elpa1
.br
.br
14
.RI  "success = \fBelpa_invert_trm_complex\fP (na, a, lda, nblk, matrixCols, mpi_comm_rows, mpi_comm_cols, wantDebug)"
15
16
17
18
19
20
21
22
.br
.RI " "
.br
.RI "With the definitions of the input and output variables:"

.br
.RI "integer, intent(in)    \fBna\fP:            Order of matrix \fBa\fP"
.br
23
.RI "complex*16,  intent(inout) \fBa\fP:         locally distributed part of the matrix \fBa\fP. The local dimensions are \fBlda\fP x \fBldaCols\fP. Only upper triangule needs to be set. The lower triangle is not referenced"
24
25
26
27
28
29
30
.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"
.br
31
.RI "integer, intent(in)    \fBmpi_comm_rows\fP: communicator for communication in rows. Constructed with \fBelpa_get_communicators\fP(3)"
32
.br
33
.RI "integer, intent(in)    \fBmpi_comm_cols\fP: communicator for communication in colums. Constructed with \fBelpa_get_communicators\fP(3)"
34
35
36
37
38
39
40
.br
.RI "logical, intent(in)    \fBwantDebug\fP:     if .true. , print more debug information in case of an error"

.br
.RI "logical                \fBsuccess\fP:       return value indicating success or failure"
.br
.SS C INTERFACE
41
#include "elpa_legacy.h"
42
43

.br
44
.RI "\fBint\fP success = \fBelpa_invert_trm_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);"
45
46
47
48
49
50
51
52
.br
.RI " "
.br
.RI "With the definitions of the input and output variables:"

.br
.RI "int \fBna\fP:               Order of matrix \fBa\fP"
.br
53
.RI "double complex *\fBa\fP:    locally distributed part of the matrix \fBa\fP. The local dimensions are \fBlda\fP x \fBmatrixCols\fP.  Only upper triangule needs to be set. The lower triangle is not referenced"
54
55
56
57
58
59
60
.br
.RI "int \fBlda\fP:              leading dimension of locally distributed matrix \fBa\fP"
.br
.RI "int \fBnblk\fP:             blocksize of cyclic distribution, must be the same in both directions"
.br
.RI "int \fBmatrixCols\fP:       number of columns of locally distributed matrices \fBa\fP"
.br
61
.RI "int \fBmpi_comm_rows\fP:    communicator for communication in rows. Constructed with \fBelpa_get_communicators\fP(3)"
62
.br
63
.RI "int \fBmpi_comm_cols\fP:    communicator for communication in colums. Constructed with \fBelpa_get_communicators\fP(3)"
64
65
66
67
68
69
70
.br
.RI "int \fBwantDebug\fP:        give more debugging information"
.br

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

.SH DESCRIPTION
71
Inverts a upper triangular matrix a. The ELPA communicators \fBmpi_comm_rows\fP and \fBmpi_comm_cols\fP are obtained with the \fBelpa_get_communicators\fP(3) function.
72
.br
73
74
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
75
.SH "SEE ALSO"
76
77
.br
Old interface:
78
\fBelpa_get_communicators\fP(3) \fBelpa_invert_trm_real\fP(3)
79
80
81
.br
Current interface:
\fBelpa2_print_kernels\fP(1)