annotate src/fftw-3.3.3/doc/html/MPI-Initialization.html @ 95:89f5e221ed7b

Add FFTW3
author Chris Cannam <cannam@all-day-breakfast.com>
date Wed, 20 Mar 2013 15:35:50 +0000
parents
children
rev   line source
cannam@95 1 <html lang="en">
cannam@95 2 <head>
cannam@95 3 <title>MPI Initialization - FFTW 3.3.3</title>
cannam@95 4 <meta http-equiv="Content-Type" content="text/html">
cannam@95 5 <meta name="description" content="FFTW 3.3.3">
cannam@95 6 <meta name="generator" content="makeinfo 4.13">
cannam@95 7 <link title="Top" rel="start" href="index.html#Top">
cannam@95 8 <link rel="up" href="FFTW-MPI-Reference.html#FFTW-MPI-Reference" title="FFTW MPI Reference">
cannam@95 9 <link rel="prev" href="MPI-Files-and-Data-Types.html#MPI-Files-and-Data-Types" title="MPI Files and Data Types">
cannam@95 10 <link rel="next" href="Using-MPI-Plans.html#Using-MPI-Plans" title="Using MPI Plans">
cannam@95 11 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
cannam@95 12 <!--
cannam@95 13 This manual is for FFTW
cannam@95 14 (version 3.3.3, 25 November 2012).
cannam@95 15
cannam@95 16 Copyright (C) 2003 Matteo Frigo.
cannam@95 17
cannam@95 18 Copyright (C) 2003 Massachusetts Institute of Technology.
cannam@95 19
cannam@95 20 Permission is granted to make and distribute verbatim copies of
cannam@95 21 this manual provided the copyright notice and this permission
cannam@95 22 notice are preserved on all copies.
cannam@95 23
cannam@95 24 Permission is granted to copy and distribute modified versions of
cannam@95 25 this manual under the conditions for verbatim copying, provided
cannam@95 26 that the entire resulting derived work is distributed under the
cannam@95 27 terms of a permission notice identical to this one.
cannam@95 28
cannam@95 29 Permission is granted to copy and distribute translations of this
cannam@95 30 manual into another language, under the above conditions for
cannam@95 31 modified versions, except that this permission notice may be
cannam@95 32 stated in a translation approved by the Free Software Foundation.
cannam@95 33 -->
cannam@95 34 <meta http-equiv="Content-Style-Type" content="text/css">
cannam@95 35 <style type="text/css"><!--
cannam@95 36 pre.display { font-family:inherit }
cannam@95 37 pre.format { font-family:inherit }
cannam@95 38 pre.smalldisplay { font-family:inherit; font-size:smaller }
cannam@95 39 pre.smallformat { font-family:inherit; font-size:smaller }
cannam@95 40 pre.smallexample { font-size:smaller }
cannam@95 41 pre.smalllisp { font-size:smaller }
cannam@95 42 span.sc { font-variant:small-caps }
cannam@95 43 span.roman { font-family:serif; font-weight:normal; }
cannam@95 44 span.sansserif { font-family:sans-serif; font-weight:normal; }
cannam@95 45 --></style>
cannam@95 46 </head>
cannam@95 47 <body>
cannam@95 48 <div class="node">
cannam@95 49 <a name="MPI-Initialization"></a>
cannam@95 50 <p>
cannam@95 51 Next:&nbsp;<a rel="next" accesskey="n" href="Using-MPI-Plans.html#Using-MPI-Plans">Using MPI Plans</a>,
cannam@95 52 Previous:&nbsp;<a rel="previous" accesskey="p" href="MPI-Files-and-Data-Types.html#MPI-Files-and-Data-Types">MPI Files and Data Types</a>,
cannam@95 53 Up:&nbsp;<a rel="up" accesskey="u" href="FFTW-MPI-Reference.html#FFTW-MPI-Reference">FFTW MPI Reference</a>
cannam@95 54 <hr>
cannam@95 55 </div>
cannam@95 56
cannam@95 57 <h4 class="subsection">6.12.2 MPI Initialization</h4>
cannam@95 58
cannam@95 59 <p>Before calling any other FFTW MPI (&lsquo;<samp><span class="samp">fftw_mpi_</span></samp>&rsquo;) function, and
cannam@95 60 before importing any wisdom for MPI problems, you must call:
cannam@95 61
cannam@95 62 <p><a name="index-fftw_005fmpi_005finit-434"></a>
cannam@95 63 <pre class="example"> void fftw_mpi_init(void);
cannam@95 64 </pre>
cannam@95 65 <p><a name="index-fftw_005finit_005fthreads-435"></a>If FFTW threads support is used, however, <code>fftw_mpi_init</code> should
cannam@95 66 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
cannam@95 67 <code>fftw_mpi_cleanup</code>) has no effect.
cannam@95 68
cannam@95 69 <p>If you want to deallocate all persistent data and reset FFTW to the
cannam@95 70 pristine state it was in when you started your program, you can call:
cannam@95 71
cannam@95 72 <p><a name="index-fftw_005fmpi_005fcleanup-436"></a>
cannam@95 73 <pre class="example"> void fftw_mpi_cleanup(void);
cannam@95 74 </pre>
cannam@95 75 <p><a name="index-fftw_005fcleanup-437"></a>(This calls <code>fftw_cleanup</code>, so you need not call the serial
cannam@95 76 cleanup routine too, although it is safe to do so.) After calling
cannam@95 77 <code>fftw_mpi_cleanup</code>, all existing plans become undefined, and you
cannam@95 78 should not attempt to execute or destroy them. You must call
cannam@95 79 <code>fftw_mpi_init</code> again after <code>fftw_mpi_cleanup</code> if you want
cannam@95 80 to resume using the MPI FFTW routines.
cannam@95 81
cannam@95 82 </body></html>
cannam@95 83