Skip to content

Commit

Permalink
Merge branch 'dev/gfdl' into fix_specifiedIceLayoutIssue199
Browse files Browse the repository at this point in the history
  • Loading branch information
@marshallward
marshallward authored Sep 13, 2023
2 parents 5ee4af9 + 0006cd2 commit 8f6b0a7
Show file tree
Hide file tree
Showing 4 changed files with 124 additions and 29 deletions.
3 changes: 3 additions & 0 deletions src/SIS_dyn_trans.F90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1007,6 +1007,9 @@ subroutine SIS_merged_dyn_cont(OSS, FIA, IOF, DS2d, IST, dt_cycle, Time_start, G
! call hchksum_pair("WindStr_[xy]_A before SIS_C_dynamics", WindStr_x_A, WindStr_y_A, G, halos=1)
endif

if (nds>1) &
call pass_var(DS2d%mca_step(:,:,DS2d%nts), G%Domain, complete=.true.)

call cpu_clock_begin(iceClocka)
!### Ridging needs to be added with C-grid dynamics.
if (CS%do_ridging) rdg_rate(:,:) = 0.0
Expand Down
127 changes: 107 additions & 20 deletions src/combined_ice_ocean_driver.F90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,26 @@ module combined_ice_ocean_driver
! This module provides a common interface for jointly stepping SIS2 and MOM6, and
! will evolve as a platform for tightly integrating the ocean and sea ice models.

use MOM_coupler_types, only : coupler_type_copy_data, coupler_type_data_override
use MOM_coupler_types, only : coupler_type_send_data
use MOM_cpu_clock, only : cpu_clock_id, cpu_clock_begin, cpu_clock_end, CLOCK_COMPONENT
use MOM_data_override, only : data_override
use MOM_domains, only : domain2D, same_domain
use MOM_error_handler, only : MOM_error, FATAL, WARNING, callTree_enter, callTree_leave
use MOM_file_parser, only : param_file_type, open_param_file, close_param_file
use MOM_file_parser, only : read_param, get_param, log_param, log_version
use MOM_io, only : file_exists, close_file, slasher, ensembler
use MOM_io, only : open_namelist_file, check_nml_error
use MOM_time_manager, only : time_type, time_type_to_real, real_to_time_type
use MOM_time_manager, only : operator(+), operator(-), operator(>)

use ice_model_mod, only : ice_data_type, ice_model_end
use ice_model_mod, only : update_ice_slow_thermo, update_ice_dynamics_trans
use ocean_model_mod, only : update_ocean_model, ocean_model_end
use ocean_model_mod, only : ocean_public_type, ocean_state_type, ice_ocean_boundary_type
use MOM_coupler_types, only : coupler_type_copy_data, coupler_type_data_override
use MOM_coupler_types, only : coupler_type_send_data
use MOM_cpu_clock, only : cpu_clock_id, cpu_clock_begin, cpu_clock_end, CLOCK_COMPONENT
use MOM_data_override, only : data_override
use MOM_domains, only : domain2D, same_domain
use MOM_error_handler, only : MOM_error, FATAL, WARNING, callTree_enter, callTree_leave
use MOM_file_parser, only : param_file_type, open_param_file, close_param_file
use MOM_file_parser, only : read_param, get_param, log_param, log_version
use MOM_io, only : file_exists, close_file, slasher, ensembler
use MOM_io, only : open_namelist_file, check_nml_error
use MOM_time_manager, only : time_type, time_type_to_real, real_to_time_type
use MOM_time_manager, only : operator(+), operator(-), operator(>)

use ice_model_mod, only : ice_data_type, ice_model_end
use ice_model_mod, only : update_ice_slow_thermo, update_ice_dynamics_trans
use ice_model_mod, only : unpack_ocn_ice_bdry
use ocean_model_mod, only : update_ocean_model, ocean_model_end
use ocean_model_mod, only : ocean_public_type, ocean_state_type, ice_ocean_boundary_type
use ocean_model_mod, only: ocean_public_type_chksum, ice_ocn_bnd_type_chksum
use ice_boundary_types, only : ocean_ice_boundary_type

implicit none ; private

Expand All @@ -41,13 +44,16 @@ module combined_ice_ocean_driver
logical :: intersperse_ice_ocn !< If true, intersperse the ice and ocean thermodynamic and
!! dynamic updates. This requires the update ocean (MOM6) interfaces
!! used with single_MOM_call=.false. The default is false.
logical :: use_intersperse_bug !< If true, use a bug in the intersperse option where the ocean
!! state was not being passed to the sea ice.
real :: dt_coupled_dyn !< The time step for coupling the ice and ocean dynamics when
!! INTERSPERSE_ICE_OCEAN is true, or <0 to use the coupled timestep.
!! The default is -1.
end type ice_ocean_driver_type

!>@{ CPU time clock IDs
integer :: fluxIceOceanClock
integer :: fluxOceanIceClock
!!@}

contains
Expand Down Expand Up @@ -120,6 +126,9 @@ subroutine ice_ocean_driver_init(CS, Time_init, Time_in)
"The time step for coupling the ice and ocean dynamics when "//&
"INTERSPERSE_ICE_OCEAN is true, or <0 to use the coupled timestep.", &
units="seconds", default=-1.0, do_not_log=.not.CS%intersperse_ice_ocn)
call get_param(param_file, mdl, "USE_INTERSPERSE_BUG", CS%use_intersperse_bug, &
"If true, use a bug in the intersperse option where the ocean state"//&
"was not being passed to the sea ice.", default=.true.)

