! SVN:$Id: ice_state.F90 1198 2017-04-18 15:06:16Z eclare $ !======================================================================= ! ! Primary state variables in various configurations ! Note: other state variables are at the end of this... ! The primary state variable names are: !------------------------------------------------------------------- ! for each category aggregated over units ! categories !------------------------------------------------------------------- ! aicen(i,j,n) aice(i,j) --- ! vicen(i,j,n) vice(i,j) m ! vsnon(i,j,n) vsno(i,j) m ! trcrn(i,j,it,n) trcr(i,j,it) ! ! Area is dimensionless because aice is the fractional area ! (normalized so that the sum over all categories, including open ! water, is 1.0). That is why vice/vsno have units of m instead of m^3. ! ! Variable names follow these rules: ! ! (1) For 3D variables (indices i,j,n), write 'ice' or 'sno' or ! 'sfc' and put an 'n' at the end. ! (2) For 2D variables (indices i,j) aggregated over all categories, ! write 'ice' or 'sno' or 'sfc' without the 'n'. ! (3) For 2D variables (indices i,j) associated with an individual ! category, write 'i' or 's' instead of 'ice' or 'sno' and put an 'n' ! at the end: e.g. hin, hsn. These are not declared here ! but in individual modules (e.g., ice_therm_vertical). ! ! authors C. M. Bitz, UW ! Elizabeth C. Hunke and William H. Lipscomb, LANL ! ! 2004: Block structure added by William Lipscomb ! 2006: Converted to free form source (F90) by Elizabeth Hunke module ice_state use ice_kinds_mod use ice_domain_size, only: max_blocks, ncat, max_ntrcr, n_aero use ice_blocks, only: nx_block, ny_block implicit none private public :: bound_state save !----------------------------------------------------------------- ! state of the ice aggregated over all categories !----------------------------------------------------------------- real (kind=dbl_kind), dimension(nx_block,ny_block,max_blocks), & public :: & aice , & ! concentration of ice vice , & ! volume per unit area of ice (m) vsno ! volume per unit area of snow (m) real (kind=dbl_kind), & dimension(nx_block,ny_block,max_ntrcr,max_blocks), public :: & trcr ! ice tracers ! 1: surface temperature of ice/snow (C) !----------------------------------------------------------------- ! state of the ice for each category !----------------------------------------------------------------- real (kind=dbl_kind), dimension (nx_block,ny_block,max_blocks), & public:: & aice0 ! concentration of open water real (kind=dbl_kind), & dimension (nx_block,ny_block,ncat,max_blocks), public :: & aicen , & ! concentration of ice vicen , & ! volume per unit area of ice (m) vsnon ! volume per unit area of snow (m) real (kind=dbl_kind), public, & dimension (nx_block,ny_block,max_ntrcr,ncat,max_blocks) :: & trcrn ! tracers ! 1: surface temperature of ice/snow (C) !----------------------------------------------------------------- ! tracers infrastructure arrays !----------------------------------------------------------------- integer (kind=int_kind), dimension (max_ntrcr), public :: & trcr_depend ! = 0 for ice area tracers ! = 1 for ice volume tracers ! = 2 for snow volume tracers integer (kind=int_kind), dimension (max_ntrcr), public :: & n_trcr_strata ! number of underlying tracer layers integer (kind=int_kind), dimension (max_ntrcr,2), public :: & nt_strata ! indices of underlying tracer layers real (kind=dbl_kind), dimension (max_ntrcr,3), public :: & trcr_base ! = 0 or 1 depending on tracer dependency ! argument 2: (1) aice, (2) vice, (3) vsno !----------------------------------------------------------------- ! dynamic variables closely related to the state of the ice !----------------------------------------------------------------- real (kind=dbl_kind), dimension(nx_block,ny_block,max_blocks), & public :: & uvel , & ! x-component of velocity (m/s) vvel , & ! y-component of velocity (m/s) divu , & ! strain rate I component, velocity divergence (1/s) shear , & ! strain rate II component (1/s) strength ! ice strength (N/m) !----------------------------------------------------------------- ! ice state at start of time step, saved for later in the step !----------------------------------------------------------------- real (kind=dbl_kind), dimension(nx_block,ny_block,max_blocks), & public :: & aice_init ! initial concentration of ice, for diagnostics real (kind=dbl_kind), & dimension(nx_block,ny_block,ncat,max_blocks), public :: & aicen_init , & ! initial ice concentration, for linear ITD vicen_init , & ! initial ice volume (m), for linear ITD vsnon_init ! initial snow volume (m), for aerosol !======================================================================= contains !======================================================================= ! ! Get ghost cell values for ice state variables in each thickness category. ! NOTE: This subroutine cannot be called from inside a block loop! ! ! author: William H. Lipscomb, LANL subroutine bound_state (aicen, & vicen, vsnon, & ntrcr, trcrn) use ice_boundary, only: ice_halo, ice_HaloMask, ice_HaloUpdate, & ice_HaloDestroy use ice_domain, only: halo_info, maskhalo_bound, nblocks use ice_constants, only: field_loc_center, field_type_scalar, c0 integer (kind=int_kind), intent(in) :: & ntrcr ! number of tracers in use real (kind=dbl_kind), & dimension(nx_block,ny_block,ncat,max_blocks), intent(inout) :: & aicen , & ! fractional ice area vicen , & ! volume per unit area of ice (m) vsnon ! volume per unit area of snow (m) real (kind=dbl_kind), & dimension(nx_block,ny_block,max_ntrcr,ncat,max_blocks), & intent(inout) :: & trcrn ! ice tracers ! local variables integer (kind=int_kind) :: i, j, n, iblk integer (kind=int_kind), & dimension(nx_block,ny_block,max_blocks) :: halomask type (ice_halo) :: halo_info_aicemask call ice_HaloUpdate (aicen, halo_info, & field_loc_center, field_type_scalar) if (maskhalo_bound) then halomask(:,:,:) = 0 !$OMP PARALLEL DO PRIVATE(iblk,n,i,j) do iblk = 1, nblocks do n = 1, ncat do j = 1, ny_block do i = 1, nx_block if (aicen(i,j,n,iblk) > c0) halomask(i,j,iblk) = 1 enddo enddo enddo enddo !$OMP END PARALLEL DO call ice_HaloMask(halo_info_aicemask, halo_info, halomask) call ice_HaloUpdate (trcrn(:,:,1:ntrcr,:,:), halo_info_aicemask, & field_loc_center, field_type_scalar) call ice_HaloUpdate (vicen, halo_info_aicemask, & field_loc_center, field_type_scalar) call ice_HaloUpdate (vsnon, halo_info_aicemask, & field_loc_center, field_type_scalar) call ice_HaloDestroy(halo_info_aicemask) else call ice_HaloUpdate (trcrn(:,:,1:ntrcr,:,:), halo_info, & field_loc_center, field_type_scalar) call ice_HaloUpdate (vicen, halo_info, & field_loc_center, field_type_scalar) call ice_HaloUpdate (vsnon, halo_info, & field_loc_center, field_type_scalar) endif end subroutine bound_state !======================================================================= end module ice_state !=======================================================================