Skip to content

Add hooks to the full coupler #161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
J-Lentz wants to merge 2 commits into from
Closed

Add hooks to the full coupler #161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
906346c
Refactor to support cheat mode
Jun 17, 2025
a1eaec2
Add coupler hooks
Jun 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions full/coupler_main.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,8 +360,7 @@ program coupler_main
type(FmsTime_type) :: Time_atmos, Time_ocean
type(FmsTime_type) :: Time_flux_ice_to_ocean, Time_flux_ocean_to_ice

integer :: num_atmos_calls, na
integer :: num_cpld_calls, nc
integer :: nc, na
integer :: current_timestep

type(FmsNetcdfDomainFile_t), dimension(:), pointer :: Ice_bc_restart => NULL()
Expand Down Expand Up @@ -392,13 +391,18 @@ program coupler_main
Ocean_ice_boundary, Ice_ocean_boundary, Land_ice_atmos_boundary, Land_ice_boundary, &
Ice_ocean_driver_CS, Ice_bc_restart, Ocn_bc_restart, ensemble_pelist, slow_ice_ocean_pelist, &
conc_nthreads, coupler_clocks, coupler_components_obj, coupler_chksum_obj, &
Time_step_cpld, Time_step_atmos, Time_atmos, Time_ocean, num_cpld_calls, &
num_atmos_calls, Time, Time_start, Time_end, Time_restart, Time_restart_current)
Time_step_cpld, Time_step_atmos, Time_atmos, Time_ocean, Time, Time_start, &
Time_end, Time_restart, Time_restart_current)

if (do_chksum) call coupler_chksum_obj%get_coupler_chksums('coupler_init+', 0)

call fms_mpp_set_current_pelist()
call fms_mpp_clock_end(coupler_clocks%initialization) !end initialization

#ifdef COUPLER_MAIN_LOOP_PRE_HOOK
call COUPLER_MAIN_LOOP_PRE_HOOK
#endif

call fms_mpp_clock_begin(coupler_clocks%main) !begin main loop

!-----------------------------------------------------------------------
Expand Down Expand Up @@ -664,7 +668,7 @@ program coupler_main
call coupler_intermediate_restart(Atm, Ice, Ocean, Ocean_state, Ocn_bc_restart, Ice_bc_restart, &
Time, Time_restart, Time_restart_current, Time_start)

call coupler_summarize_timestep(nc, num_cpld_calls, coupler_chksum_obj, Atm%pe, omp_sec, imb_sec)
call coupler_summarize_timestep(nc, coupler_chksum_obj, Atm%pe, omp_sec, imb_sec)

omp_sec(:)=0.
imb_sec(:)=0.
Expand All @@ -687,4 +691,8 @@ program coupler_main

!-----------------------------------------------------------------------

#ifdef COUPLER_POST_HOOK
call COUPLER_POST_HOOK
#endif

end program coupler_main
10 changes: 5 additions & 5 deletions full/full_coupler_mod.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,9 @@ module full_coupler_mod
integer, public :: ocean_nthreads=1 !< Number of OpenMP threads to use in the ocean
integer, public :: radiation_nthreads=1 !< Number of threads to use for the radiation.

integer, public :: num_cpld_calls !< Number of iterations in the ocean/slow-ice loop
integer, public :: num_atmos_calls !< Number of iterations in the atmos/fast-land/fast-ice loop

!> Indicates if this component should be executed. If .FALSE., then execution is skipped.
!! This is used when ALL the output fields sent by this component to the coupler have been
!! overridden using the data_override feature. This is for advanced users only.
Expand Down Expand Up @@ -325,7 +328,7 @@ subroutine coupler_init(Atm, Ocean, Land, Ice, Ocean_state, Atmos_land_boundary,
Ocean_ice_boundary, Ice_ocean_boundary, Land_ice_atmos_boundary, Land_ice_boundary, &
Ice_ocean_driver_CS, Ice_bc_restart, Ocn_bc_restart, ensemble_pelist, slow_ice_ocean_pelist, conc_nthreads, &
coupler_clocks, coupler_components_obj, coupler_chksum_obj, Time_step_cpld, Time_step_atmos, Time_atmos, &
Time_ocean, num_cpld_calls, num_atmos_calls, Time, Time_start, Time_end, Time_restart, Time_restart_current)
Time_ocean, Time, Time_start, Time_end, Time_restart, Time_restart_current)

implicit none

Expand Down Expand Up @@ -354,7 +357,6 @@ subroutine coupler_init(Atm, Ocean, Land, Ice, Ocean_state, Atmos_land_boundary,
type(FMSTime_type), intent(inout) :: Time_step_cpld, Time_step_atmos, Time_atmos, Time_ocean
type(FMSTime_type), intent(inout) :: Time, Time_start, Time_end, Time_restart, Time_restart_current

integer, intent(inout) :: num_cpld_calls, num_atmos_calls
!
!-----------------------------------------------------------------------
! local parameters
Expand Down Expand Up @@ -2390,12 +2392,10 @@ end subroutine coupler_intermediate_restart

!> This subroutine mainly prints out the current timestep in the stdout.
!! Chksum is computed if do_chksum = .True.
subroutine coupler_summarize_timestep(current_timestep, num_cpld_calls, coupler_chksum_obj, &
is_atmos_pe, omp_sec, imb_sec)
subroutine coupler_summarize_timestep(current_timestep, coupler_chksum_obj, is_atmos_pe, omp_sec, imb_sec)

implicit none
integer, intent(in) :: current_timestep !< current_timestep, nc
integer, intent(in) :: num_cpld_calls !< total number of outerloop timestep
type(coupler_chksum_type), intent(in) :: coupler_chksum_obj !< coupler_chksum_obj
logical, intent(in) :: is_atmos_pe !< Atm%pe
real, dimension(:), intent(inout) :: omp_sec, imb_sec !< from omp computation
Expand Down
Loading