Mercurial > hg > sv-dependency-builds

annotate src/fftw-3.3.8/doc/html/Defining-an-FFTW-module.html @ 167:bd3cc4d1df30

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add FFTW 3.3.8 source, and a Linux build
author Chris Cannam <cannam@all-day-breakfast.com>
date Tue, 19 Nov 2019 14:52:55 +0000
parents
children
rev   line source
cannam@167 1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
cannam@167 2 <html>
cannam@167 3 <!-- This manual is for FFTW
cannam@167 4 (version 3.3.8, 24 May 2018).
cannam@167 5
cannam@167 6 Copyright (C) 2003 Matteo Frigo.
cannam@167 7
cannam@167 8 Copyright (C) 2003 Massachusetts Institute of Technology.
cannam@167 9
cannam@167 10 Permission is granted to make and distribute verbatim copies of this
cannam@167 11 manual provided the copyright notice and this permission notice are
cannam@167 12 preserved on all copies.
cannam@167 13
cannam@167 14 Permission is granted to copy and distribute modified versions of this
cannam@167 15 manual under the conditions for verbatim copying, provided that the
cannam@167 16 entire resulting derived work is distributed under the terms of a
cannam@167 17 permission notice identical to this one.
cannam@167 18
cannam@167 19 Permission is granted to copy and distribute translations of this manual
cannam@167 20 into another language, under the above conditions for modified versions,
cannam@167 21 except that this permission notice may be stated in a translation
cannam@167 22 approved by the Free Software Foundation. -->
cannam@167 23 <!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
cannam@167 24 <head>
cannam@167 25 <title>FFTW 3.3.8: Defining an FFTW module</title>
cannam@167 26
cannam@167 27 <meta name="description" content="FFTW 3.3.8: Defining an FFTW module">
cannam@167 28 <meta name="keywords" content="FFTW 3.3.8: Defining an FFTW module">
cannam@167 29 <meta name="resource-type" content="document">
cannam@167 30 <meta name="distribution" content="global">
cannam@167 31 <meta name="Generator" content="makeinfo">
cannam@167 32 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
cannam@167 33 <link href="index.html#Top" rel="start" title="Top">
cannam@167 34 <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
cannam@167 35 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
cannam@167 36 <link href="Calling-FFTW-from-Modern-Fortran.html#Calling-FFTW-from-Modern-Fortran" rel="up" title="Calling FFTW from Modern Fortran">
cannam@167 37 <link href="Calling-FFTW-from-Legacy-Fortran.html#Calling-FFTW-from-Legacy-Fortran" rel="next" title="Calling FFTW from Legacy Fortran">
cannam@167 38 <link href="Wisdom-Generic-Export_002fImport-from-Fortran.html#Wisdom-Generic-Export_002fImport-from-Fortran" rel="prev" title="Wisdom Generic Export/Import from Fortran">
cannam@167 39 <style type="text/css">
cannam@167 40 <!--
cannam@167 41 a.summary-letter {text-decoration: none}
cannam@167 42 blockquote.indentedblock {margin-right: 0em}
cannam@167 43 blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
cannam@167 44 blockquote.smallquotation {font-size: smaller}
cannam@167 45 div.display {margin-left: 3.2em}
cannam@167 46 div.example {margin-left: 3.2em}
cannam@167 47 div.lisp {margin-left: 3.2em}
cannam@167 48 div.smalldisplay {margin-left: 3.2em}
cannam@167 49 div.smallexample {margin-left: 3.2em}
cannam@167 50 div.smalllisp {margin-left: 3.2em}
cannam@167 51 kbd {font-style: oblique}
cannam@167 52 pre.display {font-family: inherit}
cannam@167 53 pre.format {font-family: inherit}
cannam@167 54 pre.menu-comment {font-family: serif}
cannam@167 55 pre.menu-preformatted {font-family: serif}
cannam@167 56 pre.smalldisplay {font-family: inherit; font-size: smaller}
cannam@167 57 pre.smallexample {font-size: smaller}
cannam@167 58 pre.smallformat {font-family: inherit; font-size: smaller}
cannam@167 59 pre.smalllisp {font-size: smaller}
cannam@167 60 span.nolinebreak {white-space: nowrap}
cannam@167 61 span.roman {font-family: initial; font-weight: normal}
cannam@167 62 span.sansserif {font-family: sans-serif; font-weight: normal}
cannam@167 63 ul.no-bullet {list-style: none}
cannam@167 64 -->
cannam@167 65 </style>
cannam@167 66
cannam@167 67
cannam@167 68 </head>
cannam@167 69
cannam@167 70 <body lang="en">
cannam@167 71 <a name="Defining-an-FFTW-module"></a>
cannam@167 72 <div class="header">
cannam@167 73 <p>
cannam@167 74 Previous: <a href="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran" accesskey="p" rel="prev">Accessing the wisdom API from Fortran</a>, Up: <a href="Calling-FFTW-from-Modern-Fortran.html#Calling-FFTW-from-Modern-Fortran" accesskey="u" rel="up">Calling FFTW from Modern Fortran</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>
cannam@167 75 </div>
cannam@167 76 <hr>
cannam@167 77 <a name="Defining-an-FFTW-module-1"></a>
cannam@167 78 <h3 class="section">7.7 Defining an FFTW module</h3>
cannam@167 79
cannam@167 80 <p>Rather than using the <code>include</code> statement to include the
cannam@167 81 <code>fftw3.f03</code> interface file in any subroutine where you want to
cannam@167 82 use FFTW, you might prefer to define an FFTW Fortran module. FFTW
cannam@167 83 does not install itself as a module, primarily because
cannam@167 84 <code>fftw3.f03</code> can be shared between different Fortran compilers while
cannam@167 85 modules (in general) cannot. However, it is trivial to define your
cannam@167 86 own FFTW module if you want. Just create a file containing:
cannam@167 87 </p>
cannam@167 88 <div class="example">
cannam@167 89 <pre class="example"> module FFTW3
cannam@167 90 use, intrinsic :: iso_c_binding
cannam@167 91 include 'fftw3.f03'
cannam@167 92 end module
cannam@167 93 </pre></div>
cannam@167 94
cannam@167 95 <p>Compile this file into a module as usual for your compiler (e.g. with
cannam@167 96 <code>gfortran -c</code> you will get a file <code>fftw3.mod</code>). Now,
cannam@167 97 instead of <code>include 'fftw3.f03'</code>, whenever you want to use FFTW
cannam@167 98 routines you can just do:
cannam@167 99 </p>
cannam@167 100 <div class="example">
cannam@167 101 <pre class="example"> use FFTW3
cannam@167 102 </pre></div>
cannam@167 103
cannam@167 104 <p>as usual for Fortran modules. (You still need to link to the FFTW
cannam@167 105 library, of course.)
cannam@167 106 </p>
cannam@167 107
cannam@167 108
cannam@167 109 </body>
cannam@167 110 </html>