elpa_deallocate.3 1.25 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_deallocate" 3 "Sat Jun 3 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_deallocate \- deallocate an instance of the ELPA library after usage
.br

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

.RI  "call \fBelpa_deallocate\fP (\fBclass(elpa_t)\fP elpa)"
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"

.br
Andreas Marek's avatar
Andreas Marek committed
23
.RI "class(elpa_t) :: \fBelpa\fP  ! the pointer to the instance of the ELPA library which should be deallocated"
Andreas Marek's avatar
Andreas Marek committed
24 25 26 27 28 29 30 31 32
.br

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

.br
Andreas Marek's avatar
Andreas Marek committed
33
.RI "\fBvoid\fP \fBelpa_deallocate\fP(\fBelpa_t\fP handle);"
Andreas Marek's avatar
Andreas Marek committed
34 35 36 37 38 39 40
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"

.br
.br
Andreas Marek's avatar
Andreas Marek committed
41
.RI "elpa_t \fBhandle\fP; // the handle to the ELPA instance which should be deallocated."
Andreas Marek's avatar
Andreas Marek committed
42 43

.SH DESCRIPTION
Andreas Marek's avatar
Andreas Marek committed
44
Deallocate an ELPA object. The functions \fBelpa_init\fP(3) and \fBelpa_allocate\fP(3) must have been called \fIBEFORE\fP \fBelpa_deallocate\fP can be called.
Andreas Marek's avatar
Andreas Marek committed
45 46 47
.br
.SH "SEE ALSO"
.br
48
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_allocate\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_uninit\fP(3)