Icepack

index.rst

@@ -457,6 +457,7 @@ References
    models/gitm/readme
    models/gitm/netcdf_to_gitm_blocks
    models/gitm/gitm_blocks_to_netcdf
+   models/icepack/readme
    models/ikeda/readme
    models/LMDZ/readme
    models/lorenz_04/readme
@@ -494,7 +495,6 @@ References
    models/template/readme
    models/utilities/default_model_mod
 
-
 .. toctree::
    :maxdepth: 2
    :caption: Contributing and Community

models/icepack/dart_cice_mod.f90

@@ -0,0 +1,160 @@
+! DART software - Copyright UCAR. This open source software is provided
+! by UCAR, "as is", without charge, subject to all terms of use at
+! http://www.image.ucar.edu/DAReS/DART/DART_download
+
+module dart_cice_mod
+
+use        types_mod, only      : r8, rad2deg
+use time_manager_mod, only      : time_type, set_time, set_calendar_type
+use    utilities_mod, only      : file_exist, error_handler, E_ERR, E_MSG
+use  netcdf_utilities_mod, only : nc_check
+
+use netcdf
+
+implicit none
+private
+
+public :: get_horiz_grid_dims, get_ncat_dim, read_horiz_grid
+
+character(len=*), parameter :: source   = 'dart_cice_mod.f90'
+character(len=512) :: msgstring
+logical, save :: module_initialized = .false.
+
+character(len=256) :: ic_filename      = 'cice.r.nc'
+
+contains
+
+!-----------------------------------------------------------------
+! Read calendar information
+! In 'restart' mode, this is primarily the calendar type and 'stop'
+! information. The time attributes of the restart file override
+! the namelist time information.
+
+subroutine initialize_module
+
+call set_calendar_type('gregorian')
+
+! Make sure we have a cice restart file (for grid dims)
+if ( .not. file_exist(ic_filename) ) then
+   msgstring = 'dart_cice_mod: '//trim(ic_filename)//' not found'
+   call error_handler(E_ERR,'initialize_module', msgstring, source)
+endif
+
+module_initialized = .true.
+
+end subroutine initialize_module
+
+!-----------------------------------------------------------------
+! Read the lon, lat grid size from the restart netcdf file.
+! The actual grid file is a binary file with no header information.
+
+subroutine get_horiz_grid_dims(Nx)
+
+integer, intent(out) :: Nx   ! Number of Longitudes
+
+integer :: grid_id, dimid, nc_rc
+
+if ( .not. module_initialized ) call initialize_module
+
+call nc_check(nf90_open(trim(ic_filename), nf90_nowrite, grid_id), &
+         'get_horiz_grid_dims','open '//trim(ic_filename))
+
+! Longitudes : get dimid for 'ni' or 'nlon', and then get value
+nc_rc = nf90_inq_dimid(grid_id, 'ni', dimid)
+if (nc_rc /= nf90_noerr) then
+  msgstring = "unable to find either 'ni' or 'nlon' in file "//trim(ic_filename)
+  call error_handler(E_ERR, 'get_horiz_grid_dims', msgstring, source)
+endif
+
+call nc_check(nf90_inquire_dimension(grid_id, dimid, len=Nx), &
+              'get_horiz_grid_dims','inquire_dimension ni '//trim(ic_filename))
+
+call nc_check(nf90_close(grid_id), 'get_horiz_grid_dims','close '//trim(ic_filename) )
+
+end subroutine get_horiz_grid_dims
+
+!-----------------------------------------------------------------
+! Read the ncat size from the restart netcdf file.
+
+subroutine get_ncat_dim(Ncat)
+
+integer, intent(out) :: Ncat   ! Number of categories in ice-thick dist
+
+integer :: grid_id, dimid, nc_rc
+
+if ( .not. module_initialized ) call initialize_module
+
+call nc_check(nf90_open(trim(ic_filename), nf90_nowrite, grid_id), &
+              'get_ncat_dim','open '//trim(ic_filename))
+
+! ncat : get dimid for 'ncat' and then get value
+nc_rc = nf90_inq_dimid(grid_id, 'ncat', dimid)
+if (nc_rc /= nf90_noerr) then
+   nc_rc = nf90_inq_dimid(grid_id, 'Ncat', dimid)
+   if (nc_rc /= nf90_noerr) then
+      msgstring = "unable to find either 'ncat' or 'Ncat' in file "//trim(ic_filename)
+      call error_handler(E_ERR, 'get_horiz_grid_dims', msgstring, source)
+   endif
+endif
+
+call nc_check(nf90_inquire_dimension(grid_id, dimid, len=Ncat), &
+              'get_ncat_dim','inquire_dimension ni '//trim(ic_filename))
+
+call nc_check(nf90_close(grid_id), 'get_ncat_dim','close '//trim(ic_filename) )
+
+end subroutine get_ncat_dim
+
+!-----------------------------------------------------------------
+
+subroutine read_horiz_grid(nx, TLAT, TLON)
+
+integer,                 intent(in)  :: nx
+real(r8), dimension(nx), intent(out) :: TLAT, TLON
+
+integer :: grid_id, reclength, VarId
+
+if ( .not. module_initialized ) call initialize_module
+
+! Check to see that the file exists.
+if ( .not. file_exist(ic_filename) ) then
+   msgstring = 'cice grid '//trim(ic_filename)//' not found'
+   call error_handler(E_ERR,'read_horiz_grid', msgstring, source)
+endif
+
+! Open it and read them in the EXPECTED order.
+call nc_check(nf90_open(trim(ic_filename), nf90_nowrite, grid_id), &
+              'read_horiz_grid', 'open '//trim(ic_filename))
+
+! Latitude
+call nc_check(nf90_inq_varid(grid_id, 'tlat', VarId), &
+              'read_horiz_grid', 'inquiring tlat from '//trim(ic_filename))
+call nc_check(nf90_get_var(grid_id, VarId, TLAT, start=(/1/), &
+              count=(/nx/)), 'read_horiz_grid', &
+              'getting tlat from '//trim(ic_filename))
+
+! Longitude
+call nc_check(nf90_inq_varid(grid_id, 'tlon', VarId), &
+              'read_horiz_grid', 'inquiring tlon from '//trim(ic_filename))
+call nc_check(nf90_get_var(grid_id, VarId, TLON, &
+              start=(/1/), count=(/nx/)), &
+              'read_horiz_grid', 'getting tlon from '//trim(ic_filename))
+
+call nc_check(nf90_close(grid_id), 'read_horiz_grid', 'close '//trim(ic_filename))
+
+TLAT = TLAT * rad2deg
+TLON = TLON * rad2deg
+
+! ensure [0,360) [-90,90]
+where (TLON <   0.0_r8) TLON = TLON + 360.0_r8
+where (TLON > 360.0_r8) TLON = TLON - 360.0_r8
+
+where (TLAT < -90.0_r8) TLAT = -90.0_r8
+where (TLAT >  90.0_r8) TLAT =  90.0_r8
+
+end subroutine read_horiz_grid
+
+!===================================================================
+! End of module dart_cice_mod
+!===================================================================
+
+end module dart_cice_mod