Mercurial > hg > sv-dependency-builds

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