Mercurial > hg > sv-dependency-builds

annotate src/fftw-3.3.8/doc/html/Using-MPI-Plans.html @ 167:bd3cc4d1df30

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