! OS%is_ocean_pe = Ocean_sfc%is_ocean_pe
! if (.not.OS%is_ocean_pe) return
Expand All @@ -140,7 +149,7 @@ end subroutine ice_ocean_driver_init
!! the ice_data_type to advance both the sea-ice (and icebergs) and ocean states
!! for a time interval coupling_time_step.
subroutine update_slow_ice_and_ocean(CS, Ice, Ocn, Ocean_sfc, IOB, &
time_start_update, coupling_time_step)
time_start_update, coupling_time_step, OIB)
type(ice_ocean_driver_type), &
pointer :: CS !< The control structure for this driver
type(ice_data_type), intent(inout) :: Ice !< The publicly visible ice data type
Expand All @@ -154,7 +163,9 @@ subroutine update_slow_ice_and_ocean(CS, Ice, Ocn, Ocean_sfc, IOB, &
type(time_type), intent(in) :: time_start_update !< The time at the beginning of the update step
type(time_type), intent(in) :: coupling_time_step !< The amount of time over which to advance
!! the ocean and ice

type(ocean_ice_boundary_type), optional, &
intent(inout) :: OIB !< A structure containing information about
!! the ocean that is being shared wth the sea-ice.
! Local variables
type(time_type) :: time_start_step ! The start time within an iterative update cycle.
real :: dt_coupling ! The time step of the thermodynamic update calls [s].
Expand All @@ -178,6 +189,12 @@ subroutine update_slow_ice_and_ocean(CS, Ice, Ocn, Ocean_sfc, IOB, &
"ocean_state_type structure. ocean_model_init must be "// &
"called first to allocate this structure.")
endif
if ((.not.CS%use_intersperse_bug) .and. (.not.present(OIB))) then
call MOM_error(FATAL, "update_ocean_model called with an unassociated "// &
"ocean_ice_boundary. This type is required to properly "// &
"couple the sea-ice and ocean. It should be added where "// &
"this routine is called in coupler_main.")
endif

if (.not.(Ocean_sfc%is_ocean_pe .and. Ice%slow_ice_pe)) call MOM_error(FATAL, &
"update_slow_ice_and_ocean can only be called from PEs that handle both "//&
Expand All @@ -188,10 +205,13 @@ subroutine update_slow_ice_and_ocean(CS, Ice, Ocn, Ocean_sfc, IOB, &
"ocean and slow ice layouts and domain sizes are identical.")

if (CS%intersperse_ice_ocn) then
if (.not.CS%use_intersperse_bug) &
call direct_flux_ocn_to_OIB(time_start_update, Ocean_sfc, OIB, Ice, do_thermo=.true.)

! First step the ice, then ocean thermodynamics.
call update_ice_slow_thermo(Ice)

call direct_flux_ice_to_IOB(time_start_update, Ice, IOB, do_thermo=.true.)
call direct_flux_ice_to_IOB(time_start_update, Ice, IOB, do_thermo=.true.)

call update_ocean_model(IOB, Ocn, Ocean_sfc, time_start_update, coupling_time_step, &
update_dyn=.false., update_thermo=.true., &
Expand All @@ -217,6 +237,9 @@ subroutine update_slow_ice_and_ocean(CS, Ice, Ocn, Ocean_sfc, IOB, &
call update_ocean_model(IOB, Ocn, Ocean_sfc, time_start_step, dyn_time_step, &
update_dyn=.true., update_thermo=.false., &
start_cycle=.false., end_cycle=(ns==nstep), cycle_length=dt_coupling)
if (.not.CS%use_intersperse_bug) &
call direct_flux_ocn_to_OIB(time_start_step, Ocean_sfc, OIB, Ice, do_thermo=.false.)

time_start_step = time_start_step + dyn_time_step
enddo
else
Expand Down Expand Up @@ -332,6 +355,70 @@ subroutine direct_flux_ice_to_IOB(Time, Ice, IOB, do_thermo)

end subroutine direct_flux_ice_to_IOB

!> This subroutine does a direct copy of the fluxes from the ocean public type into
!! a ocean-ice boundary type on the same grid.
!! This is analogous to the flux_ocean_to_ice subroutine in ice_ocean_flux_exchange.F90
!! but assumes the sea ice and ocean are on the same grid and does a direct copy as in
!! direct_flux_ice_to_IOB above. The thermodynamic varibles are also seperated so only
!! the dynamics are updated.
!! The data_override is similar to flux_ocean_to_ice_finish
subroutine direct_flux_ocn_to_OIB(Time, Ocean, OIB, Ice, do_thermo)
type(time_type), intent(in) :: Time !< Current time
type(ocean_public_type),intent(in) :: Ocean !< A derived data type to specify ocean boundary data
type(ocean_ice_boundary_type), intent(inout) :: OIB !< A type containing ocean surface fields that
!! are used to drive the sea ice
logical, optional, intent(in) :: do_thermo !< If present and false, do not update the
!! thermodynamic or tracer fluxes.
type(ice_data_type), &
intent(inout) :: Ice !< The publicly visible ice data type in the slow part
!! of which the ocean surface information is to be stored.
logical :: used, do_therm, do_area_weighted_flux

call cpu_clock_begin(fluxOceanIceClock)

do_therm = .true. ; if (present(do_thermo)) do_therm = do_thermo
do_area_weighted_flux = .false. !! Need to add option to account for area weighted fluxes

if (ASSOCIATED(OIB%u)) OIB%u = Ocean%u_surf
if (ASSOCIATED(OIB%v)) OIB%v = Ocean%v_surf
if (ASSOCIATED(OIB%sea_level)) OIB%sea_level = Ocean%sea_lev

if (do_therm) then
if (ASSOCIATED(OIB%t)) OIB%t = Ocean%t_surf
if (ASSOCIATED(OIB%s)) OIB%s = Ocean%s_surf
if (ASSOCIATED(OIB%frazil)) then
! if(do_area_weighted_flux) then
! OIB%frazil = Ocean%frazil * Ocean%area
! call divide_by_area(OIB%frazil, Ice%area)
! else
OIB%frazil = Ocean%frazil
! endif
endif
endif

! Extra fluxes
!call coupler_type_copy_data(Ocean%fields, OIB%fields)

call data_override('ICE', 'u', OIB%u, Time)
call data_override('ICE', 'v', OIB%v, Time)
call data_override('ICE', 'sea_level', OIB%sea_level, Time)

!call coupler_type_data_override('ICE', OIB%fields, Time)

if (do_therm) then
call data_override('ICE', 't', OIB%t, Time)
call data_override('ICE', 's', OIB%s, Time)
call data_override('ICE', 'frazil', OIB%frazil, Time)
endif

!Perform diagnostic output for the ocean_ice_boundary fields
!call unpack_ocn_ice_bdry
call unpack_ocn_ice_bdry(OIB, Ice%sCS%OSS, Ice%sCS%IST%ITV, Ice%sCS%G, Ice%sCS%US, &
Ice%sCS%specified_ice, Ice%ocean_fields)

end subroutine direct_flux_ocn_to_OIB


!=======================================================================
!> The subroutine ice_ocean_driver_end terminates the model run, saving
!! the ocean and slow ice states in restart files and deallocating any data
Expand Down
21 changes: 13 additions & 8 deletions src/ice_model.F90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ module ice_model_mod
public :: ocn_ice_bnd_type_chksum, atm_ice_bnd_type_chksum
public :: lnd_ice_bnd_type_chksum, ice_data_type_chksum
public :: update_ice_atm_deposition_flux
public :: unpack_ocean_ice_boundary, exchange_slow_to_fast_ice, set_ice_surface_fields
public :: unpack_ocean_ice_boundary, unpack_ocn_ice_bdry, exchange_slow_to_fast_ice, set_ice_surface_fields
public :: ice_model_fast_cleanup, unpack_land_ice_boundary
public :: exchange_fast_to_slow_ice, update_ice_model_slow
public :: update_ice_slow_thermo, update_ice_dynamics_trans
Expand Down Expand Up @@ -1719,7 +1719,7 @@ subroutine ice_model_init(Ice, Time_Init, Time, Time_step_fast, Time_step_slow,
logical :: recategorize_ice ! If true, adjust the distribution of the ice among thickness
! categories after initialization.
logical :: Verona
logical :: Concurrent
logical :: split_fast_slow_flag
logical :: read_aux_restart
logical :: split_restart_files
logical :: is_restart = .false.
Expand All @@ -1737,7 +1737,8 @@ subroutine ice_model_init(Ice, Time_Init, Time, Time_step_fast, Time_step_slow,
Verona = .false. ; if (present(Verona_coupler)) Verona = Verona_coupler
if (Verona) call SIS_error(FATAL, "SIS2 no longer works with pre-Warsaw couplers.")
fast_ice_PE = Ice%fast_ice_pe ; slow_ice_PE = Ice%slow_ice_pe
Concurrent = .false. ; if (present(Concurrent_ice)) Concurrent = Concurrent_ice
split_fast_slow_flag = .false. ;
if (present(Concurrent_ice)) split_fast_slow_flag = Concurrent_ice

! Open the parameter file.
if (slow_ice_PE) then
Expand Down Expand Up @@ -1938,7 +1939,7 @@ subroutine ice_model_init(Ice, Time_Init, Time, Time_step_fast, Time_step_slow,
call get_param(param_file, "MOM", "REDO_FAST_ICE_UPDATE", redo_fast_update, &
"If true, recalculate the thermal updates from the fast "//&
"dynamics on the slowly evolving ice state, rather than "//&
"copying over the slow ice state to the fast ice state.", default=Concurrent)
"copying over the slow ice state to the fast ice state.", default=split_fast_slow_flag)

call get_param(param_file, mdl, "NUDGE_SEA_ICE", nudge_sea_ice, &
"If true, constrain the sea ice concentrations using observations.", &
Expand Down Expand Up @@ -1974,7 +1975,6 @@ subroutine ice_model_init(Ice, Time_Init, Time, Time_step_fast, Time_step_slow,
elseif (uppercase(stagger(1:1)) == 'C') then ; Ice%flux_uv_stagger = CGRID_NE
else ; call SIS_error(FATAL,"ice_model_init: ICE_OCEAN_STRESS_STAGGER = "//&
trim(stagger)//" is invalid.") ; endif

Ice%Time = Time

! Now that all top-level sea-ice parameters have been read, allocate the
Expand Down Expand Up @@ -2221,7 +2221,7 @@ subroutine ice_model_init(Ice, Time_Init, Time, Time_step_fast, Time_step_slow,
Ice%fCS%Rad%do_sun_angle_for_alb = do_sun_angle_for_alb
Ice%fCS%Rad%add_diurnal_sw = add_diurnal_sw

if (Concurrent) then
if (split_fast_slow_flag) then
call register_fast_to_slow_restarts(Ice%fCS%FIA, Ice%fCS%Rad, Ice%fCS%TSF, &
fGD%mpp_domain, US, Ice%Ice_fast_restart, fast_rest_file)
endif
Expand Down Expand Up @@ -2497,7 +2497,7 @@ subroutine ice_model_init(Ice, Time_Init, Time, Time_step_fast, Time_step_slow,
! Read the fast restart file, if it exists and this is indicated by the value of dirs%input_filename.
new_sim = determine_is_new_run(dirs%input_filename, dirs%restart_input_dir, fG, Ice%Ice_fast_restart)
if (.not.new_sim) then
call restore_SIS_state(Ice%Ice_restart, dirs%restart_input_dir, dirs%input_filename, fG)
call restore_SIS_state(Ice%Ice_fast_restart, dirs%restart_input_dir, dirs%input_filename, fG)
init_coszen = .not.query_initialized(Ice%Ice_fast_restart, 'coszen')
init_Tskin = .not.query_initialized(Ice%Ice_fast_restart, 'T_skin')
init_rough = .not.(query_initialized(Ice%Ice_fast_restart, 'rough_mom') .and. &
Expand All @@ -2508,7 +2508,7 @@ subroutine ice_model_init(Ice, Time_Init, Time, Time_step_fast, Time_step_slow,
endif
endif

if (Concurrent) then
if (split_fast_slow_flag) then
call rescale_fast_to_slow_restart_fields(Ice%fCS%FIA, Ice%fCS%Rad, Ice%fCS%TSF, &
Ice%fCS%G, US, Ice%fCS%IG)
endif
Expand Down Expand Up @@ -2589,6 +2589,11 @@ subroutine ice_model_init(Ice, Time_Init, Time, Time_step_fast, Time_step_slow,
Ice%xtype = REDIST
endif

! if (fast_ice_PE .and. slow_ice_PE) then
! if (split_fast_slow_flag) then
! call exchange_fast_to_slow_ice(Ice)
! endif

if (Ice%shared_slow_fast_PEs) then
iceClock = cpu_clock_id( 'Ice', grain=CLOCK_COMPONENT )
ice_clock_fast = cpu_clock_id('Ice Fast', grain=CLOCK_SUBCOMPONENT )
Expand Down
2 changes: 1 addition & 1 deletion src/ice_type.F90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -506,7 +506,7 @@ subroutine ice_model_restart(Ice, time_stamp)
type(ice_data_type), intent(inout) :: Ice !< The publicly visible ice data type.
character(len=*), optional, intent(in) :: time_stamp !< A date stamp to include in the restart file name

if (associated(Ice%Ice_restart)) then
if (associated(Ice%Ice_restart) .and. associated(Ice%sCS)) then
call save_restart(Ice%restart_output_dir, Ice%Time, Ice%sCS%G, Ice%Ice_restart, IG=Ice%sCS%IG, &
time_stamp=time_stamp)
if (associated(Ice%Ice_fast_restart)) then
Expand Down

0 comments on commit 8f6b0a7

Please sign in to comment.