Mercurial > hg > sv-dependency-builds

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

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