annotate src/fftw-3.3.3/doc/html/Linking-and-Initializing-MPI-FFTW.html @ 169:223a55898ab9 tip default

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