annotate src/fftw-3.3.8/doc/html/Linking-and-Initializing-MPI-FFTW.html @ 83:ae30d91d2ffe

Replace these with versions built using an older toolset (so as to avoid ABI compatibilities when linking on Ubuntu 14.04 for packaging purposes)
author Chris Cannam
date Fri, 07 Feb 2020 11:51:13 +0000
parents d0c2a83c1364
children
rev   line source
Chris@82 1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
Chris@82 2 <html>
Chris@82 3 <!-- This manual is for FFTW
Chris@82 4 (version 3.3.8, 24 May 2018).
Chris@82 5
Chris@82 6 Copyright (C) 2003 Matteo Frigo.
Chris@82 7
Chris@82 8 Copyright (C) 2003 Massachusetts Institute of Technology.
Chris@82 9
Chris@82 10 Permission is granted to make and distribute verbatim copies of this
Chris@82 11 manual provided the copyright notice and this permission notice are
Chris@82 12 preserved on all copies.
Chris@82 13
Chris@82 14 Permission is granted to copy and distribute modified versions of this
Chris@82 15 manual under the conditions for verbatim copying, provided that the
Chris@82 16 entire resulting derived work is distributed under the terms of a
Chris@82 17 permission notice identical to this one.
Chris@82 18
Chris@82 19 Permission is granted to copy and distribute translations of this manual
Chris@82 20 into another language, under the above conditions for modified versions,
Chris@82 21 except that this permission notice may be stated in a translation
Chris@82 22 approved by the Free Software Foundation. -->
Chris@82 23 <!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
Chris@82 24 <head>
Chris@82 25 <title>FFTW 3.3.8: Linking and Initializing MPI FFTW</title>
Chris@82 26
Chris@82 27 <meta name="description" content="FFTW 3.3.8: Linking and Initializing MPI FFTW">
Chris@82 28 <meta name="keywords" content="FFTW 3.3.8: Linking and Initializing MPI FFTW">
Chris@82 29 <meta name="resource-type" content="document">
Chris@82 30 <meta name="distribution" content="global">
Chris@82 31 <meta name="Generator" content="makeinfo">
Chris@82 32 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Chris@82 33 <link href="index.html#Top" rel="start" title="Top">
Chris@82 34 <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
Chris@82 35 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
Chris@82 36 <link href="Distributed_002dmemory-FFTW-with-MPI.html#Distributed_002dmemory-FFTW-with-MPI" rel="up" title="Distributed-memory FFTW with MPI">
Chris@82 37 <link href="2d-MPI-example.html#g_t2d-MPI-example" rel="next" title="2d MPI example">
Chris@82 38 <link href="FFTW-MPI-Installation.html#FFTW-MPI-Installation" rel="prev" title="FFTW MPI Installation">
Chris@82 39 <style type="text/css">
Chris@82 40 <!--
Chris@82 41 a.summary-letter {text-decoration: none}
Chris@82 42 blockquote.indentedblock {margin-right: 0em}
Chris@82 43 blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
Chris@82 44 blockquote.smallquotation {font-size: smaller}
Chris@82 45 div.display {margin-left: 3.2em}
Chris@82 46 div.example {margin-left: 3.2em}
Chris@82 47 div.lisp {margin-left: 3.2em}
Chris@82 48 div.smalldisplay {margin-left: 3.2em}
Chris@82 49 div.smallexample {margin-left: 3.2em}
Chris@82 50 div.smalllisp {margin-left: 3.2em}
Chris@82 51 kbd {font-style: oblique}
Chris@82 52 pre.display {font-family: inherit}
Chris@82 53 pre.format {font-family: inherit}
Chris@82 54 pre.menu-comment {font-family: serif}
Chris@82 55 pre.menu-preformatted {font-family: serif}
Chris@82 56 pre.smalldisplay {font-family: inherit; font-size: smaller}
Chris@82 57 pre.smallexample {font-size: smaller}
Chris@82 58 pre.smallformat {font-family: inherit; font-size: smaller}
Chris@82 59 pre.smalllisp {font-size: smaller}
Chris@82 60 span.nolinebreak {white-space: nowrap}
Chris@82 61 span.roman {font-family: initial; font-weight: normal}
Chris@82 62 span.sansserif {font-family: sans-serif; font-weight: normal}
Chris@82 63 ul.no-bullet {list-style: none}
Chris@82 64 -->
Chris@82 65 </style>
Chris@82 66
Chris@82 67
Chris@82 68 </head>
Chris@82 69
Chris@82 70 <body lang="en">
Chris@82 71 <a name="Linking-and-Initializing-MPI-FFTW"></a>
Chris@82 72 <div class="header">
Chris@82 73 <p>
Chris@82 74 Next: <a href="2d-MPI-example.html#g_t2d-MPI-example" accesskey="n" rel="next">2d MPI example</a>, Previous: <a href="FFTW-MPI-Installation.html#FFTW-MPI-Installation" accesskey="p" rel="prev">FFTW MPI Installation</a>, Up: <a href="Distributed_002dmemory-FFTW-with-MPI.html#Distributed_002dmemory-FFTW-with-MPI" accesskey="u" rel="up">Distributed-memory FFTW with MPI</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
Chris@82 75 </div>
Chris@82 76 <hr>
Chris@82 77 <a name="Linking-and-Initializing-MPI-FFTW-1"></a>
Chris@82 78 <h3 class="section">6.2 Linking and Initializing MPI FFTW</h3>
Chris@82 79
Chris@82 80 <p>Programs using the MPI FFTW routines should be linked with
Chris@82 81 <code>-lfftw3_mpi -lfftw3 -lm</code> on Unix in double precision,
Chris@82 82 <code>-lfftw3f_mpi -lfftw3f -lm</code> in single precision, and so on
Chris@82 83 (see <a href="Precision.html#Precision">Precision</a>). You will also need to link with whatever library
Chris@82 84 is responsible for MPI on your system; in most MPI implementations,
Chris@82 85 there is a special compiler alias named <code>mpicc</code> to compile and
Chris@82 86 link MPI code.
Chris@82 87 <a name="index-mpicc-1"></a>
Chris@82 88 <a name="index-linking-on-Unix-1"></a>
Chris@82 89 <a name="index-precision-5"></a>
Chris@82 90 </p>
Chris@82 91
Chris@82 92 <a name="index-fftw_005finit_005fthreads-1"></a>
Chris@82 93 <p>Before calling any FFTW routines except possibly
Chris@82 94 <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@82 95 <code>MPI_Init</code>, you should call the function:
Chris@82 96 </p>
Chris@82 97 <div class="example">
Chris@82 98 <pre class="example">void fftw_mpi_init(void);
Chris@82 99 </pre></div>
Chris@82 100 <a name="index-fftw_005fmpi_005finit"></a>
Chris@82 101
Chris@82 102 <p>If, at the end of your program, you want to get rid of all memory and
Chris@82 103 other resources allocated internally by FFTW, for both the serial and
Chris@82 104 MPI routines, you can call:
Chris@82 105 </p>
Chris@82 106 <div class="example">
Chris@82 107 <pre class="example">void fftw_mpi_cleanup(void);
Chris@82 108 </pre></div>
Chris@82 109 <a name="index-fftw_005fmpi_005fcleanup"></a>
Chris@82 110
Chris@82 111 <p>which is much like the <code>fftw_cleanup()</code> function except that it
Chris@82 112 also gets rid of FFTW&rsquo;s MPI-related data. You must <em>not</em> execute
Chris@82 113 any previously created plans after calling this function.
Chris@82 114 </p>
Chris@82 115
Chris@82 116
Chris@82 117
Chris@82 118 </body>
Chris@82 119 </html>