source: trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/lbcorca.html @ 402

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

update documentation
File size: 5.3 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>lbcorca.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="inrecgrid.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="ll_narcs_distances.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Interpolation/</font></h1>
58    <h2>lbcorca.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 check the lateral boundaries condition (east-west and north) of a 2D/3D/4D array
65 located on a grif of the orca grid familly.
66
67
68   
69
70     
71      <a name="#_lbcorca"></a>
72
73      <h2>lbcorca  <font size="-1" color="#006633">
74 ORCA grid
75</font></h2>
76
77      <p><font face="Courier"><i>result = </i>lbcorca(<i><a href="#_lbcorca_keyword_arr">arr</a>, <a href="#_lbcorca_keyword_grid">grid</a>[, <a href="#_lbcorca_keyword_psign">psign</a>]</i>[, <a href="#_lbcorca_keyword_VERBOSE">VERBOSE</a>=<i>0 or 1</i>][, <a href="#_lbcorca_keyword_CORRECTION">CORRECTION</a>=<i>0 or 1</i>])</font></p>
78
79   
80
81
82    <h3>Return value</h3>
83 the number of wrong lateral boundary condition found in arr (-> 0 means arr is OK)
84
85
86   
87    <h3>Parameters</h3>
88   
89
90    <a name="#_lbcorca_keyword_arr"></a>
91    <h4>arr&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
92      <font size="-1" color="#006633">in</font>
93     
94     
95      <font size="-1" color="#006633">required</font>
96     
97      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2D/3D/4D array</i></font>
98     
99     
100    </h4>
101
102   
103 array to be checked (and corrected if CORRECTION keyword is activated)
104
105   
106
107    <a name="#_lbcorca_keyword_grid"></a>
108    <h4>grid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
109      <font size="-1" color="#006633">in</font>
110     
111     
112      <font size="-1" color="#006633">required</font>
113     
114      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
115     
116     
117    </h4>
118
119   
120 type of grid-point on which is located the array: 'T', 'U', 'V' or 'F'
121 
122   
123
124    <a name="#_lbcorca_keyword_psign"></a>
125    <h4>psign&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126      <font size="-1" color="#006633">in</font>
127     
128      <font size="-1" color="#006633">optional</font>
129     
130     
131      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>1. or -1.</i></font>
132      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>1.</i></font>
133     
134    </h4>
135
136   
137
138   
139   
140
141   
142    <h3>Keywords</h3>
143
144   
145    <a name="#_lbcorca_keyword_VERBOSE"></a>
146    <h4>VERBOSE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
147     
148     
149      <font size="-1" color="#006633">optional</font>
150     
151     
152      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>0 or 1</i></font>
153      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
154     
155    </h4>
156
157   
158 Activate to get error information when getting a wrong lateral boundaries condition
159
160   
161    <a name="#_lbcorca_keyword_CORRECTION"></a>
162    <h4>CORRECTION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
163     
164     
165      <font size="-1" color="#006633">optional</font>
166     
167     
168      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>0 or 1</i></font>
169      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
170     
171    </h4>
172
173   
174 Activate to correct the wrong lateral boundary condition in arr (in that case arr is changed)
175
176   
177   
178
179    <h3>Examples</h3><pre>
180
181   IDL> @tst_initorca2
182   IDL> a = dist(jpiglo, jpjglo)
183   IDL> print, lbcorca(a, 'T')
184   IDL> dummy = lbcorca(a, 'T', /correction)
185   IDL> print, lbcorca(a, 'T')
186
187    </pre><h3>Version history</h3>
188   
189    <h4>Version</h4>
190 $Id: lbcorca.pro 371 2008-08-07 09:32:02Z pinsard $
191
192    <h4>History</h4>
193    Mai 2007: Creation, smasson@locean-ipsl.upmc.fr
194
195   
196
197    <h3>Known issues</h3>
198   
199   
200   
201    <h4>Restrictions</h4>
202 only ORCA2, ORCA05 and ORCA025 are coded (but others are very easy to add...)
203
204
205   
206   
207   
208   
209   
210   
211   
212
213    <font size="-3"><p>&nbsp;</p></font>
214    <hr size="1" color="#CCCCCC"/>
215     
216
217   
218
219    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
220
221  </body>
222</html>
Note: See TracBrowser for help on using the repository browser.