source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/definetri.html @ 89

Last change on this file since 89 was 89, checked in by pinsard, 18 years ago

add idldoc html output. see Documentation/idldoc_html_output/index.html
File size: 5.8 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.pro (IDLdoc API 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.pro (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API 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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html?format=raw" 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="completecointerre.html">&lt;&lt;prev file</a> | <a href="definetri_e.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="definetri.html" target="_TOP">view single page</a> | <a href="./../../index.html?format=raw" 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?format=raw">ToBeReviewed/TRIANGULATION/</a></h1>
82      <h2 class="pro_file">definetri.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_definetri">
103
104          <h2><a class="top" href="#container">top</a>definetri </h2>
105       
106          <p class="header">
107            <span class="result">result = </span>definetri(<span class="result"><a href="#_definetri_param_nx">nx</a>, <a href="#_definetri_param_ny">ny</a>, <a href="#_definetri_param_downward">downward</a></span>)</p>
108       
109          <div class="comments">
110 NAME:definetri
111
112 PURPOSE:Define a triangulation array like TRIANGULATE.
113         But in a VERY SIMPLE CASE:
114 the points are regulary-gridded on nx*ny array.
115 Find a Delaunay triangulation for this set of points is easy:
116 Points define (nx-1)*(ny-1) rectangles which we can cut in 2
117 triangles. cf. figure above
118
119
120      ny-1*---*---*. . . . . .*---*---*
121          |  /|  /|           |  /|  /|     
122          | / | / |           | / | / |
123          |/  |/  |           |/  |/  |
124      ny-2*---*---*. . . . . .*---*---*   
125          .       .           .       .
126          .       .           .       .
127          .       .           .       .
128         1*---*---*. . . . . .*---*---*
129          |  /|  /|           |  /|  /|
130          | / | / |           | / | / |
131          |/  |/  |           |/  |/  |
132         0*---*---*. . . . . .*---*---* 
133          0   1   2        nx-3  nx-2 nx-1
134
135  You have 2 ways to cut a rectangle:
136      1) the upward diagonal       2) the downward diagonal
137
138          *---*                        *---*
139          |  /|                        |\  |
140          | / |                        | \ |
141          |/  |                        |  \|
142          *---*                        *---* 
143
144
145 CATEGORY: to understand how TRIANGULATE and TRIANGULATION work!
146
147 CALLING SEQUENCE:triangles=definetri(nx, ny [,downward])
148 
149 INPUTS: nx and ny are the array dimensions
150
151 OPTIONAL INPUTS:
152
153        downward: When downward is undefine all rectangles are cut
154        in using the upward diagonal. Downward is a vector which
155        contains the rectangles numbers which are cut in using the
156        downward diagonal.
157        The rectangle number is define by the index (in a nx*ny
158        vector) of the lower-left corner of the rectangle.
159
160 KEYWORD PARAMETERS:
161
162 OUTPUTS:
163        triangles is a 2d array and is dimensions are 3 and
164        2*(nx-1)*(ny-1)
165        triangles is define like in the TRIANGULATE procedure.
166       
167
168 OPTIONAL OUTPUTS:
169
170 COMMON BLOCKS:
171
172 SIDE EFFECTS:
173
174 RESTRICTIONS:
175
176 PROCEDURE:
177
178 EXAMPLE:
179
180 triangles=definetri(3,3,[1,3])
181 triangles will be a this kind of triangulation:
182
183          *---*---*
184          |\  |  /|
185          | \ | / |
186          |  \|/  |
187          *---*---*
188          |  /|\  |
189          | / | \ |
190          |/  |  \|
191          *---*---*
192
193</div>
194
195         
196
197         
198            <h3>Parameters</h3>
199       
200           
201            <h4 id="_definetri_param_nx">nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
202             
203             
204             
205             
206             
207             
208             
209             
210            </h4>
211       
212          <div class="comments"></div>
213           
214            <h4 id="_definetri_param_ny">ny&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
215             
216             
217             
218             
219             
220             
221             
222             
223            </h4>
224       
225          <div class="comments"></div>
226           
227            <h4 id="_definetri_param_downward">downward&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
228             
229             
230             
231             
232             
233             
234             
235             
236            </h4>
237       
238          <div class="comments"></div>
239           
240
241         
242
243         
244
245         
246         
247         
248         
249         
250         
251         
252         
253         
254         
255         
256         
257       
258         
259         
260         
261         
262         
263         
264         
265       
266         
267       
268        </div>
269       
270      </div>
271
272     
273
274      <div id="tagline">Produced by IDLdoc 2.0.</div>
275
276    </div>
277
278  </body>
279</html>
Note: See TracBrowser for help on using the repository browser.