Changeset 142 for trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/div.html

Timestamp:

07/21/06 14:47:49 (18 years ago)

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/div.html (modified) (6 diffs)

trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/div.html

@@ -696 +696 @@
       </div>
 
-      <div id="file_comments"></div>
+      <div id="file_comments">
+ calculation of the divergence of a 2d field
+</div>
 
       
@@ -711 +713 @@
         <div class="routine_details" id="_div">
 
-          <h2><a class="top" href="#container">top</a>div </h2>
+          <h2><a class="top" href="#container">top</a>div <span class="categories">
+ Calculation on matrixes
+</span></h2>
         
           <p class="header">
@@ -717 +721 @@
         
           <div class="comments">
- NAME:div
-
- PURPOSE:calcule la divergence d'un champ 2D
-
- CATEGORY:calcule sur les matrices
-
- CALLING SEQUENCE:res=div(u,v)
-
- INPUTS:
-       u et v deux matrices representant les coordonnes d''un
-       champ de vecteur
-
- KEYWORD PARAMETERS:
-
- OUTPUTS:res: une matrice 2d
-
- COMMON BLOCKS:
-        common.pro
-
- SIDE EFFECTS:
-
- RESTRICTIONS:
- les matrices u et v peuvent de 2 a 4 dimensions.
- attention pour distinger les differents configurations de u et v
- (xy, xyz, xyt, xyzt), on regarde la variable du common 
-        -time qui contient le calendrier en jour julien d''IDL auquel
-        se rapportent u et v ansi que la variable 
-        -jpt qui est le nombre de pas de temps a considerer ds time.
- les tableaux u et v sont decoupes sur le meme domaine
- geographique. A cause du decalage des grilles T, U, V et F il est
- possiible que ces 2 tableaux n''aient pas la meme taille et se
- repportent a des indices differents. Si tel est le cas les tableaux
- sont redecoupes sur les indices qu'ils ont en commun et le dommaine
- est redefinit pour qu'il colle a ces indices communs.
- pour eviter ces redecoupes utiliser le mot cles /memeindice ds
- domdef.pro
-
- les points sur le bord du dessin sont mis a !values.f_nan
-
- EXAMPLE:
-</div>
-
-          
+</div>
+
+          <h3>Return value</h3><div class="preformat"> RES
+ A 2d matrix
+</div>
 
           
@@ -776 +742 @@
             </h4>
         
-          <div class="comments"></div>
+          <div class="comments"> 
+ Matrix representing coordinates of a field of vectors
+</div>
             
             <h4 id="_div_param_vv">vv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
@@ -789 +757 @@
             </h4>
         
-          <div class="comments"></div>
+          <div class="comments"> 
+ Matrix representing coordinates of a field of vectors
+</div>
             
 
@@ -797 +767 @@
 
           
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-        
-          
-          
-          
-          
+          <h3>Version history</h3>
+          
+          <h4>Version</h4><div class="preformat">
+ $Id$
+</div>
+          <h4>History</h4><div class="preformat"></div>
+          
+          
+          <h3>Known issues</h3>
+          
+          
+          
+          <h4>Restrictions</h4><div class="preformat">
+ U and V matrixes can be 2 or 4d.
+ Beware, to discern differents configuration of U and V (xy, xyz, xyt, xyzt), 
+ we look at the variable of the common 
+        -time which contain the calendar in IDL julian days to which U and 
+ V refered to, in the same way as the variable 
+        -jpt which is the number of time's step to consider in time.
+ U and V arrays ae cut in the same geographic domain. Because of the gap of 
+ T, U, V and F grids, it is possible that these two arrays hase not the same 
+ size and refered to different indexes. In this case, arrays are recut on 
+ common indexesand the domain is redifined to match with these common 
+ indexes. To avoid these recuts, use the keyword /memeindice in domdef.pro
+
+
+ Points on the drawing edge are at !values.f_nan 
+
+</div>
+        
+          <h3>Other attributes</h3>
+          
+          
+          <h4>Uses routines</h4><div class="preformat">
+ common.pro
+</div>