source: CPL/oasis3-mct_5.0/doc/doxygen/html/interfacemod__oasis__mpi_1_1oasis__mpi__gatherv.html @ 6328

Last change on this file since 6328 was 6328, checked in by aclsce, 17 months ago

First import of oasis3-mct_5.0 (from oasis git server, branch OASIS3-MCT_5.0)
File size: 8.7 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.13"/>
7<meta name="viewport" content="width=device-width, initial-scale=1"/>
8<title>Oasis3-MCT: mod_oasis_mpi::oasis_mpi_gatherv Interface Reference</title>
9<link href="tabs.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
12<link href="search/search.css" rel="stylesheet" type="text/css"/>
13<script type="text/javascript" src="search/searchdata.js"></script>
14<script type="text/javascript" src="search/search.js"></script>
15<link href="doxygen.css" rel="stylesheet" type="text/css" />
16</head>
17<body>
18<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19<div id="titlearea">
20<table cellspacing="0" cellpadding="0">
21 <tbody>
22 <tr style="height: 56px;">
23  <td id="projectalign" style="padding-left: 0.5em;">
24   <div id="projectname">Oasis3-MCT
25   </div>
26  </td>
27 </tr>
28 </tbody>
29</table>
30</div>
31<!-- end header part -->
32<!-- Generated by Doxygen 1.8.13 -->
33<script type="text/javascript">
34var searchBox = new SearchBox("searchBox", "search",false,'Search');
35</script>
36<script type="text/javascript" src="menudata.js"></script>
37<script type="text/javascript" src="menu.js"></script>
38<script type="text/javascript">
39$(function() {
40  initMenu('',true,false,'search.php','Search');
41  $(document).ready(function() { init_search(); });
42});
43</script>
44<div id="main-nav"></div>
45<!-- window showing the filter options -->
46<div id="MSearchSelectWindow"
47     onmouseover="return searchBox.OnSearchSelectShow()"
48     onmouseout="return searchBox.OnSearchSelectHide()"
49     onkeydown="return searchBox.OnSearchSelectKey(event)">
50</div>
51
52<!-- iframe showing the search results (closed by default) -->
53<div id="MSearchResultsWindow">
54<iframe src="javascript:void(0)" frameborder="0" 
55        name="MSearchResults" id="MSearchResults">
56</iframe>
57</div>
58
59<div id="nav-path" class="navpath">
60  <ul>
61<li class="navelem"><a class="el" href="namespacemod__oasis__mpi.html">mod_oasis_mpi</a></li><li class="navelem"><a class="el" href="interfacemod__oasis__mpi_1_1oasis__mpi__gatherv.html">oasis_mpi_gatherv</a></li>  </ul>
62</div>
63</div><!-- top -->
64<div class="header">
65  <div class="summary">
66<a href="#pri-methods">Private Member Functions</a> &#124;
67<a href="interfacemod__oasis__mpi_1_1oasis__mpi__gatherv-members.html">List of all members</a>  </div>
68  <div class="headertitle">
69<div class="title">mod_oasis_mpi::oasis_mpi_gatherv Interface Reference</div>  </div>
70</div><!--header-->
71<div class="contents">
72
73<p>Generic interfaces into an MPI vector gather. 
74 <a href="interfacemod__oasis__mpi_1_1oasis__mpi__gatherv.html#details">More...</a></p>
75<table class="memberdecls">
76<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
77Private Member Functions</h2></td></tr>
78<tr class="memitem:a8d17b5a337d8ebec5160dfb891c6a715"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacemod__oasis__mpi_1_1oasis__mpi__gatherv.html#a8d17b5a337d8ebec5160dfb891c6a715">oasis_mpi_gathervr1</a> (locarr, locSize, glob1DArr, globSize, displs, rootid, comm, string)</td></tr>
79<tr class="memdesc:a8d17b5a337d8ebec5160dfb891c6a715"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gather a vector of distributed data to a rootid.  <a href="#a8d17b5a337d8ebec5160dfb891c6a715">More...</a><br /></td></tr>
80<tr class="separator:a8d17b5a337d8ebec5160dfb891c6a715"><td class="memSeparator" colspan="2">&#160;</td></tr>
81</table>
82<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
83<div class="textblock"><p>Generic interfaces into an MPI vector gather. </p>
84
85<p class="definition">Definition at line <a class="el" href="mod__oasis__mpi_8_f90_source.html#l00078">78</a> of file <a class="el" href="mod__oasis__mpi_8_f90_source.html">mod_oasis_mpi.F90</a>.</p>
86</div><h2 class="groupheader">Member Function/Subroutine Documentation</h2>
87<a id="a8d17b5a337d8ebec5160dfb891c6a715"></a>
88<h2 class="memtitle"><span class="permalink"><a href="#a8d17b5a337d8ebec5160dfb891c6a715">&#9670;&nbsp;</a></span>oasis_mpi_gathervr1()</h2>
89
90<div class="memitem">
91<div class="memproto">
92<table class="mlabels">
93  <tr>
94  <td class="mlabels-left">
95      <table class="memname">
96        <tr>
97          <td class="memname">subroutine mod_oasis_mpi::oasis_mpi_gatherv::oasis_mpi_gathervr1 </td>
98          <td>(</td>
99          <td class="paramtype">real(ip_double_p), dimension(:), intent(in)&#160;</td>
100          <td class="paramname"><em>locarr</em>, </td>
101        </tr>
102        <tr>
103          <td class="paramkey"></td>
104          <td></td>
105          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
106          <td class="paramname"><em>locSize</em>, </td>
107        </tr>
108        <tr>
109          <td class="paramkey"></td>
110          <td></td>
111          <td class="paramtype">real(ip_double_p), dimension(:), intent(inout)&#160;</td>
112          <td class="paramname"><em>glob1DArr</em>, </td>
113        </tr>
114        <tr>
115          <td class="paramkey"></td>
116          <td></td>
117          <td class="paramtype">integer(ip_i4_p), dimension(:), intent(in)&#160;</td>
118          <td class="paramname"><em>globSize</em>, </td>
119        </tr>
120        <tr>
121          <td class="paramkey"></td>
122          <td></td>
123          <td class="paramtype">integer(ip_i4_p), dimension(:), intent(in)&#160;</td>
124          <td class="paramname"><em>displs</em>, </td>
125        </tr>
126        <tr>
127          <td class="paramkey"></td>
128          <td></td>
129          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
130          <td class="paramname"><em>rootid</em>, </td>
131        </tr>
132        <tr>
133          <td class="paramkey"></td>
134          <td></td>
135          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
136          <td class="paramname"><em>comm</em>, </td>
137        </tr>
138        <tr>
139          <td class="paramkey"></td>
140          <td></td>
141          <td class="paramtype">character(*), intent(in), optional&#160;</td>
142          <td class="paramname"><em>string</em>&#160;</td>
143        </tr>
144        <tr>
145          <td></td>
146          <td>)</td>
147          <td></td><td></td>
148        </tr>
149      </table>
150  </td>
151  <td class="mlabels-right">
152<span class="mlabels"><span class="mlabel">private</span></span>  </td>
153  </tr>
154</table>
155</div><div class="memdoc">
156
157<p>Gather a vector of distributed data to a rootid. </p>
158<p>This method passes in glob1DArr, globSize, and displs computed in the <a class="el" href="interfacemod__oasis__mpi_1_1oasis__mpi__gathscatvinit.html" title="Generic interface to oasis_mpi_gathScatVInit. ">oasis_mpi_gathscatvinit</a> routine and uses that information to gather the locArr into the glob1Darr on processor rootid in communicator comm.</p>
159<dl class="params"><dt>Parameters</dt><dd>
160  <table class="params">
161    <tr><td class="paramdir">[in]</td><td class="paramname">locarr</td><td>Local array</td></tr>
162    <tr><td class="paramdir">[in,out]</td><td class="paramname">glob1darr</td><td>Global 1D array to receive in on</td></tr>
163    <tr><td class="paramdir">[in]</td><td class="paramname">locsize</td><td>Number to send from this PE</td></tr>
164    <tr><td class="paramdir">[in]</td><td class="paramname">globsize</td><td>Number to receive from each PE</td></tr>
165    <tr><td class="paramdir">[in]</td><td class="paramname">displs</td><td>Displacements for receives</td></tr>
166    <tr><td class="paramdir">[in]</td><td class="paramname">rootid</td><td>MPI task to gather on</td></tr>
167    <tr><td class="paramdir">[in]</td><td class="paramname">comm</td><td>mpi communicator</td></tr>
168    <tr><td class="paramdir">[in]</td><td class="paramname">string</td><td>to identify caller </td></tr>
169  </table>
170  </dd>
171</dl>
172
173<p class="definition">Definition at line <a class="el" href="mod__oasis__mpi_8_f90_source.html#l01142">1142</a> of file <a class="el" href="mod__oasis__mpi_8_f90_source.html">mod_oasis_mpi.F90</a>.</p>
174
175</div>
176</div>
177<hr/>The documentation for this interface was generated from the following file:<ul>
178<li>/home/globc2/tcraig/oasis3-mct.trunk/lib/psmile/src/<a class="el" href="mod__oasis__mpi_8_f90_source.html">mod_oasis_mpi.F90</a></li>
179</ul>
180</div><!-- contents -->
181<!-- start footer part -->
182<hr class="footer"/><address class="footer"><small>
183Generated on Fri Jun 29 2018 20:52:29 for Oasis3-MCT by &#160;<a href="http://www.doxygen.org/index.html">
184<img class="footer" src="doxygen.png" alt="doxygen"/>
185</a> 1.8.13
186</small></address>
187</body>
188</html>
Note: See TracBrowser for help on using the repository browser.