source: CPL/oasis3-mct/branches/OASIS3-MCT_5.0_branch/doc/doxygen/html/interfacemod__oasis__mpi_1_1oasis__mpi__min.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: 16.9 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_min 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__min.html">oasis_mpi_min</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__min-members.html">List of all members</a>  </div>
68  <div class="headertitle">
69<div class="title">mod_oasis_mpi::oasis_mpi_min Interface Reference</div>  </div>
70</div><!--header-->
71<div class="contents">
72
73<p>Generic overloaded interface into MPI min reduction. 
74 <a href="interfacemod__oasis__mpi_1_1oasis__mpi__min.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:a1deee0fc506aeabafcf4a33866694934"><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__min.html#a1deee0fc506aeabafcf4a33866694934">oasis_mpi_mini0</a> (lvec, gvec, comm, string, all)</td></tr>
79<tr class="memdesc:a1deee0fc506aeabafcf4a33866694934"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute a global minimum for a scalar integer.  <a href="#a1deee0fc506aeabafcf4a33866694934">More...</a><br /></td></tr>
80<tr class="separator:a1deee0fc506aeabafcf4a33866694934"><td class="memSeparator" colspan="2">&#160;</td></tr>
81<tr class="memitem:a7f514ac7a5701f4a5ce8612d2e8bcb16"><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__min.html#a7f514ac7a5701f4a5ce8612d2e8bcb16">oasis_mpi_mini1</a> (lvec, gvec, comm, string, all)</td></tr>
82<tr class="memdesc:a7f514ac7a5701f4a5ce8612d2e8bcb16"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute an array of global minimums for an array of 1D integers.  <a href="#a7f514ac7a5701f4a5ce8612d2e8bcb16">More...</a><br /></td></tr>
83<tr class="separator:a7f514ac7a5701f4a5ce8612d2e8bcb16"><td class="memSeparator" colspan="2">&#160;</td></tr>
84<tr class="memitem:a18098e0abd7924b31d64e06c789aa0c4"><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__min.html#a18098e0abd7924b31d64e06c789aa0c4">oasis_mpi_minr0</a> (lvec, gvec, comm, string, all)</td></tr>
85<tr class="memdesc:a18098e0abd7924b31d64e06c789aa0c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute an global minimum for a scalar double.  <a href="#a18098e0abd7924b31d64e06c789aa0c4">More...</a><br /></td></tr>
86<tr class="separator:a18098e0abd7924b31d64e06c789aa0c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
87<tr class="memitem:a62604730fbe7bf0dc21cf9fb9d83e981"><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__min.html#a62604730fbe7bf0dc21cf9fb9d83e981">oasis_mpi_minr1</a> (lvec, gvec, comm, string, all)</td></tr>
88<tr class="memdesc:a62604730fbe7bf0dc21cf9fb9d83e981"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute an array of global minimums for an array of 1D doubles.  <a href="#a62604730fbe7bf0dc21cf9fb9d83e981">More...</a><br /></td></tr>
89<tr class="separator:a62604730fbe7bf0dc21cf9fb9d83e981"><td class="memSeparator" colspan="2">&#160;</td></tr>
90</table>
91<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
92<div class="textblock"><p>Generic overloaded interface into MPI min reduction. </p>
93
94<p class="definition">Definition at line <a class="el" href="mod__oasis__mpi_8_f90_source.html#l00106">106</a> of file <a class="el" href="mod__oasis__mpi_8_f90_source.html">mod_oasis_mpi.F90</a>.</p>
95</div><h2 class="groupheader">Member Function/Subroutine Documentation</h2>
96<a id="a1deee0fc506aeabafcf4a33866694934"></a>
97<h2 class="memtitle"><span class="permalink"><a href="#a1deee0fc506aeabafcf4a33866694934">&#9670;&nbsp;</a></span>oasis_mpi_mini0()</h2>
98
99<div class="memitem">
100<div class="memproto">
101<table class="mlabels">
102  <tr>
103  <td class="mlabels-left">
104      <table class="memname">
105        <tr>
106          <td class="memname">subroutine mod_oasis_mpi::oasis_mpi_min::oasis_mpi_mini0 </td>
107          <td>(</td>
108          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
109          <td class="paramname"><em>lvec</em>, </td>
110        </tr>
111        <tr>
112          <td class="paramkey"></td>
113          <td></td>
114          <td class="paramtype">integer(ip_i4_p), intent(out)&#160;</td>
115          <td class="paramname"><em>gvec</em>, </td>
116        </tr>
117        <tr>
118          <td class="paramkey"></td>
119          <td></td>
120          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
121          <td class="paramname"><em>comm</em>, </td>
122        </tr>
123        <tr>
124          <td class="paramkey"></td>
125          <td></td>
126          <td class="paramtype">character(*), intent(in), optional&#160;</td>
127          <td class="paramname"><em>string</em>, </td>
128        </tr>
129        <tr>
130          <td class="paramkey"></td>
131          <td></td>
132          <td class="paramtype">logical, intent(in), optional&#160;</td>
133          <td class="paramname"><em>all</em>&#160;</td>
134        </tr>
135        <tr>
136          <td></td>
137          <td>)</td>
138          <td></td><td></td>
139        </tr>
140      </table>
141  </td>
142  <td class="mlabels-right">
143<span class="mlabels"><span class="mlabel">private</span></span>  </td>
144  </tr>
145</table>
146</div><div class="memdoc">
147
148<p>Compute a global minimum for a scalar integer. </p>
149<dl class="params"><dt>Parameters</dt><dd>
150  <table class="params">
151    <tr><td class="paramdir">[in]</td><td class="paramname">lvec</td><td>local values</td></tr>
152    <tr><td class="paramdir">[out]</td><td class="paramname">gvec</td><td>global values</td></tr>
153    <tr><td class="paramdir">[in]</td><td class="paramname">comm</td><td>mpi communicator</td></tr>
154    <tr><td class="paramdir">[in]</td><td class="paramname">string</td><td>to identify caller</td></tr>
155    <tr><td class="paramdir">[in]</td><td class="paramname">all</td><td>if true call allreduce, otherwise reduce to task 0 </td></tr>
156  </table>
157  </dd>
158</dl>
159
160<p class="definition">Definition at line <a class="el" href="mod__oasis__mpi_8_f90_source.html#l02019">2019</a> of file <a class="el" href="mod__oasis__mpi_8_f90_source.html">mod_oasis_mpi.F90</a>.</p>
161
162</div>
163</div>
164<a id="a7f514ac7a5701f4a5ce8612d2e8bcb16"></a>
165<h2 class="memtitle"><span class="permalink"><a href="#a7f514ac7a5701f4a5ce8612d2e8bcb16">&#9670;&nbsp;</a></span>oasis_mpi_mini1()</h2>
166
167<div class="memitem">
168<div class="memproto">
169<table class="mlabels">
170  <tr>
171  <td class="mlabels-left">
172      <table class="memname">
173        <tr>
174          <td class="memname">subroutine mod_oasis_mpi::oasis_mpi_min::oasis_mpi_mini1 </td>
175          <td>(</td>
176          <td class="paramtype">integer(ip_i4_p), dimension(:), intent(in)&#160;</td>
177          <td class="paramname"><em>lvec</em>, </td>
178        </tr>
179        <tr>
180          <td class="paramkey"></td>
181          <td></td>
182          <td class="paramtype">integer(ip_i4_p), dimension(:), intent(out)&#160;</td>
183          <td class="paramname"><em>gvec</em>, </td>
184        </tr>
185        <tr>
186          <td class="paramkey"></td>
187          <td></td>
188          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
189          <td class="paramname"><em>comm</em>, </td>
190        </tr>
191        <tr>
192          <td class="paramkey"></td>
193          <td></td>
194          <td class="paramtype">character(*), intent(in), optional&#160;</td>
195          <td class="paramname"><em>string</em>, </td>
196        </tr>
197        <tr>
198          <td class="paramkey"></td>
199          <td></td>
200          <td class="paramtype">logical, intent(in), optional&#160;</td>
201          <td class="paramname"><em>all</em>&#160;</td>
202        </tr>
203        <tr>
204          <td></td>
205          <td>)</td>
206          <td></td><td></td>
207        </tr>
208      </table>
209  </td>
210  <td class="mlabels-right">
211<span class="mlabels"><span class="mlabel">private</span></span>  </td>
212  </tr>
213</table>
214</div><div class="memdoc">
215
216<p>Compute an array of global minimums for an array of 1D integers. </p>
217<dl class="params"><dt>Parameters</dt><dd>
218  <table class="params">
219    <tr><td class="paramdir">[in]</td><td class="paramname">lvec</td><td>local values</td></tr>
220    <tr><td class="paramdir">[out]</td><td class="paramname">gvec</td><td>global values</td></tr>
221    <tr><td class="paramdir">[in]</td><td class="paramname">comm</td><td>mpi communicator</td></tr>
222    <tr><td class="paramdir">[in]</td><td class="paramname">string</td><td>to identify caller</td></tr>
223    <tr><td class="paramdir">[in]</td><td class="paramname">all</td><td>if true call allreduce, otherwise reduce to task 0 </td></tr>
224  </table>
225  </dd>
226</dl>
227
228<p class="definition">Definition at line <a class="el" href="mod__oasis__mpi_8_f90_source.html#l02082">2082</a> of file <a class="el" href="mod__oasis__mpi_8_f90_source.html">mod_oasis_mpi.F90</a>.</p>
229
230</div>
231</div>
232<a id="a18098e0abd7924b31d64e06c789aa0c4"></a>
233<h2 class="memtitle"><span class="permalink"><a href="#a18098e0abd7924b31d64e06c789aa0c4">&#9670;&nbsp;</a></span>oasis_mpi_minr0()</h2>
234
235<div class="memitem">
236<div class="memproto">
237<table class="mlabels">
238  <tr>
239  <td class="mlabels-left">
240      <table class="memname">
241        <tr>
242          <td class="memname">subroutine mod_oasis_mpi::oasis_mpi_min::oasis_mpi_minr0 </td>
243          <td>(</td>
244          <td class="paramtype">real(ip_double_p), intent(in)&#160;</td>
245          <td class="paramname"><em>lvec</em>, </td>
246        </tr>
247        <tr>
248          <td class="paramkey"></td>
249          <td></td>
250          <td class="paramtype">real(ip_double_p), intent(out)&#160;</td>
251          <td class="paramname"><em>gvec</em>, </td>
252        </tr>
253        <tr>
254          <td class="paramkey"></td>
255          <td></td>
256          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
257          <td class="paramname"><em>comm</em>, </td>
258        </tr>
259        <tr>
260          <td class="paramkey"></td>
261          <td></td>
262          <td class="paramtype">character(*), intent(in), optional&#160;</td>
263          <td class="paramname"><em>string</em>, </td>
264        </tr>
265        <tr>
266          <td class="paramkey"></td>
267          <td></td>
268          <td class="paramtype">logical, intent(in), optional&#160;</td>
269          <td class="paramname"><em>all</em>&#160;</td>
270        </tr>
271        <tr>
272          <td></td>
273          <td>)</td>
274          <td></td><td></td>
275        </tr>
276      </table>
277  </td>
278  <td class="mlabels-right">
279<span class="mlabels"><span class="mlabel">private</span></span>  </td>
280  </tr>
281</table>
282</div><div class="memdoc">
283
284<p>Compute an global minimum for a scalar double. </p>
285<dl class="params"><dt>Parameters</dt><dd>
286  <table class="params">
287    <tr><td class="paramdir">[in]</td><td class="paramname">lvec</td><td>local values</td></tr>
288    <tr><td class="paramdir">[out]</td><td class="paramname">gvec</td><td>global values</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">all</td><td>if true call allreduce, otherwise reduce to 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#l02145">2145</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="a62604730fbe7bf0dc21cf9fb9d83e981"></a>
301<h2 class="memtitle"><span class="permalink"><a href="#a62604730fbe7bf0dc21cf9fb9d83e981">&#9670;&nbsp;</a></span>oasis_mpi_minr1()</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_min::oasis_mpi_minr1 </td>
311          <td>(</td>
312          <td class="paramtype">real(ip_double_p), dimension(:), intent(in)&#160;</td>
313          <td class="paramname"><em>lvec</em>, </td>
314        </tr>
315        <tr>
316          <td class="paramkey"></td>
317          <td></td>
318          <td class="paramtype">real(ip_double_p), dimension(:), intent(out)&#160;</td>
319          <td class="paramname"><em>gvec</em>, </td>
320        </tr>
321        <tr>
322          <td class="paramkey"></td>
323          <td></td>
324          <td class="paramtype">integer(ip_i4_p), intent(in)&#160;</td>
325          <td class="paramname"><em>comm</em>, </td>
326        </tr>
327        <tr>
328          <td class="paramkey"></td>
329          <td></td>
330          <td class="paramtype">character(*), intent(in), optional&#160;</td>
331          <td class="paramname"><em>string</em>, </td>
332        </tr>
333        <tr>
334          <td class="paramkey"></td>
335          <td></td>
336          <td class="paramtype">logical, intent(in), optional&#160;</td>
337          <td class="paramname"><em>all</em>&#160;</td>
338        </tr>
339        <tr>
340          <td></td>
341          <td>)</td>
342          <td></td><td></td>
343        </tr>
344      </table>
345  </td>
346  <td class="mlabels-right">
347<span class="mlabels"><span class="mlabel">private</span></span>  </td>
348  </tr>
349</table>
350</div><div class="memdoc">
351
352<p>Compute an array of global minimums for an array of 1D doubles. </p>
353<dl class="params"><dt>Parameters</dt><dd>
354  <table class="params">
355    <tr><td class="paramdir">[in]</td><td class="paramname">lvec</td><td>local values</td></tr>
356    <tr><td class="paramdir">[out]</td><td class="paramname">gvec</td><td>global values</td></tr>
357    <tr><td class="paramdir">[in]</td><td class="paramname">comm</td><td>mpi communicator</td></tr>
358    <tr><td class="paramdir">[in]</td><td class="paramname">string</td><td>to identify caller</td></tr>
359    <tr><td class="paramdir">[in]</td><td class="paramname">all</td><td>if true call allreduce, otherwise reduce to task 0 </td></tr>
360  </table>
361  </dd>
362</dl>
363
364<p class="definition">Definition at line <a class="el" href="mod__oasis__mpi_8_f90_source.html#l02208">2208</a> of file <a class="el" href="mod__oasis__mpi_8_f90_source.html">mod_oasis_mpi.F90</a>.</p>
365
366</div>
367</div>
368<hr/>The documentation for this interface was generated from the following file:<ul>
369<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>
370</ul>
371</div><!-- contents -->
372<!-- start footer part -->
373<hr class="footer"/><address class="footer"><small>
374Generated on Fri Jun 29 2018 20:52:29 for Oasis3-MCT by &#160;<a href="http://www.doxygen.org/index.html">
375<img class="footer" src="doxygen.png" alt="doxygen"/>
376</a> 1.8.13
377</small></address>
378</body>
379</html>
Note: See TracBrowser for help on using the repository browser.