source: CPL/oasis3-mct/branches/OASIS3-MCT_5.0_branch/doc/doxygen/html/interfacemod__oasis__mpi_1_1oasis__mpi__send.html @ 6331

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

Moved oasis-mct_5.0 in oasis3-mct/branches directory.
File size: 19.6 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_send 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__send.html">oasis_mpi_send</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__send-members.html">List of all members</a>  </div>
68  <div class="headertitle">
69<div class="title">mod_oasis_mpi::oasis_mpi_send Interface Reference</div>  </div>
70</div><!--header-->
71<div class="contents">
72
73<p>Generic overloaded interface into MPI send. 
74 <a href="interfacemod__oasis__mpi_1_1oasis__mpi__send.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:a5b7f0e4f7dc45d398bf564a324dc71c7"><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__send.html#a5b7f0e4f7dc45d398bf564a324dc71c7">oasis_mpi_sendi0</a> (lvec, pid, tag, comm, string)</td></tr>
79<tr class="memdesc:a5b7f0e4f7dc45d398bf564a324dc71c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a scalar integer.  <a href="#a5b7f0e4f7dc45d398bf564a324dc71c7">More...</a><br /></td></tr>
80<tr class="separator:a5b7f0e4f7dc45d398bf564a324dc71c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
81<tr class="memitem:af94ce9cce54b9860809fc63d59674e5b"><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__send.html#af94ce9cce54b9860809fc63d59674e5b">oasis_mpi_sendi1</a> (lvec, pid, tag, comm, string)</td></tr>
82<tr class="memdesc:af94ce9cce54b9860809fc63d59674e5b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send an array of 1D integers.  <a href="#af94ce9cce54b9860809fc63d59674e5b">More...</a><br /></td></tr>
83<tr class="separator:af94ce9cce54b9860809fc63d59674e5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
84<tr class="memitem:aefceb49505c9c2e1431ad2666657910d"><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__send.html#aefceb49505c9c2e1431ad2666657910d">oasis_mpi_sendr0</a> (lvec, pid, tag, comm, string)</td></tr>
85<tr class="memdesc:aefceb49505c9c2e1431ad2666657910d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a scalar double.  <a href="#aefceb49505c9c2e1431ad2666657910d">More...</a><br /></td></tr>
86<tr class="separator:aefceb49505c9c2e1431ad2666657910d"><td class="memSeparator" colspan="2">&#160;</td></tr>
87<tr class="memitem:adf9edd2b024a94a75db93e68318f6eff"><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__send.html#adf9edd2b024a94a75db93e68318f6eff">oasis_mpi_sendr1</a> (lvec, pid, tag, comm, string)</td></tr>
88<tr class="memdesc:adf9edd2b024a94a75db93e68318f6eff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send an array of 1D doubles.  <a href="#adf9edd2b024a94a75db93e68318f6eff">More...</a><br /></td></tr>
89<tr class="separator:adf9edd2b024a94a75db93e68318f6eff"><td class="memSeparator" colspan="2">&#160;</td></tr>
90<tr class="memitem:ad712319885937ce4c29b7bb8e66614cf"><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__send.html#ad712319885937ce4c29b7bb8e66614cf">oasis_mpi_sendr3</a> (array, pid, tag, comm, string)</td></tr>
91<tr class="memdesc:ad712319885937ce4c29b7bb8e66614cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send an array of 3D doubles.  <a href="#ad712319885937ce4c29b7bb8e66614cf">More...</a><br /></td></tr>
92<tr class="separator:ad712319885937ce4c29b7bb8e66614cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
93</table>
94<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
95<div class="textblock"><p>Generic overloaded interface into MPI send. </p>
96
97<p class="definition">Definition at line <a class="el" href="mod__oasis__mpi_8_f90_source.html#l00040">40</a> of file <a class="el" href="mod__oasis__mpi_8_f90_source.html">mod_oasis_mpi.F90</a>.</p>
98</div><h2 class="groupheader">Member Function/Subroutine Documentation</h2>
99<a id="a5b7f0e4f7dc45d398bf564a324dc71c7"></a>
100<h2 class="memtitle"><span class="permalink"><a href="#a5b7f0e4f7dc45d398bf564a324dc71c7">&#9670;&nbsp;</a></span>oasis_mpi_sendi0()</h2>
101
102<div class="memitem">
103<div class="memproto">
104<table class="mlabels">
105  <tr>
106  <td class="mlabels-left">
107      <table class="memname">
108        <tr>
109          <td class="memname">subroutine mod_oasis_mpi::oasis_mpi_send::oasis_mpi_sendi0 </td>
110          <td>(</td>
111          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
112          <td class="paramname"><em>lvec</em>, </td>
113        </tr>
114        <tr>
115          <td class="paramkey"></td>
116          <td></td>
117          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
118          <td class="paramname"><em>pid</em>, </td>
119        </tr>
120        <tr>
121          <td class="paramkey"></td>
122          <td></td>
123          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
124          <td class="paramname"><em>tag</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>comm</em>, </td>
131        </tr>
132        <tr>
133          <td class="paramkey"></td>
134          <td></td>
135          <td class="paramtype">character(*), intent(in), optional&#160;</td>
136          <td class="paramname"><em>string</em>&#160;</td>
137        </tr>
138        <tr>
139          <td></td>
140          <td>)</td>
141          <td></td><td></td>
142        </tr>
143      </table>
144  </td>
145  <td class="mlabels-right">
146<span class="mlabels"><span class="mlabel">private</span></span>  </td>
147  </tr>
148</table>
149</div><div class="memdoc">
150
151<p>Send a scalar integer. </p>
152<dl class="params"><dt>Parameters</dt><dd>
153  <table class="params">
154    <tr><td class="paramdir">[in]</td><td class="paramname">lvec</td><td>send value</td></tr>
155    <tr><td class="paramdir">[in]</td><td class="paramname">pid</td><td>pid to send to</td></tr>
156    <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>mpi tag</td></tr>
157    <tr><td class="paramdir">[in]</td><td class="paramname">comm</td><td>mpi communicator</td></tr>
158    <tr><td class="paramdir">[in]</td><td class="paramname">string</td><td>to identify caller </td></tr>
159  </table>
160  </dd>
161</dl>
162
163<p class="definition">Definition at line <a class="el" href="mod__oasis__mpi_8_f90_source.html#l00170">170</a> of file <a class="el" href="mod__oasis__mpi_8_f90_source.html">mod_oasis_mpi.F90</a>.</p>
164
165</div>
166</div>
167<a id="af94ce9cce54b9860809fc63d59674e5b"></a>
168<h2 class="memtitle"><span class="permalink"><a href="#af94ce9cce54b9860809fc63d59674e5b">&#9670;&nbsp;</a></span>oasis_mpi_sendi1()</h2>
169
170<div class="memitem">
171<div class="memproto">
172<table class="mlabels">
173  <tr>
174  <td class="mlabels-left">
175      <table class="memname">
176        <tr>
177          <td class="memname">subroutine mod_oasis_mpi::oasis_mpi_send::oasis_mpi_sendi1 </td>
178          <td>(</td>
179          <td class="paramtype">integer(ip_i4_p), dimension(:), intent(in)&#160;</td>
180          <td class="paramname"><em>lvec</em>, </td>
181        </tr>
182        <tr>
183          <td class="paramkey"></td>
184          <td></td>
185          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
186          <td class="paramname"><em>pid</em>, </td>
187        </tr>
188        <tr>
189          <td class="paramkey"></td>
190          <td></td>
191          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
192          <td class="paramname"><em>tag</em>, </td>
193        </tr>
194        <tr>
195          <td class="paramkey"></td>
196          <td></td>
197          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
198          <td class="paramname"><em>comm</em>, </td>
199        </tr>
200        <tr>
201          <td class="paramkey"></td>
202          <td></td>
203          <td class="paramtype">character(*), intent(in), optional&#160;</td>
204          <td class="paramname"><em>string</em>&#160;</td>
205        </tr>
206        <tr>
207          <td></td>
208          <td>)</td>
209          <td></td><td></td>
210        </tr>
211      </table>
212  </td>
213  <td class="mlabels-right">
214<span class="mlabels"><span class="mlabel">private</span></span>  </td>
215  </tr>
216</table>
217</div><div class="memdoc">
218
219<p>Send an array of 1D integers. </p>
220<dl class="params"><dt>Parameters</dt><dd>
221  <table class="params">
222    <tr><td class="paramdir">[in]</td><td class="paramname">lvec</td><td>send values</td></tr>
223    <tr><td class="paramdir">[in]</td><td class="paramname">pid</td><td>pid to send to</td></tr>
224    <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>mpi tag</td></tr>
225    <tr><td class="paramdir">[in]</td><td class="paramname">comm</td><td>mpi communicator</td></tr>
226    <tr><td class="paramdir">[in]</td><td class="paramname">string</td><td>to identify caller </td></tr>
227  </table>
228  </dd>
229</dl>
230
231<p class="definition">Definition at line <a class="el" href="mod__oasis__mpi_8_f90_source.html#l00210">210</a> of file <a class="el" href="mod__oasis__mpi_8_f90_source.html">mod_oasis_mpi.F90</a>.</p>
232
233</div>
234</div>
235<a id="aefceb49505c9c2e1431ad2666657910d"></a>
236<h2 class="memtitle"><span class="permalink"><a href="#aefceb49505c9c2e1431ad2666657910d">&#9670;&nbsp;</a></span>oasis_mpi_sendr0()</h2>
237
238<div class="memitem">
239<div class="memproto">
240<table class="mlabels">
241  <tr>
242  <td class="mlabels-left">
243      <table class="memname">
244        <tr>
245          <td class="memname">subroutine mod_oasis_mpi::oasis_mpi_send::oasis_mpi_sendr0 </td>
246          <td>(</td>
247          <td class="paramtype">real(ip_double_p), intent(in)&#160;</td>
248          <td class="paramname"><em>lvec</em>, </td>
249        </tr>
250        <tr>
251          <td class="paramkey"></td>
252          <td></td>
253          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
254          <td class="paramname"><em>pid</em>, </td>
255        </tr>
256        <tr>
257          <td class="paramkey"></td>
258          <td></td>
259          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
260          <td class="paramname"><em>tag</em>, </td>
261        </tr>
262        <tr>
263          <td class="paramkey"></td>
264          <td></td>
265          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
266          <td class="paramname"><em>comm</em>, </td>
267        </tr>
268        <tr>
269          <td class="paramkey"></td>
270          <td></td>
271          <td class="paramtype">character(*), intent(in), optional&#160;</td>
272          <td class="paramname"><em>string</em>&#160;</td>
273        </tr>
274        <tr>
275          <td></td>
276          <td>)</td>
277          <td></td><td></td>
278        </tr>
279      </table>
280  </td>
281  <td class="mlabels-right">
282<span class="mlabels"><span class="mlabel">private</span></span>  </td>
283  </tr>
284</table>
285</div><div class="memdoc">
286
287<p>Send a scalar double. </p>
288<dl class="params"><dt>Parameters</dt><dd>
289  <table class="params">
290    <tr><td class="paramdir">[in]</td><td class="paramname">lvec</td><td>send values</td></tr>
291    <tr><td class="paramdir">[in]</td><td class="paramname">pid</td><td>pid to send to</td></tr>
292    <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>mpi tag</td></tr>
293    <tr><td class="paramdir">[in]</td><td class="paramname">comm</td><td>mpi communicator</td></tr>
294    <tr><td class="paramdir">[in]</td><td class="paramname">string</td><td>to identify caller </td></tr>
295  </table>
296  </dd>
297</dl>
298
299<p class="definition">Definition at line <a class="el" href="mod__oasis__mpi_8_f90_source.html#l00250">250</a> of file <a class="el" href="mod__oasis__mpi_8_f90_source.html">mod_oasis_mpi.F90</a>.</p>
300
301</div>
302</div>
303<a id="adf9edd2b024a94a75db93e68318f6eff"></a>
304<h2 class="memtitle"><span class="permalink"><a href="#adf9edd2b024a94a75db93e68318f6eff">&#9670;&nbsp;</a></span>oasis_mpi_sendr1()</h2>
305
306<div class="memitem">
307<div class="memproto">
308<table class="mlabels">
309  <tr>
310  <td class="mlabels-left">
311      <table class="memname">
312        <tr>
313          <td class="memname">subroutine mod_oasis_mpi::oasis_mpi_send::oasis_mpi_sendr1 </td>
314          <td>(</td>
315          <td class="paramtype">real(ip_double_p), dimension(:), intent(in)&#160;</td>
316          <td class="paramname"><em>lvec</em>, </td>
317        </tr>
318        <tr>
319          <td class="paramkey"></td>
320          <td></td>
321          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
322          <td class="paramname"><em>pid</em>, </td>
323        </tr>
324        <tr>
325          <td class="paramkey"></td>
326          <td></td>
327          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
328          <td class="paramname"><em>tag</em>, </td>
329        </tr>
330        <tr>
331          <td class="paramkey"></td>
332          <td></td>
333          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
334          <td class="paramname"><em>comm</em>, </td>
335        </tr>
336        <tr>
337          <td class="paramkey"></td>
338          <td></td>
339          <td class="paramtype">character(*), intent(in), optional&#160;</td>
340          <td class="paramname"><em>string</em>&#160;</td>
341        </tr>
342        <tr>
343          <td></td>
344          <td>)</td>
345          <td></td><td></td>
346        </tr>
347      </table>
348  </td>
349  <td class="mlabels-right">
350<span class="mlabels"><span class="mlabel">private</span></span>  </td>
351  </tr>
352</table>
353</div><div class="memdoc">
354
355<p>Send an array of 1D doubles. </p>
356<dl class="params"><dt>Parameters</dt><dd>
357  <table class="params">
358    <tr><td class="paramdir">[in]</td><td class="paramname">lvec</td><td>send values</td></tr>
359    <tr><td class="paramdir">[in]</td><td class="paramname">pid</td><td>pid to send to</td></tr>
360    <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>mpi tag</td></tr>
361    <tr><td class="paramdir">[in]</td><td class="paramname">comm</td><td>mpi communicator</td></tr>
362    <tr><td class="paramdir">[in]</td><td class="paramname">string</td><td>to identify caller </td></tr>
363  </table>
364  </dd>
365</dl>
366
367<p class="definition">Definition at line <a class="el" href="mod__oasis__mpi_8_f90_source.html#l00290">290</a> of file <a class="el" href="mod__oasis__mpi_8_f90_source.html">mod_oasis_mpi.F90</a>.</p>
368
369</div>
370</div>
371<a id="ad712319885937ce4c29b7bb8e66614cf"></a>
372<h2 class="memtitle"><span class="permalink"><a href="#ad712319885937ce4c29b7bb8e66614cf">&#9670;&nbsp;</a></span>oasis_mpi_sendr3()</h2>
373
374<div class="memitem">
375<div class="memproto">
376<table class="mlabels">
377  <tr>
378  <td class="mlabels-left">
379      <table class="memname">
380        <tr>
381          <td class="memname">subroutine mod_oasis_mpi::oasis_mpi_send::oasis_mpi_sendr3 </td>
382          <td>(</td>
383          <td class="paramtype">real(ip_double_p), dimension(:,:,:), intent(in)&#160;</td>
384          <td class="paramname"><em>array</em>, </td>
385        </tr>
386        <tr>
387          <td class="paramkey"></td>
388          <td></td>
389          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
390          <td class="paramname"><em>pid</em>, </td>
391        </tr>
392        <tr>
393          <td class="paramkey"></td>
394          <td></td>
395          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
396          <td class="paramname"><em>tag</em>, </td>
397        </tr>
398        <tr>
399          <td class="paramkey"></td>
400          <td></td>
401          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
402          <td class="paramname"><em>comm</em>, </td>
403        </tr>
404        <tr>
405          <td class="paramkey"></td>
406          <td></td>
407          <td class="paramtype">character(*), intent(in), optional&#160;</td>
408          <td class="paramname"><em>string</em>&#160;</td>
409        </tr>
410        <tr>
411          <td></td>
412          <td>)</td>
413          <td></td><td></td>
414        </tr>
415      </table>
416  </td>
417  <td class="mlabels-right">
418<span class="mlabels"><span class="mlabel">private</span></span>  </td>
419  </tr>
420</table>
421</div><div class="memdoc">
422
423<p>Send an array of 3D doubles. </p>
424<dl class="params"><dt>Parameters</dt><dd>
425  <table class="params">
426    <tr><td class="paramdir">[in]</td><td class="paramname">array</td><td>send values</td></tr>
427    <tr><td class="paramdir">[in]</td><td class="paramname">pid</td><td>pid to send to</td></tr>
428    <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>mpi tag</td></tr>
429    <tr><td class="paramdir">[in]</td><td class="paramname">comm</td><td>mpi communicator</td></tr>
430    <tr><td class="paramdir">[in]</td><td class="paramname">string</td><td>to identify caller </td></tr>
431  </table>
432  </dd>
433</dl>
434
435<p class="definition">Definition at line <a class="el" href="mod__oasis__mpi_8_f90_source.html#l00330">330</a> of file <a class="el" href="mod__oasis__mpi_8_f90_source.html">mod_oasis_mpi.F90</a>.</p>
436
437</div>
438</div>
439<hr/>The documentation for this interface was generated from the following file:<ul>
440<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>
441</ul>
442</div><!-- contents -->
443<!-- start footer part -->
444<hr class="footer"/><address class="footer"><small>
445Generated on Fri Jun 29 2018 20:52:29 for Oasis3-MCT by &#160;<a href="http://www.doxygen.org/index.html">
446<img class="footer" src="doxygen.png" alt="doxygen"/>
447</a> 1.8.13
448</small></address>
449</body>
450</html>
Note: See TracBrowser for help on using the repository browser.