comparison src/fftw-3.3.5/doc/html/MPI-Initialization.html @ 127:7867fa7e1b6b

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: MPI Initialization</title>
26
27 <meta name="description" content="FFTW 3.3.5: MPI Initialization">
28 <meta name="keywords" content="FFTW 3.3.5: MPI Initialization">
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="FFTW-MPI-Reference.html#FFTW-MPI-Reference" rel="up" title="FFTW MPI Reference">
37 <link href="Using-MPI-Plans.html#Using-MPI-Plans" rel="next" title="Using MPI Plans">
38 <link href="MPI-Files-and-Data-Types.html#MPI-Files-and-Data-Types" rel="prev" title="MPI Files and Data Types">
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="MPI-Initialization"></a>
73 <div class="header">
74 <p>
75 Next: <a href="Using-MPI-Plans.html#Using-MPI-Plans" accesskey="n" rel="next">Using MPI Plans</a>, Previous: <a href="MPI-Files-and-Data-Types.html#MPI-Files-and-Data-Types" accesskey="p" rel="prev">MPI Files and Data Types</a>, Up: <a href="FFTW-MPI-Reference.html#FFTW-MPI-Reference" accesskey="u" rel="up">FFTW MPI Reference</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="MPI-Initialization-1"></a>
79 <h4 class="subsection">6.12.2 MPI Initialization</h4>
80
81 <p>Before calling any other FFTW MPI (&lsquo;<samp>fftw_mpi_</samp>&rsquo;) function, and
82 before importing any wisdom for MPI problems, you must call:
83 </p>
84 <a name="index-fftw_005fmpi_005finit-4"></a>
85 <div class="example">
86 <pre class="example">void fftw_mpi_init(void);
87 </pre></div>
88
89 <a name="index-fftw_005finit_005fthreads-3"></a>
90 <p>If FFTW threads support is used, however, <code>fftw_mpi_init</code> should
91 be called <em>after</em> <code>fftw_init_threads</code> (see <a href="Combining-MPI-and-Threads.html#Combining-MPI-and-Threads">Combining MPI and Threads</a>). Calling <code>fftw_mpi_init</code> additional times (before
92 <code>fftw_mpi_cleanup</code>) has no effect.
93 </p>
94
95 <p>If you want to deallocate all persistent data and reset FFTW to the
96 pristine state it was in when you started your program, you can call:
97 </p>
98 <a name="index-fftw_005fmpi_005fcleanup-1"></a>
99 <div class="example">
100 <pre class="example">void fftw_mpi_cleanup(void);
101 </pre></div>
102
103 <a name="index-fftw_005fcleanup-1"></a>
104 <p>(This calls <code>fftw_cleanup</code>, so you need not call the serial
105 cleanup routine too, although it is safe to do so.) After calling
106 <code>fftw_mpi_cleanup</code>, all existing plans become undefined, and you
107 should not attempt to execute or destroy them. You must call
108 <code>fftw_mpi_init</code> again after <code>fftw_mpi_cleanup</code> if you want
109 to resume using the MPI FFTW routines.
110 </p>
111
112
113
114 </body>
115 </html>