annotate src/fftw-3.3.8/doc/html/Using-MPI-Plans.html @ 82:d0c2a83c1364

Add FFTW 3.3.8 source, and a Linux build
author Chris Cannam
date Tue, 19 Nov 2019 14:52:55 +0000
parents
children
rev   line source
Chris@82 1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
Chris@82 2 <html>
Chris@82 3 <!-- This manual is for FFTW
Chris@82 4 (version 3.3.8, 24 May 2018).
Chris@82 5
Chris@82 6 Copyright (C) 2003 Matteo Frigo.
Chris@82 7
Chris@82 8 Copyright (C) 2003 Massachusetts Institute of Technology.
Chris@82 9
Chris@82 10 Permission is granted to make and distribute verbatim copies of this
Chris@82 11 manual provided the copyright notice and this permission notice are
Chris@82 12 preserved on all copies.
Chris@82 13
Chris@82 14 Permission is granted to copy and distribute modified versions of this
Chris@82 15 manual under the conditions for verbatim copying, provided that the
Chris@82 16 entire resulting derived work is distributed under the terms of a
Chris@82 17 permission notice identical to this one.
Chris@82 18
Chris@82 19 Permission is granted to copy and distribute translations of this manual
Chris@82 20 into another language, under the above conditions for modified versions,
Chris@82 21 except that this permission notice may be stated in a translation
Chris@82 22 approved by the Free Software Foundation. -->
Chris@82 23 <!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
Chris@82 24 <head>
Chris@82 25 <title>FFTW 3.3.8: Using MPI Plans</title>
Chris@82 26
Chris@82 27 <meta name="description" content="FFTW 3.3.8: Using MPI Plans">
Chris@82 28 <meta name="keywords" content="FFTW 3.3.8: Using MPI Plans">
Chris@82 29 <meta name="resource-type" content="document">
Chris@82 30 <meta name="distribution" content="global">
Chris@82 31 <meta name="Generator" content="makeinfo">
Chris@82 32 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Chris@82 33 <link href="index.html#Top" rel="start" title="Top">
Chris@82 34 <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
Chris@82 35 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
Chris@82 36 <link href="FFTW-MPI-Reference.html#FFTW-MPI-Reference" rel="up" title="FFTW MPI Reference">
Chris@82 37 <link href="MPI-Data-Distribution-Functions.html#MPI-Data-Distribution-Functions" rel="next" title="MPI Data Distribution Functions">
Chris@82 38 <link href="MPI-Initialization.html#MPI-Initialization" rel="prev" title="MPI Initialization">
Chris@82 39 <style type="text/css">
Chris@82 40 <!--
Chris@82 41 a.summary-letter {text-decoration: none}
Chris@82 42 blockquote.indentedblock {margin-right: 0em}
Chris@82 43 blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
Chris@82 44 blockquote.smallquotation {font-size: smaller}
Chris@82 45 div.display {margin-left: 3.2em}
Chris@82 46 div.example {margin-left: 3.2em}
Chris@82 47 div.lisp {margin-left: 3.2em}
Chris@82 48 div.smalldisplay {margin-left: 3.2em}
Chris@82 49 div.smallexample {margin-left: 3.2em}
Chris@82 50 div.smalllisp {margin-left: 3.2em}
Chris@82 51 kbd {font-style: oblique}
Chris@82 52 pre.display {font-family: inherit}
Chris@82 53 pre.format {font-family: inherit}
Chris@82 54 pre.menu-comment {font-family: serif}
Chris@82 55 pre.menu-preformatted {font-family: serif}
Chris@82 56 pre.smalldisplay {font-family: inherit; font-size: smaller}
Chris@82 57 pre.smallexample {font-size: smaller}
Chris@82 58 pre.smallformat {font-family: inherit; font-size: smaller}
Chris@82 59 pre.smalllisp {font-size: smaller}
Chris@82 60 span.nolinebreak {white-space: nowrap}
Chris@82 61 span.roman {font-family: initial; font-weight: normal}
Chris@82 62 span.sansserif {font-family: sans-serif; font-weight: normal}
Chris@82 63 ul.no-bullet {list-style: none}
Chris@82 64 -->
Chris@82 65 </style>
Chris@82 66
Chris@82 67
Chris@82 68 </head>
Chris@82 69
Chris@82 70 <body lang="en">
Chris@82 71 <a name="Using-MPI-Plans"></a>
Chris@82 72 <div class="header">
Chris@82 73 <p>
Chris@82 74 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>
Chris@82 75 </div>
Chris@82 76 <hr>
Chris@82 77 <a name="Using-MPI-Plans-1"></a>
Chris@82 78 <h4 class="subsection">6.12.3 Using MPI Plans</h4>
Chris@82 79
Chris@82 80 <p>Once an MPI plan is created, you can execute and destroy it using
Chris@82 81 <code>fftw_execute</code>, <code>fftw_destroy_plan</code>, and the other functions
Chris@82 82 in the serial interface that operate on generic plans (see <a href="Using-Plans.html#Using-Plans">Using Plans</a>).
Chris@82 83 </p>
Chris@82 84 <a name="index-collective-function-3"></a>
Chris@82 85 <a name="index-MPI-communicator-1"></a>
Chris@82 86 <p>The <code>fftw_execute</code> and <code>fftw_destroy_plan</code> functions, applied to
Chris@82 87 MPI plans, are <em>collective</em> calls: they must be called for all processes
Chris@82 88 in the communicator that was used to create the plan.
Chris@82 89 </p>
Chris@82 90 <a name="index-new_002darray-execution-1"></a>
Chris@82 91 <p>You must <em>not</em> use the serial new-array plan-execution functions
Chris@82 92 <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
Chris@82 93 problem type, and there are specific new-array execute functions for MPI plans:
Chris@82 94 </p>
Chris@82 95 <a name="index-fftw_005fmpi_005fexecute_005fdft"></a>
Chris@82 96 <a name="index-fftw_005fmpi_005fexecute_005fdft_005fr2c"></a>
Chris@82 97 <a name="index-fftw_005fmpi_005fexecute_005fdft_005fc2r"></a>
Chris@82 98 <a name="index-fftw_005fmpi_005fexecute_005fr2r"></a>
Chris@82 99 <div class="example">
Chris@82 100 <pre class="example">void fftw_mpi_execute_dft(fftw_plan p, fftw_complex *in, fftw_complex *out);
Chris@82 101 void fftw_mpi_execute_dft_r2c(fftw_plan p, double *in, fftw_complex *out);
Chris@82 102 void fftw_mpi_execute_dft_c2r(fftw_plan p, fftw_complex *in, double *out);
Chris@82 103 void fftw_mpi_execute_r2r(fftw_plan p, double *in, double *out);
Chris@82 104 </pre></div>
Chris@82 105
Chris@82 106 <a name="index-alignment-3"></a>
Chris@82 107 <a name="index-fftw_005fmalloc-6"></a>
Chris@82 108 <p>These functions have the same restrictions as those of the serial
Chris@82 109 new-array execute functions. They are <em>always</em> safe to apply to
Chris@82 110 the <em>same</em> <code>in</code> and <code>out</code> arrays that were used to
Chris@82 111 create the plan. They can only be applied to new arrarys if those
Chris@82 112 arrays have the same types, dimensions, in-placeness, and alignment as
Chris@82 113 the original arrays, where the best way to ensure the same alignment
Chris@82 114 is to use FFTW&rsquo;s <code>fftw_malloc</code> and related allocation functions
Chris@82 115 for all arrays (see <a href="Memory-Allocation.html#Memory-Allocation">Memory Allocation</a>). Note that distributed
Chris@82 116 transposes (see <a href="FFTW-MPI-Transposes.html#FFTW-MPI-Transposes">FFTW MPI Transposes</a>) use
Chris@82 117 <code>fftw_mpi_execute_r2r</code>, since they count as rank-zero r2r plans
Chris@82 118 from FFTW&rsquo;s perspective.
Chris@82 119 </p>
Chris@82 120 <hr>
Chris@82 121 <div class="header">
Chris@82 122 <p>
Chris@82 123 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>
Chris@82 124 </div>
Chris@82 125
Chris@82 126
Chris@82 127
Chris@82 128 </body>
Chris@82 129 </html>