source: CPL/oasis3-mct_5.0/doc/doxygen/html/namespacemod__oasis__auxiliary__routines.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: 29.5 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_auxiliary_routines Module 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><!-- top -->
60<div class="header">
61  <div class="summary">
62<a href="#func-members">Functions/Subroutines</a> &#124;
63<a href="#var-members">Variables</a>  </div>
64  <div class="headertitle">
65<div class="title">mod_oasis_auxiliary_routines Module Reference</div>  </div>
66</div><!--header-->
67<div class="contents">
68
69<p>Auxiliary OASIS user interfaces. 
70<a href="#details">More...</a></p>
71<table class="memberdecls">
72<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
73Functions/Subroutines</h2></td></tr>
74<tr class="memitem:a905dc11bc7613c7ac94054cf92fc2736"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemod__oasis__auxiliary__routines.html#a905dc11bc7613c7ac94054cf92fc2736">oasis_get_localcomm</a> (localcomm, kinfo)</td></tr>
75<tr class="memdesc:a905dc11bc7613c7ac94054cf92fc2736"><td class="mdescLeft">&#160;</td><td class="mdescRight">OASIS user query for the local MPI communicator.  <a href="#a905dc11bc7613c7ac94054cf92fc2736">More...</a><br /></td></tr>
76<tr class="separator:a905dc11bc7613c7ac94054cf92fc2736"><td class="memSeparator" colspan="2">&#160;</td></tr>
77<tr class="memitem:a42c3fe19a188de66499094e988c51938"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemod__oasis__auxiliary__routines.html#a42c3fe19a188de66499094e988c51938">oasis_set_couplcomm</a> (localcomm, kinfo)</td></tr>
78<tr class="memdesc:a42c3fe19a188de66499094e988c51938"><td class="mdescLeft">&#160;</td><td class="mdescRight">OASIS user call to specify a local communicator.  <a href="#a42c3fe19a188de66499094e988c51938">More...</a><br /></td></tr>
79<tr class="separator:a42c3fe19a188de66499094e988c51938"><td class="memSeparator" colspan="2">&#160;</td></tr>
80<tr class="memitem:aede33b301679f532ecd300488358ab71"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemod__oasis__auxiliary__routines.html#aede33b301679f532ecd300488358ab71">oasis_create_couplcomm</a> (icpl, allcomm, cplcomm, kinfo)</td></tr>
81<tr class="memdesc:aede33b301679f532ecd300488358ab71"><td class="mdescLeft">&#160;</td><td class="mdescRight">OASIS user call to create a new communicator.  <a href="#aede33b301679f532ecd300488358ab71">More...</a><br /></td></tr>
82<tr class="separator:aede33b301679f532ecd300488358ab71"><td class="memSeparator" colspan="2">&#160;</td></tr>
83<tr class="memitem:a940777065691d5eab0402b0bb40464c7"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemod__oasis__auxiliary__routines.html#a940777065691d5eab0402b0bb40464c7">oasis_get_debug</a> (debug, kinfo)</td></tr>
84<tr class="memdesc:a940777065691d5eab0402b0bb40464c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">OASIS user interface to query debug level.  <a href="#a940777065691d5eab0402b0bb40464c7">More...</a><br /></td></tr>
85<tr class="separator:a940777065691d5eab0402b0bb40464c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
86<tr class="memitem:a71bf70a87b2d4ce86016bbb93d9edd73"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemod__oasis__auxiliary__routines.html#a71bf70a87b2d4ce86016bbb93d9edd73">oasis_set_debug</a> (debug, kinfo)</td></tr>
87<tr class="memdesc:a71bf70a87b2d4ce86016bbb93d9edd73"><td class="mdescLeft">&#160;</td><td class="mdescRight">OASIS user interface to set debug level.  <a href="#a71bf70a87b2d4ce86016bbb93d9edd73">More...</a><br /></td></tr>
88<tr class="separator:a71bf70a87b2d4ce86016bbb93d9edd73"><td class="memSeparator" colspan="2">&#160;</td></tr>
89<tr class="memitem:a589021c0f1427f8e5edb1c7efcd7fa2c"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemod__oasis__auxiliary__routines.html#a589021c0f1427f8e5edb1c7efcd7fa2c">oasis_get_intercomm</a> (new_comm, cdnam, kinfo)</td></tr>
90<tr class="memdesc:a589021c0f1427f8e5edb1c7efcd7fa2c"><td class="mdescLeft">&#160;</td><td class="mdescRight">OASIS user interface to establish an intercomm communicator between the root of two models.  <a href="#a589021c0f1427f8e5edb1c7efcd7fa2c">More...</a><br /></td></tr>
91<tr class="separator:a589021c0f1427f8e5edb1c7efcd7fa2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
92<tr class="memitem:aa1959db40e8c27dea289b97458929526"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemod__oasis__auxiliary__routines.html#aa1959db40e8c27dea289b97458929526">oasis_get_intracomm</a> (new_comm, cdnam, kinfo)</td></tr>
93<tr class="memdesc:aa1959db40e8c27dea289b97458929526"><td class="mdescLeft">&#160;</td><td class="mdescRight">OASIS user interface to establish an intracomm communicator between the root of two models.  <a href="#aa1959db40e8c27dea289b97458929526">More...</a><br /></td></tr>
94<tr class="separator:aa1959db40e8c27dea289b97458929526"><td class="memSeparator" colspan="2">&#160;</td></tr>
95<tr class="memitem:a154d3345ef9691e378afdc871086f7eb"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemod__oasis__auxiliary__routines.html#a154d3345ef9691e378afdc871086f7eb">oasis_get_ncpl</a> (varid, ncpl, kinfo)</td></tr>
96<tr class="memdesc:a154d3345ef9691e378afdc871086f7eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">OASIS user query for the number of unique couplings associated with a variable.  <a href="#a154d3345ef9691e378afdc871086f7eb">More...</a><br /></td></tr>
97<tr class="separator:a154d3345ef9691e378afdc871086f7eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
98<tr class="memitem:a62d1c98c05bcc4bd5e8796866bcce2db"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemod__oasis__auxiliary__routines.html#a62d1c98c05bcc4bd5e8796866bcce2db">oasis_get_freqs</a> (varid, mop, ncpl, cpl_freqs, kinfo)</td></tr>
99<tr class="memdesc:a62d1c98c05bcc4bd5e8796866bcce2db"><td class="mdescLeft">&#160;</td><td class="mdescRight">OASIS user query for the coupling periods for a given variable.  <a href="#a62d1c98c05bcc4bd5e8796866bcce2db">More...</a><br /></td></tr>
100<tr class="separator:a62d1c98c05bcc4bd5e8796866bcce2db"><td class="memSeparator" colspan="2">&#160;</td></tr>
101<tr class="memitem:a7a95eb579171b6c2f06ff532c7823e2e"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemod__oasis__auxiliary__routines.html#a7a95eb579171b6c2f06ff532c7823e2e">oasis_put_inquire</a> (varid, msec, kinfo)</td></tr>
102<tr class="memdesc:a7a95eb579171b6c2f06ff532c7823e2e"><td class="mdescLeft">&#160;</td><td class="mdescRight">OASIS user query to indicate put return code expected at a specified time for a given variable.  <a href="#a7a95eb579171b6c2f06ff532c7823e2e">More...</a><br /></td></tr>
103<tr class="separator:a7a95eb579171b6c2f06ff532c7823e2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
104</table><table class="memberdecls">
105<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
106Variables</h2></td></tr>
107<tr class="memitem:a284fcb0384dbbf081a6930256fc12b27"><td class="memItemLeft" align="right" valign="top">integer(kind=ip_i4_p), dimension(mpi_status_size)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemod__oasis__auxiliary__routines.html#a284fcb0384dbbf081a6930256fc12b27">istatus</a></td></tr>
108<tr class="separator:a284fcb0384dbbf081a6930256fc12b27"><td class="memSeparator" colspan="2">&#160;</td></tr>
109</table>
110<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
111<div class="textblock"><p>Auxiliary OASIS user interfaces. </p>
112</div><h2 class="groupheader">Function/Subroutine Documentation</h2>
113<a id="aede33b301679f532ecd300488358ab71"></a>
114<h2 class="memtitle"><span class="permalink"><a href="#aede33b301679f532ecd300488358ab71">&#9670;&nbsp;</a></span>oasis_create_couplcomm()</h2>
115
116<div class="memitem">
117<div class="memproto">
118      <table class="memname">
119        <tr>
120          <td class="memname">subroutine, public mod_oasis_auxiliary_routines::oasis_create_couplcomm </td>
121          <td>(</td>
122          <td class="paramtype">integer (kind=ip_intwp_p), intent(in)&#160;</td>
123          <td class="paramname"><em>icpl</em>, </td>
124        </tr>
125        <tr>
126          <td class="paramkey"></td>
127          <td></td>
128          <td class="paramtype">integer (kind=ip_intwp_p), intent(in)&#160;</td>
129          <td class="paramname"><em>allcomm</em>, </td>
130        </tr>
131        <tr>
132          <td class="paramkey"></td>
133          <td></td>
134          <td class="paramtype">integer (kind=ip_intwp_p), intent(out)&#160;</td>
135          <td class="paramname"><em>cplcomm</em>, </td>
136        </tr>
137        <tr>
138          <td class="paramkey"></td>
139          <td></td>
140          <td class="paramtype">integer (kind=ip_intwp_p), intent(inout), optional&#160;</td>
141          <td class="paramname"><em>kinfo</em>&#160;</td>
142        </tr>
143        <tr>
144          <td></td>
145          <td>)</td>
146          <td></td><td></td>
147        </tr>
148      </table>
149</div><div class="memdoc">
150
151<p>OASIS user call to create a new communicator. </p>
152<dl class="params"><dt>Parameters</dt><dd>
153  <table class="params">
154    <tr><td class="paramdir">[in]</td><td class="paramname">icpl</td><td>coupling process flag</td></tr>
155    <tr><td class="paramdir">[in]</td><td class="paramname">allcomm</td><td>input MPI communicator</td></tr>
156    <tr><td class="paramdir">[out]</td><td class="paramname">cplcomm</td><td>reduced MPI communicator</td></tr>
157    <tr><td class="paramdir">[in,out]</td><td class="paramname">kinfo</td><td>return code </td></tr>
158  </table>
159  </dd>
160</dl>
161
162<p class="definition">Definition at line <a class="el" href="mod__oasis__auxiliary__routines_8_f90_source.html#l00113">113</a> of file <a class="el" href="mod__oasis__auxiliary__routines_8_f90_source.html">mod_oasis_auxiliary_routines.F90</a>.</p>
163
164</div>
165</div>
166<a id="a940777065691d5eab0402b0bb40464c7"></a>
167<h2 class="memtitle"><span class="permalink"><a href="#a940777065691d5eab0402b0bb40464c7">&#9670;&nbsp;</a></span>oasis_get_debug()</h2>
168
169<div class="memitem">
170<div class="memproto">
171      <table class="memname">
172        <tr>
173          <td class="memname">subroutine, public mod_oasis_auxiliary_routines::oasis_get_debug </td>
174          <td>(</td>
175          <td class="paramtype">integer (kind=ip_intwp_p), intent(out)&#160;</td>
176          <td class="paramname"><em>debug</em>, </td>
177        </tr>
178        <tr>
179          <td class="paramkey"></td>
180          <td></td>
181          <td class="paramtype">integer (kind=ip_intwp_p), intent(inout), optional&#160;</td>
182          <td class="paramname"><em>kinfo</em>&#160;</td>
183        </tr>
184        <tr>
185          <td></td>
186          <td>)</td>
187          <td></td><td></td>
188        </tr>
189      </table>
190</div><div class="memdoc">
191
192<p>OASIS user interface to query debug level. </p>
193<dl class="params"><dt>Parameters</dt><dd>
194  <table class="params">
195    <tr><td class="paramdir">[out]</td><td class="paramname">debug</td><td>debug level</td></tr>
196    <tr><td class="paramdir">[in,out]</td><td class="paramname">kinfo</td><td>return code </td></tr>
197  </table>
198  </dd>
199</dl>
200
201<p class="definition">Definition at line <a class="el" href="mod__oasis__auxiliary__routines_8_f90_source.html#l00159">159</a> of file <a class="el" href="mod__oasis__auxiliary__routines_8_f90_source.html">mod_oasis_auxiliary_routines.F90</a>.</p>
202
203</div>
204</div>
205<a id="a62d1c98c05bcc4bd5e8796866bcce2db"></a>
206<h2 class="memtitle"><span class="permalink"><a href="#a62d1c98c05bcc4bd5e8796866bcce2db">&#9670;&nbsp;</a></span>oasis_get_freqs()</h2>
207
208<div class="memitem">
209<div class="memproto">
210      <table class="memname">
211        <tr>
212          <td class="memname">subroutine, public mod_oasis_auxiliary_routines::oasis_get_freqs </td>
213          <td>(</td>
214          <td class="paramtype">integer(kind=ip_i4_p), intent(in)&#160;</td>
215          <td class="paramname"><em>varid</em>, </td>
216        </tr>
217        <tr>
218          <td class="paramkey"></td>
219          <td></td>
220          <td class="paramtype">integer(kind=ip_i4_p), intent(in)&#160;</td>
221          <td class="paramname"><em>mop</em>, </td>
222        </tr>
223        <tr>
224          <td class="paramkey"></td>
225          <td></td>
226          <td class="paramtype">integer(kind=ip_i4_p), intent(in)&#160;</td>
227          <td class="paramname"><em>ncpl</em>, </td>
228        </tr>
229        <tr>
230          <td class="paramkey"></td>
231          <td></td>
232          <td class="paramtype">integer(kind=ip_i4_p), dimension(ncpl), intent(out)&#160;</td>
233          <td class="paramname"><em>cpl_freqs</em>, </td>
234        </tr>
235        <tr>
236          <td class="paramkey"></td>
237          <td></td>
238          <td class="paramtype">integer(kind=ip_i4_p), intent(out)&#160;</td>
239          <td class="paramname"><em>kinfo</em>&#160;</td>
240        </tr>
241        <tr>
242          <td></td>
243          <td>)</td>
244          <td></td><td></td>
245        </tr>
246      </table>
247</div><div class="memdoc">
248
249<p>OASIS user query for the coupling periods for a given variable. </p>
250<dl class="params"><dt>Parameters</dt><dd>
251  <table class="params">
252    <tr><td class="paramdir">[in]</td><td class="paramname">varid</td><td>variable id</td></tr>
253    <tr><td class="paramdir">[in]</td><td class="paramname">mop</td><td>OASIS_Out or OASIS_In type</td></tr>
254    <tr><td class="paramdir">[in]</td><td class="paramname">ncpl</td><td>number of namcouple couplings</td></tr>
255    <tr><td class="paramdir">[out]</td><td class="paramname">cpl_freqs</td><td>coupling period (sec)</td></tr>
256    <tr><td class="paramdir">[out]</td><td class="paramname">kinfo</td><td>return code </td></tr>
257  </table>
258  </dd>
259</dl>
260
261<p class="definition">Definition at line <a class="el" href="mod__oasis__auxiliary__routines_8_f90_source.html#l00339">339</a> of file <a class="el" href="mod__oasis__auxiliary__routines_8_f90_source.html">mod_oasis_auxiliary_routines.F90</a>.</p>
262
263</div>
264</div>
265<a id="a589021c0f1427f8e5edb1c7efcd7fa2c"></a>
266<h2 class="memtitle"><span class="permalink"><a href="#a589021c0f1427f8e5edb1c7efcd7fa2c">&#9670;&nbsp;</a></span>oasis_get_intercomm()</h2>
267
268<div class="memitem">
269<div class="memproto">
270      <table class="memname">
271        <tr>
272          <td class="memname">subroutine, public mod_oasis_auxiliary_routines::oasis_get_intercomm </td>
273          <td>(</td>
274          <td class="paramtype">integer (kind=ip_intwp_p), intent(out)&#160;</td>
275          <td class="paramname"><em>new_comm</em>, </td>
276        </tr>
277        <tr>
278          <td class="paramkey"></td>
279          <td></td>
280          <td class="paramtype">character(len=*), intent(in)&#160;</td>
281          <td class="paramname"><em>cdnam</em>, </td>
282        </tr>
283        <tr>
284          <td class="paramkey"></td>
285          <td></td>
286          <td class="paramtype">integer (kind=ip_intwp_p), intent(out), optional&#160;</td>
287          <td class="paramname"><em>kinfo</em>&#160;</td>
288        </tr>
289        <tr>
290          <td></td>
291          <td>)</td>
292          <td></td><td></td>
293        </tr>
294      </table>
295</div><div class="memdoc">
296
297<p>OASIS user interface to establish an intercomm communicator between the root of two models. </p>
298<dl class="params"><dt>Parameters</dt><dd>
299  <table class="params">
300    <tr><td class="paramdir">[out]</td><td class="paramname">new_comm</td><td>out MPI communicator</td></tr>
301    <tr><td class="paramdir">[in]</td><td class="paramname">cdnam</td><td>other model name to link with</td></tr>
302    <tr><td class="paramdir">[out]</td><td class="paramname">kinfo</td><td>return code </td></tr>
303  </table>
304  </dd>
305</dl>
306
307<p class="definition">Definition at line <a class="el" href="mod__oasis__auxiliary__routines_8_f90_source.html#l00211">211</a> of file <a class="el" href="mod__oasis__auxiliary__routines_8_f90_source.html">mod_oasis_auxiliary_routines.F90</a>.</p>
308
309</div>
310</div>
311<a id="aa1959db40e8c27dea289b97458929526"></a>
312<h2 class="memtitle"><span class="permalink"><a href="#aa1959db40e8c27dea289b97458929526">&#9670;&nbsp;</a></span>oasis_get_intracomm()</h2>
313
314<div class="memitem">
315<div class="memproto">
316      <table class="memname">
317        <tr>
318          <td class="memname">subroutine, public mod_oasis_auxiliary_routines::oasis_get_intracomm </td>
319          <td>(</td>
320          <td class="paramtype">integer (kind=ip_intwp_p), intent(out)&#160;</td>
321          <td class="paramname"><em>new_comm</em>, </td>
322        </tr>
323        <tr>
324          <td class="paramkey"></td>
325          <td></td>
326          <td class="paramtype">character(len=*), intent(in)&#160;</td>
327          <td class="paramname"><em>cdnam</em>, </td>
328        </tr>
329        <tr>
330          <td class="paramkey"></td>
331          <td></td>
332          <td class="paramtype">integer (kind=ip_intwp_p), intent(out), optional&#160;</td>
333          <td class="paramname"><em>kinfo</em>&#160;</td>
334        </tr>
335        <tr>
336          <td></td>
337          <td>)</td>
338          <td></td><td></td>
339        </tr>
340      </table>
341</div><div class="memdoc">
342
343<p>OASIS user interface to establish an intracomm communicator between the root of two models. </p>
344<dl class="params"><dt>Parameters</dt><dd>
345  <table class="params">
346    <tr><td class="paramdir">[out]</td><td class="paramname">new_comm</td><td>output MPI communicator</td></tr>
347    <tr><td class="paramdir">[in]</td><td class="paramname">cdnam</td><td>other model name</td></tr>
348    <tr><td class="paramdir">[out]</td><td class="paramname">kinfo</td><td>return code </td></tr>
349  </table>
350  </dd>
351</dl>
352
353<p class="definition">Definition at line <a class="el" href="mod__oasis__auxiliary__routines_8_f90_source.html#l00265">265</a> of file <a class="el" href="mod__oasis__auxiliary__routines_8_f90_source.html">mod_oasis_auxiliary_routines.F90</a>.</p>
354
355</div>
356</div>
357<a id="a905dc11bc7613c7ac94054cf92fc2736"></a>
358<h2 class="memtitle"><span class="permalink"><a href="#a905dc11bc7613c7ac94054cf92fc2736">&#9670;&nbsp;</a></span>oasis_get_localcomm()</h2>
359
360<div class="memitem">
361<div class="memproto">
362      <table class="memname">
363        <tr>
364          <td class="memname">subroutine, public mod_oasis_auxiliary_routines::oasis_get_localcomm </td>
365          <td>(</td>
366          <td class="paramtype">integer (kind=ip_intwp_p), intent(out)&#160;</td>
367          <td class="paramname"><em>localcomm</em>, </td>
368        </tr>
369        <tr>
370          <td class="paramkey"></td>
371          <td></td>
372          <td class="paramtype">integer (kind=ip_intwp_p), intent(inout), optional&#160;</td>
373          <td class="paramname"><em>kinfo</em>&#160;</td>
374        </tr>
375        <tr>
376          <td></td>
377          <td>)</td>
378          <td></td><td></td>
379        </tr>
380      </table>
381</div><div class="memdoc">
382
383<p>OASIS user query for the local MPI communicator. </p>
384<dl class="params"><dt>Parameters</dt><dd>
385  <table class="params">
386    <tr><td class="paramdir">[out]</td><td class="paramname">localcomm</td><td>MPI communicator</td></tr>
387    <tr><td class="paramdir">[in,out]</td><td class="paramname">kinfo</td><td>return code </td></tr>
388  </table>
389  </dd>
390</dl>
391
392<p class="definition">Definition at line <a class="el" href="mod__oasis__auxiliary__routines_8_f90_source.html#l00043">43</a> of file <a class="el" href="mod__oasis__auxiliary__routines_8_f90_source.html">mod_oasis_auxiliary_routines.F90</a>.</p>
393
394</div>
395</div>
396<a id="a154d3345ef9691e378afdc871086f7eb"></a>
397<h2 class="memtitle"><span class="permalink"><a href="#a154d3345ef9691e378afdc871086f7eb">&#9670;&nbsp;</a></span>oasis_get_ncpl()</h2>
398
399<div class="memitem">
400<div class="memproto">
401      <table class="memname">
402        <tr>
403          <td class="memname">subroutine, public mod_oasis_auxiliary_routines::oasis_get_ncpl </td>
404          <td>(</td>
405          <td class="paramtype">integer(kind=ip_i4_p), intent(in)&#160;</td>
406          <td class="paramname"><em>varid</em>, </td>
407        </tr>
408        <tr>
409          <td class="paramkey"></td>
410          <td></td>
411          <td class="paramtype">integer(kind=ip_i4_p), intent(out)&#160;</td>
412          <td class="paramname"><em>ncpl</em>, </td>
413        </tr>
414        <tr>
415          <td class="paramkey"></td>
416          <td></td>
417          <td class="paramtype">integer(kind=ip_i4_p), intent(out)&#160;</td>
418          <td class="paramname"><em>kinfo</em>&#160;</td>
419        </tr>
420        <tr>
421          <td></td>
422          <td>)</td>
423          <td></td><td></td>
424        </tr>
425      </table>
426</div><div class="memdoc">
427
428<p>OASIS user query for the number of unique couplings associated with a variable. </p>
429<dl class="params"><dt>Parameters</dt><dd>
430  <table class="params">
431    <tr><td class="paramdir">[in]</td><td class="paramname">varid</td><td>variable id</td></tr>
432    <tr><td class="paramdir">[out]</td><td class="paramname">ncpl</td><td>number of namcouple couplings</td></tr>
433    <tr><td class="paramdir">[out]</td><td class="paramname">kinfo</td><td>return code </td></tr>
434  </table>
435  </dd>
436</dl>
437
438<p class="definition">Definition at line <a class="el" href="mod__oasis__auxiliary__routines_8_f90_source.html#l00295">295</a> of file <a class="el" href="mod__oasis__auxiliary__routines_8_f90_source.html">mod_oasis_auxiliary_routines.F90</a>.</p>
439
440</div>
441</div>
442<a id="a7a95eb579171b6c2f06ff532c7823e2e"></a>
443<h2 class="memtitle"><span class="permalink"><a href="#a7a95eb579171b6c2f06ff532c7823e2e">&#9670;&nbsp;</a></span>oasis_put_inquire()</h2>
444
445<div class="memitem">
446<div class="memproto">
447      <table class="memname">
448        <tr>
449          <td class="memname">subroutine, public mod_oasis_auxiliary_routines::oasis_put_inquire </td>
450          <td>(</td>
451          <td class="paramtype">integer(kind=ip_i4_p), intent(in)&#160;</td>
452          <td class="paramname"><em>varid</em>, </td>
453        </tr>
454        <tr>
455          <td class="paramkey"></td>
456          <td></td>
457          <td class="paramtype">integer(kind=ip_i4_p), intent(in)&#160;</td>
458          <td class="paramname"><em>msec</em>, </td>
459        </tr>
460        <tr>
461          <td class="paramkey"></td>
462          <td></td>
463          <td class="paramtype">integer(kind=ip_i4_p), intent(out)&#160;</td>
464          <td class="paramname"><em>kinfo</em>&#160;</td>
465        </tr>
466        <tr>
467          <td></td>
468          <td>)</td>
469          <td></td><td></td>
470        </tr>
471      </table>
472</div><div class="memdoc">
473
474<p>OASIS user query to indicate put return code expected at a specified time for a given variable. </p>
475<dl class="params"><dt>Parameters</dt><dd>
476  <table class="params">
477    <tr><td class="paramdir">[in]</td><td class="paramname">varid</td><td>variable id</td></tr>
478    <tr><td class="paramdir">[in]</td><td class="paramname">msec</td><td>model time in seconds</td></tr>
479    <tr><td class="paramdir">[out]</td><td class="paramname">kinfo</td><td>return code </td></tr>
480  </table>
481  </dd>
482</dl>
483
484<p class="definition">Definition at line <a class="el" href="mod__oasis__auxiliary__routines_8_f90_source.html#l00409">409</a> of file <a class="el" href="mod__oasis__auxiliary__routines_8_f90_source.html">mod_oasis_auxiliary_routines.F90</a>.</p>
485
486</div>
487</div>
488<a id="a42c3fe19a188de66499094e988c51938"></a>
489<h2 class="memtitle"><span class="permalink"><a href="#a42c3fe19a188de66499094e988c51938">&#9670;&nbsp;</a></span>oasis_set_couplcomm()</h2>
490
491<div class="memitem">
492<div class="memproto">
493      <table class="memname">
494        <tr>
495          <td class="memname">subroutine, public mod_oasis_auxiliary_routines::oasis_set_couplcomm </td>
496          <td>(</td>
497          <td class="paramtype">integer (kind=ip_intwp_p), intent(in)&#160;</td>
498          <td class="paramname"><em>localcomm</em>, </td>
499        </tr>
500        <tr>
501          <td class="paramkey"></td>
502          <td></td>
503          <td class="paramtype">integer (kind=ip_intwp_p), intent(inout), optional&#160;</td>
504          <td class="paramname"><em>kinfo</em>&#160;</td>
505        </tr>
506        <tr>
507          <td></td>
508          <td>)</td>
509          <td></td><td></td>
510        </tr>
511      </table>
512</div><div class="memdoc">
513
514<p>OASIS user call to specify a local communicator. </p>
515<dl class="params"><dt>Parameters</dt><dd>
516  <table class="params">
517    <tr><td class="paramdir">[in]</td><td class="paramname">localcomm</td><td>MPI communicator</td></tr>
518    <tr><td class="paramdir">[in,out]</td><td class="paramname">kinfo</td><td>return code </td></tr>
519  </table>
520  </dd>
521</dl>
522
523<p class="definition">Definition at line <a class="el" href="mod__oasis__auxiliary__routines_8_f90_source.html#l00072">72</a> of file <a class="el" href="mod__oasis__auxiliary__routines_8_f90_source.html">mod_oasis_auxiliary_routines.F90</a>.</p>
524
525</div>
526</div>
527<a id="a71bf70a87b2d4ce86016bbb93d9edd73"></a>
528<h2 class="memtitle"><span class="permalink"><a href="#a71bf70a87b2d4ce86016bbb93d9edd73">&#9670;&nbsp;</a></span>oasis_set_debug()</h2>
529
530<div class="memitem">
531<div class="memproto">
532      <table class="memname">
533        <tr>
534          <td class="memname">subroutine, public mod_oasis_auxiliary_routines::oasis_set_debug </td>
535          <td>(</td>
536          <td class="paramtype">integer (kind=ip_intwp_p), intent(in)&#160;</td>
537          <td class="paramname"><em>debug</em>, </td>
538        </tr>
539        <tr>
540          <td class="paramkey"></td>
541          <td></td>
542          <td class="paramtype">integer (kind=ip_intwp_p), intent(inout), optional&#160;</td>
543          <td class="paramname"><em>kinfo</em>&#160;</td>
544        </tr>
545        <tr>
546          <td></td>
547          <td>)</td>
548          <td></td><td></td>
549        </tr>
550      </table>
551</div><div class="memdoc">
552
553<p>OASIS user interface to set debug level. </p>
554<dl class="params"><dt>Parameters</dt><dd>
555  <table class="params">
556    <tr><td class="paramdir">[in]</td><td class="paramname">debug</td><td>debug level</td></tr>
557    <tr><td class="paramdir">[in,out]</td><td class="paramname">kinfo</td><td>return code </td></tr>
558  </table>
559  </dd>
560</dl>
561
562<p class="definition">Definition at line <a class="el" href="mod__oasis__auxiliary__routines_8_f90_source.html#l00183">183</a> of file <a class="el" href="mod__oasis__auxiliary__routines_8_f90_source.html">mod_oasis_auxiliary_routines.F90</a>.</p>
563
564</div>
565</div>
566<h2 class="groupheader">Variable Documentation</h2>
567<a id="a284fcb0384dbbf081a6930256fc12b27"></a>
568<h2 class="memtitle"><span class="permalink"><a href="#a284fcb0384dbbf081a6930256fc12b27">&#9670;&nbsp;</a></span>istatus</h2>
569
570<div class="memitem">
571<div class="memproto">
572<table class="mlabels">
573  <tr>
574  <td class="mlabels-left">
575      <table class="memname">
576        <tr>
577          <td class="memname">integer(kind=ip_i4_p), dimension(mpi_status_size) mod_oasis_auxiliary_routines::istatus</td>
578        </tr>
579      </table>
580  </td>
581  <td class="mlabels-right">
582<span class="mlabels"><span class="mlabel">private</span></span>  </td>
583  </tr>
584</table>
585</div><div class="memdoc">
586
587<p class="definition">Definition at line <a class="el" href="mod__oasis__auxiliary__routines_8_f90_source.html#l00034">34</a> of file <a class="el" href="mod__oasis__auxiliary__routines_8_f90_source.html">mod_oasis_auxiliary_routines.F90</a>.</p>
588
589</div>
590</div>
591</div><!-- contents -->
592<!-- start footer part -->
593<hr class="footer"/><address class="footer"><small>
594Generated on Fri Jun 29 2018 20:52:29 for Oasis3-MCT by &#160;<a href="http://www.doxygen.org/index.html">
595<img class="footer" src="doxygen.png" alt="doxygen"/>
596</a> 1.8.13
597</small></address>
598</body>
599</html>
Note: See TracBrowser for help on using the repository browser.