Context Navigation

Computation

Timestamp:

03/27/07 15:43:18 (17 years ago)

Author:

pinsard

Message:

improvements/corrections of some *.pro headers

Location:

trunk/SRC/Computation

Files:

-                      r231
+                      r238
+;
 ; @keyword DIREC {type=scalar string}
+; Use if you want to call moyenne or grossemoyenne after the div computation
+; Use if you want to call <pro>moyenne</pro> or
+; <pro>grossemoyenne</pro> after the div computation
 ; with a mean done in the DIREC direction
+;
 ; @returns RES
+; @returns
 ; the vertical component of the curl of the input data (with the same size)
+;
 ; @uses
+; cm_4cal, cm_4data, cm_4mmesh
+; cm_4cal
+; cm_4data
+; cm_4mmesh
+;
 ; @restrictions
 …
 ; @todo
 ; code the 4d case
+;
 ;-
+;

-                      r231
+                      r238
+;
 ; @keyword DIREC {type=scalar string}
+; Use if you want to call moyenne or grossemoyenne after the div computation
+; Use if you want to call <pro>moyenne</pro> or
+; <pro>grossemoyenne</pro> after the div computation
 ; (stupid ?) with a mean done in the DIREC direction
+;
 ; @returns RES
+; @returns
 ; the divergence of the input data (with the same size)
+;
 ; @uses
+; cm_4cal, cm_4data, cm_4mmesh
+; cm_4cal
+; cm_4data
+; cm_4mmesh
+;
 ; @restrictions
 …
 ;   T, U, V and F grids, it is possible that these two arrays do not have the same
 ;   size and refer to different indexes. In this case, arrays are re-cut on
 ;   common indexes. To avoid these re-cuts, use the keyword /memeindice in
+;   common indexes. To avoid these re-cuts, use the keyword /memeindice in
 ; <pro>domdef</pro>
 ; - When computing the divergence, we update, vargrid, varname, varunits and the
 …
 ; @todo
 ; code the 4d case
+;
 ;-
+;

-                      r232
+                      r238
+;
 ; @param FIELD
 ; The field for which we want to compute the gradient.  A 2D (xy),
+; 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
 ; and containing a 2D (xy), 3D (xyz or yt) or 4D (xyzt) array.
 …
 ; the gradient direction: 'x', 'y', 'z'
+;
 ; @returns RES {type=2D, 3D or 4D array}
 ; the gradient of the input data (with the same size)
+; @returns
+; the gradient of the input data with the same size 2D, 3D or 4D array
+;
 ; @uses
+; cm_4cal, cm_4data, cm_4mmesh
+; cm_4cal
+; cm_4data
+; cm_4mmesh
+;
 ; @restrictions

Note: See TracChangeset for help on using the changeset viewer.