annotate src/fftw-3.3.3/doc/html/Defining-an-FFTW-module.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>Defining an FFTW module - 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="Calling-FFTW-from-Modern-Fortran.html#Calling-FFTW-from-Modern-Fortran" title="Calling FFTW from Modern Fortran">
cannam@95 9 <link rel="prev" href="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran" title="Accessing the wisdom API from Fortran">
cannam@95 10 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
cannam@95 11 <!--
cannam@95 12 This manual is for FFTW
cannam@95 13 (version 3.3.3, 25 November 2012).
cannam@95 14
cannam@95 15 Copyright (C) 2003 Matteo Frigo.
cannam@95 16
cannam@95 17 Copyright (C) 2003 Massachusetts Institute of Technology.
cannam@95 18
cannam@95 19 Permission is granted to make and distribute verbatim copies of
cannam@95 20 this manual provided the copyright notice and this permission
cannam@95 21 notice are preserved on all copies.
cannam@95 22
cannam@95 23 Permission is granted to copy and distribute modified versions of
cannam@95 24 this manual under the conditions for verbatim copying, provided
cannam@95 25 that the entire resulting derived work is distributed under the
cannam@95 26 terms of a permission notice identical to this one.
cannam@95 27
cannam@95 28 Permission is granted to copy and distribute translations of this
cannam@95 29 manual into another language, under the above conditions for
cannam@95 30 modified versions, except that this permission notice may be
cannam@95 31 stated in a translation approved by the Free Software Foundation.
cannam@95 32 -->
cannam@95 33 <meta http-equiv="Content-Style-Type" content="text/css">
cannam@95 34 <style type="text/css"><!--
cannam@95 35 pre.display { font-family:inherit }
cannam@95 36 pre.format { font-family:inherit }
cannam@95 37 pre.smalldisplay { font-family:inherit; font-size:smaller }
cannam@95 38 pre.smallformat { font-family:inherit; font-size:smaller }
cannam@95 39 pre.smallexample { font-size:smaller }
cannam@95 40 pre.smalllisp { font-size:smaller }
cannam@95 41 span.sc { font-variant:small-caps }
cannam@95 42 span.roman { font-family:serif; font-weight:normal; }
cannam@95 43 span.sansserif { font-family:sans-serif; font-weight:normal; }
cannam@95 44 --></style>
cannam@95 45 </head>
cannam@95 46 <body>
cannam@95 47 <div class="node">
cannam@95 48 <a name="Defining-an-FFTW-module"></a>
cannam@95 49 <p>
cannam@95 50 Previous:&nbsp;<a rel="previous" accesskey="p" href="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran">Accessing the wisdom API from Fortran</a>,
cannam@95 51 Up:&nbsp;<a rel="up" accesskey="u" href="Calling-FFTW-from-Modern-Fortran.html#Calling-FFTW-from-Modern-Fortran">Calling FFTW from Modern Fortran</a>
cannam@95 52 <hr>
cannam@95 53 </div>
cannam@95 54
cannam@95 55 <h3 class="section">7.7 Defining an FFTW module</h3>
cannam@95 56
cannam@95 57 <p>Rather than using the <code>include</code> statement to include the
cannam@95 58 <code>fftw3.f03</code> interface file in any subroutine where you want to
cannam@95 59 use FFTW, you might prefer to define an FFTW Fortran module. FFTW
cannam@95 60 does not install itself as a module, primarily because
cannam@95 61 <code>fftw3.f03</code> can be shared between different Fortran compilers while
cannam@95 62 modules (in general) cannot. However, it is trivial to define your
cannam@95 63 own FFTW module if you want. Just create a file containing:
cannam@95 64
cannam@95 65 <pre class="example"> module FFTW3
cannam@95 66 use, intrinsic :: iso_c_binding
cannam@95 67 include 'fftw3.f03'
cannam@95 68 end module
cannam@95 69 </pre>
cannam@95 70 <p>Compile this file into a module as usual for your compiler (e.g. with
cannam@95 71 <code>gfortran -c</code> you will get a file <code>fftw3.mod</code>). Now,
cannam@95 72 instead of <code>include 'fftw3.f03'</code>, whenever you want to use FFTW
cannam@95 73 routines you can just do:
cannam@95 74
cannam@95 75 <pre class="example"> use FFTW3
cannam@95 76 </pre>
cannam@95 77 <p>as usual for Fortran modules. (You still need to link to the FFTW
cannam@95 78 library, of course.)
cannam@95 79
cannam@95 80 </body></html>
cannam@95 81