source: CONFIG_DEVT/IPSLCM6.5_work_ENSEMBLES/oasis3-mct/doc/doxygen/html/interfacemod__oasis__mpi_1_1oasis__mpi__bcast.html @ 5725

Last change on this file since 5725 was 5725, checked in by aclsce, 3 years ago

Added new oasis3-MCT version to be used to handle ensembles simulations with XIOS.
File size: 35.8 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_bcast 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__bcast.html">oasis_mpi_bcast</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__bcast-members.html">List of all members</a>  </div>
68  <div class="headertitle">
69<div class="title">mod_oasis_mpi::oasis_mpi_bcast Interface Reference</div>  </div>
70</div><!--header-->
71<div class="contents">
72
73<p>Generic overloaded interface into MPI broadcast. 
74 <a href="interfacemod__oasis__mpi_1_1oasis__mpi__bcast.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:ae9e3dad3027638f11550c87f1a91f780"><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__bcast.html#ae9e3dad3027638f11550c87f1a91f780">oasis_mpi_bcastc0</a> (vec, comm, string, pebcast)</td></tr>
79<tr class="memdesc:ae9e3dad3027638f11550c87f1a91f780"><td class="mdescLeft">&#160;</td><td class="mdescRight">Broadcast a character string.  <a href="#ae9e3dad3027638f11550c87f1a91f780">More...</a><br /></td></tr>
80<tr class="separator:ae9e3dad3027638f11550c87f1a91f780"><td class="memSeparator" colspan="2">&#160;</td></tr>
81<tr class="memitem:a074f77b4c72165e03e7955965e5a50bc"><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__bcast.html#a074f77b4c72165e03e7955965e5a50bc">oasis_mpi_bcastc1</a> (vec, comm, string, pebcast)</td></tr>
82<tr class="memdesc:a074f77b4c72165e03e7955965e5a50bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Broadcast an array of 1D character strings.  <a href="#a074f77b4c72165e03e7955965e5a50bc">More...</a><br /></td></tr>
83<tr class="separator:a074f77b4c72165e03e7955965e5a50bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
84<tr class="memitem:ae97f34e1ec8a66cce79cd18664ad108e"><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__bcast.html#ae97f34e1ec8a66cce79cd18664ad108e">oasis_mpi_bcastl0</a> (vec, comm, string, pebcast)</td></tr>
85<tr class="memdesc:ae97f34e1ec8a66cce79cd18664ad108e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Broadcast a scalar logical.  <a href="#ae97f34e1ec8a66cce79cd18664ad108e">More...</a><br /></td></tr>
86<tr class="separator:ae97f34e1ec8a66cce79cd18664ad108e"><td class="memSeparator" colspan="2">&#160;</td></tr>
87<tr class="memitem:aa2900064ce9079a6a2b4a8e55ff28ce7"><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__bcast.html#aa2900064ce9079a6a2b4a8e55ff28ce7">oasis_mpi_bcastl1</a> (vec, comm, string, pebcast)</td></tr>
88<tr class="memdesc:aa2900064ce9079a6a2b4a8e55ff28ce7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Broadcast an array of 1D logicals.  <a href="#aa2900064ce9079a6a2b4a8e55ff28ce7">More...</a><br /></td></tr>
89<tr class="separator:aa2900064ce9079a6a2b4a8e55ff28ce7"><td class="memSeparator" colspan="2">&#160;</td></tr>
90<tr class="memitem:a773c919f8d2e8e9f5684d8ab474adf67"><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__bcast.html#a773c919f8d2e8e9f5684d8ab474adf67">oasis_mpi_bcasti0</a> (vec, comm, string, pebcast)</td></tr>
91<tr class="memdesc:a773c919f8d2e8e9f5684d8ab474adf67"><td class="mdescLeft">&#160;</td><td class="mdescRight">Broadcast a scalar integer.  <a href="#a773c919f8d2e8e9f5684d8ab474adf67">More...</a><br /></td></tr>
92<tr class="separator:a773c919f8d2e8e9f5684d8ab474adf67"><td class="memSeparator" colspan="2">&#160;</td></tr>
93<tr class="memitem:a55099ffd2a5c5395e84381aac600f925"><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__bcast.html#a55099ffd2a5c5395e84381aac600f925">oasis_mpi_bcasti1</a> (vec, comm, string, pebcast)</td></tr>
94<tr class="memdesc:a55099ffd2a5c5395e84381aac600f925"><td class="mdescLeft">&#160;</td><td class="mdescRight">Broadcast an array of 1D integers.  <a href="#a55099ffd2a5c5395e84381aac600f925">More...</a><br /></td></tr>
95<tr class="separator:a55099ffd2a5c5395e84381aac600f925"><td class="memSeparator" colspan="2">&#160;</td></tr>
96<tr class="memitem:a37a7d70970597e2482d9972e2eec30fb"><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__bcast.html#a37a7d70970597e2482d9972e2eec30fb">oasis_mpi_bcasti2</a> (arr, comm, string, pebcast)</td></tr>
97<tr class="memdesc:a37a7d70970597e2482d9972e2eec30fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Broadcast an array of 2D integers.  <a href="#a37a7d70970597e2482d9972e2eec30fb">More...</a><br /></td></tr>
98<tr class="separator:a37a7d70970597e2482d9972e2eec30fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
99<tr class="memitem:af36d9d1af755437ac9291e95cf75b1b2"><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__bcast.html#af36d9d1af755437ac9291e95cf75b1b2">oasis_mpi_bcastr0</a> (vec, comm, string, pebcast)</td></tr>
100<tr class="memdesc:af36d9d1af755437ac9291e95cf75b1b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Broadcast a scalar double.  <a href="#af36d9d1af755437ac9291e95cf75b1b2">More...</a><br /></td></tr>
101<tr class="separator:af36d9d1af755437ac9291e95cf75b1b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
102<tr class="memitem:a0e0e3c41f07c25b5b9d6f0f452eb0178"><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__bcast.html#a0e0e3c41f07c25b5b9d6f0f452eb0178">oasis_mpi_bcastr1</a> (vec, comm, string, pebcast)</td></tr>
103<tr class="memdesc:a0e0e3c41f07c25b5b9d6f0f452eb0178"><td class="mdescLeft">&#160;</td><td class="mdescRight">Broadcast an array of 1D doubles.  <a href="#a0e0e3c41f07c25b5b9d6f0f452eb0178">More...</a><br /></td></tr>
104<tr class="separator:a0e0e3c41f07c25b5b9d6f0f452eb0178"><td class="memSeparator" colspan="2">&#160;</td></tr>
105<tr class="memitem:a83b3e5f67615db7af2bd599a067c7691"><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__bcast.html#a83b3e5f67615db7af2bd599a067c7691">oasis_mpi_bcastr2</a> (arr, comm, string, pebcast)</td></tr>
106<tr class="memdesc:a83b3e5f67615db7af2bd599a067c7691"><td class="mdescLeft">&#160;</td><td class="mdescRight">Broadcast an array of 2D doubles.  <a href="#a83b3e5f67615db7af2bd599a067c7691">More...</a><br /></td></tr>
107<tr class="separator:a83b3e5f67615db7af2bd599a067c7691"><td class="memSeparator" colspan="2">&#160;</td></tr>
108<tr class="memitem:aec70b77613425bddc9002f1dc21db1d2"><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__bcast.html#aec70b77613425bddc9002f1dc21db1d2">oasis_mpi_bcastr3</a> (arr, comm, string, pebcast)</td></tr>
109<tr class="memdesc:aec70b77613425bddc9002f1dc21db1d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Broadcast an array of 3D doubles.  <a href="#aec70b77613425bddc9002f1dc21db1d2">More...</a><br /></td></tr>
110<tr class="separator:aec70b77613425bddc9002f1dc21db1d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
111</table>
112<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
113<div class="textblock"><p>Generic overloaded interface into MPI broadcast. </p>
114
115<p class="definition">Definition at line <a class="el" href="mod__oasis__mpi_8_f90_source.html#l00058">58</a> of file <a class="el" href="mod__oasis__mpi_8_f90_source.html">mod_oasis_mpi.F90</a>.</p>
116</div><h2 class="groupheader">Member Function/Subroutine Documentation</h2>
117<a id="ae9e3dad3027638f11550c87f1a91f780"></a>
118<h2 class="memtitle"><span class="permalink"><a href="#ae9e3dad3027638f11550c87f1a91f780">&#9670;&nbsp;</a></span>oasis_mpi_bcastc0()</h2>
119
120<div class="memitem">
121<div class="memproto">
122<table class="mlabels">
123  <tr>
124  <td class="mlabels-left">
125      <table class="memname">
126        <tr>
127          <td class="memname">subroutine mod_oasis_mpi::oasis_mpi_bcast::oasis_mpi_bcastc0 </td>
128          <td>(</td>
129          <td class="paramtype">character(len=*), intent(inout)&#160;</td>
130          <td class="paramname"><em>vec</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>, </td>
143        </tr>
144        <tr>
145          <td class="paramkey"></td>
146          <td></td>
147          <td class="paramtype">integer(ip_i4_p), intent(in), optional&#160;</td>
148          <td class="paramname"><em>pebcast</em>&#160;</td>
149        </tr>
150        <tr>
151          <td></td>
152          <td>)</td>
153          <td></td><td></td>
154        </tr>
155      </table>
156  </td>
157  <td class="mlabels-right">
158<span class="mlabels"><span class="mlabel">private</span></span>  </td>
159  </tr>
160</table>
161</div><div class="memdoc">
162
163<p>Broadcast a character string. </p>
164<dl class="params"><dt>Parameters</dt><dd>
165  <table class="params">
166    <tr><td class="paramdir">[in,out]</td><td class="paramname">vec</td><td>values to broadcast</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    <tr><td class="paramdir">[in]</td><td class="paramname">pebcast</td><td>bcast pe, default is task 0 </td></tr>
170  </table>
171  </dd>
172</dl>
173
174<p class="definition">Definition at line <a class="el" href="mod__oasis__mpi_8_f90_source.html#l00659">659</a> of file <a class="el" href="mod__oasis__mpi_8_f90_source.html">mod_oasis_mpi.F90</a>.</p>
175
176</div>
177</div>
178<a id="a074f77b4c72165e03e7955965e5a50bc"></a>
179<h2 class="memtitle"><span class="permalink"><a href="#a074f77b4c72165e03e7955965e5a50bc">&#9670;&nbsp;</a></span>oasis_mpi_bcastc1()</h2>
180
181<div class="memitem">
182<div class="memproto">
183<table class="mlabels">
184  <tr>
185  <td class="mlabels-left">
186      <table class="memname">
187        <tr>
188          <td class="memname">subroutine mod_oasis_mpi::oasis_mpi_bcast::oasis_mpi_bcastc1 </td>
189          <td>(</td>
190          <td class="paramtype">character(len=*), dimension(:), intent(inout)&#160;</td>
191          <td class="paramname"><em>vec</em>, </td>
192        </tr>
193        <tr>
194          <td class="paramkey"></td>
195          <td></td>
196          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
197          <td class="paramname"><em>comm</em>, </td>
198        </tr>
199        <tr>
200          <td class="paramkey"></td>
201          <td></td>
202          <td class="paramtype">character(*), intent(in), optional&#160;</td>
203          <td class="paramname"><em>string</em>, </td>
204        </tr>
205        <tr>
206          <td class="paramkey"></td>
207          <td></td>
208          <td class="paramtype">integer(ip_i4_p), intent(in), optional&#160;</td>
209          <td class="paramname"><em>pebcast</em>&#160;</td>
210        </tr>
211        <tr>
212          <td></td>
213          <td>)</td>
214          <td></td><td></td>
215        </tr>
216      </table>
217  </td>
218  <td class="mlabels-right">
219<span class="mlabels"><span class="mlabel">private</span></span>  </td>
220  </tr>
221</table>
222</div><div class="memdoc">
223
224<p>Broadcast an array of 1D character strings. </p>
225<dl class="params"><dt>Parameters</dt><dd>
226  <table class="params">
227    <tr><td class="paramdir">[in,out]</td><td class="paramname">vec</td><td>values to broadcast</td></tr>
228    <tr><td class="paramdir">[in]</td><td class="paramname">comm</td><td>mpi communicator</td></tr>
229    <tr><td class="paramdir">[in]</td><td class="paramname">string</td><td>to identify caller</td></tr>
230    <tr><td class="paramdir">[in]</td><td class="paramname">pebcast</td><td>bcast pe, default is task 0 </td></tr>
231  </table>
232  </dd>
233</dl>
234
235<p class="definition">Definition at line <a class="el" href="mod__oasis__mpi_8_f90_source.html#l00701">701</a> of file <a class="el" href="mod__oasis__mpi_8_f90_source.html">mod_oasis_mpi.F90</a>.</p>
236
237</div>
238</div>
239<a id="a773c919f8d2e8e9f5684d8ab474adf67"></a>
240<h2 class="memtitle"><span class="permalink"><a href="#a773c919f8d2e8e9f5684d8ab474adf67">&#9670;&nbsp;</a></span>oasis_mpi_bcasti0()</h2>
241
242<div class="memitem">
243<div class="memproto">
244<table class="mlabels">
245  <tr>
246  <td class="mlabels-left">
247      <table class="memname">
248        <tr>
249          <td class="memname">subroutine mod_oasis_mpi::oasis_mpi_bcast::oasis_mpi_bcasti0 </td>
250          <td>(</td>
251          <td class="paramtype">integer(ip_i4_p), intent(inout)&#160;</td>
252          <td class="paramname"><em>vec</em>, </td>
253        </tr>
254        <tr>
255          <td class="paramkey"></td>
256          <td></td>
257          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
258          <td class="paramname"><em>comm</em>, </td>
259        </tr>
260        <tr>
261          <td class="paramkey"></td>
262          <td></td>
263          <td class="paramtype">character(*), intent(in), optional&#160;</td>
264          <td class="paramname"><em>string</em>, </td>
265        </tr>
266        <tr>
267          <td class="paramkey"></td>
268          <td></td>
269          <td class="paramtype">integer(ip_i4_p), intent(in), optional&#160;</td>
270          <td class="paramname"><em>pebcast</em>&#160;</td>
271        </tr>
272        <tr>
273          <td></td>
274          <td>)</td>
275          <td></td><td></td>
276        </tr>
277      </table>
278  </td>
279  <td class="mlabels-right">
280<span class="mlabels"><span class="mlabel">private</span></span>  </td>
281  </tr>
282</table>
283</div><div class="memdoc">
284
285<p>Broadcast a scalar integer. </p>
286<dl class="params"><dt>Parameters</dt><dd>
287  <table class="params">
288    <tr><td class="paramdir">[in,out]</td><td class="paramname">vec</td><td>values to broadcast</td></tr>
289    <tr><td class="paramdir">[in]</td><td class="paramname">comm</td><td>mpi communicator</td></tr>
290    <tr><td class="paramdir">[in]</td><td class="paramname">string</td><td>to identify caller</td></tr>
291    <tr><td class="paramdir">[in]</td><td class="paramname">pebcast</td><td>bcast pe, default is task 0 </td></tr>
292  </table>
293  </dd>
294</dl>
295
296<p class="definition">Definition at line <a class="el" href="mod__oasis__mpi_8_f90_source.html#l00575">575</a> of file <a class="el" href="mod__oasis__mpi_8_f90_source.html">mod_oasis_mpi.F90</a>.</p>
297
298</div>
299</div>
300<a id="a55099ffd2a5c5395e84381aac600f925"></a>
301<h2 class="memtitle"><span class="permalink"><a href="#a55099ffd2a5c5395e84381aac600f925">&#9670;&nbsp;</a></span>oasis_mpi_bcasti1()</h2>
302
303<div class="memitem">
304<div class="memproto">
305<table class="mlabels">
306  <tr>
307  <td class="mlabels-left">
308      <table class="memname">
309        <tr>
310          <td class="memname">subroutine mod_oasis_mpi::oasis_mpi_bcast::oasis_mpi_bcasti1 </td>
311          <td>(</td>
312          <td class="paramtype">integer(ip_i4_p), dimension(:), intent(inout)&#160;</td>
313          <td class="paramname"><em>vec</em>, </td>
314        </tr>
315        <tr>
316          <td class="paramkey"></td>
317          <td></td>
318          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
319          <td class="paramname"><em>comm</em>, </td>
320        </tr>
321        <tr>
322          <td class="paramkey"></td>
323          <td></td>
324          <td class="paramtype">character(*), intent(in), optional&#160;</td>
325          <td class="paramname"><em>string</em>, </td>
326        </tr>
327        <tr>
328          <td class="paramkey"></td>
329          <td></td>
330          <td class="paramtype">integer(ip_i4_p), intent(in), optional&#160;</td>
331          <td class="paramname"><em>pebcast</em>&#160;</td>
332        </tr>
333        <tr>
334          <td></td>
335          <td>)</td>
336          <td></td><td></td>
337        </tr>
338      </table>
339  </td>
340  <td class="mlabels-right">
341<span class="mlabels"><span class="mlabel">private</span></span>  </td>
342  </tr>
343</table>
344</div><div class="memdoc">
345
346<p>Broadcast an array of 1D integers. </p>
347<dl class="params"><dt>Parameters</dt><dd>
348  <table class="params">
349    <tr><td class="paramdir">[in,out]</td><td class="paramname">vec</td><td>values to broadcast</td></tr>
350    <tr><td class="paramdir">[in]</td><td class="paramname">comm</td><td>mpi communicator</td></tr>
351    <tr><td class="paramdir">[in]</td><td class="paramname">string</td><td>to identify caller</td></tr>
352    <tr><td class="paramdir">[in]</td><td class="paramname">pebcast</td><td>bcast pe, default is task 0 </td></tr>
353  </table>
354  </dd>
355</dl>
356
357<p class="definition">Definition at line <a class="el" href="mod__oasis__mpi_8_f90_source.html#l00785">785</a> of file <a class="el" href="mod__oasis__mpi_8_f90_source.html">mod_oasis_mpi.F90</a>.</p>
358
359</div>
360</div>
361<a id="a37a7d70970597e2482d9972e2eec30fb"></a>
362<h2 class="memtitle"><span class="permalink"><a href="#a37a7d70970597e2482d9972e2eec30fb">&#9670;&nbsp;</a></span>oasis_mpi_bcasti2()</h2>
363
364<div class="memitem">
365<div class="memproto">
366<table class="mlabels">
367  <tr>
368  <td class="mlabels-left">
369      <table class="memname">
370        <tr>
371          <td class="memname">subroutine mod_oasis_mpi::oasis_mpi_bcast::oasis_mpi_bcasti2 </td>
372          <td>(</td>
373          <td class="paramtype">integer, dimension(:,:), intent(inout)&#160;</td>
374          <td class="paramname"><em>arr</em>, </td>
375        </tr>
376        <tr>
377          <td class="paramkey"></td>
378          <td></td>
379          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
380          <td class="paramname"><em>comm</em>, </td>
381        </tr>
382        <tr>
383          <td class="paramkey"></td>
384          <td></td>
385          <td class="paramtype">character(*), intent(in), optional&#160;</td>
386          <td class="paramname"><em>string</em>, </td>
387        </tr>
388        <tr>
389          <td class="paramkey"></td>
390          <td></td>
391          <td class="paramtype">integer(ip_i4_p), intent(in), optional&#160;</td>
392          <td class="paramname"><em>pebcast</em>&#160;</td>
393        </tr>
394        <tr>
395          <td></td>
396          <td>)</td>
397          <td></td><td></td>
398        </tr>
399      </table>
400  </td>
401  <td class="mlabels-right">
402<span class="mlabels"><span class="mlabel">private</span></span>  </td>
403  </tr>
404</table>
405</div><div class="memdoc">
406
407<p>Broadcast an array of 2D integers. </p>
408<dl class="params"><dt>Parameters</dt><dd>
409  <table class="params">
410    <tr><td class="paramdir">[in,out]</td><td class="paramname">arr</td><td>values to broadcast</td></tr>
411    <tr><td class="paramdir">[in]</td><td class="paramname">comm</td><td>mpi communicator</td></tr>
412    <tr><td class="paramdir">[in]</td><td class="paramname">string</td><td>to identify caller</td></tr>
413    <tr><td class="paramdir">[in]</td><td class="paramname">pebcast</td><td>bcast pe, default is task 0 </td></tr>
414  </table>
415  </dd>
416</dl>
417
418<p class="definition">Definition at line <a class="el" href="mod__oasis__mpi_8_f90_source.html#l00955">955</a> of file <a class="el" href="mod__oasis__mpi_8_f90_source.html">mod_oasis_mpi.F90</a>.</p>
419
420</div>
421</div>
422<a id="ae97f34e1ec8a66cce79cd18664ad108e"></a>
423<h2 class="memtitle"><span class="permalink"><a href="#ae97f34e1ec8a66cce79cd18664ad108e">&#9670;&nbsp;</a></span>oasis_mpi_bcastl0()</h2>
424
425<div class="memitem">
426<div class="memproto">
427<table class="mlabels">
428  <tr>
429  <td class="mlabels-left">
430      <table class="memname">
431        <tr>
432          <td class="memname">subroutine mod_oasis_mpi::oasis_mpi_bcast::oasis_mpi_bcastl0 </td>
433          <td>(</td>
434          <td class="paramtype">logical, intent(inout)&#160;</td>
435          <td class="paramname"><em>vec</em>, </td>
436        </tr>
437        <tr>
438          <td class="paramkey"></td>
439          <td></td>
440          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
441          <td class="paramname"><em>comm</em>, </td>
442        </tr>
443        <tr>
444          <td class="paramkey"></td>
445          <td></td>
446          <td class="paramtype">character(*), intent(in), optional&#160;</td>
447          <td class="paramname"><em>string</em>, </td>
448        </tr>
449        <tr>
450          <td class="paramkey"></td>
451          <td></td>
452          <td class="paramtype">integer(ip_i4_p), intent(in), optional&#160;</td>
453          <td class="paramname"><em>pebcast</em>&#160;</td>
454        </tr>
455        <tr>
456          <td></td>
457          <td>)</td>
458          <td></td><td></td>
459        </tr>
460      </table>
461  </td>
462  <td class="mlabels-right">
463<span class="mlabels"><span class="mlabel">private</span></span>  </td>
464  </tr>
465</table>
466</div><div class="memdoc">
467
468<p>Broadcast a scalar logical. </p>
469<dl class="params"><dt>Parameters</dt><dd>
470  <table class="params">
471    <tr><td class="paramdir">[in,out]</td><td class="paramname">vec</td><td>values to broadcast</td></tr>
472    <tr><td class="paramdir">[in]</td><td class="paramname">comm</td><td>mpi communicator</td></tr>
473    <tr><td class="paramdir">[in]</td><td class="paramname">string</td><td>to identify caller</td></tr>
474    <tr><td class="paramdir">[in]</td><td class="paramname">pebcast</td><td>bcast pe, default is task 0 </td></tr>
475  </table>
476  </dd>
477</dl>
478
479<p class="definition">Definition at line <a class="el" href="mod__oasis__mpi_8_f90_source.html#l00617">617</a> of file <a class="el" href="mod__oasis__mpi_8_f90_source.html">mod_oasis_mpi.F90</a>.</p>
480
481</div>
482</div>
483<a id="aa2900064ce9079a6a2b4a8e55ff28ce7"></a>
484<h2 class="memtitle"><span class="permalink"><a href="#aa2900064ce9079a6a2b4a8e55ff28ce7">&#9670;&nbsp;</a></span>oasis_mpi_bcastl1()</h2>
485
486<div class="memitem">
487<div class="memproto">
488<table class="mlabels">
489  <tr>
490  <td class="mlabels-left">
491      <table class="memname">
492        <tr>
493          <td class="memname">subroutine mod_oasis_mpi::oasis_mpi_bcast::oasis_mpi_bcastl1 </td>
494          <td>(</td>
495          <td class="paramtype">logical, dimension(:), intent(inout)&#160;</td>
496          <td class="paramname"><em>vec</em>, </td>
497        </tr>
498        <tr>
499          <td class="paramkey"></td>
500          <td></td>
501          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
502          <td class="paramname"><em>comm</em>, </td>
503        </tr>
504        <tr>
505          <td class="paramkey"></td>
506          <td></td>
507          <td class="paramtype">character(*), intent(in), optional&#160;</td>
508          <td class="paramname"><em>string</em>, </td>
509        </tr>
510        <tr>
511          <td class="paramkey"></td>
512          <td></td>
513          <td class="paramtype">integer(ip_i4_p), intent(in), optional&#160;</td>
514          <td class="paramname"><em>pebcast</em>&#160;</td>
515        </tr>
516        <tr>
517          <td></td>
518          <td>)</td>
519          <td></td><td></td>
520        </tr>
521      </table>
522  </td>
523  <td class="mlabels-right">
524<span class="mlabels"><span class="mlabel">private</span></span>  </td>
525  </tr>
526</table>
527</div><div class="memdoc">
528
529<p>Broadcast an array of 1D logicals. </p>
530<dl class="params"><dt>Parameters</dt><dd>
531  <table class="params">
532    <tr><td class="paramdir">[in,out]</td><td class="paramname">vec</td><td>values to broadcast</td></tr>
533    <tr><td class="paramdir">[in]</td><td class="paramname">comm</td><td>mpi communicator</td></tr>
534    <tr><td class="paramdir">[in]</td><td class="paramname">string</td><td>to identify caller</td></tr>
535    <tr><td class="paramdir">[in]</td><td class="paramname">pebcast</td><td>bcast pe, default is task 0 </td></tr>
536  </table>
537  </dd>
538</dl>
539
540<p class="definition">Definition at line <a class="el" href="mod__oasis__mpi_8_f90_source.html#l00827">827</a> of file <a class="el" href="mod__oasis__mpi_8_f90_source.html">mod_oasis_mpi.F90</a>.</p>
541
542</div>
543</div>
544<a id="af36d9d1af755437ac9291e95cf75b1b2"></a>
545<h2 class="memtitle"><span class="permalink"><a href="#af36d9d1af755437ac9291e95cf75b1b2">&#9670;&nbsp;</a></span>oasis_mpi_bcastr0()</h2>
546
547<div class="memitem">
548<div class="memproto">
549<table class="mlabels">
550  <tr>
551  <td class="mlabels-left">
552      <table class="memname">
553        <tr>
554          <td class="memname">subroutine mod_oasis_mpi::oasis_mpi_bcast::oasis_mpi_bcastr0 </td>
555          <td>(</td>
556          <td class="paramtype">real(ip_double_p), intent(inout)&#160;</td>
557          <td class="paramname"><em>vec</em>, </td>
558        </tr>
559        <tr>
560          <td class="paramkey"></td>
561          <td></td>
562          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
563          <td class="paramname"><em>comm</em>, </td>
564        </tr>
565        <tr>
566          <td class="paramkey"></td>
567          <td></td>
568          <td class="paramtype">character(*), intent(in), optional&#160;</td>
569          <td class="paramname"><em>string</em>, </td>
570        </tr>
571        <tr>
572          <td class="paramkey"></td>
573          <td></td>
574          <td class="paramtype">integer(ip_i4_p), intent(in), optional&#160;</td>
575          <td class="paramname"><em>pebcast</em>&#160;</td>
576        </tr>
577        <tr>
578          <td></td>
579          <td>)</td>
580          <td></td><td></td>
581        </tr>
582      </table>
583  </td>
584  <td class="mlabels-right">
585<span class="mlabels"><span class="mlabel">private</span></span>  </td>
586  </tr>
587</table>
588</div><div class="memdoc">
589
590<p>Broadcast a scalar double. </p>
591<dl class="params"><dt>Parameters</dt><dd>
592  <table class="params">
593    <tr><td class="paramdir">[in,out]</td><td class="paramname">vec</td><td>values to broadcast</td></tr>
594    <tr><td class="paramdir">[in]</td><td class="paramname">comm</td><td>mpi communicator</td></tr>
595    <tr><td class="paramdir">[in]</td><td class="paramname">string</td><td>to identify caller</td></tr>
596    <tr><td class="paramdir">[in]</td><td class="paramname">pebcast</td><td>bcast pe, default is task 0 </td></tr>
597  </table>
598  </dd>
599</dl>
600
601<p class="definition">Definition at line <a class="el" href="mod__oasis__mpi_8_f90_source.html#l00743">743</a> of file <a class="el" href="mod__oasis__mpi_8_f90_source.html">mod_oasis_mpi.F90</a>.</p>
602
603</div>
604</div>
605<a id="a0e0e3c41f07c25b5b9d6f0f452eb0178"></a>
606<h2 class="memtitle"><span class="permalink"><a href="#a0e0e3c41f07c25b5b9d6f0f452eb0178">&#9670;&nbsp;</a></span>oasis_mpi_bcastr1()</h2>
607
608<div class="memitem">
609<div class="memproto">
610<table class="mlabels">
611  <tr>
612  <td class="mlabels-left">
613      <table class="memname">
614        <tr>
615          <td class="memname">subroutine mod_oasis_mpi::oasis_mpi_bcast::oasis_mpi_bcastr1 </td>
616          <td>(</td>
617          <td class="paramtype">real(ip_double_p), dimension(:), intent(inout)&#160;</td>
618          <td class="paramname"><em>vec</em>, </td>
619        </tr>
620        <tr>
621          <td class="paramkey"></td>
622          <td></td>
623          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
624          <td class="paramname"><em>comm</em>, </td>
625        </tr>
626        <tr>
627          <td class="paramkey"></td>
628          <td></td>
629          <td class="paramtype">character(*), intent(in), optional&#160;</td>
630          <td class="paramname"><em>string</em>, </td>
631        </tr>
632        <tr>
633          <td class="paramkey"></td>
634          <td></td>
635          <td class="paramtype">integer(ip_i4_p), intent(in), optional&#160;</td>
636          <td class="paramname"><em>pebcast</em>&#160;</td>
637        </tr>
638        <tr>
639          <td></td>
640          <td>)</td>
641          <td></td><td></td>
642        </tr>
643      </table>
644  </td>
645  <td class="mlabels-right">
646<span class="mlabels"><span class="mlabel">private</span></span>  </td>
647  </tr>
648</table>
649</div><div class="memdoc">
650
651<p>Broadcast an array of 1D doubles. </p>
652<dl class="params"><dt>Parameters</dt><dd>
653  <table class="params">
654    <tr><td class="paramdir">[in,out]</td><td class="paramname">vec</td><td>values to broadcast</td></tr>
655    <tr><td class="paramdir">[in]</td><td class="paramname">comm</td><td>mpi communicator</td></tr>
656    <tr><td class="paramdir">[in]</td><td class="paramname">string</td><td>to identify caller</td></tr>
657    <tr><td class="paramdir">[in]</td><td class="paramname">pebcast</td><td>bcast pe, default is task 0 </td></tr>
658  </table>
659  </dd>
660</dl>
661
662<p class="definition">Definition at line <a class="el" href="mod__oasis__mpi_8_f90_source.html#l00869">869</a> of file <a class="el" href="mod__oasis__mpi_8_f90_source.html">mod_oasis_mpi.F90</a>.</p>
663
664</div>
665</div>
666<a id="a83b3e5f67615db7af2bd599a067c7691"></a>
667<h2 class="memtitle"><span class="permalink"><a href="#a83b3e5f67615db7af2bd599a067c7691">&#9670;&nbsp;</a></span>oasis_mpi_bcastr2()</h2>
668
669<div class="memitem">
670<div class="memproto">
671<table class="mlabels">
672  <tr>
673  <td class="mlabels-left">
674      <table class="memname">
675        <tr>
676          <td class="memname">subroutine mod_oasis_mpi::oasis_mpi_bcast::oasis_mpi_bcastr2 </td>
677          <td>(</td>
678          <td class="paramtype">real(ip_double_p), dimension(:,:), intent(inout)&#160;</td>
679          <td class="paramname"><em>arr</em>, </td>
680        </tr>
681        <tr>
682          <td class="paramkey"></td>
683          <td></td>
684          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
685          <td class="paramname"><em>comm</em>, </td>
686        </tr>
687        <tr>
688          <td class="paramkey"></td>
689          <td></td>
690          <td class="paramtype">character(*), intent(in), optional&#160;</td>
691          <td class="paramname"><em>string</em>, </td>
692        </tr>
693        <tr>
694          <td class="paramkey"></td>
695          <td></td>
696          <td class="paramtype">integer(ip_i4_p), intent(in), optional&#160;</td>
697          <td class="paramname"><em>pebcast</em>&#160;</td>
698        </tr>
699        <tr>
700          <td></td>
701          <td>)</td>
702          <td></td><td></td>
703        </tr>
704      </table>
705  </td>
706  <td class="mlabels-right">
707<span class="mlabels"><span class="mlabel">private</span></span>  </td>
708  </tr>
709</table>
710</div><div class="memdoc">
711
712<p>Broadcast an array of 2D doubles. </p>
713<dl class="params"><dt>Parameters</dt><dd>
714  <table class="params">
715    <tr><td class="paramdir">[in,out]</td><td class="paramname">arr</td><td>values to broadcast</td></tr>
716    <tr><td class="paramdir">[in]</td><td class="paramname">comm</td><td>mpi communicator</td></tr>
717    <tr><td class="paramdir">[in]</td><td class="paramname">string</td><td>to identify caller</td></tr>
718    <tr><td class="paramdir">[in]</td><td class="paramname">pebcast</td><td>bcast pe, default is task 0 </td></tr>
719  </table>
720  </dd>
721</dl>
722
723<p class="definition">Definition at line <a class="el" href="mod__oasis__mpi_8_f90_source.html#l00911">911</a> of file <a class="el" href="mod__oasis__mpi_8_f90_source.html">mod_oasis_mpi.F90</a>.</p>
724
725</div>
726</div>
727<a id="aec70b77613425bddc9002f1dc21db1d2"></a>
728<h2 class="memtitle"><span class="permalink"><a href="#aec70b77613425bddc9002f1dc21db1d2">&#9670;&nbsp;</a></span>oasis_mpi_bcastr3()</h2>
729
730<div class="memitem">
731<div class="memproto">
732<table class="mlabels">
733  <tr>
734  <td class="mlabels-left">
735      <table class="memname">
736        <tr>
737          <td class="memname">subroutine mod_oasis_mpi::oasis_mpi_bcast::oasis_mpi_bcastr3 </td>
738          <td>(</td>
739          <td class="paramtype">real(ip_double_p), dimension(:,:,:), intent(inout)&#160;</td>
740          <td class="paramname"><em>arr</em>, </td>
741        </tr>
742        <tr>
743          <td class="paramkey"></td>
744          <td></td>
745          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
746          <td class="paramname"><em>comm</em>, </td>
747        </tr>
748        <tr>
749          <td class="paramkey"></td>
750          <td></td>
751          <td class="paramtype">character(*), intent(in), optional&#160;</td>
752          <td class="paramname"><em>string</em>, </td>
753        </tr>
754        <tr>
755          <td class="paramkey"></td>
756          <td></td>
757          <td class="paramtype">integer(ip_i4_p), intent(in), optional&#160;</td>
758          <td class="paramname"><em>pebcast</em>&#160;</td>
759        </tr>
760        <tr>
761          <td></td>
762          <td>)</td>
763          <td></td><td></td>
764        </tr>
765      </table>
766  </td>
767  <td class="mlabels-right">
768<span class="mlabels"><span class="mlabel">private</span></span>  </td>
769  </tr>
770</table>
771</div><div class="memdoc">
772
773<p>Broadcast an array of 3D doubles. </p>
774<dl class="params"><dt>Parameters</dt><dd>
775  <table class="params">
776    <tr><td class="paramdir">[in,out]</td><td class="paramname">arr</td><td>values to broadcast</td></tr>
777    <tr><td class="paramdir">[in]</td><td class="paramname">comm</td><td>mpi communicator</td></tr>
778    <tr><td class="paramdir">[in]</td><td class="paramname">string</td><td>to identify caller</td></tr>
779    <tr><td class="paramdir">[in]</td><td class="paramname">pebcast</td><td>bcast pe, default is task 0 </td></tr>
780  </table>
781  </dd>
782</dl>
783
784<p class="definition">Definition at line <a class="el" href="mod__oasis__mpi_8_f90_source.html#l00999">999</a> of file <a class="el" href="mod__oasis__mpi_8_f90_source.html">mod_oasis_mpi.F90</a>.</p>
785
786</div>
787</div>
788<hr/>The documentation for this interface was generated from the following file:<ul>
789<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>
790</ul>
791</div><!-- contents -->
792<!-- start footer part -->
793<hr class="footer"/><address class="footer"><small>
794Generated on Fri Jun 29 2018 20:52:29 for Oasis3-MCT by &#160;<a href="http://www.doxygen.org/index.html">
795<img class="footer" src="doxygen.png" alt="doxygen"/>
796</a> 1.8.13
797</small></address>
798</body>
799</html>
Note: See TracBrowser for help on using the repository browser.