mom_surface_forcing_mct.F90

Go to the documentation of this file.

module mom_surface_forcing_mct
 
! This file is part of MOM6. See LICENSE.md for the license.
 
use mom_coms,             only : reproducing_sum
use mom_constants,        only : hlv, hlf
use mom_cpu_clock,        only : cpu_clock_id, cpu_clock_begin, cpu_clock_end
use mom_cpu_clock,        only : clock_subcomponent
use mom_diag_mediator,    only : diag_ctrl
use mom_diag_mediator,    only : safe_alloc_ptr, time_type
use mom_domains,          only : pass_vector, pass_var, fill_symmetric_edges
use mom_domains,          only : global_field_sum, bitwise_exact_sum
use mom_domains,          only : agrid, bgrid_ne, cgrid_ne, to_all
use mom_domains,          only : to_north, to_east, omit_corners
use mom_error_handler,    only : mom_error, warning, fatal, is_root_pe, mom_mesg
use mom_file_parser,      only : get_param, log_version, param_file_type
use mom_forcing_type,     only : forcing, mech_forcing
use mom_forcing_type,     only : forcing_diags, mech_forcing_diags, register_forcing_type_diags
use mom_forcing_type,     only : allocate_forcing_type, deallocate_forcing_type
use mom_forcing_type,     only : allocate_mech_forcing, deallocate_mech_forcing
use mom_get_input,        only : get_mom_input, directories
use mom_grid,             only : ocean_grid_type
use mom_io,               only : slasher, write_version_number, mom_read_data
use mom_restart,          only : register_restart_field, restart_init, mom_restart_cs
use mom_restart,          only : restart_init_end, save_restart, restore_state
use mom_string_functions, only : uppercase
use mom_spatial_means,    only : adjust_area_mean_to_zero
use mom_unit_scaling,     only : unit_scale_type
use mom_variables,        only : surface
use user_revise_forcing,  only : user_alter_forcing, user_revise_forcing_init
use user_revise_forcing,  only : user_revise_forcing_cs
 
use coupler_types_mod,    only : coupler_2d_bc_type, coupler_type_write_chksums
use coupler_types_mod,    only : coupler_type_initialized, coupler_type_spawn
use coupler_types_mod,    only : coupler_type_copy_data
use data_override_mod,    only : data_override_init, data_override
use fms_mod,              only : stdout
use mpp_mod,              only : mpp_chksum
use time_interp_external_mod, only : init_external_field, time_interp_external
use time_interp_external_mod, only : time_interp_external_init
 
implicit none ; private
 
#include <MOM_memory.h>
 
public convert_iob_to_fluxes
public convert_iob_to_forces
public surface_forcing_init
public forcing_save_restart
public ice_ocn_bnd_type_chksum
 
private apply_flux_adjustments
private apply_force_adjustments
private surface_forcing_end
 
!> Contains pointers to the forcing fields which may be used to drive MOM.
!! All fluxes are positive downward.
type, public :: surface_forcing_cs ; private
  integer :: wind_stagger       !< AGRID, BGRID_NE, or CGRID_NE (integer values
                                !! from MOM_domains) to indicate the staggering of
                                !! the winds that are being provided in calls to
                                !! update_ocean_model.
  logical :: use_temperature    !! If true, temp and saln used as state variables
  real :: wind_stress_multiplier!< A multiplier applied to incoming wind stress (nondim).
 
  real :: rho0                  !< Boussinesq reference density [R ~> kg m-3]
  real :: area_surf = -1.0      !< total ocean surface area [m2]
  real :: latent_heat_fusion    !< latent heat of fusion [J kg-1]
  real :: latent_heat_vapor     !< latent heat of vaporization [J kg-1]
 
  real :: max_p_surf            !< maximum surface pressure that can be
                                !! exerted by the atmosphere and floating sea-ice,
                                !! [Pa].  This is needed because the FMS coupling
                                !! structure does not limit the water that can be
                                !! frozen out of the ocean and the ice-ocean heat
                                !! fluxes are treated explicitly.
  logical :: use_limited_p_ssh  !< If true, return the sea surface height with
                                !! the correction for the atmospheric (and sea-ice)
                                !! pressure limited by max_p_surf instead of the
                                !! full atmospheric pressure.  The default is true.
  real :: gust_const            !< constant unresolved background gustiness for ustar [R L Z T-1 ~> Pa]
  logical :: read_gust_2d       !< If true, use a 2-dimensional gustiness supplied
                                !! from an input file.
  real, pointer, dimension(:,:) :: &
    tke_tidal => null(), &      !< turbulent kinetic energy introduced to the
                                !! bottom boundary layer by drag on the tidal flows [R Z3 T-3 ~> W m-2]
    gust => null(), &           !< spatially varying unresolved background
                                !! gustiness that contributes to ustar [R L Z T-1 ~> Pa].
                                !! gust is used when read_gust_2d is true.
    ustar_tidal => null()       !< tidal contribution to the bottom friction velocity [Z T-1 ~> m s-1]
  real :: cd_tides              !< drag coefficient that applies to the tides (nondimensional)
  real :: utide                 !< constant tidal velocity to use if read_tideamp
                                !! is false [Z T-1 ~> m s-1]
  logical :: read_tideamp     !< If true, spatially varying tidal amplitude read from a file.
  logical :: rigid_sea_ice    !< If true, sea-ice exerts a rigidity that acts
                              !! to damp surface deflections (especially surface
                              !! gravity waves).  The default is false.
  real    :: g_earth            !< Gravitational acceleration [m s-2]
  real    :: kv_sea_ice         !! viscosity in sea-ice that resists sheared vertical motions [m2 s-1]
  real    :: density_sea_ice    !< typical density of sea-ice [kg m-3]. The value is
                                !! only used to convert the ice pressure into
                                !! appropriate units for use with Kv_sea_ice.
  real    :: rigid_sea_ice_mass !< A mass per unit area of sea-ice beyond which
                                !! sea-ice viscosity becomes effective, in kg m-2,
                                !! typically of order 1000 [kg m-2].
  logical :: allow_flux_adjustments !< If true, use data_override to obtain flux adjustments
  real    :: flux_const                     !< piston velocity for surface restoring [m/s]
  logical :: salt_restore_as_sflux          !< If true, SSS restore as salt flux instead of water flux
  logical :: adjust_net_srestore_to_zero    !< adjust srestore to zero (for both salt_flux or vprec)
  logical :: adjust_net_srestore_by_scaling !< adjust srestore w/o moving zero contour
  logical :: adjust_net_fresh_water_to_zero !< adjust net surface fresh-water (w/ restoring) to zero
  logical :: use_net_fw_adjustment_sign_bug !< use the wrong sign when adjusting net FW
  logical :: adjust_net_fresh_water_by_scaling !< adjust net surface fresh-water  w/o moving zero contour
  logical :: mask_srestore_under_ice        !< If true, use an ice mask defined by frazil
                                            !< criteria for salinity restoring.
  real    :: ice_salt_concentration         !< salt concentration for sea ice [kg/kg]
  logical :: mask_srestore_marginal_seas    !< if true, then mask SSS restoring in marginal seas
  real    :: max_delta_srestore             !< maximum delta salinity used for restoring
  real    :: max_delta_trestore             !< maximum delta sst used for restoring
  real, pointer, dimension(:,:) :: basin_mask => null() !< mask for SSS restoring by basin
  type(diag_ctrl), pointer :: diag          !< structure to regulate diagnostic output timing
  character(len=200)       :: inputdir      !< directory where NetCDF input files are
  character(len=200)       :: salt_restore_file !< filename for salt restoring data
  character(len=30)        :: salt_restore_var_name !< name of surface salinity in salt_restore_file
  logical                  :: mask_srestore         !< if true, apply a 2-dimensional mask to the surface
                                                    !< salinity restoring fluxes. The masking file should be
                                                    !< in inputdir/salt_restore_mask.nc and the field should
                                                    !! be named 'mask'
  real, pointer, dimension(:,:) :: srestore_mask => null() !< mask for SSS restoring
  character(len=200)       :: temp_restore_file     !< filename for sst restoring data
  character(len=30)        :: temp_restore_var_name !< name of surface temperature in temp_restore_file
  logical                  :: mask_trestore         !< if true, apply a 2-dimensional mask to the surface
                                                    !! temperature restoring fluxes. The masking file should be
                                                    !! in inputdir/temp_restore_mask.nc and the field should
                                                    !! be named 'mask'
  real, pointer, dimension(:,:) :: trestore_mask => null() !< mask for SST restoring
  integer :: id_srestore = -1     !< id number for time_interp_external.
  integer :: id_trestore = -1     !< id number for time_interp_external.
 
  type(forcing_diags), public :: handles !< diagnostics handles
  type(mom_restart_cs), pointer :: restart_csp => null() !< restart pointer
  type(user_revise_forcing_cs), pointer :: urf_cs => null() !< user revise pointer
end type surface_forcing_cs
 
