ocean_periodic_wrap_face_x_3d Subroutine

public subroutine ocean_periodic_wrap_face_x_3d(fld, nx_face, ny_total, nz, nx_phys, ny_phys, nghost, wrap_x, wrap_y, no_wait)

Fill ghost faces of a 3D x-face field (e.g. u_face_x_layer). nx_face = nx_total + 1. no_wait (optional): see ocean_periodic_wrap_centre_3d — batched async(1), sync once at the caller. Not pure (async/wait directives).

Arguments

Type IntentOptional Attributes Name
real(kind=wp), intent(inout) :: fld(nx_face,ny_total,nz)

x-face field, shape (nx_total+1, ny_total, nz).
integer, intent(in) :: nx_face
integer, intent(in) :: ny_total
integer, intent(in) :: nz
integer, intent(in) :: nx_phys
integer, intent(in) :: ny_phys
integer, intent(in) :: nghost
logical, intent(in) :: wrap_x
logical, intent(in) :: wrap_y
logical, intent(in), optional :: no_wait

Called by

proc~~ocean_periodic_wrap_face_x_3d~~CalledByGraph proc~ocean_periodic_wrap_face_x_3d ocean_periodic_wrap_face_x_3d proc~drain_wrap_face_x drain_wrap_face_x proc~drain_wrap_face_x->proc~ocean_periodic_wrap_face_x_3d proc~ocean_halo_face_x_3d ocean_halo_face_x_3d proc~ocean_halo_face_x_3d->proc~ocean_periodic_wrap_face_x_3d proc~ocean_periodic_wrap_state ocean_periodic_wrap_state proc~ocean_periodic_wrap_state->proc~ocean_periodic_wrap_face_x_3d proc~run_stage_split run_stage_split proc~run_stage_split->proc~ocean_periodic_wrap_face_x_3d proc~run_stage_split->proc~ocean_periodic_wrap_state interface~ocean_halo_face_x ocean_halo_face_x proc~run_stage_split->interface~ocean_halo_face_x 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~ocean_halo_exchange_ml_state ocean_halo_exchange_ml_state 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~visc_rem_halo_refresh visc_rem_halo_refresh proc~visc_rem_halo_refresh->proc~ocean_periodic_wrap_face_x_3d proc~visc_rem_halo_refresh->interface~ocean_halo_face_x interface~ocean_halo_face_x->proc~ocean_halo_face_x_3d proc~continuity_tracer_drain continuity_tracer_drain proc~continuity_tracer_drain->proc~drain_wrap_face_x proc~engine_setup engine_setup proc~engine_setup->proc~ocean_periodic_wrap_state proc~engine_setup->interface~ocean_halo_face_x proc~configure_ocean_closed_faces configure_ocean_closed_faces proc~engine_setup->proc~configure_ocean_closed_faces proc~configure_ocean_k_bot configure_ocean_k_bot 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~ocean_dyn_step_split ocean_dyn_step_split proc~ocean_dyn_step_split->proc~run_stage_split proc~ocean_dyn_step_split->proc~continuity_tracer_drain proc~run_gm_step run_gm_step proc~ocean_dyn_step_split->proc~run_gm_step proc~run_continuity_chain->proc~ocean_periodic_wrap_state proc~run_continuity_chain->proc~ocean_halo_exchange_ml_state proc~run_gm_step->proc~ocean_periodic_wrap_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~barotropic_substep_nonlinear barotropic_substep_nonlinear proc~barotropic_substep_nonlinear->interface~ocean_halo_face_x proc~complete_ocean_create complete_ocean_create proc~complete_ocean_create->proc~engine_setup proc~engine_enter_data engine_enter_data proc~complete_ocean_create->proc~engine_enter_data proc~configure_ocean_closed_faces->interface~ocean_halo_face_x proc~configure_ocean_k_bot->interface~ocean_halo_face_x proc~driver_run_ocean driver_run_ocean proc~driver_run_ocean->proc~engine_setup proc~driver_run_ocean->proc~engine_enter_data proc~engine_step engine_step proc~driver_run_ocean->proc~engine_step proc~ocean_dyn_flush_tracer_window ocean_dyn_flush_tracer_window proc~driver_run_ocean->proc~ocean_dyn_flush_tracer_window proc~driver_validate driver_validate proc~driver_validate->proc~engine_setup proc~engine_enter_data->interface~ocean_halo_face_x proc~engine_enter_data->proc~ocean_halo_exchange_ml_state proc~engine_step->proc~ocean_dyn_step_split proc~ocean_dyn_step ocean_dyn_step proc~engine_step->proc~ocean_dyn_step proc~ocean_data_forcing_apply ocean_data_forcing_apply proc~engine_step->proc~ocean_data_forcing_apply proc~ice_evp_dynamics_impl ice_evp_dynamics_impl proc~ice_evp_dynamics_impl->interface~ocean_halo_face_x proc~ocean_dyn_flush_tracer_window->proc~continuity_tracer_drain proc~ocean_dyn_step->proc~continuity_tracer_drain proc~run_stage run_stage proc~ocean_dyn_step->proc~run_stage 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->proc~vmix_apply_in_stage proc~barotropic_substep_nonlinear_interior->proc~barotropic_substep_nonlinear proc~bt_wide_substep->proc~barotropic_substep_nonlinear proc~configure_ocean_forcing->proc~ocean_seam_refresh_surface_stress proc~driver_run driver_run proc~driver_run->proc~driver_run_ocean 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->proc~ocean_seam_refresh_surface_stress proc~ocean_data_forcing_configure->proc~ocean_seam_refresh_surface_stress 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~rdb_ocean_set_tracer rdb_ocean_set_tracer proc~rdb_ocean_set_tracer->proc~ocean_dyn_flush_tracer_window proc~rdb_ocean_step rdb_ocean_step proc~rdb_ocean_step->proc~engine_step proc~engine_step_ice engine_step_ice proc~engine_step_ice->proc~ice_ocean_stress_flux proc~ice_evp_step ice_evp_step proc~ice_evp_step->proc~ice_evp_dynamics

