comparison src/fftw-3.3.3/doc/html/Linking-and-Initializing-MPI-FFTW.html @ 10:37bf6b4a2645

Add FFTW3
author Chris Cannam
date Wed, 20 Mar 2013 15:35:50 +0000
parents
children
comparison
equal deleted inserted replaced
9:c0fb53affa76 10:37bf6b4a2645
1 <html lang="en">
2 <head>
3 <title>Linking and Initializing MPI FFTW - FFTW 3.3.3</title>
4 <meta http-equiv="Content-Type" content="text/html">
5 <meta name="description" content="FFTW 3.3.3">
6 <meta name="generator" content="makeinfo 4.13">
7 <link title="Top" rel="start" href="index.html#Top">
8 <link rel="up" href="Distributed_002dmemory-FFTW-with-MPI.html#Distributed_002dmemory-FFTW-with-MPI" title="Distributed-memory FFTW with MPI">
9 <link rel="prev" href="FFTW-MPI-Installation.html#FFTW-MPI-Installation" title="FFTW MPI Installation">
10 <link rel="next" href="2d-MPI-example.html#g_t2d-MPI-example" title="2d MPI example">
11 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
12 <!--
13 This manual is for FFTW
14 (version 3.3.3, 25 November 2012).
15
16 Copyright (C) 2003 Matteo Frigo.
17
18 Copyright (C) 2003 Massachusetts Institute of Technology.
19
20 Permission is granted to make and distribute verbatim copies of
21 this manual provided the copyright notice and this permission
22 notice are preserved on all copies.
23
24 Permission is granted to copy and distribute modified versions of
25 this manual under the conditions for verbatim copying, provided
26 that the entire resulting derived work is distributed under the
27 terms of a permission notice identical to this one.
28
29 Permission is granted to copy and distribute translations of this
30 manual into another language, under the above conditions for
31 modified versions, except that this permission notice may be
32 stated in a translation approved by the Free Software Foundation.
33 -->
34 <meta http-equiv="Content-Style-Type" content="text/css">
35 <style type="text/css"><!--
36 pre.display { font-family:inherit }
37 pre.format { font-family:inherit }
38 pre.smalldisplay { font-family:inherit; font-size:smaller }
39 pre.smallformat { font-family:inherit; font-size:smaller }
40 pre.smallexample { font-size:smaller }
41 pre.smalllisp { font-size:smaller }
42 span.sc { font-variant:small-caps }
43 span.roman { font-family:serif; font-weight:normal; }
44 span.sansserif { font-family:sans-serif; font-weight:normal; }
45 --></style>
46 </head>
47 <body>
48 <div class="node">
49 <a name="Linking-and-Initializing-MPI-FFTW"></a>
50 <p>
51 Next:&nbsp;<a rel="next" accesskey="n" href="2d-MPI-example.html#g_t2d-MPI-example">2d MPI example</a>,
52 Previous:&nbsp;<a rel="previous" accesskey="p" href="FFTW-MPI-Installation.html#FFTW-MPI-Installation">FFTW MPI Installation</a>,
53 Up:&nbsp;<a rel="up" accesskey="u" href="Distributed_002dmemory-FFTW-with-MPI.html#Distributed_002dmemory-FFTW-with-MPI">Distributed-memory FFTW with MPI</a>
54 <hr>
55 </div>
56
57 <h3 class="section">6.2 Linking and Initializing MPI FFTW</h3>
58
59 <p>Programs using the MPI FFTW routines should be linked with
60 <code>-lfftw3_mpi -lfftw3 -lm</code> on Unix in double precision,
61 <code>-lfftw3f_mpi -lfftw3f -lm</code> in single precision, and so on
62 (see <a href="Precision.html#Precision">Precision</a>). You will also need to link with whatever library
63 is responsible for MPI on your system; in most MPI implementations,
64 there is a special compiler alias named <code>mpicc</code> to compile and
65 link MPI code.
66 <a name="index-mpicc-351"></a><a name="index-linking-on-Unix-352"></a><a name="index-precision-353"></a>
67
68 <p><a name="index-fftw_005finit_005fthreads-354"></a>Before calling any FFTW routines except possibly
69 <code>fftw_init_threads</code> (see <a href="Combining-MPI-and-Threads.html#Combining-MPI-and-Threads">Combining MPI and Threads</a>), but after calling
70 <code>MPI_Init</code>, you should call the function:
71
72 <pre class="example"> void fftw_mpi_init(void);
73 </pre>
74 <p><a name="index-fftw_005fmpi_005finit-355"></a>
75 If, at the end of your program, you want to get rid of all memory and
76 other resources allocated internally by FFTW, for both the serial and
77 MPI routines, you can call:
78
79 <pre class="example"> void fftw_mpi_cleanup(void);
80 </pre>
81 <p><a name="index-fftw_005fmpi_005fcleanup-356"></a>
82 which is much like the <code>fftw_cleanup()</code> function except that it
83 also gets rid of FFTW's MPI-related data. You must <em>not</em> execute
84 any previously created plans after calling this function.
85
86 <!-- -->
87 </body></html>
88