!> Structure corresponding to forcing, but with the elements, units, and conventions
!! that exactly conform to the use for MOM-based coupled models.
type, public :: ice_ocean_boundary_type
  real, pointer, dimension(:,:) :: rofl_flux         =>null() !< liquid runoff [kg/m2/s]
  real, pointer, dimension(:,:) :: rofi_flux         =>null() !< ice runoff [kg/m2/s]
  real, pointer, dimension(:,:) :: u_flux            =>null() !< i-direction wind stress [Pa]
  real, pointer, dimension(:,:) :: v_flux            =>null() !< j-direction wind stress [Pa]
  real, pointer, dimension(:,:) :: t_flux            =>null() !< sensible heat flux [W/m2]
  real, pointer, dimension(:,:) :: q_flux            =>null() !< specific humidity flux [kg/m2/s]
  real, pointer, dimension(:,:) :: salt_flux         =>null() !< salt flux [kg/m2/s]
  real, pointer, dimension(:,:) :: seaice_melt_heat  =>null() !< sea ice and snow melt heat flux [W/m2]
  real, pointer, dimension(:,:) :: seaice_melt       =>null() !< water flux due to sea ice and snow melting [kg/m2/s]
  real, pointer, dimension(:,:) :: lw_flux           =>null() !< long wave radiation [W/m2]
  real, pointer, dimension(:,:) :: sw_flux_vis_dir   =>null() !< direct visible sw radiation [W/m2]
  real, pointer, dimension(:,:) :: sw_flux_vis_dif   =>null() !< diffuse visible sw radiation [W/m2]
  real, pointer, dimension(:,:) :: sw_flux_nir_dir   =>null() !< direct Near InfraRed sw radiation [W/m2]
  real, pointer, dimension(:,:) :: sw_flux_nir_dif   =>null() !< diffuse Near InfraRed sw radiation [W/m2]
  real, pointer, dimension(:,:) :: lprec             =>null() !< mass flux of liquid precip [kg/m2/s]
  real, pointer, dimension(:,:) :: fprec             =>null() !< mass flux of frozen precip [kg/m2/s]
  real, pointer, dimension(:,:) :: runoff            =>null() !< mass flux of liquid runoff [kg/m2/s]
  real, pointer, dimension(:,:) :: calving           =>null() !< mass flux of frozen runoff [kg/m2/s]
  real, pointer, dimension(:,:) :: ustar_berg        =>null() !< frictional velocity beneath icebergs [m/s]
  real, pointer, dimension(:,:) :: area_berg         =>null() !< area covered by icebergs[m2/m2]
  real, pointer, dimension(:,:) :: mass_berg         =>null() !< mass of icebergs(kg/m2)
  real, pointer, dimension(:,:) :: runoff_hflx       =>null() !< heat content of liquid runoff [W/m2]
  real, pointer, dimension(:,:) :: calving_hflx      =>null() !< heat content of frozen runoff [W/m2]
  real, pointer, dimension(:,:) :: p                 =>null() !< pressure of overlying ice and atmosphere
                                                              !< on ocean surface [Pa]
  real, pointer, dimension(:,:) :: mi                =>null() !< mass of ice [kg/m2]
  real, pointer, dimension(:,:) :: ice_rigidity      =>null() !< rigidity of the sea ice, sea-ice and
                                                              !! ice-shelves, expressed as a coefficient
                                                              !! for divergence damping, as determined
                                                              !! outside of the ocean model in [m3/s]
  integer :: xtype                                            !< The type of the exchange - REGRID, REDIST or DIRECT
  type(coupler_2d_bc_type)      :: fluxes                     !< A structure that may contain an array of
                                                              !! named fields used for passive tracer fluxes.
  integer :: wind_stagger = -999                              !< A flag indicating the spatial discretization of
                                                              !! wind stresses.  This flag may be set by the
                                                              !! flux-exchange code, based on what the sea-ice
                                                              !! model is providing.  Otherwise, the value from
                                                              !! the surface_forcing_CS is used.
end type ice_ocean_boundary_type
 
integer :: id_clock_forcing
 
contains
 
