Changeset 172 for trunk/SRC/ToBeReviewed/INIT

Timestamp:

09/11/06 09:11:26 (18 years ago)

Author:

smasson

Message:

bugfix + manage roms outputs

File:

• trunk/SRC/ToBeReviewed/INIT/initncdf.pro (modified) (11 diffs)

trunk/SRC/ToBeReviewed/INIT/initncdf.pro

@@ -5 +5 @@
 ;
 ; @file_comments
-; Initfile for Netcdf file. define all the grid parameters
+; Initfile for Netcdf file. define all the grid parameters through
+; an appropriate call to computegid
 ;
 ; @categories
-;
+; Grid
 ; 
-; @param NCFILEIN {in}{required}{type=string}
+; @param NCFILEIN {in}{required}{type=scalar string}
 ; A string giving the name of the NetCdf file
 ;
-; @keyword INVMASK
-; To inverse the mask: mask = 1-mask
+; @keyword INVMASK {default=0}{type=scalar: 0 or 1}
+; Inverse the land/sea mask (that should have 0/1 values for land/sea): mask = 1-mask
 ;
 ; @keyword MASKNAME {type=string}
@@ -20 +21 @@
 ; that contains the land/sea mask
 ;
-; @keyword MISSING_VALUE
+; @keyword MISSING_VALUE {type=scalar}
 ; To define (or redefine if the attribute is
 ; already existing) the missing values used with USEASMASK
 ; keyword
 ;
-; @keyword START1
+; @keyword START1 {default=0}{type=scalar: 0 or 1}
 ; Index the axis from 1 instead of 0 when using
 ; /xyindex and/or zindex
 ;
-; @keyword USEASMASK {type=string}
+; @keyword USEASMASK {type=scalar string}
 ; A string giving the name of the variable in the file 
 ; that will be used to build the land/sea mask. In this case the
@@ -38 +39 @@
 ;    3 NaN values if existing
 ;
-; @keyword XAXISNAME {default='x', 'longitude', 'nav_lon' or 'lon'}{type=string}
+; @keyword XAXISNAME {default='x', 'longitude', 'nav_lon', 'lon', 'lon_rho' or 'NbLongitudes'}{type=scalar string}
 ; A string giving the name of the variable in the file 
 ; that contains the [xyz]axis. 
 ;      
-; @keyword YAXISNAME {default='y', 'latitude', 'nav_lat' or 'lat'}{type=string}
+; @keyword YAXISNAME {default='y', 'latitude', 'nav_lat','lat', 'lat_rho' or 'NbLatitudes'}{type=scalar string}
 ; A string giving the name of the variable in the file 
 ; that contains the [xyz]axis. 
 ;
-; @keyword ZAXISNAME {default='z', 'level', 'lev', 'depth...'}{type=string}
+; @keyword ZAXISNAME {default='z', 'level', 'lev', 'depth...'}{type=scalar string}
 ; A string giving the name of the variable in the file 
 ; that contains the [xyz]axis. 
 ;
-; @keyword XYINDEX
+; @keyword XYINDEX {default=0}{type=scalar: 0 or 1}
 ; To define the x/y axis with index instead of using
 ; the values contained in X/YAXISNAME. 
@@ -56 +57 @@
 ; this forces key_onearth = 0
 ;
-; @keyword ZINDEX
+; @keyword ZINDEX {default=0}{type=scalar: 0 or 1}
 ; To define the z axis with index instead of using
 ; the values contained in ZAXISNAME. 
@@ -62 +63 @@
 ; 
 ; @keyword _EXTRA
-; Used to pass your keywords/
+; Used to pass keywords to computegrid
 ;
 ; @uses
@@ -68 +69 @@
 ;
 ; @restrictions
-; Change the grid parameters of the common.pro
+; Change the grid parameters (see computegrid)
 ;
 ; @restrictions
@@ -122 +123 @@
 ; find the xaxis
   if keyword_set(xaxisname) then xaxisname = strlowcase(xaxisname) ELSE xaxisname = 'x'
-  xvarid = where(namevar EQ xaxisname OR namevar EQ 'longitude' $
-                 OR namevar EQ 'nav_lon' OR namevar EQ 'lon' $
-                 OR namevar EQ 'NbLongitudes')
-  xvarid = xvarid[0]
+  xvarid = (where(namevar EQ xaxisname OR namevar EQ 'longitude' $
+                  OR namevar EQ 'nav_lon' OR namevar EQ 'lon' $
+                  OR namevar EQ 'lon_rho' OR namevar EQ 'NbLongitudes'))[0]
+  romsgrid = strmid(namevar[xvarid], 0, 4) EQ 'lon_'
   if xvarid EQ -1 then begin
     print, 'the xaxis was not found, check the use of XAXISNAME keyword'
@@ -146 +147 @@
 ; find the yaxis
   if keyword_set(yaxisname) then yaxisname = strlowcase(yaxisname) ELSE yaxisname = 'y'
