diff src/fftw-3.3.3/doc/html/Linking-and-Initializing-MPI-FFTW.html @ 95:89f5e221ed7b

Add FFTW3
author Chris Cannam <cannam@all-day-breakfast.com>
date Wed, 20 Mar 2013 15:35:50 +0000
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/fftw-3.3.3/doc/html/Linking-and-Initializing-MPI-FFTW.html	Wed Mar 20 15:35:50 2013 +0000
@@ -0,0 +1,88 @@
+<html lang="en">
+<head>
+<title>Linking and Initializing MPI FFTW - FFTW 3.3.3</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="FFTW 3.3.3">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="start" href="index.html#Top">
+<link rel="up" href="Distributed_002dmemory-FFTW-with-MPI.html#Distributed_002dmemory-FFTW-with-MPI" title="Distributed-memory FFTW with MPI">
+<link rel="prev" href="FFTW-MPI-Installation.html#FFTW-MPI-Installation" title="FFTW MPI Installation">
+<link rel="next" href="2d-MPI-example.html#g_t2d-MPI-example" title="2d MPI example">
+<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
+<!--
+This manual is for FFTW
+(version 3.3.3, 25 November 2012).
+
+Copyright (C) 2003 Matteo Frigo.
+
+Copyright (C) 2003 Massachusetts Institute of Technology.
+
+     Permission is granted to make and distribute verbatim copies of
+     this manual provided the copyright notice and this permission
+     notice are preserved on all copies.
+
+     Permission is granted to copy and distribute modified versions of
+     this manual under the conditions for verbatim copying, provided
+     that the entire resulting derived work is distributed under the
+     terms of a permission notice identical to this one.
+
+     Permission is granted to copy and distribute translations of this
+     manual into another language, under the above conditions for
+     modified versions, except that this permission notice may be
+     stated in a translation approved by the Free Software Foundation.
+   -->
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+  pre.display { font-family:inherit }
+  pre.format  { font-family:inherit }
+  pre.smalldisplay { font-family:inherit; font-size:smaller }
+  pre.smallformat  { font-family:inherit; font-size:smaller }
+  pre.smallexample { font-size:smaller }
+  pre.smalllisp    { font-size:smaller }
+  span.sc    { font-variant:small-caps }
+  span.roman { font-family:serif; font-weight:normal; } 
+  span.sansserif { font-family:sans-serif; font-weight:normal; } 
+--></style>
+</head>
+<body>
+<div class="node">
+<a name="Linking-and-Initializing-MPI-FFTW"></a>
+<p>
+Next:&nbsp;<a rel="next" accesskey="n" href="2d-MPI-example.html#g_t2d-MPI-example">2d MPI example</a>,
+Previous:&nbsp;<a rel="previous" accesskey="p" href="FFTW-MPI-Installation.html#FFTW-MPI-Installation">FFTW MPI Installation</a>,
+Up:&nbsp;<a rel="up" accesskey="u" href="Distributed_002dmemory-FFTW-with-MPI.html#Distributed_002dmemory-FFTW-with-MPI">Distributed-memory FFTW with MPI</a>
+<hr>
+</div>
+
+<h3 class="section">6.2 Linking and Initializing MPI FFTW</h3>
+
+<p>Programs using the MPI FFTW routines should be linked with
+<code>-lfftw3_mpi -lfftw3 -lm</code> on Unix in double precision,
+<code>-lfftw3f_mpi -lfftw3f -lm</code> in single precision, and so on
+(see <a href="Precision.html#Precision">Precision</a>). You will also need to link with whatever library
+is responsible for MPI on your system; in most MPI implementations,
+there is a special compiler alias named <code>mpicc</code> to compile and
+link MPI code. 
+<a name="index-mpicc-351"></a><a name="index-linking-on-Unix-352"></a><a name="index-precision-353"></a>
+
+   <p><a name="index-fftw_005finit_005fthreads-354"></a>Before calling any FFTW routines except possibly
+<code>fftw_init_threads</code> (see <a href="Combining-MPI-and-Threads.html#Combining-MPI-and-Threads">Combining MPI and Threads</a>), but after calling
+<code>MPI_Init</code>, you should call the function:
+
+<pre class="example">     void fftw_mpi_init(void);
+</pre>
+   <p><a name="index-fftw_005fmpi_005finit-355"></a>
+If, at the end of your program, you want to get rid of all memory and
+other resources allocated internally by FFTW, for both the serial and
+MPI routines, you can call:
+
+<pre class="example">     void fftw_mpi_cleanup(void);
+</pre>
+   <p><a name="index-fftw_005fmpi_005fcleanup-356"></a>
+which is much like the <code>fftw_cleanup()</code> function except that it
+also gets rid of FFTW's MPI-related data.  You must <em>not</em> execute
+any previously created plans after calling this function.
+
+<!--  -->
+   </body></html>
+