!> This subroutine translates the Ice_ocean_boundary_type into a MOM
!! thermodynamic forcing type, including changes of units, sign conventions,
!! and putting the fields into arrays with MOM-standard halos.
subroutine convert_iob_to_fluxes(IOB, fluxes, index_bounds, Time, valid_time, G, US, CS, &
                                 sfc_state, restore_salt, restore_temp)
 
  type(ice_ocean_boundary_type), &
                 target, intent(in)    :: iob    !< An ice-ocean boundary type with fluxes to drive
                                                 !! the ocean in a coupled model
 
  type(forcing),           intent(inout) :: fluxes !< A structure containing pointers to all
                                                   !! possible mass, heat or salt flux forcing fields.
                                                   !!  Unused fields have NULL ptrs.
  integer, dimension(4),   intent(in)    :: index_bounds !< The i- and j- size of the arrays in IOB.
  type(time_type),         intent(in)    :: time   !< The time of the fluxes, used for interpolating the
                                                   !! salinity to the right time, when it is being restored.
  real,                    intent(in)    :: valid_time !< The amount of time over which these fluxes
                                                   !! should be applied [s].
  type(ocean_grid_type),   intent(inout) :: g      !< The ocean's grid structure
  type(unit_scale_type),   intent(in)    :: us     !< A dimensional unit scaling type
  type(surface_forcing_cs),pointer       :: cs     !< A pointer to the control structure returned by a
                                                   !! previous call to surface_forcing_init.
  type(surface),           intent(in)    :: sfc_state !< A structure containing fields that describe the
                                                      !! surface state of the ocean.
  logical,       optional, intent(in)    :: restore_salt !< If true, salinity is restored to a target value.
  logical,       optional, intent(in)    :: restore_temp !< If true, temperature is restored to a target value.
 
  ! local variables
  real, dimension(SZI_(G),SZJ_(G)) :: &
    data_restore,  & !< The surface value toward which to restore [g/kg or degC]
    sst_anom,      & !< Instantaneous sea surface temperature anomalies from a target value [deg C]
    sss_anom,      & !< Instantaneous sea surface salinity anomalies from a target value [g/kg]
    sss_mean,      & !< A (mean?) salinity about which to normalize local salinity
                     !! anomalies when calculating restorative precipitation anomalies [g/kg]
    pme_adj,       & !< The adjustment to PminusE that will cause the salinity
                     !! to be restored toward its target value [kg/(m^2 * s)]
    net_fw,        & !< The area integrated net freshwater flux into the ocean [kg/s]
    net_fw2,       & !< The area integrated net freshwater flux into the ocean [kg/s]
    work_sum,      & !< A 2-d array that is used as the work space for a global
                     !! sum, used with units of m2 or [kg/s]
    open_ocn_mask    !< a binary field indicating where ice is present based on frazil criteria
 
  integer :: i, j, is, ie, js, je, isq, ieq, jsq, jeq, i0, j0
  integer :: isd, ied, jsd, jed, isdb, iedb, jsdb, jedb, isr, ier, jsr, jer
  integer :: isc_bnd, iec_bnd, jsc_bnd, jec_bnd
 
  logical :: restore_salinity !< local copy of the argument restore_salt, if it
                              !! is present, or false (no restoring) otherwise.
  logical :: restore_sst      !< local copy of the argument restore_temp, if it
                              !! is present, or false (no restoring) otherwise.
  real :: delta_sss           !< temporary storage for sss diff from restoring value
  real :: delta_sst           !< temporary storage for sst diff from restoring value
 
  real :: kg_m2_s_conversion  !< A combination of unit conversion factors for rescaling
                              !! mass fluxes [R Z s m2 kg-1 T-1 ~> 1].
  real :: c_p                 !< heat capacity of seawater ( J/(K kg) )
  real :: sign_for_net_fw_bug !< Should be +1. but an old bug can be recovered by using -1.
 
  call cpu_clock_begin(id_clock_forcing)
 
  isc_bnd = index_bounds(1) ; iec_bnd = index_bounds(2)
  jsc_bnd = index_bounds(3) ; jec_bnd = index_bounds(4)
  is   = g%isc   ; ie   = g%iec    ; js   = g%jsc   ; je   = g%jec
  isq  = g%IscB  ; ieq  = g%IecB   ; jsq  = g%JscB  ; jeq  = g%JecB
  isd  = g%isd   ; ied  = g%ied    ; jsd  = g%jsd   ; jed  = g%jed
  isdb = g%IsdB  ; iedb = g%IedB   ; jsdb = g%JsdB  ; jedb = g%JedB
  isr = is-isd+1 ; ier  = ie-isd+1 ; jsr = js-jsd+1 ; jer = je-jsd+1
 
  kg_m2_s_conversion = us%kg_m3_to_R*us%m_to_Z*us%T_to_s
  c_p                    = fluxes%C_p
  open_ocn_mask(:,:)     = 1.0
  pme_adj(:,:)           = 0.0
  fluxes%vPrecGlobalAdj  = 0.0
  fluxes%vPrecGlobalScl  = 0.0
  fluxes%saltFluxGlobalAdj = 0.0
  fluxes%saltFluxGlobalScl = 0.0
  fluxes%netFWGlobalAdj = 0.0
  fluxes%netFWGlobalScl = 0.0
 
  restore_salinity = .false.
  if (present(restore_salt)) restore_salinity = restore_salt
  restore_sst = .false.
  if (present(restore_temp)) restore_sst = restore_temp
 
  ! allocation and initialization if this is the first time that this
  ! flux type has been used.
  if (fluxes%dt_buoy_accum < 0) then
    call allocate_forcing_type(g, fluxes, water=.true., heat=.true., &
                               ustar=.true., press=.true.)
 
    call safe_alloc_ptr(fluxes%sw_vis_dir,isd,ied,jsd,jed)
    call safe_alloc_ptr(fluxes%sw_vis_dif,isd,ied,jsd,jed)
    call safe_alloc_ptr(fluxes%sw_nir_dir,isd,ied,jsd,jed)
    call safe_alloc_ptr(fluxes%sw_nir_dif,isd,ied,jsd,jed)
 
    call safe_alloc_ptr(fluxes%p_surf,isd,ied,jsd,jed)
    call safe_alloc_ptr(fluxes%p_surf_full,isd,ied,jsd,jed)
    if (cs%use_limited_P_SSH) then
       fluxes%p_surf_SSH => fluxes%p_surf
    else
       fluxes%p_surf_SSH => fluxes%p_surf_full
    endif
 
    call safe_alloc_ptr(fluxes%salt_flux,isd,ied,jsd,jed)
    call safe_alloc_ptr(fluxes%salt_flux_in,isd,ied,jsd,jed)
    call safe_alloc_ptr(fluxes%salt_flux_added,isd,ied,jsd,jed)
 
    call safe_alloc_ptr(fluxes%TKE_tidal,isd,ied,jsd,jed)
    call safe_alloc_ptr(fluxes%ustar_tidal,isd,ied,jsd,jed)
 
    if (cs%allow_flux_adjustments) then
      call safe_alloc_ptr(fluxes%heat_added,isd,ied,jsd,jed)
      call safe_alloc_ptr(fluxes%salt_flux_added,isd,ied,jsd,jed)
    endif
 
    do j=js-2,je+2 ; do i=is-2,ie+2
      fluxes%TKE_tidal(i,j)   = cs%TKE_tidal(i,j)
      fluxes%ustar_tidal(i,j) = cs%ustar_tidal(i,j)
    enddo; enddo
 
    if (restore_temp) call safe_alloc_ptr(fluxes%heat_added,isd,ied,jsd,jed)
 
  endif   ! endif for allocation and initialization
 
 
  if (((associated(iob%ustar_berg) .and. (.not.associated(fluxes%ustar_berg))) &
    .or. (associated(iob%area_berg) .and. (.not.associated(fluxes%area_berg)))) &
    .or. (associated(iob%mass_berg) .and. (.not.associated(fluxes%mass_berg)))) &
    call allocate_forcing_type(g, fluxes, iceberg=.true.)
 
  if ((.not.coupler_type_initialized(fluxes%tr_fluxes)) .and. &
      coupler_type_initialized(iob%fluxes)) &
    call coupler_type_spawn(iob%fluxes, fluxes%tr_fluxes, &
                            (/is,is,ie,ie/), (/js,js,je,je/))
  !   It might prove valuable to use the same array extents as the rest of the
  ! ocean model, rather than using haloless arrays, in which case the last line
  ! would be: (             (/isd,is,ie,ied/), (/jsd,js,je,jed/))
 
  ! allocation and initialization on first call to this routine
  if (cs%area_surf < 0.0) then
    do j=js,je ; do i=is,ie
      work_sum(i,j) = us%L_to_m**2*g%areaT(i,j) * g%mask2dT(i,j)
    enddo; enddo
    cs%area_surf = reproducing_sum(work_sum, isr, ier, jsr, jer)
  endif    ! endif for allocation and initialization
 
 
  ! Indicate that there are new unused fluxes.
  fluxes%fluxes_used = .false.
  fluxes%dt_buoy_accum = us%s_to_T*valid_time
 
  if (cs%allow_flux_adjustments) then
    fluxes%heat_added(:,:)=0.0
    fluxes%salt_flux_added(:,:)=0.0
  endif
 
  do j=js,je ; do i=is,ie
    fluxes%salt_flux(i,j) = 0.0
    fluxes%vprec(i,j) = 0.0
  enddo; enddo
 
  ! Salinity restoring logic
  if (restore_salinity) then
    call time_interp_external(cs%id_srestore,time,data_restore)
    ! open_ocn_mask indicates where to restore salinity (1 means restore, 0 does not)
    open_ocn_mask(:,:) = 1.0
    if (cs%mask_srestore_under_ice) then ! Do not restore under sea-ice
      do j=js,je ; do i=is,ie
        if (sfc_state%SST(i,j) <= -0.0539*sfc_state%SSS(i,j)) open_ocn_mask(i,j)=0.0
      enddo; enddo
    endif
    if (cs%salt_restore_as_sflux) then
      do j=js,je ; do i=is,ie
        delta_sss = data_restore(i,j)- sfc_state%SSS(i,j)
        delta_sss = sign(1.0,delta_sss)*min(abs(delta_sss),cs%max_delta_srestore)
        fluxes%salt_flux(i,j) = 1.e-3*g%mask2dT(i,j) * (cs%Rho0*us%m_to_Z*us%T_to_s*cs%Flux_const)* &
             (cs%basin_mask(i,j)*open_ocn_mask(i,j)*cs%srestore_mask(i,j)) *delta_sss  ! R Z T-1 ~> kg Salt m-2 s-1
      enddo; enddo
      if (cs%adjust_net_srestore_to_zero) then
        if (cs%adjust_net_srestore_by_scaling) then
          call adjust_area_mean_to_zero(fluxes%salt_flux, g, fluxes%saltFluxGlobalScl, &
                          unit_scale=us%R_to_kg_m3*us%Z_to_m*us%s_to_T)
          fluxes%saltFluxGlobalAdj = 0.
        else
          work_sum(is:ie,js:je) = us%L_to_m**2*us%R_to_kg_m3*us%Z_to_m*us%s_to_T * &
                  g%areaT(is:ie,js:je)*fluxes%salt_flux(is:ie,js:je)
          fluxes%saltFluxGlobalAdj = reproducing_sum(work_sum(:,:), isr,ier, jsr,jer)/cs%area_surf
          fluxes%salt_flux(is:ie,js:je) = fluxes%salt_flux(is:ie,js:je) - kg_m2_s_conversion * fluxes%saltFluxGlobalAdj
        endif
      endif
      fluxes%salt_flux_added(is:ie,js:je) = fluxes%salt_flux(is:ie,js:je) ! Diagnostic
    else
      do j=js,je ; do i=is,ie
        if (g%mask2dT(i,j) > 0.5) then
          delta_sss = sfc_state%SSS(i,j) - data_restore(i,j)
          delta_sss = sign(1.0,delta_sss)*min(abs(delta_sss),cs%max_delta_srestore)
          fluxes%vprec(i,j) = (cs%basin_mask(i,j)*open_ocn_mask(i,j)*cs%srestore_mask(i,j))* &
               (us%m_to_Z*us%T_to_s * cs%Rho0*cs%Flux_const) * &
               delta_sss / (0.5*(sfc_state%SSS(i,j) + data_restore(i,j)))
        endif
      enddo; enddo
      if (cs%adjust_net_srestore_to_zero) then
        if (cs%adjust_net_srestore_by_scaling) then
          call adjust_area_mean_to_zero(fluxes%vprec, g, fluxes%vPrecGlobalScl, &
                                        unit_scale=us%R_to_kg_m3*us%Z_to_m*us%s_to_T)
          fluxes%vPrecGlobalAdj = 0.
        else
          work_sum(is:ie,js:je) = us%L_to_m**2*g%areaT(is:ie,js:je) * &
                                  us%R_to_kg_m3*us%Z_to_m*us%s_to_T*fluxes%vprec(is:ie,js:je)
          fluxes%vPrecGlobalAdj = reproducing_sum(work_sum(:,:), isr, ier, jsr, jer) / cs%area_surf
          do j=js,je ; do i=is,ie
            fluxes%vprec(i,j) = ( fluxes%vprec(i,j) - kg_m2_s_conversion*fluxes%vPrecGlobalAdj ) * g%mask2dT(i,j)
          enddo; enddo
        endif
      endif
    endif
  endif
 
  ! SST restoring logic
  if (restore_sst) then
    call time_interp_external(cs%id_trestore,time,data_restore)
    do j=js,je ; do i=is,ie
      delta_sst = data_restore(i,j)- sfc_state%SST(i,j)
      delta_sst = sign(1.0,delta_sst)*min(abs(delta_sst),cs%max_delta_trestore)
      fluxes%heat_added(i,j) = g%mask2dT(i,j) * cs%trestore_mask(i,j) * &
                      (us%R_to_kg_m3*cs%Rho0*fluxes%C_p) * delta_sst * cs%Flux_const   ! W m-2
    enddo; enddo
  endif
 
  ! obtain fluxes from IOB; note the staggering of indices
  i0 = 0; j0 = 0
  do j=js,je ; do i=is,ie
    ! liquid precipitation (rain)
    if (associated(iob%lprec)) &
      fluxes%lprec(i,j) = kg_m2_s_conversion * iob%lprec(i-i0,j-j0) * g%mask2dT(i,j)
 
    ! frozen precipitation (snow)
    if (associated(iob%fprec)) &
      fluxes%fprec(i,j) = kg_m2_s_conversion * iob%fprec(i-i0,j-j0) * g%mask2dT(i,j)
 
    ! evaporation
    if (associated(iob%q_flux)) &
      fluxes%evap(i,j) = kg_m2_s_conversion * iob%q_flux(i-i0,j-j0) * g%mask2dT(i,j)
 
    ! liquid runoff flux
    if (associated(iob%rofl_flux)) then
       fluxes%lrunoff(i,j) = kg_m2_s_conversion * iob%rofl_flux(i-i0,j-j0) * g%mask2dT(i,j)
    else if (associated(iob%runoff)) then
       fluxes%lrunoff(i,j) = kg_m2_s_conversion * iob%runoff(i-i0,j-j0) * g%mask2dT(i,j)
    end if
 
    ! ice runoff flux
    if (associated(iob%rofi_flux)) then
       fluxes%frunoff(i,j) = kg_m2_s_conversion * iob%rofi_flux(i-i0,j-j0) * g%mask2dT(i,j)
    else if (associated(iob%calving)) then
       fluxes%frunoff(i,j) = kg_m2_s_conversion * iob%calving(i-i0,j-j0) * g%mask2dT(i,j)
    end if
 
    if (associated(iob%ustar_berg)) &
         fluxes%ustar_berg(i,j) = us%m_to_Z * iob%ustar_berg(i-i0,j-j0) * g%mask2dT(i,j)
 
    if (associated(iob%area_berg)) &
         fluxes%area_berg(i,j) = iob%area_berg(i-i0,j-j0) * g%mask2dT(i,j)
 
    if (associated(iob%mass_berg)) &
         fluxes%mass_berg(i,j) = iob%mass_berg(i-i0,j-j0) * g%mask2dT(i,j)
 
    ! GMM, cime does not not have an equivalent for heat_content_lrunoff and
    ! heat_content_frunoff. I am seeting these to zero for now.
    if (associated(fluxes%heat_content_lrunoff)) &
      fluxes%heat_content_lrunoff(i,j) = 0.0 * g%mask2dT(i,j)
    if (associated(fluxes%heat_content_frunoff)) &
      fluxes%heat_content_frunoff(i,j) = 0.0 * g%mask2dT(i,j)
 
    if (associated(iob%calving_hflx)) &
         fluxes%heat_content_frunoff(i,j) = kg_m2_s_conversion * iob%calving_hflx(i-i0,j-j0) * g%mask2dT(i,j)
 
    ! longwave radiation, sum up and down (W/m2)
    if (associated(iob%lw_flux)) &
         fluxes%LW(i,j) = iob%lw_flux(i-i0,j-j0) * g%mask2dT(i,j)
 
    ! sensible heat flux (W/m2)
    if (associated(iob%t_flux)) &
         fluxes%sens(i,j) = iob%t_flux(i-i0,j-j0) * g%mask2dT(i,j)
 
    ! sea ice and snow melt heat flux [W/m2]
    if (associated(iob%seaice_melt_heat)) &
         fluxes%seaice_melt_heat(i,j) = g%mask2dT(i,j) * iob%seaice_melt_heat(i-i0,j-j0)
 
    ! water flux due to sea ice and snow melt [kg/m2/s]
    if (associated(iob%seaice_melt)) &
         fluxes%seaice_melt(i,j) = g%mask2dT(i,j) * kg_m2_s_conversion * iob%seaice_melt(i-i0,j-j0)
 
    ! latent heat flux (W/m^2)
    fluxes%latent(i,j) = 0.0
    ! contribution from frozen ppt
    if (associated(iob%fprec)) then
      fluxes%latent(i,j)              = fluxes%latent(i,j) + iob%fprec(i-i0,j-j0)*cs%latent_heat_fusion
      fluxes%latent_fprec_diag(i,j)   = g%mask2dT(i,j) * iob%fprec(i-i0,j-j0)*cs%latent_heat_fusion
    endif
    ! contribution from frozen runoff
    if (associated(fluxes%frunoff)) then
      fluxes%latent(i,j)              = fluxes%latent(i,j) + iob%rofi_flux(i-i0,j-j0)*cs%latent_heat_fusion
      fluxes%latent_frunoff_diag(i,j) = g%mask2dT(i,j) * iob%rofi_flux(i-i0,j-j0)*cs%latent_heat_fusion
    endif
    ! contribution from evaporation
    if (associated(iob%q_flux)) then
      fluxes%latent(i,j)             = fluxes%latent(i,j) + iob%q_flux(i-i0,j-j0)*cs%latent_heat_vapor
      fluxes%latent_evap_diag(i,j)  = g%mask2dT(i,j) * iob%q_flux(i-i0,j-j0)*cs%latent_heat_vapor
    endif
    fluxes%latent(i,j) = g%mask2dT(i,j) * fluxes%latent(i,j)
 
    if (associated(iob%sw_flux_vis_dir)) &
      fluxes%sw_vis_dir(i,j) = g%mask2dT(i,j) * iob%sw_flux_vis_dir(i-i0,j-j0)
 
    if (associated(iob%sw_flux_vis_dif)) &
      fluxes%sw_vis_dif(i,j) = g%mask2dT(i,j) * iob%sw_flux_vis_dif(i-i0,j-j0)
 
    if (associated(iob%sw_flux_nir_dir)) &
      fluxes%sw_nir_dir(i,j) = g%mask2dT(i,j) * iob%sw_flux_nir_dir(i-i0,j-j0)
 
    if (associated(iob%sw_flux_nir_dif)) &
      fluxes%sw_nir_dif(i,j) = g%mask2dT(i,j) * iob%sw_flux_nir_dif(i-i0,j-j0)
 
    fluxes%sw(i,j) = fluxes%sw_vis_dir(i,j) + fluxes%sw_vis_dif(i,j) + &
                     fluxes%sw_nir_dir(i,j) + fluxes%sw_nir_dif(i,j)
 
  enddo; enddo
 
  ! applied surface pressure from atmosphere and cryosphere
  if (associated(iob%p)) then
     if (cs%max_p_surf >= 0.0) then
        do j=js,je ; do i=is,ie
           fluxes%p_surf_full(i,j) = g%mask2dT(i,j) * iob%p(i-i0,j-j0)
           fluxes%p_surf(i,j) = min(fluxes%p_surf_full(i,j),cs%max_p_surf)
        enddo; enddo
     else
        do j=js,je ; do i=is,ie
           fluxes%p_surf_full(i,j) = g%mask2dT(i,j) * iob%p(i-i0,j-j0)
           fluxes%p_surf(i,j) = fluxes%p_surf_full(i,j)
        enddo; enddo
     endif
     fluxes%accumulate_p_surf = .true. ! Multiple components may contribute to surface pressure.
  endif
 
  if (associated(iob%salt_flux)) then
    do j=js,je ; do i=is,ie
      fluxes%salt_flux(i,j)    = g%mask2dT(i,j)*(fluxes%salt_flux(i,j) + kg_m2_s_conversion*iob%salt_flux(i-i0,j-j0))
      fluxes%salt_flux_in(i,j) = g%mask2dT(i,j)*( kg_m2_s_conversion*iob%salt_flux(i-i0,j-j0) )
    enddo ; enddo
  endif
 
  ! adjust the NET fresh-water flux to zero, if flagged
  if (cs%adjust_net_fresh_water_to_zero) then
    sign_for_net_fw_bug = 1.
    if (cs%use_net_FW_adjustment_sign_bug) sign_for_net_fw_bug = -1.
    do j=js,je ; do i=is,ie
      net_fw(i,j) = us%R_to_kg_m3*us%Z_to_m*us%s_to_T * &
        (((fluxes%lprec(i,j)   + fluxes%fprec(i,j) + fluxes%seaice_melt(i,j)) + &
          (fluxes%lrunoff(i,j) + fluxes%frunoff(i,j))) + &
          (fluxes%evap(i,j)    + fluxes%vprec(i,j)) ) * us%L_to_m**2*g%areaT(i,j)
 
      net_fw2(i,j) = net_fw(i,j) / (us%L_to_m**2*g%areaT(i,j))
    enddo; enddo
 
    if (cs%adjust_net_fresh_water_by_scaling) then
      call adjust_area_mean_to_zero(net_fw2, g, fluxes%netFWGlobalScl)
      do j=js,je ; do i=is,ie
        fluxes%vprec(i,j) = fluxes%vprec(i,j) + kg_m2_s_conversion * &
            (net_fw2(i,j) - net_fw(i,j)/(us%L_to_m**2*g%areaT(i,j))) * g%mask2dT(i,j)
      enddo; enddo
    else
      fluxes%netFWGlobalAdj = reproducing_sum(net_fw(:,:), isr, ier, jsr, jer) / cs%area_surf
      do j=js,je ; do i=is,ie
        fluxes%vprec(i,j) = ( fluxes%vprec(i,j) - kg_m2_s_conversion * fluxes%netFWGlobalAdj ) * g%mask2dT(i,j)
      enddo; enddo
    endif
  endif
 
  if (coupler_type_initialized(fluxes%tr_fluxes) .and. &
      coupler_type_initialized(iob%fluxes)) &
    call coupler_type_copy_data(iob%fluxes, fluxes%tr_fluxes)
 
  if (cs%allow_flux_adjustments) then
    ! Apply adjustments to fluxes
    call apply_flux_adjustments(g, us, cs, time, fluxes)
  endif
 
  ! Allow for user-written code to alter fluxes after all the above
  call user_alter_forcing(sfc_state, fluxes, time, g, cs%urf_CS)
 
  call cpu_clock_end(id_clock_forcing)
 
