<!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::FileGrp 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_1FileGrp.html">FileGrp</a>
</div>
</div>
<div class="contents">
<h1>sc::FileGrp Class Reference</h1><!-- doxytag: class="sc::FileGrp" --><!-- doxytag: inherits="sc::DescribedClass" -->The <a class="el" href="classsc_1_1FileGrp.html" title="The FileGrp abstract class provides a way of accessing distributed file in a parallel...">FileGrp</a> abstract class provides a way of accessing distributed file in a parallel machine.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="file_8h_source.html">file.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for sc::FileGrp:</div>
<div class="dynsection">
<p><center><img src="classsc_1_1FileGrp.png" usemap="#sc::FileGrp_map" border="0" alt=""></center>
<map name="sc::FileGrp_map">
<area href="classsc_1_1DescribedClass.html" alt="sc::DescribedClass" shape="rect" coords="0,112,120,136">
<area href="classsc_1_1RefCount.html" alt="sc::RefCount" shape="rect" coords="0,56,120,80">
<area href="classsc_1_1Identity.html" alt="sc::Identity" shape="rect" coords="0,0,120,24">
<area href="classsc_1_1ProcFileGrp.html" alt="sc::ProcFileGrp" shape="rect" coords="0,224,120,248">
</map>
</div>
<p>
<a href="classsc_1_1FileGrp-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"><a class="anchor" name="b52e0207dd1c6de82a38f5c7abdba30e"></a><!-- doxytag: member="sc::FileGrp::FileGrp" ref="b52e0207dd1c6de82a38f5c7abdba30e" args="(const Ref< KeyVal > &)" -->
</td><td class="memItemRight" valign="bottom"><b>FileGrp</b> (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="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4d3cd5760ca784d720757545e251149e"></a><!-- doxytag: member="sc::FileGrp::open" ref="4d3cd5760ca784d720757545e251149e" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#4d3cd5760ca784d720757545e251149e">open</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Opens the files. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b1dfe407f49ebc9f557367ea5ff32e4b"></a><!-- doxytag: member="sc::FileGrp::close" ref="b1dfe407f49ebc9f557367ea5ff32e4b" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#b1dfe407f49ebc9f557367ea5ff32e4b">close</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes the files. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8bb3c4c964e856e535e918529dea181e"></a><!-- doxytag: member="sc::FileGrp::set_filename" ref="8bb3c4c964e856e535e918529dea181e" args="(char *name)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#8bb3c4c964e856e535e918529dea181e">set_filename</a> (char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the filename for the <a class="el" href="classsc_1_1FileGrp.html" title="The FileGrp abstract class provides a way of accessing distributed file in a parallel...">FileGrp</a>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7aefcb818b0bd91f693bc42cdd5db308"></a><!-- doxytag: member="sc::FileGrp::get_filename" ref="7aefcb818b0bd91f693bc42cdd5db308" args="() const " -->
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#7aefcb818b0bd91f693bc42cdd5db308">get_filename</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the filename for the <a class="el" href="classsc_1_1FileGrp.html" title="The FileGrp abstract class provides a way of accessing distributed file in a parallel...">FileGrp</a>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eeacf0973b402c7da3b3c2d2a945e4ba"></a><!-- doxytag: member="sc::FileGrp::me" ref="eeacf0973b402c7da3b3c2d2a945e4ba" args="() const " -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#eeacf0973b402c7da3b3c2d2a945e4ba">me</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns who I am. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0b0cd42d0eb3b7d5197811d498dd97c3"></a><!-- doxytag: member="sc::FileGrp::n" ref="0b0cd42d0eb3b7d5197811d498dd97c3" args="() const " -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#0b0cd42d0eb3b7d5197811d498dd97c3">n</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns how many nodes there are. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#f3c0d0bebc58de111acf28c333977091">set_localsize</a> (size_t)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the size of locally held data. <a href="#f3c0d0bebc58de111acf28c333977091"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9dc0b00e30683ea9f36b5ae74957ff54"></a><!-- doxytag: member="sc::FileGrp::localsize" ref="9dc0b00e30683ea9f36b5ae74957ff54" args="()" -->
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#9dc0b00e30683ea9f36b5ae74957ff54">localsize</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the amount of data residing locally on <a class="el" href="classsc_1_1FileGrp.html#eeacf0973b402c7da3b3c2d2a945e4ba" title="Returns who I am.">me()</a>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a507540c3a6d0c702067e66276f2b28a"></a><!-- doxytag: member="sc::FileGrp::localoffset" ref="a507540c3a6d0c702067e66276f2b28a" args="()" -->
distsize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#a507540c3a6d0c702067e66276f2b28a">localoffset</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the global offset to this node's data. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6551664f81c13b3c20cb629a2f540023"></a><!-- doxytag: member="sc::FileGrp::size" ref="6551664f81c13b3c20cb629a2f540023" args="(int node)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#6551664f81c13b3c20cb629a2f540023">size</a> (int node)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the amount of data residing on node. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b6d94c169f58d39d23605dca93a74903"></a><!-- doxytag: member="sc::FileGrp::offset" ref="b6d94c169f58d39d23605dca93a74903" args="(int node)" -->
distsize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#b6d94c169f58d39d23605dca93a74903">offset</a> (int node)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the global offset to node's data. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3a0501f1133eeda5cf32bbeba91eb0a4"></a><!-- doxytag: member="sc::FileGrp::totalsize" ref="3a0501f1133eeda5cf32bbeba91eb0a4" args="()" -->
distsize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#3a0501f1133eeda5cf32bbeba91eb0a4">totalsize</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the sum of all data allocated on all nodes. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="88937aa7100a75ab5702aa0cc9a9348d"></a><!-- doxytag: member="sc::FileGrp::activate" ref="88937aa7100a75ab5702aa0cc9a9348d" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#88937aa7100a75ab5702aa0cc9a9348d">activate</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Activate is called before the data is to be used. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2ba7caab1e304ce3a5590cbd57cf822f"></a><!-- doxytag: member="sc::FileGrp::deactivate" ref="2ba7caab1e304ce3a5590cbd57cf822f" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#2ba7caab1e304ce3a5590cbd57cf822f">deactivate</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deactivate is called after the data has been used. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4db5e65f5b418bb8f340e94bee2c2991"></a><!-- doxytag: member="sc::FileGrp::obtain_writeonly" ref="4db5e65f5b418bb8f340e94bee2c2991" args="(distsize_t offset, int size)=0" -->
virtual void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#4db5e65f5b418bb8f340e94bee2c2991">obtain_writeonly</a> (distsize_t offset, int size)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This gives write access to the data location. No locking is done. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#2cc72b52a6ff1d30b49302b5ad3c15ac">obtain_readwrite</a> (distsize_t offset, int size)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Only one thread can have an unreleased obtain_readwrite at a time. <a href="#2cc72b52a6ff1d30b49302b5ad3c15ac"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="32a07e227af5cdbb30fd5516344671c4"></a><!-- doxytag: member="sc::FileGrp::obtain_readonly" ref="32a07e227af5cdbb30fd5516344671c4" args="(distsize_t offset, int size)=0" -->
virtual void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#32a07e227af5cdbb30fd5516344671c4">obtain_readonly</a> (distsize_t offset, int size)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This gives read access to the file location. No locking is done. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="060301208ed173cbbb35e56eb7e60744"></a><!-- doxytag: member="sc::FileGrp::release_readonly" ref="060301208ed173cbbb35e56eb7e60744" args="(void *data, distsize_t offset, int size)=0" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#060301208ed173cbbb35e56eb7e60744">release_readonly</a> (void *data, distsize_t offset, int size)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is called when read access is no longer needed. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="28241a684ef59c0ee0dc7d798984e7e6"></a><!-- doxytag: member="sc::FileGrp::release_writeonly" ref="28241a684ef59c0ee0dc7d798984e7e6" args="(void *data, distsize_t offset, int size)=0" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#28241a684ef59c0ee0dc7d798984e7e6">release_writeonly</a> (void *data, distsize_t offset, int size)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is called when write access is no longer needed. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#fb5c732e25f5c97cb01286a2a859390a">release_readwrite</a> (void *data, distsize_t offset, int size)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is called when read/write access is no longer needed. <a href="#fb5c732e25f5c97cb01286a2a859390a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6d08c8cd6ffd7131db9d40662d9c9054"></a><!-- doxytag: member="sc::FileGrp::sum_reduction" ref="6d08c8cd6ffd7131db9d40662d9c9054" args="(double *data, distsize_t doffset, int dsize)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>sum_reduction</b> (double *data, distsize_t doffset, int dsize)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a65f16608820cc62d81c434863037ee8"></a><!-- doxytag: member="sc::FileGrp::sum_reduction_on_node" ref="a65f16608820cc62d81c434863037ee8" args="(double *data, size_t doffset, int dsize, int node=-1)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>sum_reduction_on_node</b> (double *data, size_t doffset, int dsize, int node=-1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#764899ffda84b68b052cf896ae251131">sync</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Synchronizes all the nodes. <a href="#764899ffda84b68b052cf896ae251131"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#ca5697a4320bd23a1a43235f3affca4b">catchup</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Processes outstanding requests. <a href="#ca5697a4320bd23a1a43235f3affca4b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="860f2807e181f935562d7b2f27e240d9"></a><!-- doxytag: member="sc::FileGrp::print" ref="860f2807e181f935562d7b2f27e240d9" args="(std::ostream &o=ExEnv::out0()) const " -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#860f2807e181f935562d7b2f27e240d9">print</a> (std::ostream &o=ExEnv::out0()) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prints out information about the object. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="16e63c6a1ad6391620b9910209f2a18c"></a><!-- doxytag: member="sc::FileGrp::clone" ref="16e63c6a1ad6391620b9910209f2a18c" args="()=0" -->
virtual <a class="el" href="classsc_1_1FileGrp.html">FileGrp</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#16e63c6a1ad6391620b9910209f2a18c">clone</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clones the given <a class="el" href="classsc_1_1FileGrp.html" title="The FileGrp abstract class provides a way of accessing distributed file in a parallel...">FileGrp</a>. The new <a class="el" href="classsc_1_1FileGrp.html" title="The FileGrp abstract class provides a way of accessing distributed file in a parallel...">FileGrp</a> may need to be initialized additionally. <br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classsc_1_1FileGrp.html">FileGrp</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#d6a1771bdad5ce782544a82f4519b705">initial_filegrp</a> (int &argc, char **argv)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a file group. <a href="#d6a1771bdad5ce782544a82f4519b705"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aa54b3f5599e6bf77e4362afdd788668"></a><!-- doxytag: member="sc::FileGrp::initial_filegrp" ref="aa54b3f5599e6bf77e4362afdd788668" args="()" -->
static <a class="el" href="classsc_1_1FileGrp.html">FileGrp</a> * </td><td class="memItemRight" valign="bottom"><b>initial_filegrp</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#74f4c1961c1a3c09c5ca59e5fabdc5aa">set_default_filegrp</a> (const <a class="el" href="classsc_1_1Ref.html">Ref</a>< <a class="el" href="classsc_1_1FileGrp.html">FileGrp</a> > &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The default file group contains the primary file group to be used by an application. <a href="#74f4c1961c1a3c09c5ca59e5fabdc5aa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6dd93351ea013c8da3d18b12b505bcfc"></a><!-- doxytag: member="sc::FileGrp::get_default_filegrp" ref="6dd93351ea013c8da3d18b12b505bcfc" args="()" -->
static <a class="el" href="classsc_1_1FileGrp.html">FileGrp</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1FileGrp.html#6dd93351ea013c8da3d18b12b505bcfc">get_default_filegrp</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the default file group. <br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e9d4155877c6b49551e75c1e8bc1b2fd"></a><!-- doxytag: member="sc::FileGrp::obtain_local_lock" ref="e9d4155877c6b49551e75c1e8bc1b2fd" args="(size_t start, size_t fence)" -->
void </td><td class="memItemRight" valign="bottom"><b>obtain_local_lock</b> (size_t start, size_t fence)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3c8c8ef2d969f073b8ce62a815ec7f86"></a><!-- doxytag: member="sc::FileGrp::release_local_lock" ref="3c8c8ef2d969f073b8ce62a815ec7f86" args="(size_t start, size_t fence)" -->
void </td><td class="memItemRight" valign="bottom"><b>release_local_lock</b> (size_t start, size_t fence)</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="297e8bb1e3f21257bd60108b2d6f168e"></a><!-- doxytag: member="sc::FileGrp::me_" ref="297e8bb1e3f21257bd60108b2d6f168e" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>me_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1d38b45d8f45408853c9b095a2be55aa"></a><!-- doxytag: member="sc::FileGrp::n_" ref="1d38b45d8f45408853c9b095a2be55aa" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>n_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="635f37fb25e618ac8c1f8df47a4e9b4e"></a><!-- doxytag: member="sc::FileGrp::offsets_" ref="635f37fb25e618ac8c1f8df47a4e9b4e" args="" -->
distsize_t * </td><td class="memItemRight" valign="bottom"><b>offsets_</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fb277fdbdf9d1065547e551b30e89eb3"></a><!-- doxytag: member="sc::FileGrp::debug_" ref="fb277fdbdf9d1065547e551b30e89eb3" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>debug_</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="classsc_1_1FileGrp.html" title="The FileGrp abstract class provides a way of accessing distributed file in a parallel...">FileGrp</a> abstract class provides a way of accessing distributed file in a parallel machine.
<p>
Several specializations are available. For one processor, <a class="el" href="classsc_1_1ProcFileGrp.html" title="The ProcFileGrp concrete class provides an implementation of FileGrp for a single...">ProcFileGrp</a> provides a simple stub implementation. Otherwise, the specializations that should work are MPIIOIFileGrp and MTMPIFileGrp.<p>
If a <a class="el" href="classsc_1_1FileGrp.html" title="The FileGrp abstract class provides a way of accessing distributed file in a parallel...">FileGrp</a> is not given to the program, then one will be automatically chosen depending on which <a class="el" href="classsc_1_1MessageGrp.html" title="The MessageGrp abstract class provides a mechanism for moving data and objects between...">MessageGrp</a> is used by default, the type of machine on which the code was compiled, and what options were given at configuration time. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ca5697a4320bd23a1a43235f3affca4b"></a><!-- doxytag: member="sc::FileGrp::catchup" ref="ca5697a4320bd23a1a43235f3affca4b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void sc::FileGrp::catchup </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Processes outstanding requests.
<p>
Some file group implementations don't have access to real shared memory or even active messages. Instead, requests are processed whenever certain file group routines are called. This can cause large latencies and buffer overflows. If this is a problem, then the catchup member can be called to process all outstanding requests.
</div>
</div><p>
<a class="anchor" name="d6a1771bdad5ce782544a82f4519b705"></a><!-- doxytag: member="sc::FileGrp::initial_filegrp" ref="d6a1771bdad5ce782544a82f4519b705" args="(int &argc, char **argv)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classsc_1_1FileGrp.html">FileGrp</a>* sc::FileGrp::initial_filegrp </td>
<td>(</td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"> <em>argv</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a file group.
<p>
This routine looks for a -filegrp argument, then the environmental variable FILEGRP, and, finally, 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> object to decide which specialization of <a class="el" href="classsc_1_1FileGrp.html" title="The FileGrp abstract class provides a way of accessing distributed file in a parallel...">FileGrp</a> would be appropriate. The argument to -integralgrp should be either string for a <a class="el" href="classsc_1_1ParsedKeyVal.html" title="Converts textual information into keyword/value assocations.">ParsedKeyVal</a> constructor or a classname. 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> and <a class="el" href="classsc_1_1MessageGrp.html" title="The MessageGrp abstract class provides a mechanism for moving data and objects between...">MessageGrp</a> objects should be initialized before this is called.
</div>
</div><p>
<a class="anchor" name="2cc72b52a6ff1d30b49302b5ad3c15ac"></a><!-- doxytag: member="sc::FileGrp::obtain_readwrite" ref="2cc72b52a6ff1d30b49302b5ad3c15ac" args="(distsize_t offset, int size)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void* sc::FileGrp::obtain_readwrite </td>
<td>(</td>
<td class="paramtype">distsize_t </td>
<td class="paramname"> <em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Only one thread can have an unreleased obtain_readwrite at a time.
<p>
The actual file region locked can be larger than that requested. If the file region is already locked this will block. For this reason, data should be held as read/write for as short a time as possible.
<p>Implemented in <a class="el" href="classsc_1_1ProcFileGrp.html#0b52545c08471b0ab34a8f4a48785f4f">sc::ProcFileGrp</a>.</p>
</div>
</div><p>
<a class="anchor" name="fb5c732e25f5c97cb01286a2a859390a"></a><!-- doxytag: member="sc::FileGrp::release_readwrite" ref="fb5c732e25f5c97cb01286a2a859390a" args="(void *data, distsize_t offset, int size)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void sc::FileGrp::release_readwrite </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">distsize_t </td>
<td class="paramname"> <em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This is called when read/write access is no longer needed.
<p>
The data will be unlocked.
<p>Implemented in <a class="el" href="classsc_1_1ProcFileGrp.html#deafe291861de7bd8b2ed99f83c89fae">sc::ProcFileGrp</a>.</p>
</div>
</div><p>
<a class="anchor" name="74f4c1961c1a3c09c5ca59e5fabdc5aa"></a><!-- doxytag: member="sc::FileGrp::set_default_filegrp" ref="74f4c1961c1a3c09c5ca59e5fabdc5aa" args="(const Ref< FileGrp > &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void sc::FileGrp::set_default_filegrp </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsc_1_1Ref.html">Ref</a>< <a class="el" href="classsc_1_1FileGrp.html">FileGrp</a> > & </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The default file group contains the primary file group to be used by an application.
<p>
</div>
</div><p>
<a class="anchor" name="f3c0d0bebc58de111acf28c333977091"></a><!-- doxytag: member="sc::FileGrp::set_localsize" ref="f3c0d0bebc58de111acf28c333977091" args="(size_t)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void sc::FileGrp::set_localsize </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the size of locally held data.
<p>
When data is accessed using a global offset counting starts at node 0 and proceeds up to node <a class="el" href="classsc_1_1FileGrp.html#0b0cd42d0eb3b7d5197811d498dd97c3" title="Returns how many nodes there are.">n()</a> - 1.
<p>Implemented in <a class="el" href="classsc_1_1ProcFileGrp.html#dced8c2dda4cf41da5a063f29530fb27">sc::ProcFileGrp</a>.</p>
</div>
</div><p>
<a class="anchor" name="764899ffda84b68b052cf896ae251131"></a><!-- doxytag: member="sc::FileGrp::sync" ref="764899ffda84b68b052cf896ae251131" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void sc::FileGrp::sync </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Synchronizes all the nodes.
<p>
Consider using this when the way you you access data changes.
<p>Implemented in <a class="el" href="classsc_1_1ProcFileGrp.html#fe49724ffc515fbb4823bc0151583952">sc::ProcFileGrp</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="file_8h_source.html">file.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
>
247
