awips2/pythonPackages/scientific/Doc/Reference/Scientific.MPI-module.html
2016-06-27 15:10:22 -05:00

304 lines
12 KiB
HTML
Executable file

<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Scientific.MPI</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="Scientific-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://dirac.cnrs-orleans.fr/ScientificPython/">Scientific Python</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="Scientific-module.html">Package&nbsp;Scientific</a> ::
Package&nbsp;MPI
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>]&nbsp;|&nbsp;<a href="Scientific.MPI-module.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== PACKAGE DESCRIPTION ==================== -->
<h1 class="epydoc">Package MPI</h1><p class="nomargin-top"></p>
<p>Python interface to the Message Passing Interface (MPI)</p>
<p>This module contains a Python interface to the Message Passing
Interface (MPI), and standardized library for message-passing parallel
computing. Please read an introduction to MPI before using this module;
some terms in the documentation do not make much sense unless you
understand the principles of MPI.</p>
<p>This module contains an object, 'world', which represents the default
communicator in MPI. This communicator can be used directly for sending
and receiving data, or other communicators can be derived from it.</p>
<p>A number of global constants are also defined (<a
href="Scientific.MPI.max-class.html" class="link">max</a>, <a
href="Scientific.MPI.min-class.html" class="link">min</a>, <a
href="Scientific.MPI.prod-class.html" class="link">prod</a>, <a
href="Scientific.MPI.sum-class.html" class="link">sum</a>, <a
href="Scientific.MPI.land-class.html" class="link">land</a>, <a
href="Scientific.MPI.lor-class.html" class="link">lor</a>, <a
href="Scientific.MPI.lxor-class.html" class="link">lxor</a>, <a
href="Scientific.MPI.band-class.html" class="link">band</a>, <a
href="Scientific.MPI.bor-class.html" class="link">bor</a>, <a
href="Scientific.MPI.bxor-class.html" class="link">bxor</a>, <a
href="Scientific.MPI.maxloc-class.html" class="link">maxloc</a>), and <a
href="Scientific.MPI.minloc-class.html" class="link">minloc</a>). They
are used to specify the desired operator in calls to the 'reduce' and
'allreduce' methods of the communicator objects.</p>
<!-- ==================== SUBMODULES ==================== -->
<a name="section-Submodules"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Submodules</span></td>
</tr>
<tr><td class="summary">
<ul class="nomargin">
<li> <strong class="uidlink"><a href="Scientific.MPI.IO-module.html">Scientific.MPI.IO</a></strong>: <em class="summary">I/O utilities for use with MPI programs</em> </li>
</ul></td></tr>
</table>
<br />
<!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Classes</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="Scientific.MPI.MPICommunicator-class.html" class="summary-name">MPICommunicator</a><br />
MPI Communicator
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="Scientific.MPI.MPIOperationObject-class.html" class="summary-name">MPIOperationObject</a>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="Scientific.MPI.MPIRequest-class.html" class="summary-name">MPIRequest</a><br />
MPI Request
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="Scientific.MPI.band-class.html" class="summary-name">band</a><br />
The 'bitwise and' operation in reduce/allreduce communications.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="Scientific.MPI.bor-class.html" class="summary-name">bor</a><br />
The 'bitwise or' operation in reduce/allreduce communications.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="Scientific.MPI.bxor-class.html" class="summary-name">bxor</a><br />
The 'bitwise exclusive-or' operation.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="Scientific.MPI.land-class.html" class="summary-name">land</a><br />
The 'logical and' operation in reduce/allreduce communications.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="Scientific.MPI.lor-class.html" class="summary-name">lor</a><br />
The 'logical or' operation in reduce/allreduce communications.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="Scientific.MPI.lxor-class.html" class="summary-name">lxor</a><br />
The 'logical exclusive-or' operation.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="Scientific.MPI.max-class.html" class="summary-name">max</a><br />
The 'maximum' operation in reduce/allreduce communications.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="Scientific.MPI.maxloc-class.html" class="summary-name">maxloc</a><br />
The 'location of the maximum' operation.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="Scientific.MPI.min-class.html" class="summary-name">min</a><br />
The 'minimum' operation in reduce/allreduce communications.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="Scientific.MPI.minloc-class.html" class="summary-name">minloc</a><br />
The 'location of the minimum' operation.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="Scientific.MPI.prod-class.html" class="summary-name">prod</a><br />
The 'product' operation in reduce/allreduce communications.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="Scientific.MPI.replace-class.html" class="summary-name">replace</a><br />
The 'replace' operation.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="Scientific.MPI.sum-class.html" class="summary-name">sum</a><br />
The 'sum' operation in reduce/allreduce communications.
</td>
</tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Variables</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="world"></a><span class="summary-name">world</span> = <code title="&lt;Scientific.MPI.MPICommunicator instance at 0x167ed00&gt;">&lt;Scientific.MPI.MPICommunicator instance at 0x167ed00&gt;</code>
</td>
</tr>
</table>
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="Scientific-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://dirac.cnrs-orleans.fr/ScientificPython/">Scientific Python</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0 on Tue Oct 28 14:16:00 2008
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>