elpa_allocate.3 1.33 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
.TH "elpa_allocate" 3 "Sat Jun 3 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_allocate \- allocate an instance of the ELPA library
.br

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

16
.RI  "elpa => \fBelpa_allocate\fP (error)"
17 18 19
.br
.RI " "
.br
20
.RI "With the definitions of the input and output variables:"
21 22

.br
23
.RI "class(elpa_t)     :: \fBelpa\fP  ! returns an instance of the ELPA object"
24
.br
25
.RI "integer, optional :: \fBerror\fp ! a returned error code 
26 27 28 29 30 31 32
.br
.SS C INTERFACE
#include <elpa/elpa.h>
.br
elpa_t handle;

.br
33
.RI "\fBelpa_t\fP handle = \fBelpa_allocate\fP(\fBint\fP *error);"
34 35 36
.br
.RI " "
.br
37
.RI "With the definitions of the input and output variables:"
38 39 40

.br
.br
Andreas Marek's avatar
Andreas Marek committed
41
.RI "elpa_t \fBhandle\fP;  // returns an handle to the allocated ELPA object"
42 43 44 45
.br
.RI "int \fB*error\fP;     // a returned error code
.br

46 47

.SH DESCRIPTION
Andreas Marek's avatar
Andreas Marek committed
48
Allocate an ELPA object. The function \fBelpa_init\fP(3) must be called once \fIBEFORE\fP \fBelpa_allocate\fP can be called.
49 50 51
.br
.SH "SEE ALSO"
.br
52
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_set\fP(3) \fBelpa_setup\fP(3) \fBelpa_strerr\fP(3) \fBelpa_eigenvalues\fP(3) \fBelpa_eigenvectors\fP(3) \fBelpa_cholesky\fP(3) \fBelpa_invert_triangular\fP(3) \fBelpa_solve_tridiagonal\fP(3) \fBelpa_hermitian_multiply\fP(3) \fBelpa_uninit\fP(3) \fBelpa_deallocate\fP(3)