end subroutine convert_iob_to_fluxes
 
!> This subroutine translates the Ice_ocean_boundary_type into a MOM
!! mechanical forcing type, including changes of units, sign conventions,
!! and putting the fields into arrays with MOM-standard halos.
subroutine convert_iob_to_forces(IOB, forces, index_bounds, Time, G, US, CS)
  type(ice_ocean_boundary_type), &
                   target, intent(in)    :: iob    !< An ice-ocean boundary type with fluxes to drive
                                                   !! the ocean in a coupled model
  type(mech_forcing),      intent(inout) :: forces !< A structure with the driving mechanical forces
  integer, dimension(4),   intent(in)    :: index_bounds !< The i- and j- size of the arrays in IOB.
  type(time_type),         intent(in)    :: time   !< The time of the fluxes, used for interpolating the
                                                   !! salinity to the right time, when it is being restored.
  type(ocean_grid_type),   intent(inout) :: g      !< The ocean's grid structure
  type(unit_scale_type),   intent(in)    :: us     !< A dimensional unit scaling type
  type(surface_forcing_cs),pointer       :: cs     !< A pointer to the control structure returned by a
                                                   !! previous call to surface_forcing_init.
 
  ! local variables
  real, dimension(SZIB_(G),SZJB_(G)) :: &
    taux_at_q, & !< Zonal wind stresses at q points [R Z L T-2 ~> Pa]
    tauy_at_q    !< Meridional wind stresses at q points [R Z L T-2 ~> Pa]
 
  real, dimension(SZI_(G),SZJ_(G)) :: &
    rigidity_at_h, & !< Ice rigidity at tracer points [m3 s-1]
    taux_at_h, & !< Zonal wind stresses at h points [R Z L T-2 ~> Pa]
    tauy_at_h    !< Meridional wind stresses at h points [R Z L T-2 ~> Pa]
 
  real :: gustiness     !< unresolved gustiness that contributes to ustar [R Z L T-2 ~> Pa]
  real :: irho0         !< inverse of the mean density in [Z L-1 R-1 ~> m3 kg-1]
  real :: taux2, tauy2  !< squared wind stresses [R2 Z2 L2 T-4 ~> Pa2]
  real :: tau_mag       !< magnitude of the wind stress [R Z L T-2 ~> Pa]
  real :: pa_conversion ! A unit conversion factor from Pa to the internal wind stress units [R Z L T-2 Pa-1 ~> 1]
  real :: stress_conversion ! A unit conversion factor from Pa times any stress multiplier [R Z L T-2 Pa-1 ~> 1]
  real :: i_gearth      !< 1.0 / G%G_Earth  [s2 m-1]
  real :: kv_rho_ice    !< (CS%kv_sea_ice / CS%density_sea_ice) [m5 s-1 kg-1]
  real :: mass_ice      !< mass of sea ice at a face [kg m-2]
  real :: mass_eff      !< effective mass of sea ice for rigidity [kg m-2]
 
  integer :: wind_stagger  !< AGRID, BGRID_NE, or CGRID_NE (integers from MOM_domains)
  integer :: i, j, is, ie, js, je, isq, ieq, jsq, jeq, i0, j0
  integer :: isd, ied, jsd, jed, isdb, iedb, jsdb, jedb, isr, ier, jsr, jer
  integer :: isc_bnd, iec_bnd, jsc_bnd, jec_bnd
 
  call cpu_clock_begin(id_clock_forcing)
 
  isc_bnd = index_bounds(1) ; iec_bnd = index_bounds(2)
  jsc_bnd = index_bounds(3) ; jec_bnd = index_bounds(4)
  is   = g%isc   ; ie   = g%iec    ; js   = g%jsc   ; je   = g%jec
  isq  = g%IscB  ; ieq  = g%IecB   ; jsq  = g%JscB  ; jeq  = g%JecB
  isd  = g%isd   ; ied  = g%ied    ; jsd  = g%jsd   ; jed  = g%jed
  isdb = g%IsdB  ; iedb = g%IedB   ; jsdb = g%JsdB  ; jedb = g%JedB
  isr = is-isd+1 ; ier  = ie-isd+1 ; jsr = js-jsd+1 ; jer = je-jsd+1
 !i0 = is - isc_bnd ; j0 = js - jsc_bnd
  i0 = 0; j0 = 0
 
  irho0 = us%L_to_Z / cs%Rho0
  pa_conversion = us%kg_m3_to_R*us%m_s_to_L_T**2*us%L_to_Z
  stress_conversion = pa_conversion * cs%wind_stress_multiplier
 
  ! allocation and initialization if this is the first time that this
  ! mechanical forcing type has been used.
  if (.not.forces%initialized) then
 
    call allocate_mech_forcing(g, forces, stress=.true., ustar=.true., press=.true.)
 
    call safe_alloc_ptr(forces%p_surf,isd,ied,jsd,jed)
    call safe_alloc_ptr(forces%p_surf_full,isd,ied,jsd,jed)
 
    if (cs%rigid_sea_ice) then
      call safe_alloc_ptr(forces%rigidity_ice_u,isdb,iedb,jsd,jed)
      call safe_alloc_ptr(forces%rigidity_ice_v,isd,ied,jsdb,jedb)
    endif
 
    forces%initialized = .true.
  endif
 
  if ( (associated(iob%area_berg) .and. (.not. associated(forces%area_berg))) .or. &
       (associated(iob%mass_berg) .and. (.not. associated(forces%mass_berg))) ) &
    call allocate_mech_forcing(g, forces, iceberg=.true.)
  if (associated(iob%ice_rigidity)) then
    rigidity_at_h(:,:) = 0.0
    call safe_alloc_ptr(forces%rigidity_ice_u,isdb,iedb,jsd,jed)
    call safe_alloc_ptr(forces%rigidity_ice_v,isd,ied,jsdb,jedb)
  endif
 
  forces%accumulate_rigidity = .true. ! Multiple components may contribute to rigidity.
  if (associated(forces%rigidity_ice_u)) forces%rigidity_ice_u(:,:) = 0.0
  if (associated(forces%rigidity_ice_v)) forces%rigidity_ice_v(:,:) = 0.0
 
  !applied surface pressure from atmosphere and cryosphere
  if (cs%use_limited_P_SSH) then
     forces%p_surf_SSH => forces%p_surf
  else
     forces%p_surf_SSH => forces%p_surf_full
  endif
  if (associated(iob%p)) then
    if (cs%max_p_surf >= 0.0) then
      do j=js,je ; do i=is,ie
        forces%p_surf_full(i,j) = g%mask2dT(i,j) * iob%p(i-i0,j-j0)
        forces%p_surf(i,j) = min(forces%p_surf_full(i,j),cs%max_p_surf)
      enddo ; enddo
    else
      do j=js,je ; do i=is,ie
        forces%p_surf_full(i,j) = g%mask2dT(i,j) * iob%p(i-i0,j-j0)
        forces%p_surf(i,j) = forces%p_surf_full(i,j)
      enddo ; enddo
    endif
  else
    do j=js,je ; do i=is,ie
      forces%p_surf_full(i,j) = 0.0
      forces%p_surf(i,j) = 0.0
    enddo ; enddo
  endif
  forces%accumulate_p_surf = .true. ! Multiple components may contribute to surface pressure.
 
  ! GMM, CIME uses AGRID. All the BGRID_NE code can be cleaned later
  wind_stagger = agrid
 
  if (wind_stagger == bgrid_ne) then
    ! This is necessary to fill in the halo points.
    taux_at_q(:,:) = 0.0 ; tauy_at_q(:,:) = 0.0
  endif
  if (wind_stagger == agrid) then
    ! This is necessary to fill in the halo points.
    taux_at_h(:,:) = 0.0 ; tauy_at_h(:,:) = 0.0
  endif
 
  ! obtain fluxes from IOB; note the staggering of indices
  do j=js,je ; do i=is,ie
    if (associated(iob%area_berg)) &
      forces%area_berg(i,j) = iob%area_berg(i-i0,j-j0) * g%mask2dT(i,j)
 
    if (associated(iob%mass_berg)) &
      forces%mass_berg(i,j) = iob%mass_berg(i-i0,j-j0) * g%mask2dT(i,j)
 
    if (associated(iob%ice_rigidity)) &
      rigidity_at_h(i,j) = iob%ice_rigidity(i-i0,j-j0) * g%mask2dT(i,j)
 
    if (wind_stagger == bgrid_ne) then
      if (associated(iob%u_flux)) taux_at_q(i,j) = iob%u_flux(i-i0,j-j0) * stress_conversion
      if (associated(iob%v_flux)) tauy_at_q(i,j) = iob%v_flux(i-i0,j-j0) * stress_conversion
    elseif (wind_stagger == agrid) then
      if (associated(iob%u_flux)) taux_at_h(i,j) = iob%u_flux(i-i0,j-j0) * stress_conversion
      if (associated(iob%v_flux)) tauy_at_h(i,j) = iob%v_flux(i-i0,j-j0) * stress_conversion
    else ! C-grid wind stresses.
      if (associated(iob%u_flux)) forces%taux(i,j) = iob%u_flux(i-i0,j-j0) * stress_conversion
      if (associated(iob%v_flux)) forces%tauy(i,j) = iob%v_flux(i-i0,j-j0) * stress_conversion
    endif
 
  enddo ; enddo
 
  ! surface momentum stress related fields as function of staggering
  if (wind_stagger == bgrid_ne) then
    if (g%symmetric) &
      call fill_symmetric_edges(taux_at_q, tauy_at_q, g%Domain, stagger=bgrid_ne)
    call pass_vector(taux_at_q, tauy_at_q, g%Domain, stagger=bgrid_ne, halo=1)
 
    do j=js,je ; do i=isq,ieq
      forces%taux(i,j) = 0.0
      if ((g%mask2dBu(i,j) + g%mask2dBu(i,j-1)) > 0) &
        forces%taux(i,j) = (g%mask2dBu(i,j)*taux_at_q(i,j) + &
                            g%mask2dBu(i,j-1)*taux_at_q(i,j-1)) / &
                           (g%mask2dBu(i,j) + g%mask2dBu(i,j-1))
    enddo; enddo
 
    do j=jsq,jeq ; do i=is,ie
      forces%tauy(i,j) = 0.0
      if ((g%mask2dBu(i,j) + g%mask2dBu(i-1,j)) > 0) &
        forces%tauy(i,j) = (g%mask2dBu(i,j)*tauy_at_q(i,j) + &
                            g%mask2dBu(i-1,j)*tauy_at_q(i-1,j)) / &
                           (g%mask2dBu(i,j) + g%mask2dBu(i-1,j))
    enddo; enddo
 
    ! ustar is required for the bulk mixed layer formulation. The background value
    ! of 0.02 Pa is a relatively small value intended to give reasonable behavior
    ! in regions of very weak winds.
 
    do j=js,je ; do i=is,ie
      tau_mag = 0.0 ; gustiness = cs%gust_const
      if (((g%mask2dBu(i,j) + g%mask2dBu(i-1,j-1)) + &
           (g%mask2dBu(i,j-1) + g%mask2dBu(i-1,j))) > 0) then
        tau_mag = sqrt(((g%mask2dBu(i,j)*(taux_at_q(i,j)**2 + tauy_at_q(i,j)**2) + &
             g%mask2dBu(i-1,j-1)*(taux_at_q(i-1,j-1)**2 + tauy_at_q(i-1,j-1)**2)) + &
             (g%mask2dBu(i,j-1)*(taux_at_q(i,j-1)**2 + tauy_at_q(i,j-1)**2) + &
             g%mask2dBu(i-1,j)*(taux_at_q(i-1,j)**2 + tauy_at_q(i-1,j)**2)) ) / &
             ((g%mask2dBu(i,j) + g%mask2dBu(i-1,j-1)) + (g%mask2dBu(i,j-1) + g%mask2dBu(i-1,j))) )
        if (cs%read_gust_2d) gustiness = cs%gust(i,j)
      endif
      forces%ustar(i,j) = sqrt(gustiness*irho0 + irho0*tau_mag)
    enddo; enddo
 
  elseif (wind_stagger == agrid) then
    call pass_vector(taux_at_h, tauy_at_h, g%Domain, to_all+omit_corners, stagger=agrid, halo=1)
 
    do j=js,je ; do i=isq,ieq
      forces%taux(i,j) = 0.0
      if ((g%mask2dT(i,j) + g%mask2dT(i+1,j)) > 0) &
        forces%taux(i,j) = (g%mask2dT(i,j)*taux_at_h(i,j) + &
                            g%mask2dT(i+1,j)*taux_at_h(i+1,j)) / &
                           (g%mask2dT(i,j) + g%mask2dT(i+1,j))
    enddo; enddo
 
    do j=jsq,jeq ; do i=is,ie
      forces%tauy(i,j) = 0.0
      if ((g%mask2dT(i,j) + g%mask2dT(i,j+1)) > 0) &
        forces%tauy(i,j) = (g%mask2dT(i,j)*tauy_at_h(i,j) + &
                            g%mask2dT(i,j+1)*tauy_at_h(i,j+1)) / &
                           (g%mask2dT(i,j) + g%mask2dT(i,j+1))
    enddo; enddo
 
    do j=js,je ; do i=is,ie
      gustiness = cs%gust_const
      if (cs%read_gust_2d .and. (g%mask2dT(i,j) > 0)) gustiness = cs%gust(i,j)
      forces%ustar(i,j) = sqrt(gustiness*irho0 + irho0 * g%mask2dT(i,j) * &
                               sqrt(taux_at_h(i,j)**2 + tauy_at_h(i,j)**2))
    enddo; enddo
 
  else ! C-grid wind stresses.
    if (g%symmetric) &
      call fill_symmetric_edges(forces%taux, forces%tauy, g%Domain)
    call pass_vector(forces%taux, forces%tauy, g%Domain, halo=1)
 
    do j=js,je ; do i=is,ie
      taux2 = 0.0
      if ((g%mask2dCu(i-1,j) + g%mask2dCu(i,j)) > 0) &
        taux2 = (g%mask2dCu(i-1,j)*forces%taux(i-1,j)**2 + &
                 g%mask2dCu(i,j)*forces%taux(i,j)**2) / (g%mask2dCu(i-1,j) + g%mask2dCu(i,j))
 
      tauy2 = 0.0
      if ((g%mask2dCv(i,j-1) + g%mask2dCv(i,j)) > 0) &
        tauy2 = (g%mask2dCv(i,j-1)*forces%tauy(i,j-1)**2 + &
                 g%mask2dCv(i,j)*forces%tauy(i,j)**2) / (g%mask2dCv(i,j-1) + g%mask2dCv(i,j))
 
      if (cs%read_gust_2d) then
        forces%ustar(i,j) = sqrt(cs%gust(i,j)*irho0 + irho0*sqrt(taux2 + tauy2))
      else
        forces%ustar(i,j) = sqrt(cs%gust_const*irho0 + irho0*sqrt(taux2 + tauy2))
      endif
    enddo; enddo
 
  endif   ! endif for wind related fields
 
  ! sea ice related dynamic fields
  if (associated(iob%ice_rigidity)) then
    call pass_var(rigidity_at_h, g%Domain, halo=1)
    do i=is-1,ie ; do j=js,je
      forces%rigidity_ice_u(i,j) = forces%rigidity_ice_u(i,j) + &
              min(rigidity_at_h(i,j), rigidity_at_h(i+1,j))
    enddo ; enddo
    do i=is,ie ; do j=js-1,je
      forces%rigidity_ice_v(i,j) = forces%rigidity_ice_v(i,j) + &
              min(rigidity_at_h(i,j), rigidity_at_h(i,j+1))
    enddo ; enddo
  endif
 
  if (cs%rigid_sea_ice) then
    call pass_var(forces%p_surf_full, g%Domain, halo=1)
    i_gearth = 1.0 / cs%G_Earth
    kv_rho_ice = (cs%kv_sea_ice / cs%density_sea_ice)
    do i=is-1,ie ; do j=js,je
      mass_ice = min(forces%p_surf_full(i,j), forces%p_surf_full(i+1,j)) * i_gearth
      mass_eff = 0.0
      if (mass_ice > cs%rigid_sea_ice_mass) then
        mass_eff = (mass_ice - cs%rigid_sea_ice_mass) **2 / &
                   (mass_ice + cs%rigid_sea_ice_mass)
      endif
      forces%rigidity_ice_u(i,j) = forces%rigidity_ice_u(i,j) + kv_rho_ice * mass_eff
    enddo ; enddo
    do i=is,ie ; do j=js-1,je
      mass_ice = min(forces%p_surf_full(i,j), forces%p_surf_full(i,j+1)) * i_gearth
      mass_eff = 0.0
      if (mass_ice > cs%rigid_sea_ice_mass) then
        mass_eff = (mass_ice - cs%rigid_sea_ice_mass) **2 / &
                   (mass_ice + cs%rigid_sea_ice_mass)
      endif
      forces%rigidity_ice_v(i,j) = forces%rigidity_ice_v(i,j) + kv_rho_ice * mass_eff
    enddo ; enddo
  endif
 
  if (cs%allow_flux_adjustments) then
    ! Apply adjustments to forces
    call apply_force_adjustments(g, us, cs, time, forces)
  endif
 
