Changeset 242 for trunk/SRC/Computation

Timestamp:

04/06/07 10:35:17 (17 years ago)

Author:

pinsard

Message:

improvements/corrections of some *.pro headers + replace some message by some report

Location:

trunk/SRC/Computation

Files:

• curl.pro (modified) (3 diffs)
• div.pro (modified) (4 diffs)
• grad.pro (modified) (2 diffs)

trunk/SRC/Computation/curl.pro

@@ -10 +10 @@
 ; Matrix representing the zonal coordinates (U point) of a field of vectors
 ; A 2D (xy), 3D (xyz or yt) or a structure readable by litchamp and containing
-; a 2D (xy), 3D (xyz or yt) array (4d case is not coded yet).
-; note that the dimension of the array must suit the domain dimension.
+; a 2D (xy), 3D (xyz or yt) array (4D case is not coded yet).
+; Note that the dimension of the array must suit the domain dimension.
 ;
 ; @param VV
 ; Matrix representing the meridional coordinates (V point) of a field of vectors
 ; A 2D (xy), 3D (xyz or yt) or a structure readable by litchamp and containing
-; a 2D (xy), 3D (xyz or yt) array (4d case is not coded yet).
-; note that the dimension of the array must suit the domain dimension.
+; a 2D (xy), 3D (xyz or yt) array (4D case is not coded yet).
+; Note that the dimension of the array must suit the domain dimension.
 ;
 ; @keyword DIREC {type=scalar string}
@@ -36 +36 @@
 ; - Works only for Arakawa C-grid.
 ; - UU must be on U grid, VV must be on V grid
-; - 4d case is not coded yet
+; - 4D case is not coded yet
 ; - the common variable jpt is used to differ xyz (jpt=1) and xyt (jpt\=1) cases.
 ; - U and V arrays are cut in the same geographic domain. Because of the shift between
@@ -61 +61 @@
 ;
 ; @todo
-; code the 4d case
+; code the 4D case
 ;
 ;-

trunk/SRC/Computation/div.pro

@@ -10 +10 @@
 ; Matrix representing the zonal coordinates (U point) of a field of vectors
 ; A 2D (xy), 3D (xyz or yt) or a structure readable by litchamp and containing
-; a 2D (xy), 3D (xyz or yt) array (4d case is not coded yet).
+; a 2D (xy), 3D (xyz or yt) array (4D case is not coded yet).
 ; note that the dimension of the array must suit the domain dimension.
 ;
@@ -16 +16 @@
 ; Matrix representing the meridional coordinates (V point) of a field of vectors
 ; A 2D (xy), 3D (xyz or yt) or a structure readable by litchamp and containing
-; a 2D (xy), 3D (xyz or yt) array (4d case is not coded yet).
+; a 2D (xy), 3D (xyz or yt) array (4D case is not coded yet).
 ; note that the dimension of the array must suit the domain dimension.
 ;
@@ -36 +36 @@
 ; - Works only for Arakawa C-grid.
 ; - UU must be on U grid, VV must be on V grid
-; - 4d case is not coded yet
+; - 4D case is not coded yet
 ; - the common variable jpt is used to differ xyz (jpt=1) and xyt (jpt\=1) cases.
 ; - U and V arrays are cut in the same geographic domain. Because of the shift between
@@ -60 +60 @@
 ;
 ; @todo
-; code the 4d case
+; code the 4D case
 ;
 ;-
 ;
-FUNCTION div, uu, vv, DIREC = DIREC
+FUNCTION div, uu, vv, DIREC = direc
 ;
   compile_opt idl2, strictarrsubs

trunk/SRC/Computation/grad.pro

@@ -9 +9 @@
 ; @param FIELD
 ; The field for which we want to compute the gradient. A 2D (xy),
-; 3D (xyz or yt) or 4D (xyzt) array or a structure readable by litchamp
+; 3D (xyz or yt) or 4D (xyzt) array or a structure readable by 
+; <proidl>litchamp</proidl>
 ; and containing a 2D (xy), 3D (xyz or yt) or 4D (xyzt) array.
-; note that the dimension of the array must suit the domain dimension.
+; Note that the dimension of the array must suit the domain dimension.
 ;
 ; @param DIREC {type=scalar string}
@@ -308 +309 @@
       ENDIF
     END
-;------------------------------------------------------------
-;------------------------------------------------------------
     ELSE:return, report('input array must have 2, 3 or 4 dimensions')
   ENDCASE
-;------------------------------------------------------------
-
-
-;------------------------------------------------------------
   return, res
 END
-
-
-
-
-
-