Commit a456199b authored by Andreas Marek's avatar Andreas Marek
Browse files

Man pages for elpa_mult_at_b_real

parent 02972217
......@@ -179,6 +179,7 @@ dist_man_MANS = \
man/solve_evp_complex_2stage.3 \
man/get_elpa_row_col_comms.3 \
man/get_elpa_communicators.3 \
man/elpa_mult_at_b_real.3 \
man/elpa2_print_kernels.1
# other files to distribute
......
.TH "elpa_mult_at_b_real" 3 "Wed Sept 28 2016" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_mult_at_b \- Performs C = transpose(A) * B
.br
.SH SYNOPSIS
.br
.SS FORTRAN INTERFACE
use elpa1
.br
.br
.RI "success = \fBelpa_mult_at_b_real\fP (uplo_a, uplo_c, na, ncb, a, lda, ldaCols, b, ldb, ldbCols, nblk, mpi_comm_rows, mpi_comm_cols, c, ldc, ldcCols)"
.br
.RI " "
.br
.RI "With the definitions of the input and output variables:"
.br
.RI "character, intent(in) \fBuplo_a\fP: 'U' if \fBa\fP is upper triangular, 'L' if \fBa\fP is lower triangular, anything else if \fBa\fP is a full matrix
.br
.RI "character, intent(in) \fBuplo_c\fP: 'U' if only the upper diagonal part of \fBc\fP is needed, 'L' if only the lower diagonal part of \fBc\fP is needed, anything else if the full matrix \fBc\fP is needed
.br
.RI "integer, intent(in) \fBna\fP: Number of rows/columns of \fBa\fP, number of rows of \fBb\fP and \fBc\fP"
.br
.RI "integer, intent(in) \fBncb\fP: Number of /columns of \fBb\fP and \fBc\fP"
.br
.RI "real*8, intent(inout) \fBa\fP: locally distributed part of the matrix \fBa\fP. The local dimensions are \fBlda\fP x \fBldaCols\fP"
.br
.RI "integer, intent(in) \fBlda\fP: leading dimension of locally distributed matrix \fBa\fP"
.br
.RI "integer, intent(in) \fBldaCols\fP: number of columns of locally distributed matrices \fBa\fP"
.br
.RI "real*8, intent(inout) \fBb\fP: locally distributed part of the matrix \fBb\fP. The local dimensions are \fBldb\fP x \fBldbCols\fP"
.br
.RI "integer, intent(in) \fBldb\fP: leading dimension of locally distributed matrix \fBb\fP"
.br
.RI "integer, intent(in) \fBldbCols\fP: number of columns of locally distributed matrices \fBb\fP"
.br
.RI "integer, intent(in) \fBnblk\fP: blocksize of cyclic distribution, must be the same in both directions"
.br
.RI "integer, intent(in) \fBmpi_comm_rows\fP: communicator for communication in rows. Constructed with \fBget_elpa_communicators\fP(3)"
.br
.RI "integer, intent(in) \fBmpi_comm_cols\fP: communicator for communication in colums. Constructed with \fBget_elpa_communicators\fP(3)"
.br
.RI "real*8, intent(inout) \fBc\fP: locally distributed part of the matrix \fBc\fP. The local dimensions are \fBldc\fP x \fBldcCols\fP"
.br
.RI "integer, intent(in) \fBldc\fP: leading dimension of locally distributed matrix \fBc\fP"
.br
.RI "integer, intent(in) \fBldcCols\fP: number of columns of locally distributed matrices \fBc\fP"
.br
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
.br
.RI "\fBint\fP success = \fBelpa_mult_at_b_real\fP (\fBchar\fP uplo_a, \fBchar\fP uplo_c, \fBint\fP na, \fBint\fP ncb, \fB double *\fPa, \fBint\fP lda, \fBint\fP ldaCols, \fB double *\fPb, \fBint\fP ldb, \fBint\fP ldbCols, \fBint\fP nblk, \fBint\fP mpi_comm_rows, \fBint\fP mpi_comm_cols, \fB double *\fPc, \fBint\fP lc, \fBint\fP ldcCols );"
.br
.RI " "
.br
.RI "With the definitions of the input and output variables:"
.br
.RI "char \fBuplo_a\fP: 'U' if \fBa\fP is upper triangular, 'L' if \fBa\fP is lower triangular, anything else if \fBa\fP is a full matrix
.br
.RI "char \fBuplo_c\fP: 'U' if only the upper diagonal part of \fBc\fP is needed, 'L' if only the lower diagonal part of \fBc\fP is needed, anything else if the full matrix \fBc\fP is needed
.br
.RI "int \fBna\fP: Number of rows/columns of \fBa\fP, number of rows of \fBb\fP and \fBc\fP"
.br
.RI "int \fBncb\fP: Number of /columns of \fBb\fP and \fBc\fP"
.br
.RI "double *\fBa\fP: locally distributed part of the matrix \fBa\fP. The local dimensions are \fBlda\fP x \fBldaCols\fP"
.br
.RI "int \fBlda\fP: leading dimension of locally distributed matrix \fBa\fP"
.br
.RI "int \fBldaCols\fP: number of columns of locally distributed matrices \fBa\fP"
.br
.RI "double *\fBb\fP: locally distributed part of the matrix \fBb\fP. The local dimensions are \fBldb\fP x \fBldbCols\fP"
.br
.RI "int \fBldb\fP: leading dimension of locally distributed matrix \fBb\fP"
.br
.RI "int \fBldbCols\fP: number of columns of locally distributed matrices \fBb\fP"
.br
.RI "int \fBnblk\fP: blocksize of cyclic distribution, must be the same in both directions"
.br
.RI "int \fBmpi_comm_rows\fP: communicator for communication in rows. Constructed with \fBget_elpa_communicators\fP(3)"
.br
.RI "int \fBmpi_comm_cols\fP: communicator for communication in colums. Constructed with \fBget_elpa_communicators\fP(3)"
.br
.RI "double *\fBc\fP: locally distributed part of the matrix \fBc\fP. The local dimensions are \fBldc\fP x \fBldcCols\fP"
.br
.RI "int \fBldc\fP: leading dimension of locally distributed matrix \fBc\fP"
.br
.RI "int \fBldcCols\fP: number of columns of locally distributed matrices \fBc\fP"
.br
.RI "int \fBsuccess\fP: return value indicating success (1) or failure (0)
.SH DESCRIPTION
Does c = transpose(a) * b. The ELPA communicators \fBmpi_comm_rows\fP and \fBmpi_comm_cols\fP are obtained with the \fBget_elpa_communicators\fP(3) function.
.br
.SH "SEE ALSO"
\fBget_elpa_communicators\fP(3)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment