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