!###  ! Allow for user-written code to alter fluxes after all the above
!###  call user_alter_mech_forcing(forces, Time, G, CS%urf_CS)
 
  call cpu_clock_end(id_clock_forcing)
end subroutine convert_iob_to_forces
 
!> Adds thermodynamic flux adjustments obtained via data_override
!! Component name is 'OCN'
!! Available adjustments are:
!! - hflx_adj (Heat flux into the ocean, in W m-2)
!! - sflx_adj (Salt flux into the ocean, in kg salt m-2 s-1)
!! - prcme_adj (Fresh water flux into the ocean, in kg m-2 s-1)
subroutine apply_flux_adjustments(G, US, CS, Time, fluxes)
  type(ocean_grid_type),    intent(inout) :: g !< Ocean grid structure
  type(unit_scale_type),    intent(in)    :: us !< A dimensional unit scaling type
  type(surface_forcing_cs), pointer       :: cs !< Surface forcing control structure
  type(time_type),          intent(in)    :: time !< Model time structure
  type(forcing),            intent(inout) :: fluxes !< Surface fluxes structure
 
  ! Local variables
  real, dimension(SZI_(G),SZJ_(G)) :: temp_at_h !< Fluxes at h points [W m-2 or kg m-2 s-1]
 
  integer :: isc, iec, jsc, jec, i, j
  logical :: overrode_h
 
  isc = g%isc; iec = g%iec ; jsc = g%jsc; jec = g%jec
 
  overrode_h = .false.
  call data_override('OCN', 'hflx_adj', temp_at_h(isc:iec,jsc:jec), time, override=overrode_h)
 
  if (overrode_h) then ; do j=jsc,jec ; do i=isc,iec
    fluxes%heat_added(i,j) = fluxes%heat_added(i,j) + temp_at_h(i,j)* g%mask2dT(i,j)
  enddo ; enddo ; endif
  ! Not needed? ! if (overrode_h) call pass_var(fluxes%heat_added, G%Domain)
 
  overrode_h = .false.
  call data_override('OCN', 'sflx_adj', temp_at_h(isc:iec,jsc:jec), time, override=overrode_h)
 
  if (overrode_h) then ; do j=jsc,jec ; do i=isc,iec
    fluxes%salt_flux_added(i,j) = fluxes%salt_flux_added(i,j) + &
            us%kg_m3_to_R*us%m_to_Z*us%T_to_s * temp_at_h(i,j)* g%mask2dT(i,j)
  enddo ; enddo ; endif
  ! Not needed? ! if (overrode_h) call pass_var(fluxes%salt_flux_added, G%Domain)
 
  overrode_h = .false.
  call data_override('OCN', 'prcme_adj', temp_at_h(isc:iec,jsc:jec), time, override=overrode_h)
 
  if (overrode_h) then ; do j=jsc,jec ; do i=isc,iec
    fluxes%vprec(i,j) = fluxes%vprec(i,j) + us%kg_m3_to_R*us%m_to_Z*us%T_to_s * temp_at_h(i,j)* g%mask2dT(i,j)
  enddo ; enddo ; endif
  ! Not needed? ! if (overrode_h) call pass_var(fluxes%vprec, G%Domain)
 
