source: CPL/oasis3-mct/branches/OASIS3-MCT_5.0_branch/doc/doxygen/html/namespacemod__oasis__mem.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: 11.4 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_mem 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_mem Module Reference</div>  </div>
66</div><!--header-->
67<div class="contents">
68
69<p>Provides methods for querying memory use. 
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:a104b7e7e85cd79e731a6e12a14358bbb"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemod__oasis__mem.html#a104b7e7e85cd79e731a6e12a14358bbb">oasis_mem_init</a> (iunit)</td></tr>
75<tr class="memdesc:a104b7e7e85cd79e731a6e12a14358bbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize memory conversion to MB.  <a href="#a104b7e7e85cd79e731a6e12a14358bbb">More...</a><br /></td></tr>
76<tr class="separator:a104b7e7e85cd79e731a6e12a14358bbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
77<tr class="memitem:a2e20a40b48c7a7572f72da1b5d109ce3"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemod__oasis__mem.html#a2e20a40b48c7a7572f72da1b5d109ce3">oasis_mem_getusage</a> (r_msize, r_mrss)</td></tr>
78<tr class="memdesc:a2e20a40b48c7a7572f72da1b5d109ce3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determine memory use.  <a href="#a2e20a40b48c7a7572f72da1b5d109ce3">More...</a><br /></td></tr>
79<tr class="separator:a2e20a40b48c7a7572f72da1b5d109ce3"><td class="memSeparator" colspan="2">&#160;</td></tr>
80<tr class="memitem:ac628b504553edbe9345cd070a8db2634"><td class="memItemLeft" align="right" valign="top">subroutine, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemod__oasis__mem.html#ac628b504553edbe9345cd070a8db2634">oasis_mem_print</a> (iunit, string)</td></tr>
81<tr class="memdesc:ac628b504553edbe9345cd070a8db2634"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print memory use.  <a href="#ac628b504553edbe9345cd070a8db2634">More...</a><br /></td></tr>
82<tr class="separator:ac628b504553edbe9345cd070a8db2634"><td class="memSeparator" colspan="2">&#160;</td></tr>
83</table><table class="memberdecls">
84<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
85Variables</h2></td></tr>
86<tr class="memitem:a7c262f1c120ed57d527ee3de91552ee9"><td class="memItemLeft" align="right" valign="top">real(ip_double_p)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemod__oasis__mem.html#a7c262f1c120ed57d527ee3de91552ee9">mb_blk</a> = 1.0_ip_double_p</td></tr>
87<tr class="separator:a7c262f1c120ed57d527ee3de91552ee9"><td class="memSeparator" colspan="2">&#160;</td></tr>
88<tr class="memitem:aad83c95e1a17a31825eb9c4e1c663aa1"><td class="memItemLeft" align="right" valign="top">logical&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemod__oasis__mem.html#aad83c95e1a17a31825eb9c4e1c663aa1">initset</a> = .false.</td></tr>
89<tr class="separator:aad83c95e1a17a31825eb9c4e1c663aa1"><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>Provides methods for querying memory use. </p>
93</div><h2 class="groupheader">Function/Subroutine Documentation</h2>
94<a id="a2e20a40b48c7a7572f72da1b5d109ce3"></a>
95<h2 class="memtitle"><span class="permalink"><a href="#a2e20a40b48c7a7572f72da1b5d109ce3">&#9670;&nbsp;</a></span>oasis_mem_getusage()</h2>
96
97<div class="memitem">
98<div class="memproto">
99      <table class="memname">
100        <tr>
101          <td class="memname">subroutine, public mod_oasis_mem::oasis_mem_getusage </td>
102          <td>(</td>
103          <td class="paramtype">real(ip_double_p), intent(out)&#160;</td>
104          <td class="paramname"><em>r_msize</em>, </td>
105        </tr>
106        <tr>
107          <td class="paramkey"></td>
108          <td></td>
109          <td class="paramtype">real(ip_double_p), intent(out)&#160;</td>
110          <td class="paramname"><em>r_mrss</em>&#160;</td>
111        </tr>
112        <tr>
113          <td></td>
114          <td>)</td>
115          <td></td><td></td>
116        </tr>
117      </table>
118</div><div class="memdoc">
119
120<p>Determine memory use. </p>
121<dl class="params"><dt>Parameters</dt><dd>
122  <table class="params">
123    <tr><td class="paramdir">[out]</td><td class="paramname">r_msize</td><td>memory usage value</td></tr>
124    <tr><td class="paramdir">[out]</td><td class="paramname">r_mrss</td><td>memory usage value </td></tr>
125  </table>
126  </dd>
127</dl>
128
129<p class="definition">Definition at line <a class="el" href="mod__oasis__mem_8_f90_source.html#l00088">88</a> of file <a class="el" href="mod__oasis__mem_8_f90_source.html">mod_oasis_mem.F90</a>.</p>
130
131</div>
132</div>
133<a id="a104b7e7e85cd79e731a6e12a14358bbb"></a>
134<h2 class="memtitle"><span class="permalink"><a href="#a104b7e7e85cd79e731a6e12a14358bbb">&#9670;&nbsp;</a></span>oasis_mem_init()</h2>
135
136<div class="memitem">
137<div class="memproto">
138      <table class="memname">
139        <tr>
140          <td class="memname">subroutine, public mod_oasis_mem::oasis_mem_init </td>
141          <td>(</td>
142          <td class="paramtype">integer, optional&#160;</td>
143          <td class="paramname"><em>iunit</em></td><td>)</td>
144          <td></td>
145        </tr>
146      </table>
147</div><div class="memdoc">
148
149<p>Initialize memory conversion to MB. </p>
150<dl class="params"><dt>Parameters</dt><dd>
151  <table class="params">
152    <tr><td class="paramname">iunit</td><td>output unit number for optional writes </td></tr>
153  </table>
154  </dd>
155</dl>
156
157<p class="definition">Definition at line <a class="el" href="mod__oasis__mem_8_f90_source.html#l00034">34</a> of file <a class="el" href="mod__oasis__mem_8_f90_source.html">mod_oasis_mem.F90</a>.</p>
158
159</div>
160</div>
161<a id="ac628b504553edbe9345cd070a8db2634"></a>
162<h2 class="memtitle"><span class="permalink"><a href="#ac628b504553edbe9345cd070a8db2634">&#9670;&nbsp;</a></span>oasis_mem_print()</h2>
163
164<div class="memitem">
165<div class="memproto">
166      <table class="memname">
167        <tr>
168          <td class="memname">subroutine, public mod_oasis_mem::oasis_mem_print </td>
169          <td>(</td>
170          <td class="paramtype">integer, intent(in)&#160;</td>
171          <td class="paramname"><em>iunit</em>, </td>
172        </tr>
173        <tr>
174          <td class="paramkey"></td>
175          <td></td>
176          <td class="paramtype">character(len=*), intent(in), optional&#160;</td>
177          <td class="paramname"><em>string</em>&#160;</td>
178        </tr>
179        <tr>
180          <td></td>
181          <td>)</td>
182          <td></td><td></td>
183        </tr>
184      </table>
185</div><div class="memdoc">
186
187<p>Print memory use. </p>
188<dl class="params"><dt>Parameters</dt><dd>
189  <table class="params">
190    <tr><td class="paramdir">[in]</td><td class="paramname">iunit</td><td>unit number to write to</td></tr>
191    <tr><td class="paramdir">[in]</td><td class="paramname">string</td><td>optional string </td></tr>
192  </table>
193  </dd>
194</dl>
195
196<p class="definition">Definition at line <a class="el" href="mod__oasis__mem_8_f90_source.html#l00119">119</a> of file <a class="el" href="mod__oasis__mem_8_f90_source.html">mod_oasis_mem.F90</a>.</p>
197
198</div>
199</div>
200<h2 class="groupheader">Variable Documentation</h2>
201<a id="aad83c95e1a17a31825eb9c4e1c663aa1"></a>
202<h2 class="memtitle"><span class="permalink"><a href="#aad83c95e1a17a31825eb9c4e1c663aa1">&#9670;&nbsp;</a></span>initset</h2>
203
204<div class="memitem">
205<div class="memproto">
206<table class="mlabels">
207  <tr>
208  <td class="mlabels-left">
209      <table class="memname">
210        <tr>
211          <td class="memname">logical mod_oasis_mem::initset = .false.</td>
212        </tr>
213      </table>
214  </td>
215  <td class="mlabels-right">
216<span class="mlabels"><span class="mlabel">private</span></span>  </td>
217  </tr>
218</table>
219</div><div class="memdoc">
220
221<p class="definition">Definition at line <a class="el" href="mod__oasis__mem_8_f90_source.html#l00025">25</a> of file <a class="el" href="mod__oasis__mem_8_f90_source.html">mod_oasis_mem.F90</a>.</p>
222
223</div>
224</div>
225<a id="a7c262f1c120ed57d527ee3de91552ee9"></a>
226<h2 class="memtitle"><span class="permalink"><a href="#a7c262f1c120ed57d527ee3de91552ee9">&#9670;&nbsp;</a></span>mb_blk</h2>
227
228<div class="memitem">
229<div class="memproto">
230<table class="mlabels">
231  <tr>
232  <td class="mlabels-left">
233      <table class="memname">
234        <tr>
235          <td class="memname">real(ip_double_p) mod_oasis_mem::mb_blk = 1.0_ip_double_p</td>
236        </tr>
237      </table>
238  </td>
239  <td class="mlabels-right">
240<span class="mlabels"><span class="mlabel">private</span></span>  </td>
241  </tr>
242</table>
243</div><div class="memdoc">
244
245<p class="definition">Definition at line <a class="el" href="mod__oasis__mem_8_f90_source.html#l00024">24</a> of file <a class="el" href="mod__oasis__mem_8_f90_source.html">mod_oasis_mem.F90</a>.</p>
246
247</div>
248</div>
249</div><!-- contents -->
250<!-- start footer part -->
251<hr class="footer"/><address class="footer"><small>
252Generated on Fri Jun 29 2018 20:52:29 for Oasis3-MCT by &#160;<a href="http://www.doxygen.org/index.html">
253<img class="footer" src="doxygen.png" alt="doxygen"/>
254</a> 1.8.13
255</small></address>
256</body>
257</html>
Note: See TracBrowser for help on using the repository browser.