Mercurial > hg > sv-dependency-builds

annotate src/fftw-3.3.5/doc/html/Using-MPI-Plans.html @ 83:ae30d91d2ffe

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