Mercurial > hg > sv-dependency-builds

comparison src/fftw-3.3.5/doc/html/Using-MPI-Plans.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
comparison
equal deleted inserted replaced
41:481f5f8c5634 42:2cd0e3b3e1fd
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: Using MPI Plans</title>
26
27 <meta name="description" content="FFTW 3.3.5: Using MPI Plans">
28 <meta name="keywords" content="FFTW 3.3.5: Using MPI Plans">
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="MPI-Data-Distribution-Functions.html#MPI-Data-Distribution-Functions" rel="next" title="MPI Data Distribution Functions">
38 <link href="MPI-Initialization.html#MPI-Initialization" rel="prev" title="MPI Initialization">
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="Using-MPI-Plans"></a>
73 <div class="header">
74 <p>
75 Next: <a href="MPI-Data-Distribution-Functions.html#MPI-Data-Distribution-Functions" accesskey="n" rel="next">MPI Data Distribution Functions</a>, Previous: <a href="MPI-Initialization.html#MPI-Initialization" accesskey="p" rel="prev">MPI Initialization</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="Using-MPI-Plans-1"></a>
79 <h4 class="subsection">6.12.3 Using MPI Plans</h4>
80
81 <p>Once an MPI plan is created, you can execute and destroy it using
82 <code>fftw_execute</code>, <code>fftw_destroy_plan</code>, and the other functions
83 in the serial interface that operate on generic plans (see <a href="Using-Plans.html#Using-Plans">Using Plans</a>).
84 </p>
85 <a name="index-collective-function-3"></a>
86 <a name="index-MPI-communicator-1"></a>
87 <p>The <code>fftw_execute</code> and <code>fftw_destroy_plan</code> functions, applied to
88 MPI plans, are <em>collective</em> calls: they must be called for all processes
89 in the communicator that was used to create the plan.
90 </p>
91 <a name="index-new_002darray-execution-1"></a>
92 <p>You must <em>not</em> use the serial new-array plan-execution functions
93 <code>fftw_execute_dft</code> and so on (see <a href="New_002darray-Execute-Functions.html#New_002darray-Execute-Functions">New-array Execute Functions</a>) with MPI plans. Such functions are specialized to the
94 problem type, and there are specific new-array execute functions for MPI plans:
95 </p>
96 <a name="index-fftw_005fmpi_005fexecute_005fdft"></a>
97 <a name="index-fftw_005fmpi_005fexecute_005fdft_005fr2c"></a>
98 <a name="index-fftw_005fmpi_005fexecute_005fdft_005fc2r"></a>
99 <a name="index-fftw_005fmpi_005fexecute_005fr2r"></a>
100 <div class="example">
101 <pre class="example">void fftw_mpi_execute_dft(fftw_plan p, fftw_complex *in, fftw_complex *out);
102 void fftw_mpi_execute_dft_r2c(fftw_plan p, double *in, fftw_complex *out);
103 void fftw_mpi_execute_dft_c2r(fftw_plan p, fftw_complex *in, double *out);
104 void fftw_mpi_execute_r2r(fftw_plan p, double *in, double *out);
105 </pre></div>
106
107 <a name="index-alignment-3"></a>
108 <a name="index-fftw_005fmalloc-6"></a>
109 <p>These functions have the same restrictions as those of the serial
110 new-array execute functions. They are <em>always</em> safe to apply to
111 the <em>same</em> <code>in</code> and <code>out</code> arrays that were used to
112 create the plan. They can only be applied to new arrarys if those
113 arrays have the same types, dimensions, in-placeness, and alignment as
114 the original arrays, where the best way to ensure the same alignment
115 is to use FFTW&rsquo;s <code>fftw_malloc</code> and related allocation functions
116 for all arrays (see <a href="Memory-Allocation.html#Memory-Allocation">Memory Allocation</a>). Note that distributed
117 transposes (see <a href="FFTW-MPI-Transposes.html#FFTW-MPI-Transposes">FFTW MPI Transposes</a>) use
118 <code>fftw_mpi_execute_r2r</code>, since they count as rank-zero r2r plans
119 from FFTW&rsquo;s perspective.
120 </p>
121 <hr>
122 <div class="header">
123 <p>
124 Next: <a href="MPI-Data-Distribution-Functions.html#MPI-Data-Distribution-Functions" accesskey="n" rel="next">MPI Data Distribution Functions</a>, Previous: <a href="MPI-Initialization.html#MPI-Initialization" accesskey="p" rel="prev">MPI Initialization</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>
125 </div>
126
127
128
129 </body>
130 </html>