Merge pull request #112 from gustavo-marques/mct_nuopc_validation

Refactor MCT driver to make modules consistent with those in the NUOPC driver
NCAR · Jul 25, 2019 · 06a7c46 · 06a7c46
2 parents b9844d7 + 562297c
commit 06a7c46
Show file tree

Hide file tree

Showing 6 changed files with 983 additions and 815 deletions.
diff --git a/config_src/mct_driver/MOM_ocean_model.F90 b/config_src/mct_driver/MOM_ocean_model.F90
diff --git a/config_src/mct_driver/MOM_surface_forcing.F90 b/config_src/mct_driver/MOM_surface_forcing.F90
diff --git a/config_src/mct_driver/ocn_cap_methods.F90 b/config_src/mct_driver/ocn_cap_methods.F90
@@ -71,9 +71,6 @@ subroutine ocn_import(x2o, ind, grid, ice_ocean_boundary, ocean_public, logunit,
       ! sensible heat flux (W/m2)
       ice_ocean_boundary%t_flux(i,j) = x2o(ind%x2o_Foxx_sen,k)
 
-      ! latent heat flux (W/m^2)
-      ice_ocean_boundary%latent_flux(i,j) = x2o(ind%x2o_Foxx_lat,k)
-
       ! snow&ice melt heat flux  (W/m^2)
       ice_ocean_boundary%seaice_melt_heat(i,j) = x2o(ind%x2o_Fioi_melth,k)
 
@@ -89,8 +86,8 @@ subroutine ocn_import(x2o, ind, grid, ice_ocean_boundary, ocean_public, logunit,
       ! surface pressure
       ice_ocean_boundary%p(i,j) = x2o(ind%x2o_Sa_pslv,k) * GRID%mask2dT(i,j)
 
-      ! salt flux (minus sign needed here -GMM)
-      ice_ocean_boundary%salt_flux(i,j) = -x2o(ind%x2o_Fioi_salt,k) * GRID%mask2dT(i,j)
+      ! salt flux
+      ice_ocean_boundary%salt_flux(i,j) = x2o(ind%x2o_Fioi_salt,k) * GRID%mask2dT(i,j)
 
       ! 1) visible, direct shortwave  (W/m2)
       ! 2) visible, diffuse shortwave (W/m2)
