Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/definetri_e.html @ 191

Last change on this file since 191 was 191, checked in by pinsard, 18 years ago
remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output
File size: 7.7 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>definetri_e.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="definetri_e.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="../../../../ToBeReviewed/TRIANGULATION//definetri_e.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 documentation</td>
67	</tr>
68	</table>
69
70	</div>
71
72	<div id="secondary_navbar">
73
74	<a href="definetri.html"><<prev file</a> \| <a href="dessinetri.html">next file >></a>    <a href="definetri_e.html" target="_TOP">view single page</a> \| <a href="./../../index.html" target="_TOP">view frames</a>    summary: fields \| <a href="#routine_summary">routine</a>    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">ToBeReviewed/TRIANGULATION/</a></h1>
82	<h2 class="pro_file">definetri_e.pro</h2>
83
84	<div id="file_attr">
85	<dl>
86	</dl>
87	</div>
88
89	<div id="file_comments">
90
91
92
93	Define a triangulation array like TRIANGULATE but for a
94	E-grid type
95	</div>
96
97
98
99
100
101
102
103
104	<div id="routine_summary">
105	<h2>Routine summary</h2>
106
107	<dl>
108
109	<dt><p><a href="#_numtri"><span class="result">result = </span>numtri(<span class="result">index, nx, ny</span>)</a></p><dt>
110	<dd></dd>
111
112	<dt><p><a href="#_definetri_e"><span class="result">result = </span>definetri_e(<span class="result">nx, ny[, singular]</span>, SHIFTED=<span class="result">SHIFTED</span>)</a></p><dt>
113	<dd> </dd>
114
115	</dl>
116	</div>
117
118
119	<div id="routine_details">
120
121
122	<div class="routine_details" id="_numtri">
123
124	<h2><a class="top" href="#container">top</a>numtri <span class="categories">
125
126	</span></h2>
127
128	<p class="header">
129	<span class="result">result = </span>numtri(<span class="result"><a href="#_numtri_param_index">index</a>, <a href="#_numtri_param_nx">nx</a>, <a href="#_numtri_param_ny">ny</a></span>)</p>
130
131	<div class="comments"></div>
132
133	<h3>Return value</h3><div class="preformat">
134
135	</div>
136
137
138	<h3>Parameters</h3>
139
140
141	<h4 id="_numtri_param_index">index
142
143
144
145
146
147
148
149
150	</h4>
151
152	<div class="comments">
153	It is the tick mark index which starts at 0.
154	</div>
155
156	<h4 id="_numtri_param_nx">nx
157	<span class="attr">in</span>
158
159
160	<span class="attr">required</span>
161
162
163
164
165	</h4>
166
167	<div class="comments">
168	The x dimension array
169	</div>
170
171	<h4 id="_numtri_param_ny">ny
172	<span class="attr">in</span>
173
174
175	<span class="attr">required</span>
176
177
178
179
180	</h4>
181
182	<div class="comments">
183	The y dimension array
184
185	</div>
186
187
188
189
190
191
192	<h3>Examples</h3><div class="preformat">
193
194	</div>
195	<h3>Version history</h3>
196
197	<h4>Version</h4><div class="preformat">
198	$Id: definetri_e.pro 186 2006-09-20 10:50:37Z pinsard $</div>
199	<h4>History</h4><div class="preformat">
200
201	</div>
202
203
204	<h3>Known issues</h3>
205
206
207
208	<h4>Restrictions</h4><div class="preformat">
209
210	</div>
211
212
213
214
215
216
217
218
219
220	<h3>Statistics</h3>
221	<table class="statistics">
222	<tr><td>McCabe cyclic</td><td> 1</td></tr>
223	<tr><td>McCabe essential</td><td> 1</td></tr>
224	<tr><td>McCabe modular design</td><td> 1</td></tr>
225	</table>
226
227
228	</div>
229
230
231	<div class="routine_details" id="_definetri_e">
232
233	<h2><a class="top" href="#container">top</a>definetri_e <span class="categories">
234	Make contours with E-grid type
235	</span></h2>
236
237	<p class="header">
238	<span class="result">result = </span>definetri_e(<span class="result"><a href="#_definetri_e_param_nx">nx</a>, <a href="#_definetri_e_param_ny">ny</a>[, <a href="#_definetri_e_param_singular">singular</a>]</span>, <a href="#_definetri_e_keyword_SHIFTED">SHIFTED</a>=<span class="result">SHIFTED</span>)</p>
239
240	<div class="comments">
241	</div>
242
243	<h3>Return value</h3><div class="preformat">
244	Triangles is a 2d array and is dimensions are 3 and (nx-1)*(ny-1).
245	Triangles is defined like in the TRIANGULATE procedure.
246	</div>
247
248
249	<h3>Parameters</h3>
250
251
252	<h4 id="_definetri_e_param_nx">nx
253	<span class="attr">in</span>
254
255
256	<span class="attr">required</span>
257
258
259
260
261	</h4>
262
263	<div class="comments">
264	The x dimension array
265	</div>
266
267	<h4 id="_definetri_e_param_ny">ny
268	<span class="attr">in</span>
269
270
271	<span class="attr">required</span>
272
273
274
275
276	</h4>
277
278	<div class="comments">
279	The y dimension array
280	</div>
281
282	<h4 id="_definetri_e_param_singular">singular
283	<span class="attr">in</span>
284
285	<span class="attr">optional</span>
286
287
288
289
290
291	</h4>
292
293	<div class="comments">
294	When singular is undefined all rectangles are cut in using the vertical
295	diagonal.
296	Singular is a vector which contains the rectangles numbers which are cut in
297	using the horizontal diagonal.
298	The rectangle number is defined by the index (in a nx*ny vector) of the
299	lower-left corner of the rectangle.
300	</div>
301
302
303
304
305
306
307	<h3>Keywords</h3>
308
309	<h4 id="_definetri_e_keyword_SHIFTED">SHIFTED
310
311
312
313
314
315
316
317
318	</h4>
319
320	<div class="comments">
321
322	</div>
323
324
325
326
327	<h3>Version history</h3>
328
329	<h4>Version</h4><div class="preformat">
330	$Id: definetri_e.pro 186 2006-09-20 10:50:37Z pinsard $
331	</div>
332	<h4>History</h4><div class="preformat">
333	Sebastien Masson (smlod@ipsl.jussieu.fr)
334	June 2001
335	</div>
336
337
338	<h3>Known issues</h3>
339
340
341	<h4>Todo items</h4><div class="preformat">
342	seb: documenter SHIFTED</div>
343
344
345
346
347
348
349
350
351
352
353	<h3>Statistics</h3>
354	<table class="statistics">
355	<tr><td>McCabe cyclic</td><td> 4</td></tr>
356	<tr><td>McCabe essential</td><td> 1</td></tr>
357	<tr><td>McCabe modular design</td><td> 1</td></tr>
358	</table>
359
360
361	</div>
362
363	</div>
364
365
366
367	<div id="tagline">Produced by IDLdoc 2.0.</div>
368
369	</div>
370
371	</body>
372	</html>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: