Commit d47c47b4 authored by Andreas Marek's avatar Andreas Marek

Man page for elpa_set

parent e58228fc
......@@ -363,7 +363,9 @@ dist_man_MANS = \
man/elpa2_print_kernels.1 \
man/elpa_init.3 \
man/elpa_allocate.3 \
man/elpa_set.3 \
man/elpa_setup.3 \
man/elpa_deallocate.3 \
man/elpa_uninit.3
if ENABLE_LEGACY
......
.TH "elpa_set" 3 "Sat Jun 3 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_set \- set parameter or tunables for the ELPA library
.br
.SH SYNOPSIS
.br
.SS FORTRAN INTERFACE
use elpa
.br
class(elpa_t), pointer :: elpa
.br
.RI "call \fBelpa%set\fP (\fBcharacter(*)\fP name, \fBdatatype\fP value, \fBinteger\fP error)"
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"
.br
.RI "character(*) \fBname\fP: the name of the option to be set"
.br
.RI "datatype \fBvalue\fP: the value which should be assigned to the option \fBname\fP. The datatype can be \fBinteger\fP or \fBreal(kind=c_double)\fP."
.br
.RI "integer, optional \fBerror\fP: the returned error code. On success it is ELPA_OK, otherwise an error. The error code can be querried with \fBelpa_strerr\fP(3)"
.br
.SS C INTERFACE
#include <elpa/elpa.h>
.br
elpa_t handle;
.br
.RI "\fBvoid\fP \fBelpa_set\fP (\fBelpa_t\fP handle, \fBconst char\fP *name, \fBdatatype\fP value, \fBint\fP *error);"
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"
.br
.br
.RI "elpa_t \fBhandle\fP: the handle of an ELPA object, obtained before with \fBelpa_allocate\fP(3)"
.br
.RI "const char\fB*name\fP: the name of the option to be set."
.br
.RI "datatype \fBvalue\fP: the value which should be assigned to the option \fBname\fP. Datatype can be either \fBint\fP or \fBdouble\fP."
.SH DESCRIPTION
The elpa_set function is used to set \fBparameters\fP and \fBtunables\fP for the run-time of the ELPA library. It returns an error code which cab be querried with \fBelpa_strerr\fP(3).
\fBParameters:\fP
Parameters of an ELPA instance have to be set BEFORE the ELPA instance is set up with the function \fBelpa_setup\fP(3).
At the moment the following parameters are supported:
\fB"na"\fP: integer parameter. The global matrix has size (na * na)
\fB"nev"\fP: integer parameter. The number of eigenvectors to be computed in a call to \fBelpa_eigenvectors\fP(3).
Must have dimension 1 <= nev <= na.
\fB"local_nrows"\fP: integer parameter. Number of matrix rows stored on this MPI process.
\fB"local_ncols"\fP: integer parameter. Number of matrix cols stored on this MPI process.
\fB"process_row"\fP: integer parameter. Process row number in the 2D domain decomposition.
\fB"process_col"\fP: integer parameter. Process col number in the 2D domain decomposition.
\fB"mpi_comm_parent"\fP: \fBinteger\fP parameter. The parent MPI communicator which includes all MPI process which are used
in the 2D domain decomposition.
\fB"bandwidth"\fP: integer parameter. Some ELPA compute steps can be accelerated if the matrix is already in banded
form. If set, ELPA assumes that the bandwidth of the matrix is the value set.
\fBTunables:\fP
Tunables of an ELPA can be set at anytime.
At the moment the following parameters are supported:
\fB"solver"\fP: Choose which solver should be used in the compute steps \fBelpa_eigenvalues\fP(3) or \fBelpa_eigenvectors\fP(3). At the moment allowed option are \fB"ELPA_SOLVER_1STAGE"\fP or \fB"ELPA_SOLVER_2STAGE"\fP.
\fB"real_kernel"\fP: Choose which real kernel should be used in the \fBelpa_eigenvalues\fP(3) or \fBelpa_eigenvectors\fP(3)compute steps, if solver is set to \fB"ELPA_SOLVER_2STAGE"\fP. The available kernels can be querried with \fBelpa2_print_kernels\fP(1).
\fB"complex_kernel"\fP: Choose which complex kernel should be used in the \fBelpa_eigenvalues\fP(3) or \fBelpa_eigenvectors\fP(3)compute steps, if solver is set to \fB"ELPA_SOLVER_2STAGE"\fP. The available kernels can be querried with \fBelpa2_print_kernels\fP(1).
\fB"qr"\fP : Choose whether in the real case computations in \fBelpa_eigenvalues\fP(3) or \fBelpa_eigenvectors\fP(3)compute steps, if solver is set to \fB"ELPA_SOLVER_2STAGE"\fP, a QR decompostion should be used.
\fB"qpu"\fP : Choose whether accelerated GPU calculations should be used. Only available if ELPA has been build with GPU support.
\fB"timings"\fP : Choose whether time measurements should be done in the ELPA routines.
\fB"debug"\f P : Choose whether, in case of an error, more debug information should be provided.
.br
.SH "SEE ALSO"
.br
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_allocate\fP(3) \fBelpa_strerr\fP(3) \fBelpa_deallocate\fP(3) \fBelpa_uninit\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