annotate fft/fftw/fftw-3.3.4/doc/html/Linking-and-Initializing-MPI-FFTW.html @ 40:223f770b5341 kissfft-double tip

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