Chris@82: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
Chris@82: <html>
Chris@82: <!-- This manual is for FFTW
Chris@82: (version 3.3.8, 24 May 2018).
Chris@82:
Chris@82: Copyright (C) 2003 Matteo Frigo.
Chris@82:
Chris@82: Copyright (C) 2003 Massachusetts Institute of Technology.
Chris@82:
Chris@82: Permission is granted to make and distribute verbatim copies of this
Chris@82: manual provided the copyright notice and this permission notice are
Chris@82: preserved on all copies.
Chris@82:
Chris@82: Permission is granted to copy and distribute modified versions of this
Chris@82: manual under the conditions for verbatim copying, provided that the
Chris@82: entire resulting derived work is distributed under the terms of a
Chris@82: permission notice identical to this one.
Chris@82:
Chris@82: Permission is granted to copy and distribute translations of this manual
Chris@82: into another language, under the above conditions for modified versions,
Chris@82: except that this permission notice may be stated in a translation
Chris@82: approved by the Free Software Foundation. -->
Chris@82: <!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
Chris@82: <head>
Chris@82: <title>FFTW 3.3.8: Allocating aligned memory in Fortran</title>
Chris@82:
Chris@82: <meta name="description" content="FFTW 3.3.8: Allocating aligned memory in Fortran">
Chris@82: <meta name="keywords" content="FFTW 3.3.8: Allocating aligned memory in Fortran">
Chris@82: <meta name="resource-type" content="document">
Chris@82: <meta name="distribution" content="global">
Chris@82: <meta name="Generator" content="makeinfo">
Chris@82: <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Chris@82: <link href="index.html#Top" rel="start" title="Top">
Chris@82: <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
Chris@82: <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
Chris@82: <link href="Calling-FFTW-from-Modern-Fortran.html#Calling-FFTW-from-Modern-Fortran" rel="up" title="Calling FFTW from Modern Fortran">
Chris@82: <link href="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran" rel="next" title="Accessing the wisdom API from Fortran">
Chris@82: <link href="Plan-execution-in-Fortran.html#Plan-execution-in-Fortran" rel="prev" title="Plan execution in Fortran">
Chris@82: <style type="text/css">
Chris@82: <!--
Chris@82: a.summary-letter {text-decoration: none}
Chris@82: blockquote.indentedblock {margin-right: 0em}
Chris@82: blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
Chris@82: blockquote.smallquotation {font-size: smaller}
Chris@82: div.display {margin-left: 3.2em}
Chris@82: div.example {margin-left: 3.2em}
Chris@82: div.lisp {margin-left: 3.2em}
Chris@82: div.smalldisplay {margin-left: 3.2em}
Chris@82: div.smallexample {margin-left: 3.2em}
Chris@82: div.smalllisp {margin-left: 3.2em}
Chris@82: kbd {font-style: oblique}
Chris@82: pre.display {font-family: inherit}
Chris@82: pre.format {font-family: inherit}
Chris@82: pre.menu-comment {font-family: serif}
Chris@82: pre.menu-preformatted {font-family: serif}
Chris@82: pre.smalldisplay {font-family: inherit; font-size: smaller}
Chris@82: pre.smallexample {font-size: smaller}
Chris@82: pre.smallformat {font-family: inherit; font-size: smaller}
Chris@82: pre.smalllisp {font-size: smaller}
Chris@82: span.nolinebreak {white-space: nowrap}
Chris@82: span.roman {font-family: initial; font-weight: normal}
Chris@82: span.sansserif {font-family: sans-serif; font-weight: normal}
Chris@82: ul.no-bullet {list-style: none}
Chris@82: -->
Chris@82: </style>
Chris@82:
Chris@82:
Chris@82: </head>
Chris@82:
Chris@82: <body lang="en">
Chris@82: <a name="Allocating-aligned-memory-in-Fortran"></a>
Chris@82: <div class="header">
Chris@82: <p>
Chris@82: Next: <a href="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran" accesskey="n" rel="next">Accessing the wisdom API from Fortran</a>, Previous: <a href="Plan-execution-in-Fortran.html#Plan-execution-in-Fortran" accesskey="p" rel="prev">Plan execution in 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> [<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>
Chris@82: </div>
Chris@82: <hr>
Chris@82: <a name="Allocating-aligned-memory-in-Fortran-1"></a>
Chris@82: <h3 class="section">7.5 Allocating aligned memory in Fortran</h3>
Chris@82:
Chris@82: <a name="index-alignment-5"></a>
Chris@82: <a name="index-fftw_005falloc_005freal-5"></a>
Chris@82: <a name="index-fftw_005falloc_005fcomplex-5"></a>
Chris@82: <p>In order to obtain maximum performance in FFTW, you should store your
Chris@82: data in arrays that have been specially aligned in memory (see <a href="SIMD-alignment-and-fftw_005fmalloc.html#SIMD-alignment-and-fftw_005fmalloc">SIMD alignment and fftw_malloc</a>). Enforcing alignment also permits you to
Chris@82: safely use the new-array execute functions (see <a href="New_002darray-Execute-Functions.html#New_002darray-Execute-Functions">New-array Execute Functions</a>) to apply a given plan to more than one pair of in/out
Chris@82: arrays. Unfortunately, standard Fortran arrays do <em>not</em> provide
Chris@82: any alignment guarantees. The <em>only</em> way to allocate aligned
Chris@82: memory in standard Fortran is to allocate it with an external C
Chris@82: function, like the <code>fftw_alloc_real</code> and
Chris@82: <code>fftw_alloc_complex</code> functions. Fortunately, Fortran 2003 provides
Chris@82: a simple way to associate such allocated memory with a standard Fortran
Chris@82: array pointer that you can then use normally.
Chris@82: </p>
Chris@82: <p>We therefore recommend allocating all your input/output arrays using
Chris@82: the following technique:
Chris@82: </p>
Chris@82: <ol>
Chris@82: <li> Declare a <code>pointer</code>, <code>arr</code>, to your array of the desired type
Chris@82: and dimensions. For example, <code>real(C_DOUBLE), pointer :: a(:,:)</code>
Chris@82: for a 2d real array, or <code>complex(C_DOUBLE_COMPLEX), pointer ::
Chris@82: a(:,:,:)</code> for a 3d complex array.
Chris@82:
Chris@82: </li><li> The number of elements to allocate must be an
Chris@82: <code>integer(C_SIZE_T)</code>. You can either declare a variable of this
Chris@82: type, e.g. <code>integer(C_SIZE_T) :: sz</code>, to store the number of
Chris@82: elements to allocate, or you can use the <code>int(..., C_SIZE_T)</code>
Chris@82: intrinsic function. e.g. set <code>sz = L * M * N</code> or use
Chris@82: <code>int(L * M * N, C_SIZE_T)</code> for an L × M × N
Chris@82: array.
Chris@82:
Chris@82: </li><li> Declare a <code>type(C_PTR) :: p</code> to hold the return value from
Chris@82: FFTW’s allocation routine. Set <code>p = fftw_alloc_real(sz)</code> for a real array, or <code>p = fftw_alloc_complex(sz)</code> for a complex array.
Chris@82:
Chris@82: </li><li> <a name="index-c_005ff_005fpointer-2"></a>
Chris@82: Associate your pointer <code>arr</code> with the allocated memory <code>p</code>
Chris@82: using the standard <code>c_f_pointer</code> subroutine: <code>call
Chris@82: c_f_pointer(p, arr, [...dimensions...])</code>, where
Chris@82: <code>[...dimensions...])</code> are an array of the dimensions of the array
Chris@82: (in the usual Fortran order). e.g. <code>call c_f_pointer(p, arr,
Chris@82: [L,M,N])</code> for an L × M × N
Chris@82: array. (Alternatively, you can
Chris@82: omit the dimensions argument if you specified the shape explicitly
Chris@82: when declaring <code>arr</code>.) You can now use <code>arr</code> as a usual
Chris@82: multidimensional array.
Chris@82:
Chris@82: </li><li> When you are done using the array, deallocate the memory by <code>call
Chris@82: fftw_free(p)</code> on <code>p</code>.
Chris@82:
Chris@82: </li></ol>
Chris@82:
Chris@82: <p>For example, here is how we would allocate an L × M
Chris@82: 2d real array:
Chris@82: </p>
Chris@82: <div class="example">
Chris@82: <pre class="example"> real(C_DOUBLE), pointer :: arr(:,:)
Chris@82: type(C_PTR) :: p
Chris@82: p = fftw_alloc_real(int(L * M, C_SIZE_T))
Chris@82: call c_f_pointer(p, arr, [L,M])
Chris@82: <em>...use arr and arr(i,j) as usual...</em>
Chris@82: call fftw_free(p)
Chris@82: </pre></div>
Chris@82:
Chris@82: <p>and here is an L × M × N
Chris@82: 3d complex array:
Chris@82: </p>
Chris@82: <div class="example">
Chris@82: <pre class="example"> complex(C_DOUBLE_COMPLEX), pointer :: arr(:,:,:)
Chris@82: type(C_PTR) :: p
Chris@82: p = fftw_alloc_complex(int(L * M * N, C_SIZE_T))
Chris@82: call c_f_pointer(p, arr, [L,M,N])
Chris@82: <em>...use arr and arr(i,j,k) as usual...</em>
Chris@82: call fftw_free(p)
Chris@82: </pre></div>
Chris@82:
Chris@82: <p>See <a href="Reversing-array-dimensions.html#Reversing-array-dimensions">Reversing array dimensions</a> for an example allocating a
Chris@82: single array and associating both real and complex array pointers with
Chris@82: it, for in-place real-to-complex transforms.
Chris@82: </p>
Chris@82: <hr>
Chris@82: <div class="header">
Chris@82: <p>
Chris@82: Next: <a href="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran" accesskey="n" rel="next">Accessing the wisdom API from Fortran</a>, Previous: <a href="Plan-execution-in-Fortran.html#Plan-execution-in-Fortran" accesskey="p" rel="prev">Plan execution in 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> [<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>
Chris@82: </div>
Chris@82:
Chris@82:
Chris@82:
Chris@82: </body>
Chris@82: </html>