source: trunk/SRC/Documentation/idldoc_html_output/Interpolation/lbcorca.html

Last change on this file was 402, checked in by smasson, 15 years ago

update documentation
File size: 6.3 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>lbcorca.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="lbcorca.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../Interpolation//lbcorca.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="inrecgrid.html">&lt;&lt;prev file</a> | <a href="ll_narcs_distances.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="lbcorca.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">Interpolation/</a></h1>
82      <h2 class="pro_file">lbcorca.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 check the lateral boundaries condition (east-west and north) of a 2D/3D/4D array
91 located on a grif of the orca grid familly.
92</div>
93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_lbcorca">
106
107          <h2><a class="top" href="#container">top</a>lbcorca <span class="categories">
108 ORCA grid
109</span></h2>
110       
111          <p class="header">
112            <span class="result">result = </span>lbcorca(<span class="result"><a href="#_lbcorca_param_arr">arr</a>, <a href="#_lbcorca_param_grid">grid</a>[, <a href="#_lbcorca_param_psign">psign</a>]</span>[, <a href="#_lbcorca_keyword_VERBOSE">VERBOSE</a>=<span class="result">0 or 1</span>][, <a href="#_lbcorca_keyword_CORRECTION">CORRECTION</a>=<span class="result">0 or 1</span>])</p>
113       
114          <div class="comments">
115</div>
116
117          <h3>Return value</h3><div class="preformat">
118 the number of wrong lateral boundary condition found in arr (-> 0 means arr is OK)
119</div>
120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_lbcorca_param_arr">arr&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126              <span class="attr">in</span>
127             
128             
129              <span class="attr">required</span>
130             
131              <span class="attr">type:</span> <span class="value">2D/3D/4D array</span>
132             
133             
134            </h4>
135       
136          <div class="comments">
137 array to be checked (and corrected if CORRECTION keyword is activated)
138</div>
139           
140            <h4 id="_lbcorca_param_grid">grid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
141              <span class="attr">in</span>
142             
143             
144              <span class="attr">required</span>
145             
146              <span class="attr">type:</span> <span class="value">scalar string</span>
147             
148             
149            </h4>
150       
151          <div class="comments">
152 type of grid-point on which is located the array: 'T', 'U', 'V' or 'F'
153 </div>
154           
155            <h4 id="_lbcorca_param_psign">psign&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
156              <span class="attr">in</span>
157             
158              <span class="attr">optional</span>
159             
160             
161              <span class="attr">type:</span> <span class="value">1. or -1.</span>
162              <span class="attr">default:</span> <span class="value">1.</span>
163             
164            </h4>
165       
166          <div class="comments">
167</div>
168           
169
170         
171
172         
173
174            <h3>Keywords</h3>
175           
176            <h4 id="_lbcorca_keyword_VERBOSE">VERBOSE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
177             
178             
179              <span class="attr">optional</span>
180             
181             
182              <span class="attr">type:</span> <span class="value">0 or 1</span>
183              <span class="attr">default:</span> <span class="value">0</span>
184             
185            </h4>
186       
187            <div class="comments">
188 Activate to get error information when getting a wrong lateral boundaries condition
189</div>
190           
191            <h4 id="_lbcorca_keyword_CORRECTION">CORRECTION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
192             
193             
194              <span class="attr">optional</span>
195             
196             
197              <span class="attr">type:</span> <span class="value">0 or 1</span>
198              <span class="attr">default:</span> <span class="value">0</span>
199             
200            </h4>
201       
202            <div class="comments">
203 Activate to correct the wrong lateral boundary condition in arr (in that case arr is changed)
204</div>
205           
206         
207
208          <h3>Examples</h3><div class="preformat">
209
210   IDL> @tst_initorca2
211   IDL> a = dist(jpiglo, jpjglo)
212   IDL> print, lbcorca(a, 'T')
213   IDL> dummy = lbcorca(a, 'T', /correction)
214   IDL> print, lbcorca(a, 'T')
215</div>
216          <h3>Version history</h3>
217         
218          <h4>Version</h4><div class="preformat">
219 $Id: lbcorca.pro 371 2008-08-07 09:32:02Z pinsard $
220</div>
221          <h4>History</h4><div class="preformat">
222    Mai 2007: Creation, smasson@locean-ipsl.upmc.fr
223</div>
224         
225         
226          <h3>Known issues</h3>
227         
228         
229         
230          <h4>Restrictions</h4><div class="preformat">
231 only ORCA2, ORCA05 and ORCA025 are coded (but others are very easy to add...)
232</div>
233       
234         
235         
236         
237         
238         
239         
240         
241       
242          <h3>Statistics</h3>
243          <table class="statistics">
244            <tr><td>McCabe cyclic</td><td>          55</td></tr>
245            <tr><td>McCabe essential</td><td>           1</td></tr>
246            <tr><td>McCabe modular design</td><td>           1</td></tr>
247          </table>
248         
249       
250        </div>
251       
252      </div>
253
254     
255
256      <div id="tagline">Produced by IDLdoc 2.0.</div>
257
258    </div>
259
260  </body>
261</html>
Note: See TracBrowser for help on using the repository browser.