scrip_remap_read Module Reference

Functions/Subroutines
subroutine	read_remap_ww3 (map_name, interp_file, errorCode)
subroutine	read_remap_scrip_ww3

Function/Subroutine Documentation

read_remap_scrip_ww3()

subroutine scrip_remap_read::read_remap_scrip_ww3

Definition at line 251 of file scrip_remap_read.f.

 
!-----------------------------------------------------------------------
!
!     the routine reads a netCDF file to extract remapping info
!     in SCRIP format
!
!     Only read variables needed by WW3
!
!-----------------------------------------------------------------------
!-----------------------------------------------------------------------
!
!     local variables
!
!-----------------------------------------------------------------------
 
      character (SCRIP_charLength) ::
     &  grid1_name           ! grid name for source grid
     &, grid2_name           ! grid name for dest   grid
 
      integer (SCRIP_i4) ::
     &  n                    ! dummy index
     &, errorCode            ! error code for SCRIP routine
 
      integer (SCRIP_i4), dimension(:), allocatable ::
     &  grid1_mask_int,      ! integer masks to determine
     &  grid2_mask_int       ! cells that participate in map
 
      character (20), parameter ::
     &  rtnName = 'read_remap_scrip_ww3'
 
!-----------------------------------------------------------------------
!
!     read some additional global attributes
!
!-----------------------------------------------------------------------
 
      !***
      !*** source and destination grid names
      !***
 
      grid1_name = ' '
      grid2_name = ' '
      errorcode = scrip_success
      ncstat = nf90_get_att(nc_file_id, nf90_global, 'source_grid',
     &                          grid1_name)
      if (scrip_netcdferrorcheck(ncstat, errorcode, rtnname, 'error
     &   reading source grid name')) return
 
      ncstat = nf90_get_att(nc_file_id, nf90_global, 'dest_grid',
     &                          grid2_name)
      if (scrip_netcdferrorcheck(ncstat, errorcode, rtnname, 'error
     &   reading destination grid name')) return
 
! Let's not include routine write statements w/out check on improc, l_master, etc.
!     print *,' '
!     print *,'Remapping between:',trim(grid1_name)
!     print *,'and ',trim(grid2_name)
!     print *,' '
 
!-----------------------------------------------------------------------
!
!     read dimension information
!
!-----------------------------------------------------------------------
 
      ncstat = nf90_inq_dimid(nc_file_id, 'dst_grid_size',
     &                      nc_dstgrdsize_id)
      if (scrip_netcdferrorcheck(ncstat, errorcode, rtnname, 'error
     &   reading destination grid id')) return
!     ncstat = nf90_inq_dimlen(nc_file_id, nc_dstgrdsize_id, grid2_size)
      ncstat = nf90_inquire_dimension(nc_file_id, nc_dstgrdsize_id,
     &                                len = grid2_size)
      if (scrip_netcdferrorcheck(ncstat, errorcode, rtnname, 'error
     &   reading destination grid size')) return
 
      ncstat = nf90_inq_dimid(nc_file_id, 'num_links',
     &                      nc_numlinks_id)
      if (scrip_netcdferrorcheck(ncstat, errorcode, rtnname, 'error
     &   reading number of links id')) return
!     ncstat = nf90_inq_dimlen(nc_file_id, nc_numlinks_id,
!    &                       num_links_map1)
      ncstat = nf90_inquire_dimension(nc_file_id, nc_numlinks_id,
     &                                len = num_links_map1)
      if (scrip_netcdferrorcheck(ncstat, errorcode, rtnname, 'error
     &   reading number of links')) return
      max_links_map1 = num_links_map1
 
      ncstat = nf90_inq_dimid(nc_file_id, 'num_wgts',
     &                      nc_numwgts_id)
      if (scrip_netcdferrorcheck(ncstat, errorcode, rtnname, 'error
     &   reading number of weights id')) return
!     ncstat = nf90_inq_dimlen(nc_file_id, nc_numwgts_id, num_wts)
      ncstat = nf90_inquire_dimension(nc_file_id, nc_numwgts_id,
     &                                len = num_wts)
      if (scrip_netcdferrorcheck(ncstat, errorcode, rtnname, 'error
     &   reading number of weights')) return
 
!-----------------------------------------------------------------------
!
!     allocate arrays
!
!-----------------------------------------------------------------------
 
! grid2_frac is allocated in grid_init
      if(allocated(grid2_frac))deallocate(grid2_frac)
      allocate( grid2_frac(grid2_size) )
 
! grid1_add_map1, grid2_add_map1, wts_map1 are allocated in init_remap_vars
      if(allocated(grid1_add_map1))deallocate(grid1_add_map1)
      if(allocated(grid2_add_map1))deallocate(grid2_add_map1)
      if(allocated(wts_map1))deallocate(wts_map1)
      allocate( grid1_add_map1(num_links_map1),
     &          grid2_add_map1(num_links_map1),
     &          wts_map1(num_wts,num_links_map1) )
 
!-----------------------------------------------------------------------
!
!     get variable ids
!
!-----------------------------------------------------------------------
 
      ncstat = nf90_inq_varid(nc_file_id, 'dst_grid_frac',
     &                                   nc_dstgrdfrac_id)
      if (scrip_netcdferrorcheck(ncstat, errorcode, rtnname, 'error
     &   reading destination grid fraction id')) return
 
      ncstat = nf90_inq_varid(nc_file_id, 'src_address',
     &                                   nc_srcgrdadd_id)
      if (scrip_netcdferrorcheck(ncstat, errorcode, rtnname, 'error
     &   reading source grid address id')) return
 
      ncstat = nf90_inq_varid(nc_file_id, 'dst_address',
     &                                   nc_dstgrdadd_id)
      if (scrip_netcdferrorcheck(ncstat, errorcode, rtnname, 'error
     &   reading destination grid address id')) return
 
      ncstat = nf90_inq_varid(nc_file_id, 'remap_matrix',
     &                                   nc_rmpmatrix_id)
      if (scrip_netcdferrorcheck(ncstat, errorcode, rtnname, 'error
     &   reading remap matrix id')) return
 
!-----------------------------------------------------------------------
!
!     read all variables
!
!-----------------------------------------------------------------------
 
      ncstat = nf90_get_var(nc_file_id, nc_dstgrdfrac_id,
     &                                       grid2_frac)
      if (scrip_netcdferrorcheck(ncstat, errorcode, rtnname, 'error
     &   reading destination grid fraction')) return
 
      ncstat = nf90_get_var(nc_file_id, nc_srcgrdadd_id,
     &                        grid1_add_map1)
      if (scrip_netcdferrorcheck(ncstat, errorcode, rtnname, 'error
     &   reading source grid address')) return
 
      ncstat = nf90_get_var(nc_file_id, nc_dstgrdadd_id,
     &                        grid2_add_map1)
      if (scrip_netcdferrorcheck(ncstat, errorcode, rtnname, 'error
     &   reading destination grid address')) return
 
      ncstat = nf90_get_var(nc_file_id, nc_rmpmatrix_id,
     &                                       wts_map1)
      if (scrip_netcdferrorcheck(ncstat, errorcode, rtnname, 'error
     &   reading remap weights')) return
 
 
      ncstat = nf90_close(nc_file_id)
      if (scrip_netcdferrorcheck(ncstat, errorcode, rtnname, 'error
     &   closing netCDF file')) return
 
!-----------------------------------------------------------------------
 

References scrip_remap_vars::grid1_add_map1, scrip_remap_vars::grid2_add_map1, scrip_grids::grid2_frac, scrip_grids::grid2_size, scrip_remap_vars::max_links_map1, scrip_remap_vars::num_links_map1, scrip_remap_vars::num_wts, scrip_netcdfmod::scrip_netcdferrorcheck(), scrip_errormod::scrip_success, and scrip_remap_vars::wts_map1.

Referenced by read_remap_ww3().

read_remap_ww3()

subroutine scrip_remap_read::read_remap_ww3	(	character(scrip_charlength), intent(out)	map_name,
		character(scrip_charlength), intent(in)	interp_file,
		integer (scrip_i4)	errorCode
	)

Definition at line 115 of file scrip_remap_read.f.

 
!-----------------------------------------------------------------------
!
!     this driver routine reads some global attributes and then
!     calls a specific read routine based on file conventions
!
!-----------------------------------------------------------------------
 
!-----------------------------------------------------------------------
!
!     input variables
!
!-----------------------------------------------------------------------
 
      character(SCRIP_CharLength), intent(in) ::
     &            interp_file  ! filename for remap data
 
!-----------------------------------------------------------------------
!
!     output variables
!
!-----------------------------------------------------------------------
 
      character(SCRIP_CharLength), intent(out) ::
     &            map_name     ! name for mapping
 
!-----------------------------------------------------------------------
!
!     local variables
!
!-----------------------------------------------------------------------
 
      integer (SCRIP_i4) ::
     &  errorCode            ! error code for SCRIP routine
 
      character (14), parameter ::
     &  rtnName = 'read_remap_ww3'
 
!-----------------------------------------------------------------------
!
!     open file and read some global information
!
!-----------------------------------------------------------------------
 
      ncstat = nf90_open(interp_file, nf90_noclobber, nc_file_id)
      if (scrip_netcdferrorcheck(ncstat, errorcode, rtnname, 'error
     &   opening interpolation file')) return
 
      !***
      !*** map name
      !***
      map_name = ' '
      ncstat = nf90_get_att(nc_file_id, nf90_global, 'title',
     &                         map_name)
      if (scrip_netcdferrorcheck(ncstat, errorcode, rtnname, 'error
     &   reading map name')) return
 
 
      !***
      !*** normalization option
      !***
      normalize_opt = ' '
      ncstat = nf90_get_att(nc_file_id, nf90_global, 'normalization',
     &                         normalize_opt)
      if (scrip_netcdferrorcheck(ncstat, errorcode, rtnname, 'error
     &   reading interpolation option')) return
 
      select case(normalize_opt)
      case ('none')
        norm_opt = norm_opt_none
      case ('fracarea')
        norm_opt = norm_opt_frcarea
      case ('destarea')
        norm_opt = norm_opt_dstarea
      case default
        print *,'normalize_opt = ',normalize_opt
        stop 'Invalid normalization option'
      end select
 
      !***
      !*** map method
      !***
      map_method = ' '
      ncstat = nf90_get_att(nc_file_id, nf90_global, 'map_method',
     &                          map_method)
      if (scrip_netcdferrorcheck(ncstat, errorcode, rtnname, 'error
     &   reading map method')) return
 
      select case(map_method)
      case('Conservative remapping')
        map_type = map_type_conserv
      case('Bilinear remapping')
        map_type = map_type_bilinear
      case('Distance weighted avg of nearest neighbors')
        map_type = map_type_distwgt
      case('Bicubic remapping')
        map_type = map_type_bicubic
      case default
        print *,'map_type = ',map_method
        stop 'Invalid Map Type'
      end select
 
      !***
      !*** file convention
      !***
      convention = ' '
      ncstat = nf90_get_att(nc_file_id, nf90_global, 'conventions',
     &                          convention)
      if (scrip_netcdferrorcheck(ncstat, errorcode, rtnname, 'error
     &   reading file convention')) return
 
!-----------------------------------------------------------------------
!
!     call appropriate read routine based on output convention
!
!-----------------------------------------------------------------------
 
      select case(convention)
      case ('SCRIP')
        call read_remap_scrip_ww3
      case ('NCAR-CSM')
        print *,'convention = NCAR-CSM not supported for WW3'
        stop 'unsupported file convention'
!       call read_remap_csm
      case default
        print *,'convention = ',convention
        stop 'unknown output file convention'
      end select
 
!-----------------------------------------------------------------------
 

References scrip_remap_vars::map_type, scrip_remap_vars::map_type_bicubic, scrip_remap_vars::map_type_bilinear, scrip_remap_vars::map_type_conserv, scrip_remap_vars::map_type_distwgt, scrip_remap_vars::norm_opt, scrip_remap_vars::norm_opt_dstarea, scrip_remap_vars::norm_opt_frcarea, scrip_remap_vars::norm_opt_none, read_remap_scrip_ww3(), and scrip_netcdfmod::scrip_netcdferrorcheck().

Referenced by scrip_interface::scrip().