elpa_init.3 1.39 KB
Newer Older
Andreas Marek's avatar
Andreas Marek committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
.TH "elpa_init" 3 "Sat Jun 3 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_init \- initialize the ELPA library
.br

.SH SYNOPSIS
.br
.SS FORTRAN INTERFACE
use elpa
.br
class(elpa_t), pointer :: elpa
.br

.RI  "error = \fBelpa_init\fP (api_version)"
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"

.br
Andreas Marek's avatar
Andreas Marek committed
23
.RI "integer, intent(in) :: \fBapi_version\fP  ! the api version that you want to initialize, currently the version is 20170403"
Andreas Marek's avatar
Andreas Marek committed
24
.br
Andreas Marek's avatar
Andreas Marek committed
25
.RI "integer             :: \fBerror\fP        ! the return code. If the function returns without an error, the error code will be ELPA_OK."
Andreas Marek's avatar
Andreas Marek committed
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
.br

.br
.SS C INTERFACE
#include <elpa/elpa.h>
.br
elpa_t handle;

.br
.RI "\fBint\fP error = \fBelpa_init\fP (\fBint\fP api_version);"
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"

.br
.br
Andreas Marek's avatar
Andreas Marek committed
43
.RI "int \fBapi_version\fP;  // the api version that you want to initialize currently the version is 20170403"
Andreas Marek's avatar
Andreas Marek committed
44
.br
Andreas Marek's avatar
Andreas Marek committed
45
.RI "int \fBerror\fP;        // the return code. If the function returns without an error, the error code will be ELPA_OK."
Andreas Marek's avatar
Andreas Marek committed
46
47
48
49
50
51
52

.SH DESCRIPTION
Initializes the ELPA library for usage. The return code shold be ELPA_OK. The return code can be querried
with the \fBelpa_strerr\fP(3) function.
.br
.SH "SEE ALSO"
.br
Andreas Marek's avatar
Andreas Marek committed
53
\fBelpa2_print_kernels\fP(1) \fBelpa_allocate\fP(3) \fPelpa_set\fP(3) \fPelpa_setup\fP(3) \fBelpa_strerr\fP(3) \fPelpa_uninit\fP(3) \fBelpa_deallocate\fP(3)