Mercurial > hg > sv-dependency-builds

comparison src/fftw-3.3.5/doc/html/Linking-and-Initializing-MPI-FFTW.html @ 127:7867fa7e1b6b

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