Variables

Type Visibility Attributes Name Initial
integer, private :: i
integer, private :: i_e
integer, private :: i_w
integer, private :: j
integer, private :: k
logical, private :: lwait

Source Code

   subroutine ocean_periodic_wrap_face_x_3d(fld, nx_face, ny_total, nz, &
                                            nx_phys, ny_phys, nghost, &
                                            wrap_x, wrap_y, no_wait)
      !! Fill ghost faces of a 3D x-face field (e.g. u_face_x_layer).
      !! nx_face = nx_total + 1.  `no_wait` (optional): see
      !! `ocean_periodic_wrap_centre_3d` — batched async(1), sync once at the
      !! caller.  Not `pure` (async/wait directives).
      integer, intent(in) :: nx_face, ny_total, nz, nx_phys, ny_phys, nghost
      real(wp), intent(inout) :: fld(nx_face, ny_total, nz)
         !! x-face field, shape (nx_total+1, ny_total, nz).
      logical, intent(in) :: wrap_x
      logical, intent(in) :: wrap_y
      logical, intent(in), optional :: no_wait

      integer :: i, j, k
      integer :: i_w, i_e
      logical :: lwait

      lwait = .true.   ! default: blocking (wait) — safe for non-batched callers
      if (present(no_wait)) lwait = .not. no_wait
      i_w = nghost + 1
      i_e = nghost + nx_phys + 1

      ! Two-pass: X-wrap (+ belt-and-braces) first, Y-wrap second.
      !$acc kernels async(1)
      if (wrap_x) then
         do concurrent(k=1:nz, j=1:ny_total, i=1:nx_face)
            if (i <= nghost) then
               fld(i, j, k) = fld(i + nx_phys, j, k)
            end if
            if (i > nx_phys + nghost + 1) then
               fld(i, j, k) = fld(i - nx_phys, j, k)
            end if
            if (i == i_e) fld(i, j, k) = fld(i_w, j, k)
         end do
      end if
      if (wrap_y) then
         do concurrent(k=1:nz, j=1:ny_total, i=1:nx_face)
            if (j <= nghost) then
               fld(i, j, k) = fld(i, j + ny_phys, k)
            end if
            if (j > ny_phys + nghost) then
               fld(i, j, k) = fld(i, j - ny_phys, k)
            end if
         end do
      end if
      !$acc end kernels
      if (lwait) then
         !$acc wait(1)
      end if
   end subroutine ocean_periodic_wrap_face_x_3d