source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/div.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: 4.4 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>div.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="div.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="determ3.html">&lt;&lt;prev file</a> | <a href="floatlevel2depth.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="div.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/CALCULS/</a></h1>
82      <h2 class="pro_file">div.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="_div">
103
104          <h2><a class="top" href="#container">top</a>div </h2>
105       
106          <p class="header">
107            <span class="result">result = </span>div(<span class="result"><a href="#_div_param_uu">uu</a>, <a href="#_div_param_vv">vv</a></span>)</p>
108       
109          <div class="comments">
110 NAME:div
111
112 PURPOSE:calcule la divergence d'un champ 2D
113
114 CATEGORY:calcule sur les matrices
115
116 CALLING SEQUENCE:res=div(u,v)
117
118 INPUTS:
119       u et v deux matrices representant les coordonnes d''un
120       champ de vecteur
121
122 KEYWORD PARAMETERS:
123
124 OUTPUTS:res: une matrice 2d
125
126 COMMON BLOCKS:
127        common.pro
128
129 SIDE EFFECTS:
130
131 RESTRICTIONS:
132 les matrices u et v peuvent de 2 a 4 dimensions.
133 attention pour distinger les differents configurations de u et v
134 (xy, xyz, xyt, xyzt), on regarde la variable du common
135        -time qui contient le calendrier en jour julien d''IDL auquel
136        se rapportent u et v ansi que la variable
137        -jpt qui est le nombre de pas de temps a considerer ds time.
138 les tableaux u et v sont decoupes sur le meme domaine
139 geographique. A cause du decalage des grilles T, U, V et F il est
140 possiible que ces 2 tableaux n''aient pas la meme taille et se
141 repportent a des indices differents. Si tel est le cas les tableaux
142 sont redecoupes sur les indices qu'ils ont en commun et le dommaine
143 est redefinit pour qu'il colle a ces indices communs.
144 pour eviter ces redecoupes utiliser le mot cles /memeindice ds
145 domdef.pro
146
147 les points sur le bord du dessin sont mis a !values.f_nan
148
149 EXAMPLE:
150</div>
151
152         
153
154         
155            <h3>Parameters</h3>
156       
157           
158            <h4 id="_div_param_uu">uu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
159             
160             
161             
162             
163             
164             
165             
166             
167            </h4>
168       
169          <div class="comments"></div>
170           
171            <h4 id="_div_param_vv">vv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
172             
173             
174             
175             
176             
177             
178             
179             
180            </h4>
181       
182          <div class="comments"></div>
183           
184
185         
186
187         
188
189         
190         
191         
192         
193         
194         
195         
196         
197         
198         
199         
200         
201       
202         
203         
204         
205         
206         
207         
208         
209       
210         
211       
212        </div>
213       
214      </div>
215
216     
217
218      <div id="tagline">Produced by IDLdoc 2.0.</div>
219
220    </div>
221
222  </body>
223</html>
Note: See TracBrowser for help on using the repository browser.