Mercurial > hg > sv-dependency-builds

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

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