ocean_halo_face_x_2d Subroutine

private subroutine ocean_halo_face_x_2d(fld, device_resident)

Two-pass X-then-Y halo exchange for a 2D x-face field.

Index map (ng=nghost, nxl=nx_local): Send EAST (ng+1 per j-row): source i = nxl+1..ng+nxl+1 (last i = ng+nxl+1 is owned seam face; first ng are pre-seam interior) → fills east-nbr’s i = 1..ng+1 (west ghosts + seam-copy overwrite)

Recv FROM EAST (ng per j-row): east-nbr sends its i = ng+2..2*ng+1 → fills OUR east ghosts i = ng+nxl+2..ng+nxl+ng+1

Send WEST (ng per j-row): source i = ng+2..2*ng+1 → fills west-nbr’s east ghosts

Recv FROM WEST (ng+1 per j-row): west-nbr sends its owned seam + ng interior → fills OUR i = 1..ng+1

Arguments

Type IntentOptional Attributes Name
real(kind=wp), intent(inout) :: fld(oh_nx_total+1,oh_ny_total)

x-face field (nx_total+1, ny_total)
logical, intent(in), optional :: device_resident

If .false., operate on host memory (no OpenACC directives). Default (.true.) is the normal device-resident path.

Calls

proc~~ocean_halo_face_x_2d~~CallsGraph proc~ocean_halo_face_x_2d ocean_halo_face_x_2d proc~ocean_halo_face_x_2d_impl ocean_halo_face_x_2d_impl proc~ocean_halo_face_x_2d->proc~ocean_halo_face_x_2d_impl proc~oh_count_face_x_2d oh_count_face_x_2d proc~ocean_halo_face_x_2d->proc~oh_count_face_x_2d comm_irecv_real_sp_array_n comm_irecv_real_sp_array_n proc~ocean_halo_face_x_2d_impl->comm_irecv_real_sp_array_n comm_isend_real_sp_array_n comm_isend_real_sp_array_n proc~ocean_halo_face_x_2d_impl->comm_isend_real_sp_array_n proc~comm_env_compute_comm comm_env_compute_comm proc~ocean_halo_face_x_2d_impl->proc~comm_env_compute_comm proc~ew_rank_east ew_rank_east proc~ocean_halo_face_x_2d_impl->proc~ew_rank_east proc~ew_rank_west ew_rank_west proc~ocean_halo_face_x_2d_impl->proc~ew_rank_west proc~needs_flags needs_flags proc~ocean_halo_face_x_2d_impl->proc~needs_flags proc~ns_rank_north ns_rank_north proc~ocean_halo_face_x_2d_impl->proc~ns_rank_north proc~ns_rank_south ns_rank_south proc~ocean_halo_face_x_2d_impl->proc~ns_rank_south proc~ocean_periodic_wrap_face_x_2d ocean_periodic_wrap_face_x_2d proc~ocean_halo_face_x_2d_impl->proc~ocean_periodic_wrap_face_x_2d proc~oh_count_msgs oh_count_msgs proc~ocean_halo_face_x_2d_impl->proc~oh_count_msgs waitall waitall proc~ocean_halo_face_x_2d_impl->waitall comm_world comm_world proc~comm_env_compute_comm->comm_world proc~decomp_rank_from_coords decomp_rank_from_coords proc~ew_rank_east->proc~decomp_rank_from_coords proc~ew_rank_west->proc~decomp_rank_from_coords proc~ns_rank_north->proc~decomp_rank_from_coords proc~ns_rank_south->proc~decomp_rank_from_coords

Called by

