Mercurial > hg > sv-dependency-builds

annotate src/fftw-3.3.5/doc/html/MPI-Initialization.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
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: MPI Initialization</title>
Chris@42 26
Chris@42 27 <meta name="description" content="FFTW 3.3.5: MPI Initialization">
Chris@42 28 <meta name="keywords" content="FFTW 3.3.5: MPI Initialization">
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="Using-MPI-Plans.html#Using-MPI-Plans" rel="next" title="Using MPI Plans">
Chris@42 38 <link href="MPI-Files-and-Data-Types.html#MPI-Files-and-Data-Types" rel="prev" title="MPI Files and Data Types">
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="MPI-Initialization"></a>
Chris@42 73 <div class="header">
Chris@42 74 <p>
Chris@42 75 Next: <a href="Using-MPI-Plans.html#Using-MPI-Plans" accesskey="n" rel="next">Using MPI Plans</a>, Previous: <a href="MPI-Files-and-Data-Types.html#MPI-Files-and-Data-Types" accesskey="p" rel="prev">MPI Files and Data Types</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="MPI-Initialization-1"></a>
Chris@42 79 <h4 class="subsection">6.12.2 MPI Initialization</h4>
Chris@42 80
Chris@42 81 <p>Before calling any other FFTW MPI (&lsquo;<samp>fftw_mpi_</samp>&rsquo;) function, and
Chris@42 82 before importing any wisdom for MPI problems, you must call:
Chris@42 83 </p>
Chris@42 84 <a name="index-fftw_005fmpi_005finit-4"></a>
Chris@42 85 <div class="example">
Chris@42 86 <pre class="example">void fftw_mpi_init(void);
Chris@42 87 </pre></div>
Chris@42 88
Chris@42 89 <a name="index-fftw_005finit_005fthreads-3"></a>
Chris@42 90 <p>If FFTW threads support is used, however, <code>fftw_mpi_init</code> should
Chris@42 91 be called <em>after</em> <code>fftw_init_threads</code> (see <a href="Combining-MPI-and-Threads.html#Combining-MPI-and-Threads">Combining MPI and Threads</a>). Calling <code>fftw_mpi_init</code> additional times (before
Chris@42 92 <code>fftw_mpi_cleanup</code>) has no effect.
Chris@42 93 </p>
Chris@42 94
Chris@42 95 <p>If you want to deallocate all persistent data and reset FFTW to the
Chris@42 96 pristine state it was in when you started your program, you can call:
Chris@42 97 </p>
Chris@42 98 <a name="index-fftw_005fmpi_005fcleanup-1"></a>
Chris@42 99 <div class="example">
Chris@42 100 <pre class="example">void fftw_mpi_cleanup(void);
Chris@42 101 </pre></div>
Chris@42 102
Chris@42 103 <a name="index-fftw_005fcleanup-1"></a>
Chris@42 104 <p>(This calls <code>fftw_cleanup</code>, so you need not call the serial
Chris@42 105 cleanup routine too, although it is safe to do so.) After calling
Chris@42 106 <code>fftw_mpi_cleanup</code>, all existing plans become undefined, and you
Chris@42 107 should not attempt to execute or destroy them. You must call
Chris@42 108 <code>fftw_mpi_init</code> again after <code>fftw_mpi_cleanup</code> if you want
Chris@42 109 to resume using the MPI FFTW routines.
Chris@42 110 </p>
Chris@42 111
Chris@42 112
Chris@42 113
Chris@42 114 </body>
Chris@42 115 </html>