metgrid/src/gridinfo_module.F

   1 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   2 ! MODULE GRIDINFO_MODULE
   3 !
   4 ! This module handles (i.e., acquires, stores, and makes available) all data
   5 !   describing the model domains to be processed.
   6 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   7 module gridinfo_module
   8
   9    use misc_definitions_module
  10    use module_debug
  11
  12    ! Parameters
  13    integer, parameter :: MAX_DOMAINS = 21
  14
  15    ! Variables
  16    integer :: interval_seconds, max_dom, io_form_input, io_form_output, debug_level
  17    integer, dimension(MAX_DOMAINS) :: subgrid_ratio_x, subgrid_ratio_y
  18    integer :: process_only_bdy
  19    character (len=MAX_FILENAME_LEN) :: opt_output_from_geogrid_path, &
  20                           opt_output_from_metgrid_path, opt_metgrid_tbl_path
  21    character (len=128), dimension(MAX_DOMAINS) :: start_date, end_date
  22    character (len=MAX_FILENAME_LEN), dimension(MAX_DOMAINS) :: fg_name, constants_name
  23    logical :: do_tiled_input, do_tiled_output, nocolons
  24    logical, dimension(MAX_DOMAINS) :: grid_is_active
  25    character (len=1) :: gridtype
  26
  27    contains
  28
  29    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  30    ! Name: get_namelist_params
  31    !
  32    ! Purpose: Read namelist parameters.
  33    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  34    subroutine get_namelist_params()
  35
  36       implicit none
  37
  38       ! Local variables
  39       integer :: i, io_form_geogrid, io_form_metgrid
  40       integer, dimension(MAX_DOMAINS) :: start_year, start_month, start_day, start_hour, start_minute, start_second, &
  41                                          end_year, end_month, end_day, end_hour, end_minute, end_second
  42       logical, dimension(MAX_DOMAINS) :: active_grid
  43       integer :: funit
  44       logical :: is_used
  45       character (len=3) :: wrf_core
  46
  47       namelist /share/ wrf_core, max_dom, start_date, end_date, &
  48                         start_year, end_year, start_month, end_month, &
  49                         start_day, end_day, start_hour, end_hour, &
  50                         start_minute, end_minute, start_second, end_second, &
  51                         interval_seconds, io_form_geogrid, opt_output_from_geogrid_path, &
  52                         debug_level, active_grid, nocolons, &
  53                         subgrid_ratio_x, subgrid_ratio_y
  54       namelist /metgrid/ io_form_metgrid, fg_name, constants_name, process_only_bdy, opt_output_from_metgrid_path, &
  55                          opt_metgrid_tbl_path
  56
  57       ! Set defaults
  58       io_form_geogrid = 2
  59       io_form_metgrid = 2
  60       max_dom = 1
  61       wrf_core = 'ARW'
  62       debug_level = 0
  63       nocolons = .false.
  64       do i=1,MAX_DOMAINS
  65          fg_name(i) = '*'
  66          constants_name(i) = '*'
  67          start_year(i) = 0
  68          start_month(i) = 0
  69          start_day(i) = 0
  70          start_hour(i) = 0
  71          start_minute(i) = 0
  72          start_second(i) = 0
  73          end_year(i) = 0
  74          end_month(i) = 0
  75          end_day(i) = 0
  76          end_hour(i) = 0
  77          end_minute(i) = 0
  78          end_second(i) = 0
  79          start_date(i) = '0000-00-00_00:00:00'
  80          end_date(i) = '0000-00-00_00:00:00'
  81          active_grid(i) = .true.
  82          subgrid_ratio_x(i) = 1
  83          subgrid_ratio_y(i) = 1
  84       end do
  85       process_only_bdy = 0
  86       opt_output_from_geogrid_path = './'
  87       opt_output_from_metgrid_path = './'
  88       opt_metgrid_tbl_path = 'metgrid/'
  89       interval_seconds = INVALID
  90
  91       ! Read parameters from Fortran namelist
  92       do funit=10,100
  93          inquire(unit=funit, opened=is_used)
  94          if (.not. is_used) exit
  95       end do
  96       open(funit,file='namelist.wps',status='old',form='formatted',err=1000)
  97       read(funit,share)
  98       read(funit,metgrid)
  99       close(funit)
 100
 101 ! BUG: Better handle debug_level in module_debug
 102       if ( debug_level .gt. 100 ) then
 103          call set_debug_level(DEBUG)
 104       else
 105          call set_debug_level(WARN)
 106       end if
 107
 108       call mprintf(.true.,LOGFILE,'Using the following namelist variables:')
 109       call mprintf(.true.,LOGFILE,'&SHARE')
 110       call mprintf(.true.,LOGFILE,'  WRF_CORE         = %s',s1=wrf_core)
 111       call mprintf(.true.,LOGFILE,'  MAX_DOM          = %i',i1=max_dom)
 112       call mprintf(.true.,LOGFILE,'  START_YEAR       = %i',i1=start_year(1))
 113       do i=2,max_dom
 114          call mprintf(.true.,LOGFILE,'                   = %i',i1=start_year(i))
 115       end do
 116       call mprintf(.true.,LOGFILE,'  START_MONTH      = %i',i1=start_month(1))
 117       do i=2,max_dom
 118          call mprintf(.true.,LOGFILE,'                   = %i',i1=start_month(i))
 119       end do
 120       call mprintf(.true.,LOGFILE,'  START_DAY        = %i',i1=start_day(1))
 121       do i=2,max_dom
 122          call mprintf(.true.,LOGFILE,'                   = %i',i1=start_day(i))
 123       end do
 124       call mprintf(.true.,LOGFILE,'  START_HOUR       = %i',i1=start_hour(1))
 125       do i=2,max_dom
 126          call mprintf(.true.,LOGFILE,'                   = %i',i1=start_hour(i))
 127       end do
 128       call mprintf(.true.,LOGFILE,'  START_MINUTE     = %i',i1=start_minute(1))
 129       do i=2,max_dom
 130          call mprintf(.true.,LOGFILE,'                   = %i',i1=start_minute(i))
 131       end do
 132       call mprintf(.true.,LOGFILE,'  START_SECOND     = %i',i1=start_second(1))
 133       do i=2,max_dom
 134          call mprintf(.true.,LOGFILE,'                   = %i',i1=start_second(i))
 135       end do
 136       call mprintf(.true.,LOGFILE,'  END_YEAR         = %i',i1=end_year(1))
 137       do i=2,max_dom
 138          call mprintf(.true.,LOGFILE,'                   = %i',i1=end_year(i))
 139       end do
 140       call mprintf(.true.,LOGFILE,'  END_MONTH        = %i',i1=end_month(1))
 141       do i=2,max_dom
 142          call mprintf(.true.,LOGFILE,'                   = %i',i1=end_month(i))
 143       end do
 144       call mprintf(.true.,LOGFILE,'  END_DAY          = %i',i1=end_day(1))
 145       do i=2,max_dom
 146          call mprintf(.true.,LOGFILE,'                   = %i',i1=end_day(i))
 147       end do
 148       call mprintf(.true.,LOGFILE,'  END_HOUR         = %i',i1=end_hour(1))
 149       do i=2,max_dom
 150          call mprintf(.true.,LOGFILE,'                   = %i',i1=end_hour(i))
 151       end do
 152       call mprintf(.true.,LOGFILE,'  END_MINUTE       = %i',i1=end_minute(1))
 153       do i=2,max_dom
 154          call mprintf(.true.,LOGFILE,'                   = %i',i1=end_minute(i))
 155       end do
 156       call mprintf(.true.,LOGFILE,'  END_SECOND       = %i',i1=end_second(1))
 157       do i=2,max_dom
 158          call mprintf(.true.,LOGFILE,'                   = %i',i1=end_second(i))
 159       end do
 160       call mprintf(.true.,LOGFILE,'  START_DATE       = %s',s1=start_date(1))
 161       do i=2,max_dom
 162          call mprintf(.true.,LOGFILE,'                   = %s',s1=start_date(i))
 163       end do
 164       call mprintf(.true.,LOGFILE,'  END_DATE         = %s',s1=end_date(1))
 165       do i=2,max_dom
 166          call mprintf(.true.,LOGFILE,'                   = %s',s1=end_date(i))
 167       end do
 168       call mprintf(.true.,LOGFILE,'  INTERVAL_SECONDS = %i',i1=interval_seconds)
 169       call mprintf(.true.,LOGFILE,'  IO_FORM_GEOGRID  = %i',i1=io_form_geogrid)
 170       call mprintf(.true.,LOGFILE,'  OPT_OUTPUT_FROM_GEOGRID_PATH = %s',s1=opt_output_from_geogrid_path)
 171       call mprintf(.true.,LOGFILE,'  SUBGRID_RATIO_X  = %i',i1=subgrid_ratio_x(1))
 172       do i=2,max_dom
 173          call mprintf(.true.,LOGFILE,'                   = %i',i1=subgrid_ratio_x(i))
 174       enddo
 175       call mprintf(.true.,LOGFILE,'  SUBGRID_RATIO_Y  = %i',i1=subgrid_ratio_y(1))
 176       do i=2,max_dom
 177          call mprintf(.true.,LOGFILE,'                   = %i',i1=subgrid_ratio_y(i))
 178       enddo
 179       call mprintf(.true.,LOGFILE,'  DEBUG_LEVEL      = %i',i1=debug_level)
 180       call mprintf(.true.,LOGFILE,'  ACTIVE_GRID      = %l',l1=active_grid(1))
 181       do i=2,max_dom
 182          call mprintf(.true.,LOGFILE,'                   = %l',l1=active_grid(i))
 183       end do
 184       call mprintf(.true.,LOGFILE,'  NOCOLONS         = %l',l1=nocolons)
 185       call mprintf(.true.,LOGFILE,'/')
 186
 187       call mprintf(.true.,LOGFILE,'&METGRID')
 188       do i=1,MAX_DOMAINS
 189          if (i == 1) then
 190             if (fg_name(i) == '*') then
 191                call mprintf(.true.,LOGFILE,'  FG_NAME               = ')
 192             else
 193                call mprintf(.true.,LOGFILE,'  FG_NAME               = %s',s1=fg_name(i))
 194             end if
 195          else
 196             if (fg_name(i) == '*') exit
 197             call mprintf(.true.,LOGFILE,'                        = %s',s1=fg_name(i))
 198          end if
 199       end do
 200       do i=1,MAX_DOMAINS
 201          if (i == 1) then
 202             if (constants_name(i) == '*') then
 203                call mprintf(.true.,LOGFILE,'  CONSTANTS_NAME        = ')
 204             else
 205                call mprintf(.true.,LOGFILE,'  CONSTANTS_NAME        = %s',s1=constants_name(i))
 206             end if
 207          else
 208             if (constants_name(i) == '*') exit
 209             call mprintf(.true.,LOGFILE,'                        = %s',s1=constants_name(i))
 210          end if
 211       end do
 212       call mprintf(.true.,LOGFILE,'  IO_FORM_METGRID       = %i',i1=io_form_metgrid)
 213       call mprintf(.true.,LOGFILE,'  PROCESS_ONLY_BDY      = %i',i1=process_only_bdy)
 214       call mprintf(.true.,LOGFILE,'  OPT_OUTPUT_FROM_METGRID_PATH = %s',s1=opt_output_from_metgrid_path)
 215       call mprintf(.true.,LOGFILE,'  OPT_METGRID_TBL_PATH  = %s',s1=opt_metgrid_tbl_path)
 216       call mprintf(.true.,LOGFILE,'/')
 217
 218
 219       ! Convert wrf_core to uppercase letters
 220       do i=1,3
 221          if (ichar(wrf_core(i:i)) >= ichar('a') .and. ichar(wrf_core(i:i)) <= ichar('z') ) &
 222              wrf_core(i:i) = char(ichar(wrf_core(i:i))-ichar('a')+ichar('A'))
 223       end do
 224
 225       ! Before doing anything else, we must have a valid grid type
 226       gridtype = ' '
 227       if (wrf_core == 'ARW') then
 228          gridtype = 'C'
 229       else if (wrf_core == 'NMM') then
 230          gridtype = 'E'
 231       end if
 232
 233       call mprintf(gridtype /= 'C' .and. gridtype /= 'E', ERROR, &
 234                    'A valid wrf_core must be specified in the namelist. '// &
 235                    'Currently, only "ARW" and "NMM" are supported.')
 236
 237       call mprintf(max_dom > MAX_DOMAINS, ERROR, &
 238                    'In namelist, max_dom must be <= %i. To run with more'// &
 239                    ' than %i domains, increase the MAX_DOMAINS parameter.', &
 240                    i1=MAX_DOMAINS, i2=MAX_DOMAINS)
 241
 242       call mprintf(gridtype /= 'C' .and. process_only_bdy /= 0, ERROR, &
 243                    'The use of process_only_bdy is only currently supported in the "ARW" core. '// &
 244                    'For "NMM", please set process_only_bdy to 0 in the namelist.')
 245
 246       ! Handle IO_FORM+100
 247       if (io_form_geogrid > 100) then
 248          io_form_geogrid = io_form_geogrid - 100
 249          do_tiled_input = .true.
 250       else
 251          do_tiled_input = .false.
 252       end if
 253       if (io_form_metgrid > 100) then
 254          io_form_metgrid = io_form_metgrid - 100
 255          do_tiled_output = .true.
 256       else
 257          do_tiled_output = .false.
 258       end if
 259
 260       ! Check for valid io_form_geogrid
 261       if ( &
 262 #ifdef IO_BINARY
 263           io_form_geogrid /= BINARY .and. &
 264 #endif
 265 #ifdef IO_NETCDF
 266           io_form_geogrid /= NETCDF .and. &
 267 #endif
 268 #ifdef IO_GRIB1
 269           io_form_geogrid /= GRIB1 .and. &
 270 #endif
 271           .true. ) then
 272          call mprintf(.true.,WARN,'Valid io_form_geogrid values are:')
 273 #ifdef IO_BINARY
 274          call mprintf(.true.,WARN,'       %i (=BINARY)',i1=BINARY)
 275 #endif
 276 #ifdef IO_NETCDF
 277          call mprintf(.true.,WARN,'       %i (=NETCDF)',i1=NETCDF)
 278 #endif
 279 #ifdef IO_GRIB1
 280          call mprintf(.true.,WARN,'       %i (=GRIB1)',i1=GRIB1)
 281 #endif
 282          call mprintf(.true.,ERROR,'No valid value for io_form_geogrid was specified in the namelist.')
 283       end if
 284       io_form_input = io_form_geogrid
 285
 286       ! Check for valid io_form_metgrid
 287       if ( &
 288 #ifdef IO_BINARY
 289           io_form_metgrid /= BINARY .and. &
 290 #endif
 291 #ifdef IO_NETCDF
 292           io_form_metgrid /= NETCDF .and. &
 293 #endif
 294 #ifdef IO_GRIB1
 295           io_form_metgrid /= GRIB1 .and. &
 296 #endif
 297           .true. ) then
 298          call mprintf(.true.,WARN,'Valid io_form_metgrid values are:')
 299 #ifdef IO_BINARY
 300          call mprintf(.true.,WARN,'       %i (=BINARY)',i1=BINARY)
 301 #endif
 302 #ifdef IO_NETCDF
 303          call mprintf(.true.,WARN,'       %i (=NETCDF)',i1=NETCDF)
 304 #endif
 305 #ifdef IO_GRIB1
 306          call mprintf(.true.,WARN,'       %i (=GRIB1)',i1=GRIB1)
 307 #endif
 308          call mprintf(.true.,ERROR,'No valid value for io_form_metgrid was specified in the namelist.')
 309       end if
 310       io_form_output = io_form_metgrid
 311
 312       if (start_date(1) == '0000-00-00_00:00:00') then
 313          do i=1,max_dom
 314             ! Build starting date string
 315             write(start_date(i), '(i4.4,a1,i2.2,a1,i2.2,a1,i2.2,a1,i2.2,a1,i2.2)') &
 316                start_year(i),'-',start_month(i),'-',start_day(i),'_',start_hour(i),':',start_minute(i),':',start_second(i)
 317
 318             ! Build ending date string
 319             write(end_date(i), '(i4.4,a1,i2.2,a1,i2.2,a1,i2.2,a1,i2.2,a1,i2.2)') &
 320                end_year(i),'-',end_month(i),'-',end_day(i),'_',end_hour(i),':',end_minute(i),':',end_second(i)
 321          end do
 322       end if
 323
 324
 325       ! Paths need to end with a /
 326       i = len_trim(opt_metgrid_tbl_path)
 327       if (opt_metgrid_tbl_path(i:i) /= '/') then
 328          opt_metgrid_tbl_path(i+1:i+1) = '/'
 329       end if
 330
 331       i = len_trim(opt_output_from_geogrid_path)
 332       if (opt_output_from_geogrid_path(i:i) /= '/') then
 333          opt_output_from_geogrid_path(i+1:i+1) = '/'
 334       end if
 335
 336       i = len_trim(opt_output_from_metgrid_path)
 337       if (opt_output_from_metgrid_path(i:i) /= '/') then
 338          opt_output_from_metgrid_path(i+1:i+1) = '/'
 339       end if
 340
 341
 342       ! Blank strings should be set to flag values
 343       do i=1,max_dom
 344          if (len_trim(constants_name(i)) == 0) then
 345             constants_name(i) = '*'
 346          end if
 347          if (len_trim(fg_name(i)) == 0) then
 348             fg_name(i) = '*'
 349          end if
 350       end do
 351
 352       do i=1,max_dom
 353          grid_is_active(i) = active_grid(i)
 354       end do
 355
 356       return
 357
 358  1000 call mprintf(.true.,ERROR,'Error opening file namelist.wps')
 359
 360    end subroutine get_namelist_params
 361
 362 end module gridinfo_module