annotate src/fftw-3.3.3/doc/html/MPI-Initialization.html @ 83:ae30d91d2ffe

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