<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>MPQC: sc::MTMPIMemoryGrp Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><b>sc</b>::<a class="el" href="classsc_1_1MTMPIMemoryGrp.html">MTMPIMemoryGrp</a>
</div>
</div>
<div class="contents">
<h1>sc::MTMPIMemoryGrp Class Reference</h1><!-- doxytag: class="sc::MTMPIMemoryGrp" --><!-- doxytag: inherits="sc::ActiveMsgMemoryGrp" -->This <a class="el" href="classsc_1_1MemoryGrp.html" title="The MemoryGrp abstract class provides a way of accessing distributed memory in a...">MemoryGrp</a> class requires a MT-safe MPI implementation.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="memmtmpi_8h_source.html">memmtmpi.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for sc::MTMPIMemoryGrp:</div>
<div class="dynsection">
<p><center><img src="classsc_1_1MTMPIMemoryGrp.png" usemap="#sc::MTMPIMemoryGrp_map" border="0" alt=""></center>
<map name="sc::MTMPIMemoryGrp_map">
<area href="classsc_1_1ActiveMsgMemoryGrp.html" alt="sc::ActiveMsgMemoryGrp" shape="rect" coords="0,280,158,304">
<area href="classsc_1_1MsgMemoryGrp.html" alt="sc::MsgMemoryGrp" shape="rect" coords="0,224,158,248">
<area href="classsc_1_1MemoryGrp.html" alt="sc::MemoryGrp" shape="rect" coords="0,168,158,192">
<area href="classsc_1_1DescribedClass.html" alt="sc::DescribedClass" shape="rect" coords="0,112,158,136">
<area href="classsc_1_1RefCount.html" alt="sc::RefCount" shape="rect" coords="0,56,158,80">
<area href="classsc_1_1Identity.html" alt="sc::Identity" shape="rect" coords="0,0,158,24">
</map>
</div>
<p>
<a href="classsc_1_1MTMPIMemoryGrp-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MTMPIMemoryGrp.html#614734ce26aba2715c568ab52fa11a57">MTMPIMemoryGrp</a> (const <a class="el" href="classsc_1_1Ref.html">Ref</a>< <a class="el" href="classsc_1_1MessageGrp.html">MessageGrp</a> > &msg, const <a class="el" href="classsc_1_1Ref.html">Ref</a>< <a class="el" href="classsc_1_1ThreadGrp.html">ThreadGrp</a> > &th, MPI_Comm comm=MPI_COMM_WORLD)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classsc_1_1MTMPIMemoryGrp.html" title="This MemoryGrp class requires a MT-safe MPI implementation.">MTMPIMemoryGrp</a> given a <a class="el" href="classsc_1_1MessageGrp.html" title="The MessageGrp abstract class provides a mechanism for moving data and objects between...">MessageGrp</a>, <a class="el" href="classsc_1_1ThreadGrp.html" title="The ThreadGrp abstract class provides a means to manage separate threads of control...">ThreadGrp</a>, and an MPI communicator. <a href="#614734ce26aba2715c568ab52fa11a57"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MTMPIMemoryGrp.html#b7bf09855d0825828204af619b729cdb">MTMPIMemoryGrp</a> (const <a class="el" href="classsc_1_1Ref.html">Ref</a>< <a class="el" href="classsc_1_1KeyVal.html">KeyVal</a> > &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classsc_1_1MTMPIMemoryGrp.html" title="This MemoryGrp class requires a MT-safe MPI implementation.">MTMPIMemoryGrp</a> given a <a class="el" href="classsc_1_1KeyVal.html" title="The KeyVal class is designed to simplify the process of allowing a user to specify...">KeyVal</a> input object. <a href="#b7bf09855d0825828204af619b729cdb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="931820bc4523886e16eb8f1eebf0f107"></a><!-- doxytag: member="sc::MTMPIMemoryGrp::activate" ref="931820bc4523886e16eb8f1eebf0f107" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MTMPIMemoryGrp.html#931820bc4523886e16eb8f1eebf0f107">activate</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Activate is called before the memory is to be used. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="42424f49d89eeca0b5b444601844d236"></a><!-- doxytag: member="sc::MTMPIMemoryGrp::deactivate" ref="42424f49d89eeca0b5b444601844d236" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MTMPIMemoryGrp.html#42424f49d89eeca0b5b444601844d236">deactivate</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deactivate is called after the memory has been used. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1MTMPIMemoryGrp.html#113a2c3b575498f47461ada78237ddd8">sync</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Synchronizes all the nodes. <a href="#113a2c3b575498f47461ada78237ddd8"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2fad42aef6478ccc71a8be96d4922617"></a><!-- doxytag: member="sc::MTMPIMemoryGrp::MTMPIThread" ref="2fad42aef6478ccc71a8be96d4922617" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>MTMPIThread</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This <a class="el" href="classsc_1_1MemoryGrp.html" title="The MemoryGrp abstract class provides a way of accessing distributed memory in a...">MemoryGrp</a> class requires a MT-safe MPI implementation.
<p>
The default <a class="el" href="classsc_1_1MessageGrp.html" title="The MessageGrp abstract class provides a mechanism for moving data and objects between...">MessageGrp</a> must be a <a class="el" href="classsc_1_1MPIMessageGrp.html" title="The MPIMessageGrp class is an concrete implementation of MessageGrp that uses the...">MPIMessageGrp</a>. MPI must be safe with respect to the default <a class="el" href="classsc_1_1ThreadGrp.html" title="The ThreadGrp abstract class provides a means to manage separate threads of control...">ThreadGrp</a>. Alternately, a <a class="el" href="classsc_1_1MessageGrp.html" title="The MessageGrp abstract class provides a mechanism for moving data and objects between...">MessageGrp</a> and a <a class="el" href="classsc_1_1ThreadGrp.html" title="The ThreadGrp abstract class provides a means to manage separate threads of control...">ThreadGrp</a> can be passed to the constructor. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="614734ce26aba2715c568ab52fa11a57"></a><!-- doxytag: member="sc::MTMPIMemoryGrp::MTMPIMemoryGrp" ref="614734ce26aba2715c568ab52fa11a57" args="(const Ref< MessageGrp > &msg, const Ref< ThreadGrp > &th, MPI_Comm comm=MPI_COMM_WORLD)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sc::MTMPIMemoryGrp::MTMPIMemoryGrp </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsc_1_1Ref.html">Ref</a>< <a class="el" href="classsc_1_1MessageGrp.html">MessageGrp</a> > & </td>
<td class="paramname"> <em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classsc_1_1Ref.html">Ref</a>< <a class="el" href="classsc_1_1ThreadGrp.html">ThreadGrp</a> > & </td>
<td class="paramname"> <em>th</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MPI_Comm </td>
<td class="paramname"> <em>comm</em> = <code>MPI_COMM_WORLD</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Construct a <a class="el" href="classsc_1_1MTMPIMemoryGrp.html" title="This MemoryGrp class requires a MT-safe MPI implementation.">MTMPIMemoryGrp</a> given a <a class="el" href="classsc_1_1MessageGrp.html" title="The MessageGrp abstract class provides a mechanism for moving data and objects between...">MessageGrp</a>, <a class="el" href="classsc_1_1ThreadGrp.html" title="The ThreadGrp abstract class provides a means to manage separate threads of control...">ThreadGrp</a>, and an MPI communicator.
<p>
The communicator can be a subset of MPI_COMM_WORLD, in which case, the <a class="el" href="classsc_1_1MessageGrp.html" title="The MessageGrp abstract class provides a mechanism for moving data and objects between...">MessageGrp</a> must refer to the same subset.
</div>
</div><p>
<a class="anchor" name="b7bf09855d0825828204af619b729cdb"></a><!-- doxytag: member="sc::MTMPIMemoryGrp::MTMPIMemoryGrp" ref="b7bf09855d0825828204af619b729cdb" args="(const Ref< KeyVal > &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sc::MTMPIMemoryGrp::MTMPIMemoryGrp </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsc_1_1Ref.html">Ref</a>< <a class="el" href="classsc_1_1KeyVal.html">KeyVal</a> > & </td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Construct a <a class="el" href="classsc_1_1MTMPIMemoryGrp.html" title="This MemoryGrp class requires a MT-safe MPI implementation.">MTMPIMemoryGrp</a> given a <a class="el" href="classsc_1_1KeyVal.html" title="The KeyVal class is designed to simplify the process of allowing a user to specify...">KeyVal</a> input object.
<p>
A fully thread safe MPI is needed (MPI_THREAD_MULTIPLE).
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="113a2c3b575498f47461ada78237ddd8"></a><!-- doxytag: member="sc::MTMPIMemoryGrp::sync" ref="113a2c3b575498f47461ada78237ddd8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sc::MTMPIMemoryGrp::sync </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Synchronizes all the nodes.
<p>
This is useful after remote memory writes to be certain that all of the writes have completed and the data can be accessed locally, for example.
<p>Reimplemented from <a class="el" href="classsc_1_1MsgMemoryGrp.html#0fd841a6c2d1547a8d66134f787f1cdc">sc::MsgMemoryGrp</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="memmtmpi_8h_source.html">memmtmpi.h</a></ul>
</div>
<hr>
<address>
<small>
Generated at Wed Oct 14 14:12:16 2009 for <a
href="http://www.mpqc.org">MPQC</a>
2.3.1 using the documentation package <a
href="http://www.doxygen.org">Doxygen</a>
1.5.9.
</small>
</address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
247b28499c443e092731ffba814075f2
>
files
>
413
