Mercurial > hg > sv-dependency-builds

annotate src/fftw-3.3.5/doc/html/Linking-and-Initializing-MPI-FFTW.html @ 42:2cd0e3b3e1fd

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