furnace/extern/fftw/doc/html/MPI-Initialization.html
2022-05-31 03:24:29 -05:00

103 lines
4.4 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for FFTW
(version 3.3.10, 10 December 2020).
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. -->
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>MPI Initialization (FFTW 3.3.10)</title>
<meta name="description" content="MPI Initialization (FFTW 3.3.10)">
<meta name="keywords" content="MPI Initialization (FFTW 3.3.10)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="FFTW-MPI-Reference.html" rel="up" title="FFTW MPI Reference">
<link href="Using-MPI-Plans.html" rel="next" title="Using MPI Plans">
<link href="MPI-Files-and-Data-Types.html" rel="prev" title="MPI Files and Data Types">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en">
<span id="MPI-Initialization"></span><div class="header">
<p>
Next: <a href="Using-MPI-Plans.html" accesskey="n" rel="next">Using MPI Plans</a>, Previous: <a href="MPI-Files-and-Data-Types.html" accesskey="p" rel="prev">MPI Files and Data Types</a>, Up: <a href="FFTW-MPI-Reference.html" 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" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<span id="MPI-Initialization-1"></span><h4 class="subsection">6.12.2 MPI Initialization</h4>
<p>Before calling any other FFTW MPI (&lsquo;<samp>fftw_mpi_</samp>&rsquo;) function, and
before importing any wisdom for MPI problems, you must call:
</p>
<span id="index-fftw_005fmpi_005finit-4"></span>
<div class="example">
<pre class="example">void fftw_mpi_init(void);
</pre></div>
<span id="index-fftw_005finit_005fthreads-3"></span>
<p>If FFTW threads support is used, however, <code>fftw_mpi_init</code> should
be called <em>after</em> <code>fftw_init_threads</code> (see <a href="Combining-MPI-and-Threads.html">Combining MPI and Threads</a>). Calling <code>fftw_mpi_init</code> additional times (before
<code>fftw_mpi_cleanup</code>) has no effect.
</p>
<p>If you want to deallocate all persistent data and reset FFTW to the
pristine state it was in when you started your program, you can call:
</p>
<span id="index-fftw_005fmpi_005fcleanup-1"></span>
<div class="example">
<pre class="example">void fftw_mpi_cleanup(void);
</pre></div>
<span id="index-fftw_005fcleanup-1"></span>
<p>(This calls <code>fftw_cleanup</code>, so you need not call the serial
cleanup routine too, although it is safe to do so.) After calling
<code>fftw_mpi_cleanup</code>, all existing plans become undefined, and you
should not attempt to execute or destroy them. You must call
<code>fftw_mpi_init</code> again after <code>fftw_mpi_cleanup</code> if you want
to resume using the MPI FFTW routines.
</p>
</body>
</html>