@@ -127,8 +124,6 @@ subroutine ocn_import(x2o, ind, grid, ice_ocean_boundary, ocean_public, logunit,
                           day,secs,j,i,ice_ocean_boundary%seaice_melt_heat(i,j)
         write(logunit,F01)'import: day, secs, j, i, seaice_melt      = ',&
                           day,secs,j,i,ice_ocean_boundary%seaice_melt(i,j)
-        write(logunit,F01)'import: day, secs, j, i, latent_flux     = ',&
-                          day,secs,j,i,ice_ocean_boundary%latent_flux(i,j)
         write(logunit,F01)'import: day, secs, j, i, runoff          = ',&
                           day,secs,j,i,ice_ocean_boundary%rofl_flux(i,j) + ice_ocean_boundary%rofi_flux(i,j)
         write(logunit,F01)'import: day, secs, j, i, psurf           = ',&

diff --git a/config_src/mct_driver/ocn_comp_mct.F90 b/config_src/mct_driver/ocn_comp_mct.F90
@@ -24,8 +24,6 @@ module ocn_comp_mct
                                shr_file_getLogUnit, shr_file_getLogLevel, &
                                shr_file_setLogUnit, shr_file_setLogLevel
 
-use MOM_surface_forcing, only: IOB_allocate, ice_ocean_boundary_type
-
 ! MOM6 modules
 use MOM,                  only: extract_surface_state
 use MOM_variables,        only: surface
@@ -49,7 +47,7 @@ module ocn_comp_mct
 use MOM_ocean_model,      only: ocean_public_type, ocean_state_type
 use MOM_ocean_model,      only: ocean_model_init , update_ocean_model, ocean_model_end
 use MOM_ocean_model,      only: convert_state_to_ocean_type
-use MOM_surface_forcing,  only: surface_forcing_CS, forcing_save_restart
+use MOM_surface_forcing,  only: surface_forcing_CS, forcing_save_restart, ice_ocean_boundary_type
 use ocn_cap_methods,      only: ocn_import, ocn_export
 
 ! FMS modules
@@ -813,4 +811,61 @@ end subroutine ocean_model_init_sfc
 !! CO2
 !! DMS
 
+!> Allocates ice-ocean boundary type containers and sets to 0.
+subroutine IOB_allocate(IOB, isc, iec, jsc, jec)
+  type(ice_ocean_boundary_type), intent(inout)    :: IOB    !< An ice-ocean boundary type with fluxes to drive
+  integer, intent(in) :: isc, iec, jsc, jec                 !< The ocean's local grid size
+
+  allocate ( IOB% rofl_flux (isc:iec,jsc:jec),       &
+             IOB% rofi_flux (isc:iec,jsc:jec),       &
+             IOB% u_flux (isc:iec,jsc:jec),          &
+             IOB% v_flux (isc:iec,jsc:jec),          &
+             IOB% t_flux (isc:iec,jsc:jec),          &
+             IOB% seaice_melt_heat (isc:iec,jsc:jec),&
+             IOB% seaice_melt (isc:iec,jsc:jec),     &
+             IOB% q_flux (isc:iec,jsc:jec),          &
+             IOB% salt_flux (isc:iec,jsc:jec),       &
+             IOB% lw_flux (isc:iec,jsc:jec),         &
+             IOB% sw_flux_vis_dir (isc:iec,jsc:jec), &
+             IOB% sw_flux_vis_dif (isc:iec,jsc:jec), &
+             IOB% sw_flux_nir_dir (isc:iec,jsc:jec), &
+             IOB% sw_flux_nir_dif (isc:iec,jsc:jec), &
+             IOB% lprec (isc:iec,jsc:jec),           &
+             IOB% fprec (isc:iec,jsc:jec),           &
+             IOB% ustar_berg (isc:iec,jsc:jec),      &
+             IOB% area_berg (isc:iec,jsc:jec),       &
+             IOB% mass_berg (isc:iec,jsc:jec),       &
+             IOB% calving (isc:iec,jsc:jec),         &
+             IOB% runoff_hflx (isc:iec,jsc:jec),     &
+             IOB% calving_hflx (isc:iec,jsc:jec),    &
+             IOB% mi (isc:iec,jsc:jec),              &
+             IOB% p (isc:iec,jsc:jec))
+
+  IOB%rofl_flux        = 0.0
+  IOB%rofi_flux        = 0.0
+  IOB%u_flux           = 0.0
+  IOB%v_flux           = 0.0
+  IOB%t_flux           = 0.0
+  IOB%seaice_melt_heat = 0.0
+  IOB%seaice_melt      = 0.0
+  IOB%q_flux           = 0.0
+  IOB%salt_flux        = 0.0
+  IOB%lw_flux          = 0.0
+  IOB%sw_flux_vis_dir  = 0.0
+  IOB%sw_flux_vis_dif  = 0.0
+  IOB%sw_flux_nir_dir  = 0.0
+  IOB%sw_flux_nir_dif  = 0.0
+  IOB%lprec            = 0.0
+  IOB%fprec            = 0.0
+  IOB%ustar_berg       = 0.0
+  IOB%area_berg        = 0.0
+  IOB%mass_berg        = 0.0
+  IOB%calving          = 0.0
+  IOB%runoff_hflx      = 0.0
+  IOB%calving_hflx     = 0.0
+  IOB%mi               = 0.0
+  IOB%p                = 0.0
+
+end subroutine IOB_allocate
+
 end module ocn_comp_mct
diff --git a/config_src/nuopc_driver/MOM_ocean_model.F90 b/config_src/nuopc_driver/MOM_ocean_model.F90
@@ -11,57 +11,57 @@ module MOM_ocean_model
 ! This code is a stop-gap wrapper of the MOM6 code to enable it to be called
 ! in the same way as MOM4.
 
-use MOM, only : initialize_MOM, step_MOM, MOM_control_struct, MOM_end
-use MOM, only : extract_surface_state, allocate_surface_state, finish_MOM_initialization
-use MOM, only : get_MOM_state_elements, MOM_state_is_synchronized
-use MOM, only : get_ocean_stocks, step_offline
-use MOM_constants, only : CELSIUS_KELVIN_OFFSET, hlf
-use MOM_diag_mediator, only : diag_ctrl, enable_averaging, disable_averaging
-use MOM_diag_mediator, only : diag_mediator_close_registration, diag_mediator_end
-use MOM_domains, only : pass_var, pass_vector, AGRID, BGRID_NE, CGRID_NE
-use MOM_domains, only : TO_ALL, Omit_Corners
-use MOM_error_handler, only : MOM_error, FATAL, WARNING, is_root_pe
-use MOM_error_handler, only : callTree_enter, callTree_leave
-use MOM_file_parser, only : get_param, log_version, close_param_file, param_file_type
-use MOM_forcing_type, only : allocate_forcing_type
-use MOM_forcing_type, only : forcing, mech_forcing
-use MOM_forcing_type, only : forcing_accumulate, copy_common_forcing_fields
-use MOM_forcing_type, only : copy_back_forcing_fields, set_net_mass_forcing
-use MOM_forcing_type, only : set_derived_forcing_fields
-use MOM_forcing_type, only : forcing_diagnostics, mech_forcing_diags
-use MOM_get_input, only : Get_MOM_Input, directories
-use MOM_grid, only : ocean_grid_type
-use MOM_io, only : close_file, file_exists, read_data, write_version_number
-use MOM_marine_ice, only : iceberg_forces, iceberg_fluxes, marine_ice_init, marine_ice_CS
-use MOM_restart, only : MOM_restart_CS, save_restart
-use MOM_string_functions, only : uppercase
-use MOM_surface_forcing, only : surface_forcing_init, convert_IOB_to_fluxes
-use MOM_surface_forcing, only : convert_IOB_to_forces, ice_ocn_bnd_type_chksum
-use MOM_surface_forcing, only : ice_ocean_boundary_type, surface_forcing_CS
-use MOM_surface_forcing, only : forcing_save_restart
-use MOM_time_manager, only : time_type, get_time, set_time, operator(>)
-use MOM_time_manager, only : operator(+), operator(-), operator(*), operator(/)
-use MOM_time_manager, only : operator(/=), operator(<=), operator(>=)
-use MOM_time_manager, only : operator(<), real_to_time_type, time_type_to_real
+use MOM,                     only : initialize_MOM, step_MOM, MOM_control_struct, MOM_end
+use MOM,                     only : extract_surface_state, allocate_surface_state, finish_MOM_initialization
+use MOM,                     only : get_MOM_state_elements, MOM_state_is_synchronized
+use MOM,                     only : get_ocean_stocks, step_offline
+use MOM_constants,           only : CELSIUS_KELVIN_OFFSET, hlf
+use MOM_diag_mediator,       only : diag_ctrl, enable_averaging, disable_averaging
+use MOM_diag_mediator,       only : diag_mediator_close_registration, diag_mediator_end
+use MOM_domains,             only : pass_var, pass_vector, AGRID, BGRID_NE, CGRID_NE
+use MOM_domains,             only : TO_ALL, Omit_Corners
+use MOM_error_handler,       only : MOM_error, FATAL, WARNING, is_root_pe
+use MOM_error_handler,       only : callTree_enter, callTree_leave
+use MOM_file_parser,         only : get_param, log_version, close_param_file, param_file_type
+use MOM_forcing_type,        only : allocate_forcing_type
+use MOM_forcing_type,        only : forcing, mech_forcing
+use MOM_forcing_type,        only : forcing_accumulate, copy_common_forcing_fields
+use MOM_forcing_type,        only : copy_back_forcing_fields, set_net_mass_forcing
+use MOM_forcing_type,        only : set_derived_forcing_fields
+use MOM_forcing_type,        only : forcing_diagnostics, mech_forcing_diags
+use MOM_get_input,           only : Get_MOM_Input, directories
+use MOM_grid,                only : ocean_grid_type
+use MOM_io,                  only : close_file, file_exists, read_data, write_version_number
+use MOM_marine_ice,          only : iceberg_forces, iceberg_fluxes, marine_ice_init, marine_ice_CS
+use MOM_restart,             only : MOM_restart_CS, save_restart
+use MOM_string_functions,    only : uppercase
+use MOM_surface_forcing,     only : surface_forcing_init, convert_IOB_to_fluxes
+use MOM_surface_forcing,     only : convert_IOB_to_forces, ice_ocn_bnd_type_chksum
+use MOM_surface_forcing,     only : ice_ocean_boundary_type, surface_forcing_CS
+use MOM_surface_forcing,     only : forcing_save_restart
+use MOM_time_manager,        only : time_type, get_time, set_time, operator(>)
+use MOM_time_manager,        only : operator(+), operator(-), operator(*), operator(/)
+use MOM_time_manager,        only : operator(/=), operator(<=), operator(>=)
+use MOM_time_manager,        only : operator(<), real_to_time_type, time_type_to_real
 use MOM_tracer_flow_control, only : call_tracer_register, tracer_flow_control_init
 use MOM_tracer_flow_control, only : call_tracer_flux_init
 use MOM_unit_scaling,        only : unit_scale_type
-use MOM_variables, only : surface
-use MOM_verticalGrid, only : verticalGrid_type
-use MOM_ice_shelf, only : initialize_ice_shelf, shelf_calc_flux, ice_shelf_CS
-use MOM_ice_shelf, only : add_shelf_forces, ice_shelf_end, ice_shelf_save_restart
-use coupler_types_mod, only : coupler_1d_bc_type, coupler_2d_bc_type
-use coupler_types_mod, only : coupler_type_spawn, coupler_type_write_chksums
-use coupler_types_mod, only : coupler_type_initialized, coupler_type_copy_data
-use coupler_types_mod, only : coupler_type_set_diags, coupler_type_send_data
-use mpp_domains_mod, only : domain2d, mpp_get_layout, mpp_get_global_domain
-use mpp_domains_mod, only : mpp_define_domains, mpp_get_compute_domain, mpp_get_data_domain
-use atmos_ocean_fluxes_mod, only : aof_set_coupler_flux
-use fms_mod, only : stdout
-use mpp_mod, only : mpp_chksum
-use MOM_EOS, only : gsw_sp_from_sr, gsw_pt_from_ct
-use MOM_wave_interface, only: wave_parameters_CS, MOM_wave_interface_init
-use MOM_wave_interface, only: MOM_wave_interface_init_lite, Update_Surface_Waves
+use MOM_variables,           only : surface
+use MOM_verticalGrid,        only : verticalGrid_type
+use MOM_ice_shelf,           only : initialize_ice_shelf, shelf_calc_flux, ice_shelf_CS
+use MOM_ice_shelf,           only : add_shelf_forces, ice_shelf_end, ice_shelf_save_restart
+use coupler_types_mod,       only : coupler_1d_bc_type, coupler_2d_bc_type
+use coupler_types_mod,       only : coupler_type_spawn, coupler_type_write_chksums
+use coupler_types_mod,       only : coupler_type_initialized, coupler_type_copy_data
+use coupler_types_mod,       only : coupler_type_set_diags, coupler_type_send_data
+use mpp_domains_mod,         only : domain2d, mpp_get_layout, mpp_get_global_domain
+use mpp_domains_mod,         only : mpp_define_domains, mpp_get_compute_domain, mpp_get_data_domain
+use atmos_ocean_fluxes_mod,  only : aof_set_coupler_flux
+use fms_mod,                 only : stdout
+use mpp_mod,                 only : mpp_chksum
+use MOM_EOS,                 only : gsw_sp_from_sr, gsw_pt_from_ct
+use MOM_wave_interface,      only: wave_parameters_CS, MOM_wave_interface_init
+use MOM_wave_interface,      only: MOM_wave_interface_init_lite, Update_Surface_Waves
 
 #include <MOM_memory.h>
 
@@ -260,7 +260,6 @@ subroutine ocean_model_init(Ocean_sfc, OS, Time_init, Time_in, gas_fields_ocn, i
   integer :: secs, days
   type(param_file_type) :: param_file !< A structure to parse for run-time parameters
   logical :: use_temperature
-  type(time_type) :: dt_geometric, dt_savedays, dt_from_base
 
   call callTree_enter("ocean_model_init(), ocean_model_MOM.F90")
   if (associated(OS)) then
@@ -476,7 +475,7 @@ subroutine update_ocean_model(Ice_ocean_boundary, OS, Ocean_sfc, &
   integer :: secs, days
   integer :: is, ie, js, je
 
-  call callTree_enter("update_ocean_model(), ocean_model_MOM.F90")
+  call callTree_enter("update_ocean_model(), MOM_ocean_model.F90")
   call get_time(Ocean_coupling_time_step, secs, days)
   dt_coupling = 86400.0*real(days) + real(secs)
 

diff --git a/config_src/nuopc_driver/MOM_surface_forcing.F90 b/config_src/nuopc_driver/MOM_surface_forcing.F90
@@ -222,7 +222,7 @@ subroutine convert_IOB_to_fluxes(IOB, fluxes, index_bounds, Time, G, US, CS, &
   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 varibles
+  ! 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]
@@ -693,8 +693,6 @@ subroutine convert_IOB_to_forces(IOB, forces, index_bounds, Time, G, US, CS)
   wind_stagger = CS%wind_stagger
 #endif
 
-  if ((IOB%wind_stagger == AGRID) .or. (IOB%wind_stagger == BGRID_NE) .or. &
-      (IOB%wind_stagger == CGRID_NE)) wind_stagger = IOB%wind_stagger
   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
@@ -769,12 +767,7 @@ subroutine convert_IOB_to_forces(IOB, forces, index_bounds, Time, G, US, CS)
     enddo ; enddo
 
   elseif (wind_stagger == AGRID) then
-     !TODO: which one of these is correct?
-#ifdef CESMCOUPLED
-    call pass_vector(taux_at_h, tauy_at_h, G%Domain,stagger=AGRID)
-#else
     call pass_vector(taux_at_h, tauy_at_h, G%Domain, To_All+Omit_Corners, stagger=AGRID, halo=1)
-#endif
 
     do j=js,je ; do I=Isq,Ieq
       forces%taux(I,j) = 0.0