proc~~ocean_halo_face_x_2d~~CalledByGraph proc~ocean_halo_face_x_2d ocean_halo_face_x_2d interface~ocean_halo_face_x ocean_halo_face_x interface~ocean_halo_face_x->proc~ocean_halo_face_x_2d proc~ocean_halo_bt_group_2d ocean_halo_bt_group_2d proc~ocean_halo_bt_group_2d->proc~ocean_halo_face_x_2d proc~barotropic_substep_nonlinear barotropic_substep_nonlinear proc~barotropic_substep_nonlinear->interface~ocean_halo_face_x proc~barotropic_substep_nonlinear->proc~ocean_halo_bt_group_2d proc~configure_ocean_closed_faces configure_ocean_closed_faces proc~configure_ocean_closed_faces->interface~ocean_halo_face_x proc~configure_ocean_k_bot configure_ocean_k_bot proc~configure_ocean_k_bot->interface~ocean_halo_face_x proc~engine_enter_data engine_enter_data proc~engine_enter_data->interface~ocean_halo_face_x proc~engine_enter_data->proc~ocean_halo_bt_group_2d proc~ocean_halo_exchange_ml_state ocean_halo_exchange_ml_state proc~engine_enter_data->proc~ocean_halo_exchange_ml_state proc~engine_setup engine_setup proc~engine_setup->interface~ocean_halo_face_x proc~engine_setup->proc~configure_ocean_closed_faces proc~engine_setup->proc~configure_ocean_k_bot proc~engine_setup->proc~ocean_halo_exchange_ml_state proc~configure_ocean_forcing configure_ocean_forcing proc~engine_setup->proc~configure_ocean_forcing proc~ocean_data_forcing_configure ocean_data_forcing_configure proc~engine_setup->proc~ocean_data_forcing_configure proc~ice_evp_dynamics_impl ice_evp_dynamics_impl proc~ice_evp_dynamics_impl->interface~ocean_halo_face_x proc~ocean_halo_exchange_ml_state->interface~ocean_halo_face_x proc~ocean_seam_refresh_surface_stress ocean_seam_refresh_surface_stress proc~ocean_seam_refresh_surface_stress->interface~ocean_halo_face_x proc~run_stage_split run_stage_split proc~run_stage_split->interface~ocean_halo_face_x proc~run_stage_split->proc~ocean_halo_bt_group_2d proc~run_stage_split->proc~ocean_halo_exchange_ml_state proc~barotropic_substep_nonlinear_interior barotropic_substep_nonlinear_interior proc~run_stage_split->proc~barotropic_substep_nonlinear_interior proc~bt_wide_substep bt_wide_substep proc~run_stage_split->proc~bt_wide_substep proc~run_continuity_chain run_continuity_chain proc~run_stage_split->proc~run_continuity_chain proc~visc_rem_precompute visc_rem_precompute proc~run_stage_split->proc~visc_rem_precompute proc~vmix_apply_in_stage vmix_apply_in_stage proc~run_stage_split->proc~vmix_apply_in_stage proc~visc_rem_halo_refresh visc_rem_halo_refresh proc~visc_rem_halo_refresh->interface~ocean_halo_face_x proc~barotropic_substep_nonlinear_interior->proc~barotropic_substep_nonlinear proc~bt_wide_substep->proc~barotropic_substep_nonlinear proc~complete_ocean_create complete_ocean_create proc~complete_ocean_create->proc~engine_enter_data proc~complete_ocean_create->proc~engine_setup proc~configure_ocean_forcing->proc~ocean_seam_refresh_surface_stress proc~driver_run_ocean driver_run_ocean proc~driver_run_ocean->proc~engine_enter_data proc~driver_run_ocean->proc~engine_setup proc~engine_step engine_step proc~driver_run_ocean->proc~engine_step proc~engine_step_ice engine_step_ice proc~driver_run_ocean->proc~engine_step_ice proc~driver_validate driver_validate proc~driver_validate->proc~engine_setup proc~ice_evp_dynamics ice_evp_dynamics proc~ice_evp_dynamics->proc~ice_evp_dynamics_impl proc~ice_ocean_stress_flux ice_ocean_stress_flux proc~ice_ocean_stress_flux->proc~ocean_seam_refresh_surface_stress proc~ocean_data_forcing_apply ocean_data_forcing_apply proc~ocean_data_forcing_apply->proc~ocean_seam_refresh_surface_stress proc~ocean_data_forcing_configure->proc~ocean_seam_refresh_surface_stress proc~ocean_dyn_step_split ocean_dyn_step_split proc~ocean_dyn_step_split->proc~run_stage_split proc~run_gm_step run_gm_step proc~ocean_dyn_step_split->proc~run_gm_step proc~run_continuity_chain->proc~ocean_halo_exchange_ml_state proc~run_gm_step->proc~ocean_halo_exchange_ml_state proc~visc_rem_precompute->proc~visc_rem_halo_refresh proc~vmix_apply_in_stage->proc~visc_rem_halo_refresh proc~vmix_apply_in_stage->proc~visc_rem_precompute proc~driver_run driver_run proc~driver_run->proc~driver_run_ocean proc~engine_step->proc~ocean_data_forcing_apply proc~engine_step->proc~ocean_dyn_step_split proc~engine_step_ice->proc~ice_ocean_stress_flux proc~ice_evp_step ice_evp_step proc~engine_step_ice->proc~ice_evp_step proc~ice_evp_step->proc~ice_evp_dynamics proc~rdb_ocean_create_finalize rdb_ocean_create_finalize proc~rdb_ocean_create_finalize->proc~complete_ocean_create proc~rdb_ocean_create_from_string rdb_ocean_create_from_string proc~rdb_ocean_create_from_string->proc~complete_ocean_create proc~run_stage run_stage proc~run_stage->proc~vmix_apply_in_stage proc~ocean_dyn_step ocean_dyn_step proc~ocean_dyn_step->proc~run_stage proc~rdb_ocean_step rdb_ocean_step proc~rdb_ocean_step->proc~engine_step proc~rdb_ocean_step->proc~engine_step_ice

Source Code

   subroutine ocean_halo_face_x_2d(fld, device_resident)
      !! Two-pass X-then-Y halo exchange for a 2D x-face field.
      !!
      !! Index map (ng=nghost, nxl=nx_local):
      !!   Send EAST (ng+1 per j-row): source i = nxl+1..ng+nxl+1
      !!     (last i = ng+nxl+1 is owned seam face; first ng are pre-seam interior)
      !!     → fills east-nbr's i = 1..ng+1 (west ghosts + seam-copy overwrite)
      !!
      !!   Recv FROM EAST (ng per j-row):
      !!     east-nbr sends its i = ng+2..2*ng+1 → fills OUR east ghosts i = ng+nxl+2..ng+nxl+ng+1
      !!
      !!   Send WEST (ng per j-row): source i = ng+2..2*ng+1
      !!     → fills west-nbr's east ghosts
      !!
      !!   Recv FROM WEST (ng+1 per j-row):
      !!     west-nbr sends its owned seam + ng interior → fills OUR i = 1..ng+1
      real(wp), intent(inout) :: fld(oh_nx_total + 1, oh_ny_total)
         !! x-face field (nx_total+1, ny_total)
      logical, intent(in), optional :: device_resident
         !! If .false., operate on host memory (no OpenACC directives).
         !! Default (.true.) is the normal device-resident path.

      call oh_count_face_x_2d()
      call ocean_halo_face_x_2d_impl(fld, oh_nghost, device_resident)
   end subroutine ocean_halo_face_x_2d