source: CONFIG_DEVT/IPSLCM6.5_work_ENSEMBLES/oasis3-mct/doc/doxygen/html/interfacemod__oasis__grid_1_1oasis__write__grid.html

Last change on this file 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: 11.2 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_grid::oasis_write_grid 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__grid.html">mod_oasis_grid</a></li><li class="navelem"><a class="el" href="interfacemod__oasis__grid_1_1oasis__write__grid.html">oasis_write_grid</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__grid_1_1oasis__write__grid-members.html">List of all members</a>  </div>
68  <div class="headertitle">
69<div class="title">mod_oasis_grid::oasis_write_grid Interface Reference</div>  </div>
70</div><!--header-->
71<div class="contents">
72
73<p>Generic interface to support writing 4 or 8 byte reals. 
74 <a href="interfacemod__oasis__grid_1_1oasis__write__grid.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:a7eede475150c0fa6692193c940d4268b"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacemod__oasis__grid_1_1oasis__write__grid.html#a7eede475150c0fa6692193c940d4268b">oasis_write_grid_r4</a> (cgrid, nx, ny, lon, lat, partid)</td></tr>
79<tr class="memdesc:a7eede475150c0fa6692193c940d4268b"><td class="mdescLeft">&#160;</td><td class="mdescRight">User interface to set latitudes and longitudes for 4 byte reals.  <a href="#a7eede475150c0fa6692193c940d4268b">More...</a><br /></td></tr>
80<tr class="separator:a7eede475150c0fa6692193c940d4268b"><td class="memSeparator" colspan="2">&#160;</td></tr>
81<tr class="memitem:a31dbc6c9b5268a261b61a005762ffb28"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacemod__oasis__grid_1_1oasis__write__grid.html#a31dbc6c9b5268a261b61a005762ffb28">oasis_write_grid_r8</a> (cgrid, nx, ny, lon, lat, partid)</td></tr>
82<tr class="memdesc:a31dbc6c9b5268a261b61a005762ffb28"><td class="mdescLeft">&#160;</td><td class="mdescRight">User interface to set latitudes and longitudes for 8 byte reals.  <a href="#a31dbc6c9b5268a261b61a005762ffb28">More...</a><br /></td></tr>
83<tr class="separator:a31dbc6c9b5268a261b61a005762ffb28"><td class="memSeparator" colspan="2">&#160;</td></tr>
84</table>
85<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
86<div class="textblock"><p>Generic interface to support writing 4 or 8 byte reals. </p>
87
88<p class="definition">Definition at line <a class="el" href="mod__oasis__grid_8_f90_source.html#l00079">79</a> of file <a class="el" href="mod__oasis__grid_8_f90_source.html">mod_oasis_grid.F90</a>.</p>
89</div><h2 class="groupheader">Member Function/Subroutine Documentation</h2>
90<a id="a7eede475150c0fa6692193c940d4268b"></a>
91<h2 class="memtitle"><span class="permalink"><a href="#a7eede475150c0fa6692193c940d4268b">&#9670;&nbsp;</a></span>oasis_write_grid_r4()</h2>
92
93<div class="memitem">
94<div class="memproto">
95<table class="mlabels">
96  <tr>
97  <td class="mlabels-left">
98      <table class="memname">
99        <tr>
100          <td class="memname">subroutine mod_oasis_grid::oasis_write_grid::oasis_write_grid_r4 </td>
101          <td>(</td>
102          <td class="paramtype">character(len=*), intent(in)&#160;</td>
103          <td class="paramname"><em>cgrid</em>, </td>
104        </tr>
105        <tr>
106          <td class="paramkey"></td>
107          <td></td>
108          <td class="paramtype">integer(kind=ip_intwp_p), intent(in)&#160;</td>
109          <td class="paramname"><em>nx</em>, </td>
110        </tr>
111        <tr>
112          <td class="paramkey"></td>
113          <td></td>
114          <td class="paramtype">integer(kind=ip_intwp_p), intent(in)&#160;</td>
115          <td class="paramname"><em>ny</em>, </td>
116        </tr>
117        <tr>
118          <td class="paramkey"></td>
119          <td></td>
120          <td class="paramtype">real(kind=ip_single_p), dimension(:,:), intent(in)&#160;</td>
121          <td class="paramname"><em>lon</em>, </td>
122        </tr>
123        <tr>
124          <td class="paramkey"></td>
125          <td></td>
126          <td class="paramtype">real(kind=ip_single_p), dimension(:,:), intent(in)&#160;</td>
127          <td class="paramname"><em>lat</em>, </td>
128        </tr>
129        <tr>
130          <td class="paramkey"></td>
131          <td></td>
132          <td class="paramtype">integer(kind=ip_intwp_p), intent(in), optional&#160;</td>
133          <td class="paramname"><em>partid</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>User interface to set latitudes and longitudes for 4 byte reals. </p>
149<dl class="params"><dt>Parameters</dt><dd>
150  <table class="params">
151    <tr><td class="paramdir">[in]</td><td class="paramname">cgrid</td><td>grid name</td></tr>
152    <tr><td class="paramdir">[in]</td><td class="paramname">nx</td><td>global nx size</td></tr>
153    <tr><td class="paramdir">[in]</td><td class="paramname">ny</td><td>global ny size</td></tr>
154    <tr><td class="paramdir">[in]</td><td class="paramname">lon</td><td>longitudes</td></tr>
155    <tr><td class="paramdir">[in]</td><td class="paramname">lat</td><td>latitudes</td></tr>
156    <tr><td class="paramdir">[in]</td><td class="paramname">partid</td><td>partition id if nonglobal data </td></tr>
157  </table>
158  </dd>
159</dl>
160
161<p class="definition">Definition at line <a class="el" href="mod__oasis__grid_8_f90_source.html#l00324">324</a> of file <a class="el" href="mod__oasis__grid_8_f90_source.html">mod_oasis_grid.F90</a>.</p>
162
163</div>
164</div>
165<a id="a31dbc6c9b5268a261b61a005762ffb28"></a>
166<h2 class="memtitle"><span class="permalink"><a href="#a31dbc6c9b5268a261b61a005762ffb28">&#9670;&nbsp;</a></span>oasis_write_grid_r8()</h2>
167
168<div class="memitem">
169<div class="memproto">
170<table class="mlabels">
171  <tr>
172  <td class="mlabels-left">
173      <table class="memname">
174        <tr>
175          <td class="memname">subroutine mod_oasis_grid::oasis_write_grid::oasis_write_grid_r8 </td>
176          <td>(</td>
177          <td class="paramtype">character(len=*), intent(in)&#160;</td>
178          <td class="paramname"><em>cgrid</em>, </td>
179        </tr>
180        <tr>
181          <td class="paramkey"></td>
182          <td></td>
183          <td class="paramtype">integer(kind=ip_intwp_p), intent(in)&#160;</td>
184          <td class="paramname"><em>nx</em>, </td>
185        </tr>
186        <tr>
187          <td class="paramkey"></td>
188          <td></td>
189          <td class="paramtype">integer(kind=ip_intwp_p), intent(in)&#160;</td>
190          <td class="paramname"><em>ny</em>, </td>
191        </tr>
192        <tr>
193          <td class="paramkey"></td>
194          <td></td>
195          <td class="paramtype">real(kind=ip_double_p), dimension(:,:), intent(in)&#160;</td>
196          <td class="paramname"><em>lon</em>, </td>
197        </tr>
198        <tr>
199          <td class="paramkey"></td>
200          <td></td>
201          <td class="paramtype">real(kind=ip_double_p), dimension(:,:), intent(in)&#160;</td>
202          <td class="paramname"><em>lat</em>, </td>
203        </tr>
204        <tr>
205          <td class="paramkey"></td>
206          <td></td>
207          <td class="paramtype">integer(kind=ip_intwp_p), intent(in), optional&#160;</td>
208          <td class="paramname"><em>partid</em>&#160;</td>
209        </tr>
210        <tr>
211          <td></td>
212          <td>)</td>
213          <td></td><td></td>
214        </tr>
215      </table>
216  </td>
217  <td class="mlabels-right">
218<span class="mlabels"><span class="mlabel">private</span></span>  </td>
219  </tr>
220</table>
221</div><div class="memdoc">
222
223<p>User interface to set latitudes and longitudes for 8 byte reals. </p>
224<dl class="params"><dt>Parameters</dt><dd>
225  <table class="params">
226    <tr><td class="paramdir">[in]</td><td class="paramname">cgrid</td><td>grid name</td></tr>
227    <tr><td class="paramdir">[in]</td><td class="paramname">nx</td><td>global nx size</td></tr>
228    <tr><td class="paramdir">[in]</td><td class="paramname">ny</td><td>global ny size</td></tr>
229    <tr><td class="paramdir">[in]</td><td class="paramname">lon</td><td>longitudes</td></tr>
230    <tr><td class="paramdir">[in]</td><td class="paramname">lat</td><td>latitudes</td></tr>
231    <tr><td class="paramdir">[in]</td><td class="paramname">partid</td><td>partition id if nonglobal data </td></tr>
232  </table>
233  </dd>
234</dl>
235
236<p class="definition">Definition at line <a class="el" href="mod__oasis__grid_8_f90_source.html#l00255">255</a> of file <a class="el" href="mod__oasis__grid_8_f90_source.html">mod_oasis_grid.F90</a>.</p>
237
238</div>
239</div>
240<hr/>The documentation for this interface was generated from the following file:<ul>
241<li>/home/globc2/tcraig/oasis3-mct.trunk/lib/psmile/src/<a class="el" href="mod__oasis__grid_8_f90_source.html">mod_oasis_grid.F90</a></li>
242</ul>
243</div><!-- contents -->
244<!-- start footer part -->
245<hr class="footer"/><address class="footer"><small>
246Generated on Fri Jun 29 2018 20:52:29 for Oasis3-MCT by &#160;<a href="http://www.doxygen.org/index.html">
247<img class="footer" src="doxygen.png" alt="doxygen"/>
248</a> 1.8.13
249</small></address>
250</body>
251</html>
Note: See TracBrowser for help on using the repository browser.