-  yvarid = where(namevar EQ yaxisname OR namevar EQ 'latitude' $
-                 OR namevar EQ 'nav_lat' OR namevar EQ 'lat' $
-                 OR namevar EQ 'NbLatitudes')
+  yvarid = (where(namevar EQ yaxisname OR namevar EQ 'latitude' $
+                  OR namevar EQ 'nav_lat' OR namevar EQ 'lat' $
+                  OR namevar EQ 'lat_rho' OR namevar EQ 'NbLatitudes'))[0]
   yvarid = yvarid[0]
   if yvarid EQ -1 then begin
@@ -177 +178 @@
 ;----------------------------------------------------------
 ; find the zaxis
-  if keyword_set(zaxisname) then zaxisname = strlowcase(zaxisname) ELSE zaxisname = 'z'
-  zvarid = where(namevar EQ 'nav_lev' or namevar EQ zaxisname OR namevar EQ 'level' OR namevar EQ 'lev' OR strmid(namevar, 0, 5) EQ 'depth')
-  zvarid = zvarid[0]
-  if zvarid EQ -1 AND inside.ndims GT 3 then begin
-    print, 'initncdf: the zaxis was not found..., check the the use of ZAXISNAME keyword if you whant to find one...'
+  IF keyword_set(romsgrid) THEN BEGIN
+    FOR i = 0, inside.ndims-1 DO BEGIN 
+      ncdf_diminq, cdfid, i, name, size
+      CASE strlowcase(name) OF
+        's_rho':zaxis = reverse(indgen(size))
+        's_u':zaxis = reverse(indgen(size))
+        's_v':zaxis = reverse(indgen(size))
+        's_psi':zaxis = reverse(indgen(size))
+        's_w':zaxis = reverse(indgen(size-1))
+        ELSE:
+      ENDCASE
+    ENDFOR 
+    IF (where(namevar EQ 'h'))[0] NE -1 THEN BEGIN
+      ncdf_varget, cdfid, 'h', romsh
+    ENDIF ELSE romsh = -1
+  ENDIF ELSE BEGIN 
+    if keyword_set(zaxisname) then zaxisname = strlowcase(zaxisname) ELSE zaxisname = 'z'
+    zvarid = (where(namevar EQ 'nav_lev' or namevar EQ zaxisname OR namevar EQ 'level' OR namevar EQ 'lev' OR strmid(namevar, 0, 5) EQ 'depth'))[0]
+    if zvarid EQ -1 AND inside.ndims GT 3 then begin
+      print, 'initncdf: the zaxis was not found..., check the the use of ZAXISNAME keyword if you whant to find one...'
 ;     stop
-  endif
+    endif
 ; read the zaxis
-  if zvarid NE -1 THEN ncdf_varget, cdfid, zvarid, zaxis
-  IF keyword_set(zindex) THEN $
-    zaxis = keyword_set(start1) + findgen(n_elements(zaxis))
+    if zvarid NE -1 THEN ncdf_varget, cdfid, zvarid, zaxis
+  ENDELSE 
+  IF keyword_set(zindex) AND keyword_set(zaxis) THEN $
+     zaxis = keyword_set(start1) + findgen(n_elements(zaxis))
 ;----------------------------------------------------------
 ; mask
+  IF NOT (keyword_set(maskname) OR keyword_set(useasmask)) AND keyword_set(romsgrid) THEN maskname = 'mask_rho'
   CASE 1 OF
     keyword_set(maskname):BEGIN
@@ -252 +270 @@
             'scale_factor':ncdf_attget, cdfid, mskid, attname, scale_factor
             'missing_value':IF n_elements(missing_value) EQ 0 THEN $
-              ncdf_attget, cdfid, mskid, attname, missing_value
+               ncdf_attget, cdfid, mskid, attname, missing_value
             ELSE:
           ENDCASE
@@ -279 +297 @@
     ELSE:tmask  = -1
   ENDCASE
+;
   ncdf_close, cdfid
 ;
 ; compute the grid
-  if zvarid EQ -1 then BEGIN 
+  if NOT keyword_set(zaxis) then BEGIN 
     computegrid, xaxis = xaxis, yaxis = yaxis $
-      , mask = tmask, onearth = 1b - keyword_set(xyindex), _EXTRA = ex 
+                 , mask = tmask, onearth = 1b - keyword_set(xyindex), ROMSH = romsh, _EXTRA = ex 
   ENDIF ELSE BEGIN 
     computegrid, xaxis = xaxis, yaxis = yaxis, zaxis = zaxis $
-      , mask = tmask, onearth = 1b - keyword_set(xyindex), _EXTRA = ex
+                 , mask = tmask, onearth = 1b - keyword_set(xyindex), ROMSH = romsh, _EXTRA = ex
   ENDELSE 
   IF n_elements(time) EQ 0 THEN time = 0