Mercurial > hg > sv-dependency-builds

annotate src/fftw-3.3.5/doc/html/Defining-an-FFTW-module.html @ 127:7867fa7e1b6b

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