end subroutine apply_flux_adjustments
 
!> Adds mechanical forcing adjustments obtained via data_override
!! Component name is 'OCN'
!! Available adjustments are:
!! - taux_adj (Zonal wind stress delta, positive to the east, in Pa)
!! - tauy_adj (Meridional wind stress delta, positive to the north, in Pa)
subroutine apply_force_adjustments(G, US, CS, Time, forces)
  type(ocean_grid_type),    intent(inout) :: g  !< Ocean grid structure
  type(unit_scale_type),    intent(in)    :: us !< A dimensional unit scaling type
  type(surface_forcing_cs), pointer       :: cs !< Surface forcing control structure
  type(time_type),          intent(in)    :: time !< Model time structure
  type(mech_forcing),       intent(inout) :: forces !< A structure with the driving mechanical forces
 
  ! Local variables
  real, dimension(SZI_(G),SZJ_(G)) :: tempx_at_h !< Delta to zonal wind stress at h points [R Z L T-2 ~> Pa]
  real, dimension(SZI_(G),SZJ_(G)) :: tempy_at_h !< Delta to meridional wind stress at h points [R Z L T-2 ~> Pa]
 
  integer :: isc, iec, jsc, jec, i, j
  real :: dlondx, dlondy, rdlon, cosa, sina, zonal_tau, merid_tau
  real :: pa_conversion ! A unit conversion factor from Pa to the internal units [R Z L T-2 Pa-1 ~> 1]
  logical :: overrode_x, overrode_y
 
  isc = g%isc; iec = g%iec ; jsc = g%jsc; jec = g%jec
  pa_conversion = us%kg_m3_to_R*us%m_s_to_L_T**2*us%L_to_Z
 
  tempx_at_h(:,:) = 0.0 ; tempy_at_h(:,:) = 0.0
  ! Either reads data or leaves contents unchanged
  overrode_x = .false. ; overrode_y = .false.
  call data_override('OCN', 'taux_adj', tempx_at_h(isc:iec,jsc:jec), time, override=overrode_x)
  call data_override('OCN', 'tauy_adj', tempy_at_h(isc:iec,jsc:jec), time, override=overrode_y)
 
  if (overrode_x .or. overrode_y) then
    if (.not. (overrode_x .and. overrode_y)) call mom_error(fatal,"apply_flux_adjustments: "//&
            "Both taux_adj and tauy_adj must be specified, or neither, in data_table")
 
    ! Rotate winds
    call pass_vector(tempx_at_h, tempy_at_h, g%Domain, to_all, agrid, halo=1)
    do j=jsc-1,jec+1 ; do i=isc-1,iec+1
      dlondx = g%geoLonCu(i,j) - g%geoLonCu(i-1,j)
      dlondy = g%geoLonCv(i,j) - g%geoLonCv(i,j-1)
      rdlon = sqrt( dlondx * dlondx + dlondy * dlondy )
      if (rdlon > 0.) rdlon = 1. / rdlon
      cosa = dlondx * rdlon
      sina = dlondy * rdlon
      zonal_tau = pa_conversion * tempx_at_h(i,j)
      merid_tau = pa_conversion * tempy_at_h(i,j)
      tempx_at_h(i,j) = cosa * zonal_tau - sina * merid_tau
      tempy_at_h(i,j) = sina * zonal_tau + cosa * merid_tau
    enddo ; enddo
 
    ! Average to C-grid locations
    do j=jsc,jec ; do i=isc-1,iec
      forces%taux(i,j) = forces%taux(i,j) + 0.5 * ( tempx_at_h(i,j) + tempx_at_h(i+1,j) )
    enddo ; enddo
 
    do j=jsc-1,jec ; do i=isc,iec
      forces%tauy(i,j) = forces%tauy(i,j) + 0.5 * ( tempy_at_h(i,j) + tempy_at_h(i,j+1) )
    enddo ; enddo
  endif ! overrode_x .or. overrode_y
 
end subroutine apply_force_adjustments
 
!> Save any restart files associated with the surface forcing.
subroutine forcing_save_restart(CS, G, Time, directory, time_stamped, &
                                filename_suffix)
  type(surface_forcing_cs),   pointer       :: cs   !< A pointer to the control structure returned
                                                    !! by a previous call to surface_forcing_init
  type(ocean_grid_type),      intent(inout) :: g    !< The ocean's grid structure
  type(time_type),            intent(in)    :: time !< The current model time
  character(len=*),           intent(in)    :: directory !< The directory into which to write the
                                                    !! restart files
  logical,          optional, intent(in)    :: time_stamped !< If true, the restart file names include
                                                    !! a unique time stamp.  The default is false.
  character(len=*), optional, intent(in)    :: filename_suffix !< An optional suffix (e.g., a time-
                                                    !! stamp) to append to the restart file names.
 
  if (.not.associated(cs)) return
  if (.not.associated(cs%restart_CSp)) return
  call save_restart(directory, time, g, cs%restart_CSp, time_stamped)
 
end subroutine forcing_save_restart
 
!> Initialize the surface forcing, including setting parameters and allocating permanent memory.
subroutine surface_forcing_init(Time, G, US, param_file, diag, CS, restore_salt, restore_temp)
  type(time_type),          intent(in)    :: time !< The current model time
  type(ocean_grid_type),    intent(in)    :: g    !< The ocean's grid structure
  type(unit_scale_type),    intent(in)    :: us   !< A dimensional unit scaling type
  type(param_file_type),    intent(in)    :: param_file !< A structure to parse for run-time parameters
  type(diag_ctrl), target,  intent(inout) :: diag !< A structure that is used to regulate
                                                  !! diagnostic output
  type(surface_forcing_cs), pointer       :: cs   !< A pointer that is set to point to the control
                                                  !! structure for this module
  logical, optional,        intent(in)    :: restore_salt !< If present and true surface salinity
                                                  !! restoring will be applied in this model.
  logical, optional,        intent(in)    :: restore_temp !< If present and true surface temperature
                                                  !! restoring will be applied in this model.
 
  ! Local variables
  real :: utide  ! The RMS tidal velocity [Z T-1 ~> m s-1].
  type(directories)  :: dirs
  logical            :: new_sim, iceberg_flux_diags
  type(time_type)    :: time_frc
  character(len=200) :: tideamp_file, gust_file, salt_file, temp_file ! Input file names.
