elpa_uninit.3 1.12 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
.TH "elpa_uninit" 3 "Sat Jun 3 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_uninit \- uninitialize the ELPA library
.br

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

16
.RI  "call \fBelpa_uninit\fP (error)"
Andreas Marek's avatar
Andreas Marek committed
17 18 19
.br
.RI " "
.br
20
.RI "With the definitions of the input and output variables:"
Andreas Marek's avatar
Andreas Marek committed
21 22

.br
23
.RI "error     integer, optional error code"
Andreas Marek's avatar
Andreas Marek committed
24 25 26 27 28 29 30 31 32 33
.br
.br

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

.br
34
.RI "\fBvoid\fP \fBelpa_uninit\fP (int *error);"
Andreas Marek's avatar
Andreas Marek committed
35 36 37
.br
.RI " "
.br
38
.RI "With the definitions of the input and output variables:"
Andreas Marek's avatar
Andreas Marek committed
39 40 41

.br
.br
42
.RI "\fBint *\fP    error : the error code"
Andreas Marek's avatar
Andreas Marek committed
43 44 45
.br

.SH DESCRIPTION
Andreas Marek's avatar
Andreas Marek committed
46
Uninitializes the ELPA library after usage. The function \fBelpa_init\fP(3) must have been called \fIBEFORE\fP elpa_uninit can be called.
Andreas Marek's avatar
Andreas Marek committed
47 48 49
.br
.SH "SEE ALSO"
.br
50
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_allocate\fP(3) \fBelpa_set\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_setup\fP(3) \fBelpa_deallocate\fP(3)