Files
hdf5/fortran/doc/DevelGuide/src/H5FDmpioff_f90.html
Scot Breitenfeld a9c065c5ce [svn-r21248] Mereged the F2003 branch into the trunk.
Items merged: fortran directory, 
              src/libhdf5.settings.in 
              configure.in configure 
              MANIFEST

Tested: (all platforms used by daily tests, both with --enable-fortran and --enable-fortran2003)
2011-08-18 09:32:47 -05:00

254 lines
14 KiB
HTML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="Content-type" content="text/html; charset=ISO-8859-1" />
<link rel="stylesheet" href="../robodoc.css" type="text/css" />
<title>./src/H5FDmpioff.f90</title>
<!-- Source: ./src/H5FDmpioff.f90 -->
</head>
<body>
<div id="logo">
<a name="robo_top_of_doc">HDF5 FORTRAN Developer's Guide</a>
</div> <!-- logo -->
<div id="navigation">
<a class="menuitem" href="../toc_index.html#top">Table of Contents</a>
<a class="menuitem" href="../robo_sourcefiles.html#top">Sourcefiles</a>
<a class="menuitem" href="../masterindex.html#top">Index</a>
<a class="menuitem" href="../robo_functions.html#top">Functions</a>
<a class="menuitem" href="../robo_modules.html#top">Modules</a>
<a class="menuitem" href="../robo_procedures.html#top">Procedures</a>
<a class="menuitem" href="../robo_subroutines.html#top">Subroutines</a>
</div> <!-- navigation -->
<div id="content">
<hr />
<a name="ROBODoc2fH5FDMPIO"></a>
<a name="robo41"></a><h2>H5FDMPIO</h2>
<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="../robo_modules.html#robo_top_of_doc">Modules</a> ]</p>
<p class="item_name">NAME</p>
<pre> MODULE <strong>H5FDMPIO</strong>
</pre>
<p class="item_name">PURPOSE</p>
<pre> This file contains Fortran interfaces for H5P functions needed by
parallel MPI programs.
</pre>
<p class="item_name">NOTES</p>
<pre> *** IMPORTANT ***
If you add a new H5P function you must add the function name to the
Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
This is needed for Windows based operating systems.
</pre>
<hr />
<a name="H5FDMPIO2fh5pget5fdxpl5fmpio5ff"></a>
<a name="robo231"></a><h2>h5pget_dxpl_mpio_f</h2>
<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo41">H5FDMPIO</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p>
<p class="item_name">NAME</p>
<pre> <strong>h5pget_dxpl_mpio_f</strong>
</pre>
<p class="item_name">PURPOSE</p>
<pre> Returns the data transfer mode.
</pre>
<p class="item_name">INPUTS</p>
<pre> prp_id - data transfer property list identifier
</pre>
<p class="item_name">OUTPUTS</p>
<pre> data_xfer_mode- transfer mode; possible values are:
H5FD_MPIO_INDEPENDENT_F
H5FD_MPIO_COLLECTIVE_F
hdferr - Returns 0 if successful and -1 if fails
</pre>
<p class="item_name">AUTHOR</p>
<pre> Elena Pourmal
November, 2000
</pre>
<p class="item_name">SOURCE</p>
<pre class="source"> SUBROUTINE <strong>h5pget_dxpl_mpio_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> data_xfer_mode<span class="sign">,</span> hdferr<span class="sign">)</span>
IMPLICIT NONE
INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> data_xfer_mode <span class="sign">!</span> Data transfer mode<span class="sign">.</span> Possible values are<span class="sign">:</span>
<span class="sign">!</span> H5FD_MPIO_INDEPENDENT_F
<span class="sign">!</span> H5FD_MPIO_COLLECTIVE_F
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code
</pre>
<hr />
<a name="H5FDMPIO2fh5pget5ffapl5fmpio5ff"></a>
<a name="robo239"></a><h2>h5pget_fapl_mpio_f</h2>
<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo41">H5FDMPIO</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p>
<p class="item_name">NAME</p>
<pre> <strong>h5pget_fapl_mpio_f</strong>
</pre>
<p class="item_name">PURPOSE</p>
<pre> Returns MPI communicator information.
</pre>
<p class="item_name">INPUTS</p>
<pre> prp_id - file access property list identifier
</pre>
<p class="item_name">OUTPUTS</p>
<pre> comm - MPI-2 communicator
info - MPI-2 info object
hdferr - Returns 0 if successful and -1 if fails
</pre>
<p class="item_name">AUTHOR</p>
<pre> Elena Pourmal
November, 2000
</pre>
<p class="item_name">SOURCE</p>
<pre class="source"> SUBROUTINE <strong>h5pget_fapl_mpio_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> comm<span class="sign">,</span> info<span class="sign">,</span> hdferr<span class="sign">)</span>
IMPLICIT NONE
INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> comm <span class="sign">!</span> buffer to <span class="keyword">return</span> communicator
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> info <span class="sign">!</span> buffer to <span class="keyword">return</span> info object
<span class="sign">!</span> as defined in MPI_FILE_OPEN of MPI<span class="sign">-</span>2
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code
</pre>
<hr />
<a name="H5FDMPIO2fh5pget5ffapl5fmpiposix5ff"></a>
<a name="robo240"></a><h2>h5pget_fapl_mpiposix_f</h2>
<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo41">H5FDMPIO</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p>
<p class="item_name">NAME</p>
<pre> <strong>h5pget_fapl_mpiposix_f</strong>
</pre>
<p class="item_name">PURPOSE</p>
<pre> Returns MPI communicator information.
</pre>
<p class="item_name">INPUTS</p>
<pre> prp_id - file access property list identifier
</pre>
<p class="item_name">OUTPUTS</p>
<pre> comm - MPI-2 communicator
use_gpfs - flag to use GPFS hints
hdferr - Returns 0 if successful and -1 if fails
</pre>
<p class="item_name">AUTHOR</p>
<pre> Elena Pourmal
May 6, 2003
</pre>
<p class="item_name">SOURCE</p>
<pre class="source"> SUBROUTINE <strong>h5pget_fapl_mpiposix_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> comm<span class="sign">,</span> use_gpfs<span class="sign">,</span> hdferr<span class="sign">)</span>
IMPLICIT NONE
INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> comm <span class="sign">!</span> Buffer to <span class="keyword">return</span> communicator
LOGICAL<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> use_gpfs
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code
</pre>
<hr />
<a name="H5FDMPIO2fh5pset5fdxpl5fmpio5ff"></a>
<a name="robo314"></a><h2>h5pset_dxpl_mpio_f</h2>
<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo41">H5FDMPIO</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p>
<p class="item_name">NAME</p>
<pre> <strong>h5pset_dxpl_mpio_f</strong>
</pre>
<p class="item_name">PURPOSE</p>
<pre> Sets data transfer mode.
</pre>
<p class="item_name">INPUTS</p>
<pre> prp_id - data transfer property list identifier
data_xfer_mode - transfer mode; possible values are:
H5FD_MPIO_INDEPENDENT_F
H5FD_MPIO_COLLECTIVE_F
</pre>
<p class="item_name">OUTPUTS</p>
<pre> hdferr - Returns 0 if successful and -1 if fails
</pre>
<p class="item_name">AUTHOR</p>
<pre> Elena Pourmal
November, 2000
</pre>
<p class="item_name">SOURCE</p>
<pre class="source"> SUBROUTINE <strong>h5pset_dxpl_mpio_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> data_xfer_mode<span class="sign">,</span> hdferr<span class="sign">)</span>
IMPLICIT NONE
INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> data_xfer_mode <span class="sign">!</span> Data transfer mode<span class="sign">.</span> Possible values are<span class="sign">:</span>
<span class="sign">!</span> H5FD_MPIO_INDEPENDENT_F
<span class="sign">!</span> H5FD_MPIO_COLLECTIVE_F
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code
</pre>
<hr />
<a name="H5FDMPIO2fh5pset5ffapl5fmpio5ff"></a>
<a name="robo320"></a><h2>h5pset_fapl_mpio_f</h2>
<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo41">H5FDMPIO</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p>
<p class="item_name">NAME</p>
<pre> <strong>h5pset_fapl_mpio_f</strong>
</pre>
<p class="item_name">PURPOSE</p>
<pre> Stores MPI IO communicator information to the file
access property list.
</pre>
<p class="item_name">INPUTS</p>
<pre> prp_id - file access property list identifier
comm - MPI-2 communicator
info - MPI-2 info object
</pre>
<p class="item_name">OUTPUTS</p>
<pre> hdferr - Returns 0 if successful and -1 if fails
</pre>
<p class="item_name">AUTHOR</p>
<pre> Elena Pourmal
November, 2000
</pre>
<p class="item_name">SOURCE</p>
<pre class="source"> SUBROUTINE <strong>h5pset_fapl_mpio_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> comm<span class="sign">,</span> info<span class="sign">,</span> hdferr<span class="sign">)</span>
IMPLICIT NONE
INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> comm <span class="sign">!</span> MPI communicator to be used <span class="keyword">for</span> file open
<span class="sign">!</span> as defined in MPI_FILE_OPEN of MPI<span class="sign">-</span>2
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> info <span class="sign">!</span> MPI info object to be used <span class="keyword">for</span> file open
<span class="sign">!</span> as defined in MPI_FILE_OPEN of MPI<span class="sign">-</span>2
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code
</pre>
<hr />
<a name="H5FDMPIO2fh5pset5ffapl5fmpiposix5ff"></a>
<a name="robo321"></a><h2>h5pset_fapl_mpiposix_f</h2>
<p>[ <a href="#robo_top_of_doc">Top</a> ] [ <a href="#robo41">H5FDMPIO</a> ] [ <a href="../robo_subroutines.html#robo_top_of_doc">Subroutines</a> ]</p>
<p class="item_name">NAME</p>
<pre> <strong>h5pset_fapl_mpiposix_f</strong>
</pre>
<p class="item_name">PURPOSE</p>
<pre> Stores MPI IO communicator information to the file
access property list.
</pre>
<p class="item_name">INPUTS</p>
<pre> prp_id - file access property list identifier
comm - MPI-2 communicator
use_gpfs - logical flag to use the GPFS hints
</pre>
<p class="item_name">OUTPUTS</p>
<pre> hdferr - Returns 0 if successful and -1 if fails
</pre>
<p class="item_name">AUTHOR</p>
<pre> Elena Pourmal
May 6, 2003
</pre>
<p class="item_name">SOURCE</p>
<pre class="source"> SUBROUTINE <strong>h5pset_fapl_mpiposix_f</strong><span class="sign">(</span>prp_id<span class="sign">,</span> comm<span class="sign">,</span> use_gpfs<span class="sign">,</span> hdferr<span class="sign">)</span>
IMPLICIT NONE
INTEGER<span class="sign">(</span>HID_T<span class="sign">)</span><span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> prp_id <span class="sign">!</span> Property list identifier
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> comm <span class="sign">!</span> MPI communicator to be used <span class="keyword">for</span> file open
<span class="sign">!</span> as defined in MPI_FILE_OPEN of MPI<span class="sign">-</span>2
LOGICAL<span class="sign">,</span> INTENT<span class="sign">(</span>IN<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> use_gpfs
INTEGER<span class="sign">,</span> INTENT<span class="sign">(</span>OUT<span class="sign">)</span> <span class="sign">:</span><span class="sign">:</span> hdferr <span class="sign">!</span> Error code
</pre>
</div> <!-- content -->
<div id="footer">
<p>Generated from ./src/H5FDmpioff.f90 on Sun Aug 14 2011 22:49:38
</p>
</div> <!-- footer -->
</body>
</html>