cannam@127: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
cannam@127: <html>
cannam@127: <!-- This manual is for FFTW
cannam@127: (version 3.3.5, 30 July 2016).
cannam@127:
cannam@127: Copyright (C) 2003 Matteo Frigo.
cannam@127:
cannam@127: Copyright (C) 2003 Massachusetts Institute of Technology.
cannam@127:
cannam@127: Permission is granted to make and distribute verbatim copies of this
cannam@127: manual provided the copyright notice and this permission notice are
cannam@127: preserved on all copies.
cannam@127:
cannam@127: Permission is granted to copy and distribute modified versions of this
cannam@127: manual under the conditions for verbatim copying, provided that the
cannam@127: entire resulting derived work is distributed under the terms of a
cannam@127: permission notice identical to this one.
cannam@127:
cannam@127: Permission is granted to copy and distribute translations of this manual
cannam@127: into another language, under the above conditions for modified versions,
cannam@127: except that this permission notice may be stated in a translation
cannam@127: approved by the Free Software Foundation. -->
cannam@127: <!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
cannam@127: <head>
cannam@127: <title>FFTW 3.3.5: Wisdom Generic Export/Import from Fortran</title>
cannam@127:
cannam@127: <meta name="description" content="FFTW 3.3.5: Wisdom Generic Export/Import from Fortran">
cannam@127: <meta name="keywords" content="FFTW 3.3.5: Wisdom Generic Export/Import from Fortran">
cannam@127: <meta name="resource-type" content="document">
cannam@127: <meta name="distribution" content="global">
cannam@127: <meta name="Generator" content="makeinfo">
cannam@127: <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
cannam@127: <link href="index.html#Top" rel="start" title="Top">
cannam@127: <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
cannam@127: <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
cannam@127: <link href="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran" rel="up" title="Accessing the wisdom API from Fortran">
cannam@127: <link href="Defining-an-FFTW-module.html#Defining-an-FFTW-module" rel="next" title="Defining an FFTW module">
cannam@127: <link href="Wisdom-String-Export_002fImport-from-Fortran.html#Wisdom-String-Export_002fImport-from-Fortran" rel="prev" title="Wisdom String Export/Import from Fortran">
cannam@127: <style type="text/css">
cannam@127: <!--
cannam@127: a.summary-letter {text-decoration: none}
cannam@127: blockquote.smallquotation {font-size: smaller}
cannam@127: div.display {margin-left: 3.2em}
cannam@127: div.example {margin-left: 3.2em}
cannam@127: div.indentedblock {margin-left: 3.2em}
cannam@127: div.lisp {margin-left: 3.2em}
cannam@127: div.smalldisplay {margin-left: 3.2em}
cannam@127: div.smallexample {margin-left: 3.2em}
cannam@127: div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
cannam@127: div.smalllisp {margin-left: 3.2em}
cannam@127: kbd {font-style:oblique}
cannam@127: pre.display {font-family: inherit}
cannam@127: pre.format {font-family: inherit}
cannam@127: pre.menu-comment {font-family: serif}
cannam@127: pre.menu-preformatted {font-family: serif}
cannam@127: pre.smalldisplay {font-family: inherit; font-size: smaller}
cannam@127: pre.smallexample {font-size: smaller}
cannam@127: pre.smallformat {font-family: inherit; font-size: smaller}
cannam@127: pre.smalllisp {font-size: smaller}
cannam@127: span.nocodebreak {white-space:nowrap}
cannam@127: span.nolinebreak {white-space:nowrap}
cannam@127: span.roman {font-family:serif; font-weight:normal}
cannam@127: span.sansserif {font-family:sans-serif; font-weight:normal}
cannam@127: ul.no-bullet {list-style: none}
cannam@127: -->
cannam@127: </style>
cannam@127:
cannam@127:
cannam@127: </head>
cannam@127:
cannam@127: <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
cannam@127: <a name="Wisdom-Generic-Export_002fImport-from-Fortran"></a>
cannam@127: <div class="header">
cannam@127: <p>
cannam@127: Previous: <a href="Wisdom-String-Export_002fImport-from-Fortran.html#Wisdom-String-Export_002fImport-from-Fortran" accesskey="p" rel="prev">Wisdom String Export/Import from Fortran</a>, Up: <a href="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran" accesskey="u" rel="up">Accessing the wisdom API from 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>
cannam@127: </div>
cannam@127: <hr>
cannam@127: <a name="Wisdom-Generic-Export_002fImport-from-Fortran-1"></a>
cannam@127: <h4 class="subsection">7.6.3 Wisdom Generic Export/Import from Fortran</h4>
cannam@127:
cannam@127: <p>The most generic wisdom export/import functions allow you to provide
cannam@127: an arbitrary callback function to read/write one character at a time
cannam@127: in any way you want. However, your callback function must be written
cannam@127: in a special way, using the <code>bind(C)</code> attribute to be passed to a
cannam@127: C interface.
cannam@127: </p>
cannam@127: <a name="index-fftw_005fexport_005fwisdom-1"></a>
cannam@127: <p>In particular, to call the generic wisdom export function
cannam@127: <code>fftw_export_wisdom</code>, you would write a callback subroutine of the form:
cannam@127: </p>
cannam@127: <div class="example">
cannam@127: <pre class="example"> subroutine my_write_char(c, p) bind(C)
cannam@127: use, intrinsic :: iso_c_binding
cannam@127: character(C_CHAR), value :: c
cannam@127: type(C_PTR), value :: p
cannam@127: <em>...write c...</em>
cannam@127: end subroutine my_write_char
cannam@127: </pre></div>
cannam@127:
cannam@127: <p>Given such a subroutine (along with the corresponding interface definition), you could then export wisdom using:
cannam@127: </p>
cannam@127: <a name="index-c_005ffunloc"></a>
cannam@127: <div class="example">
cannam@127: <pre class="example"> call fftw_export_wisdom(c_funloc(my_write_char), p)
cannam@127: </pre></div>
cannam@127:
cannam@127: <a name="index-c_005floc"></a>
cannam@127: <a name="index-c_005ff_005fpointer-4"></a>
cannam@127: <p>The standard <code>c_funloc</code> intrinsic converts a Fortran
cannam@127: <code>bind(C)</code> subroutine into a C function pointer. The parameter
cannam@127: <code>p</code> is a <code>type(C_PTR)</code> to any arbitrary data that you want
cannam@127: to pass to <code>my_write_char</code> (or <code>C_NULL_PTR</code> if none). (Note
cannam@127: that you can get a C pointer to Fortran data using the intrinsic
cannam@127: <code>c_loc</code>, and convert it back to a Fortran pointer in
cannam@127: <code>my_write_char</code> using <code>c_f_pointer</code>.)
cannam@127: </p>
cannam@127: <p>Similarly, to use the generic <code>fftw_import_wisdom</code>, you would
cannam@127: define a callback function of the form:
cannam@127: </p>
cannam@127: <a name="index-fftw_005fimport_005fwisdom-1"></a>
cannam@127: <div class="example">
cannam@127: <pre class="example"> integer(C_INT) function my_read_char(p) bind(C)
cannam@127: use, intrinsic :: iso_c_binding
cannam@127: type(C_PTR), value :: p
cannam@127: character :: c
cannam@127: <em>...read a character c...</em>
cannam@127: my_read_char = ichar(c, C_INT)
cannam@127: end function my_read_char
cannam@127:
cannam@127: ....
cannam@127:
cannam@127: integer(C_INT) :: ret
cannam@127: ret = fftw_import_wisdom(c_funloc(my_read_char), p)
cannam@127: if (ret .eq. 0) stop 'error importing wisdom'
cannam@127: </pre></div>
cannam@127:
cannam@127: <p>Your function can return <code>-1</code> if the end of the input is reached.
cannam@127: Again, <code>p</code> is an arbitrary <code>type(C_PTR</code> that is passed
cannam@127: through to your function. <code>fftw_import_wisdom</code> returns <code>0</code>
cannam@127: if an error occurred and nonzero otherwise.
cannam@127: </p>
cannam@127: <hr>
cannam@127: <div class="header">
cannam@127: <p>
cannam@127: Previous: <a href="Wisdom-String-Export_002fImport-from-Fortran.html#Wisdom-String-Export_002fImport-from-Fortran" accesskey="p" rel="prev">Wisdom String Export/Import from Fortran</a>, Up: <a href="Accessing-the-wisdom-API-from-Fortran.html#Accessing-the-wisdom-API-from-Fortran" accesskey="u" rel="up">Accessing the wisdom API from 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>
cannam@127: </div>
cannam@127:
cannam@127:
cannam@127:
cannam@127: </body>
cannam@127: </html>