! This include declares and sets the variable "version".
#include "version_variable.h"
  character(len=40)  :: mdl = "MOM_surface_forcing_mct"  ! This module's name.
  character(len=48)  :: stagger
  character(len=48)  :: flnam
  character(len=240) :: basin_file
  integer :: i, j, isd, ied, jsd, jed
 
  isd = g%isd ; ied = g%ied ; jsd = g%jsd ; jed = g%jed
 
  if (associated(cs)) then
    call mom_error(warning, "surface_forcing_init called with an associated "// &
                            "control structure.")
    return
  endif
  allocate(cs)
 
  id_clock_forcing=cpu_clock_id('Ocean surface forcing', grain=clock_subcomponent)
  call cpu_clock_begin(id_clock_forcing)
 
  cs%diag => diag
 
  call write_version_number(version)
  ! Read all relevant parameters and write them to the model log.
  call log_version(param_file, mdl, version, "")
 
  call get_param(param_file, mdl, "INPUTDIR", cs%inputdir, &
                 "The directory in which all input files are found.", &
                 default=".")
  cs%inputdir = slasher(cs%inputdir)
  call get_param(param_file, mdl, "ENABLE_THERMODYNAMICS", cs%use_temperature, &
                 "If true, Temperature and salinity are used as state "//&
                 "variables.", default=.true.)
  call get_param(param_file, mdl, "RHO_0", cs%Rho0, &
                 "The mean ocean density used with BOUSSINESQ true to "//&
                 "calculate accelerations and the mass for conservation "//&
                 "properties, or with BOUSSINSEQ false to convert some "//&
                 "parameters from vertical units of m to kg m-2.", &
                 units="kg m-3", default=1035.0, scale=us%kg_m3_to_R)
  call get_param(param_file, mdl, "LATENT_HEAT_FUSION", cs%latent_heat_fusion, &
                 "The latent heat of fusion.", units="J/kg", default=hlf)
  call get_param(param_file, mdl, "LATENT_HEAT_VAPORIZATION", cs%latent_heat_vapor, &
                 "The latent heat of fusion.", units="J/kg", default=hlv)
  call get_param(param_file, mdl, "MAX_P_SURF", cs%max_p_surf, &
                 "The maximum surface pressure that can be exerted by the "//&
                 "atmosphere and floating sea-ice or ice shelves. This is "//&
                 "needed because the FMS coupling structure does not "//&
                 "limit the water that can be frozen out of the ocean and "//&
                 "the ice-ocean heat fluxes are treated explicitly.  No "//&
                 "limit is applied if a negative value is used.", units="Pa", &
                 default=-1.0)
  call get_param(param_file, mdl, "ADJUST_NET_SRESTORE_TO_ZERO", &
                 cs%adjust_net_srestore_to_zero, &
                 "If true, adjusts the salinity restoring seen to zero "//&
                 "whether restoring is via a salt flux or virtual precip.",&
                 default=restore_salt)
  call get_param(param_file, mdl, "ADJUST_NET_SRESTORE_BY_SCALING", &
                 cs%adjust_net_srestore_by_scaling, &
                 "If true, adjustments to salt restoring to achieve zero net are "//&
                 "made by scaling values without moving the zero contour.",&
                 default=.false.)
  call get_param(param_file, mdl, "ADJUST_NET_FRESH_WATER_TO_ZERO", &
                 cs%adjust_net_fresh_water_to_zero, &
                 "If true, adjusts the net fresh-water forcing seen "//&
                 "by the ocean (including restoring) to zero.", default=.false.)
  if (cs%adjust_net_fresh_water_to_zero) &
    call get_param(param_file, mdl, "USE_NET_FW_ADJUSTMENT_SIGN_BUG", &
                 cs%use_net_FW_adjustment_sign_bug, &
                   "If true, use the wrong sign for the adjustment to "//&
                   "the net fresh-water.", default=.false.)
  call get_param(param_file, mdl, "ADJUST_NET_FRESH_WATER_BY_SCALING", &
                 cs%adjust_net_fresh_water_by_scaling, &
                 "If true, adjustments to net fresh water to achieve zero net are "//&
                 "made by scaling values without moving the zero contour.",&
                 default=.false.)
  call get_param(param_file, mdl, "ICE_SALT_CONCENTRATION", &
                 cs%ice_salt_concentration, &
                 "The assumed sea-ice salinity needed to reverse engineer the "//&
                 "melt flux (or ice-ocean fresh-water flux).", &
                 units="kg/kg", default=0.005)
  call get_param(param_file, mdl, "USE_LIMITED_PATM_SSH", cs%use_limited_P_SSH, &
                 "If true, return the sea surface height with the "//&
                 "correction for the atmospheric (and sea-ice) pressure "//&
                 "limited by max_p_surf instead of the full atmospheric "//&
                 "pressure.", default=.true.)
 
  call get_param(param_file, mdl, "WIND_STAGGER", stagger, &
                 "A case-insensitive character string to indicate the "//&
                 "staggering of the input wind stress field.  Valid "//&
                 "values are 'A', 'B', or 'C'.", default="C")
  if (uppercase(stagger(1:1)) == 'A') then ; cs%wind_stagger = agrid
  elseif (uppercase(stagger(1:1)) == 'B') then ; cs%wind_stagger = bgrid_ne
  elseif (uppercase(stagger(1:1)) == 'C') then ; cs%wind_stagger = cgrid_ne
  else ; call mom_error(fatal,"surface_forcing_init: WIND_STAGGER = "// &
                        trim(stagger)//" is invalid.") ; endif
  call get_param(param_file, mdl, "WIND_STRESS_MULTIPLIER", cs%wind_stress_multiplier, &
                 "A factor multiplying the wind-stress given to the ocean by the "//&
                 "coupler. This is used for testing and should be =1.0 for any "//&
                 "production runs.", default=1.0)
 
  if (restore_salt) then
    call get_param(param_file, mdl, "FLUXCONST", cs%Flux_const, &
                 "The constant that relates the restoring surface fluxes "//&
                 "to the relative surface anomalies (akin to a piston "//&
                 "velocity).  Note the non-MKS units.", units="m day-1", &
                 fail_if_missing=.true.)
    call get_param(param_file, mdl, "SALT_RESTORE_FILE", cs%salt_restore_file, &
                 "A file in which to find the surface salinity to use for restoring.", &
                 default="salt_restore.nc")
    call get_param(param_file, mdl, "SALT_RESTORE_VARIABLE", cs%salt_restore_var_name, &
                 "The name of the surface salinity variable to read from "//&
                 "SALT_RESTORE_FILE for restoring salinity.", &
                 default="salt")
! Convert CS%Flux_const from m day-1 to m s-1.
    cs%Flux_const = cs%Flux_const / 86400.0
 
    call get_param(param_file, mdl, "SRESTORE_AS_SFLUX", cs%salt_restore_as_sflux, &
                 "If true, the restoring of salinity is applied as a salt "//&
                 "flux instead of as a freshwater flux.", default=.false.)
    call get_param(param_file, mdl, "MAX_DELTA_SRESTORE", cs%max_delta_srestore, &
                 "The maximum salinity difference used in restoring terms.", &
                 units="PSU or g kg-1", default=999.0)
    call get_param(param_file, mdl, "MASK_SRESTORE_UNDER_ICE", &
                 cs%mask_srestore_under_ice, &
                 "If true, disables SSS restoring under sea-ice based on a frazil "//&
                 "criteria (SST<=Tf). Only used when RESTORE_SALINITY is True.",      &
                 default=.false.)
    call get_param(param_file, mdl, "MASK_SRESTORE_MARGINAL_SEAS", &
                 cs%mask_srestore_marginal_seas, &
                 "If true, disable SSS restoring in marginal seas. Only used when "//&
                 "RESTORE_SALINITY is True.", default=.false.)
    call get_param(param_file, mdl, "BASIN_FILE", basin_file, &
                 "A file in which to find the basin masks, in variable 'basin'.", &
                 default="basin.nc")
    basin_file = trim(cs%inputdir) // trim(basin_file)
    call safe_alloc_ptr(cs%basin_mask,isd,ied,jsd,jed) ; cs%basin_mask(:,:) = 1.0
    if (cs%mask_srestore_marginal_seas) then
      call mom_read_data(basin_file,'basin',cs%basin_mask,g%domain, timelevel=1)
      do j=jsd,jed ; do i=isd,ied
        if (cs%basin_mask(i,j) >= 6.0) then ; cs%basin_mask(i,j) = 0.0
        else ; cs%basin_mask(i,j) = 1.0 ; endif
      enddo ; enddo
    endif
    call get_param(param_file, mdl, "MASK_SRESTORE", cs%mask_srestore, &
                 "If true, read a file (salt_restore_mask) containing "//&
                 "a mask for SSS restoring.", default=.false.)
  endif
 
  if (restore_temp) then
    call get_param(param_file, mdl, "FLUXCONST", cs%Flux_const, &
                 "The constant that relates the restoring surface fluxes "//&
                 "to the relative surface anomalies (akin to a piston "//&
                 "velocity).  Note the non-MKS units.", units="m day-1", &
                 fail_if_missing=.true.)
    call get_param(param_file, mdl, "SST_RESTORE_FILE", cs%temp_restore_file, &
                 "A file in which to find the surface temperature to use for restoring.", &
                 default="temp_restore.nc")
    call get_param(param_file, mdl, "SST_RESTORE_VARIABLE", cs%temp_restore_var_name, &
                 "The name of the surface temperature variable to read from "//&
                 "SST_RESTORE_FILE for restoring sst.", &
                 default="temp")
  ! Convert CS%Flux_const from m day-1 to m s-1.
    cs%Flux_const = cs%Flux_const / 86400.0
 
    call get_param(param_file, mdl, "MAX_DELTA_TRESTORE", cs%max_delta_trestore, &
                 "The maximum sst difference used in restoring terms.", &
                 units="degC ", default=999.0)
 
    call get_param(param_file, mdl, "MASK_TRESTORE", cs%mask_trestore, &
                 "If true, read a file (temp_restore_mask) containing "//&
                 "a mask for SST restoring.", default=.false.)
  endif
 
! Optionally read tidal amplitude from input file (m s-1) on model grid.
! Otherwise use default tidal amplitude for bottom frictionally-generated
! dissipation. Default cd_tides is chosen to yield approx 1 TWatt of
! work done against tides globally using OSU tidal amplitude.
  call get_param(param_file, mdl, "CD_TIDES", cs%cd_tides, &
                 "The drag coefficient that applies to the tides.", &
                 units="nondim", default=1.0e-4)
  call get_param(param_file, mdl, "READ_TIDEAMP", cs%read_TIDEAMP, &
                 "If true, read a file (given by TIDEAMP_FILE) containing "//&
                 "the tidal amplitude with INT_TIDE_DISSIPATION.", default=.false.)
  if (cs%read_TIDEAMP) then
    call get_param(param_file, mdl, "TIDEAMP_FILE", tideamp_file, &
                 "The path to the file containing the spatially varying "//&
                 "tidal amplitudes with INT_TIDE_DISSIPATION.", &
                 default="tideamp.nc")
    cs%utide=0.0
  else
    call get_param(param_file, mdl, "UTIDE", cs%utide, &
                 "The constant tidal amplitude used with INT_TIDE_DISSIPATION.", &
                 units="m s-1", default=0.0, scale=us%m_to_Z*us%T_to_s)
  endif
 
  call safe_alloc_ptr(cs%TKE_tidal,isd,ied,jsd,jed)
  call safe_alloc_ptr(cs%ustar_tidal,isd,ied,jsd,jed)
 
  if (cs%read_TIDEAMP) then
    tideamp_file = trim(cs%inputdir) // trim(tideamp_file)
    call mom_read_data(tideamp_file,'tideamp',cs%TKE_tidal,g%domain,timelevel=1, scale=us%m_to_Z*us%T_to_s)
    do j=jsd, jed; do i=isd, ied
      utide = cs%TKE_tidal(i,j)
      cs%TKE_tidal(i,j) = g%mask2dT(i,j)*cs%Rho0*cs%cd_tides*(utide*utide*utide)
      cs%ustar_tidal(i,j) = sqrt(cs%cd_tides)*utide
    enddo ; enddo
  else
    do j=jsd,jed; do i=isd,ied
      utide = cs%utide
      cs%TKE_tidal(i,j) = cs%Rho0*cs%cd_tides*(utide*utide*utide)
      cs%ustar_tidal(i,j) = sqrt(cs%cd_tides)*utide
    enddo ; enddo
  endif
 
  call time_interp_external_init
 
! Optionally read a x-y gustiness field in place of a global
! constant.
 
  call get_param(param_file, mdl, "READ_GUST_2D", cs%read_gust_2d, &
                 "If true, use a 2-dimensional gustiness supplied from "//&
                 "an input file", default=.false.)
  call get_param(param_file, mdl, "GUST_CONST", cs%gust_const, &
               "The background gustiness in the winds.", units="Pa", &
               default=0.02)
  if (cs%read_gust_2d) then
    call get_param(param_file, mdl, "GUST_2D_FILE", gust_file, &
                 "The file in which the wind gustiness is found in "//&
                 "variable gustiness.")
 
    call safe_alloc_ptr(cs%gust,isd,ied,jsd,jed)
    gust_file = trim(cs%inputdir) // trim(gust_file)
    call mom_read_data(gust_file,'gustiness',cs%gust,g%domain, timelevel=1, &
               scale=us%kg_m3_to_R*us%m_s_to_L_T**2*us%L_to_Z) ! units in file should be Pa
  endif
 
! See whether sufficiently thick sea ice should be treated as rigid.
  call get_param(param_file, mdl, "USE_RIGID_SEA_ICE", cs%rigid_sea_ice, &
                 "If true, sea-ice is rigid enough to exert a "//&
                 "nonhydrostatic pressure that resist vertical motion.", &
                 default=.false.)
  if (cs%rigid_sea_ice) then
    call get_param(param_file, mdl, "G_EARTH", cs%g_Earth, &
                 "The gravitational acceleration of the Earth.", &
                 units="m s-2", default = 9.80)
    call get_param(param_file, mdl, "SEA_ICE_MEAN_DENSITY", cs%density_sea_ice, &
                 "A typical density of sea ice, used with the kinematic "//&
                 "viscosity, when USE_RIGID_SEA_ICE is true.", units="kg m-3", &
                 default=900.0)
    call get_param(param_file, mdl, "SEA_ICE_VISCOSITY", cs%Kv_sea_ice, &
                 "The kinematic viscosity of sufficiently thick sea ice "//&
                 "for use in calculating the rigidity of sea ice.", &
                 units="m2 s-1", default=1.0e9)
    call get_param(param_file, mdl, "SEA_ICE_RIGID_MASS", cs%rigid_sea_ice_mass, &
                 "The mass of sea-ice per unit area at which the sea-ice "//&
                 "starts to exhibit rigidity", units="kg m-2", default=1000.0)
  endif
 
  call get_param(param_file, mdl, "ALLOW_ICEBERG_FLUX_DIAGNOSTICS", iceberg_flux_diags, &
                 "If true, makes available diagnostics of fluxes from icebergs "//&
                 "as seen by MOM6.", default=.false.)
  call register_forcing_type_diags(time, diag, us, cs%use_temperature, cs%handles, &
                                   use_berg_fluxes=iceberg_flux_diags)
 
  call get_param(param_file, mdl, "ALLOW_FLUX_ADJUSTMENTS", cs%allow_flux_adjustments, &
                 "If true, allows flux adjustments to specified via the "//&
                 "data_table using the component name 'OCN'.", default=.false.)
  if (cs%allow_flux_adjustments) then
    call data_override_init(ocean_domain_in=g%Domain%mpp_domain)
  endif
 
  if (present(restore_salt)) then ; if (restore_salt) then
    salt_file = trim(cs%inputdir) // trim(cs%salt_restore_file)
    cs%id_srestore = init_external_field(salt_file, cs%salt_restore_var_name, domain=g%Domain%mpp_domain)
    call safe_alloc_ptr(cs%srestore_mask,isd,ied,jsd,jed); cs%srestore_mask(:,:) = 1.0
    if (cs%mask_srestore) then ! read a 2-d file containing a mask for restoring fluxes
      flnam = trim(cs%inputdir) // 'salt_restore_mask.nc'
      call mom_read_data(flnam,'mask', cs%srestore_mask, g%domain, timelevel=1)
    endif
  endif ; endif
 
  if (present(restore_temp)) then ; if (restore_temp) then
    temp_file = trim(cs%inputdir) // trim(cs%temp_restore_file)
    cs%id_trestore = init_external_field(temp_file, cs%temp_restore_var_name, domain=g%Domain%mpp_domain)
    call safe_alloc_ptr(cs%trestore_mask,isd,ied,jsd,jed); cs%trestore_mask(:,:) = 1.0
    if (cs%mask_trestore) then  ! read a 2-d file containing a mask for restoring fluxes
      flnam = trim(cs%inputdir) // 'temp_restore_mask.nc'
      call mom_read_data(flnam, 'mask', cs%trestore_mask, g%domain, timelevel=1)
    endif
  endif ; endif
 
  ! Set up any restart fields associated with the forcing.
  call restart_init(param_file, cs%restart_CSp, "MOM_forcing.res")
  call restart_init_end(cs%restart_CSp)
 
  if (associated(cs%restart_CSp)) then
    call get_mom_input(dirs=dirs)
 
    new_sim = .false.
    if ((dirs%input_filename(1:1) == 'n') .and. &
        (len_trim(dirs%input_filename) == 1)) new_sim = .true.
    if (.not.new_sim) then
      call restore_state(dirs%input_filename, dirs%restart_input_dir, time_frc, &
                         g, cs%restart_CSp)
    endif
  endif
 
  call user_revise_forcing_init(param_file, cs%urf_CS)
 
  call cpu_clock_end(id_clock_forcing)
end subroutine surface_forcing_init
 
!> Clean up and deallocate any memory associated with this module and its children.
subroutine surface_forcing_end(CS, fluxes)
  type(surface_forcing_cs), pointer       :: cs !< A pointer to the control structure returned by
                                                !! a previous call to surface_forcing_init, it will
                                                !! be deallocated here.
  type(forcing), optional,  intent(inout) :: fluxes !< A structure containing pointers to all
                                                !! possible mass, heat or salt flux forcing fields.
                                                !! If present, it will be deallocated here.
 
  if (present(fluxes)) call deallocate_forcing_type(fluxes)
 
  if (associated(cs)) deallocate(cs)
  cs => null()
 
end subroutine surface_forcing_end
 
!> Write out a set of messages with checksums of the fields in an ice_ocen_boundary type
subroutine ice_ocn_bnd_type_chksum(id, timestep, iobt)
 
  character(len=*), intent(in) :: id     !< An identifying string for this call
  integer,          intent(in) :: timestep !< The number of elapsed timesteps
  type(ice_ocean_boundary_type), &
                    intent(in) :: iobt   !< An ice-ocean boundary type with fluxes to drive the
                                         !! ocean in a coupled model whose checksums are reported
 
  ! local variables
  integer ::   n,m, outunit
 
  outunit = stdout()
 
  write(outunit,*) "BEGIN CHECKSUM(ice_ocean_boundary_type):: ", id, timestep
  write(outunit,100) 'iobt%u_flux         '   , mpp_chksum( iobt%u_flux         )
  write(outunit,100) 'iobt%v_flux         '   , mpp_chksum( iobt%v_flux         )
  write(outunit,100) 'iobt%t_flux         '   , mpp_chksum( iobt%t_flux         )
  write(outunit,100) 'iobt%q_flux         '   , mpp_chksum( iobt%q_flux         )
  write(outunit,100) 'iobt%salt_flux      '   , mpp_chksum( iobt%salt_flux      )
  write(outunit,100) 'iobt%seaice_melt_heat'  , mpp_chksum( iobt%seaice_melt_heat)
  write(outunit,100) 'iobt%seaice_melt    '   , mpp_chksum( iobt%seaice_melt    )
  write(outunit,100) 'iobt%lw_flux        '   , mpp_chksum( iobt%lw_flux        )
  write(outunit,100) 'iobt%sw_flux_vis_dir'   , mpp_chksum( iobt%sw_flux_vis_dir)
  write(outunit,100) 'iobt%sw_flux_vis_dif'   , mpp_chksum( iobt%sw_flux_vis_dif)
  write(outunit,100) 'iobt%sw_flux_nir_dir'   , mpp_chksum( iobt%sw_flux_nir_dir)
  write(outunit,100) 'iobt%sw_flux_nir_dif'   , mpp_chksum( iobt%sw_flux_nir_dif)
  write(outunit,100) 'iobt%lprec          '   , mpp_chksum( iobt%lprec          )
  write(outunit,100) 'iobt%fprec          '   , mpp_chksum( iobt%fprec          )
  write(outunit,100) 'iobt%runoff         '   , mpp_chksum( iobt%runoff         )
  write(outunit,100) 'iobt%calving        '   , mpp_chksum( iobt%calving        )
  write(outunit,100) 'iobt%p              '   , mpp_chksum( iobt%p              )
  if (associated(iobt%ustar_berg)) &
    write(outunit,100) 'iobt%ustar_berg     ' , mpp_chksum( iobt%ustar_berg )
  if (associated(iobt%area_berg)) &
    write(outunit,100) 'iobt%area_berg      ' , mpp_chksum( iobt%area_berg  )
  if (associated(iobt%mass_berg)) &
    write(outunit,100) 'iobt%mass_berg      ' , mpp_chksum( iobt%mass_berg  )
100 FORMAT("   CHECKSUM::",a20," = ",z20)
 
  call coupler_type_write_chksums(iobt%fluxes, outunit, 'iobt%')
 
end subroutine ice_ocn_bnd_type_chksum
 
end module mom_surface_forcing_mct