annotate src/fftw-3.3.3/doc/html/Defining-an-FFTW-module.html @ 10:37bf6b4a2645

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