Newer
Older
#define DECAL_FEEDBACK /* SEPARATION of INTERFACES */
#undef DECAL_FEEDBACK_2D /* SEPARATION of INTERFACES (Barotropic mode) */
#undef VOL_REFLUX /* VOLUME REFLUXING*/
MODULE agrif_oce_update
!!======================================================================
!! *** MODULE agrif_oce_update ***
!! AGRIF: update package for the ocean dynamics (OCE)
!!======================================================================
!! History : 2.0 ! 2002-06 (L. Debreu) Original code
!! 3.2 ! 2009-04 (R. Benshila)
!! 3.6 ! 2014-09 (R. Benshila)
!! 4.2 ! 2021-11 (J. Chanut)
!!----------------------------------------------------------------------
#if defined key_agrif
!!----------------------------------------------------------------------
!! 'key_agrif' AGRIF zoom
!!----------------------------------------------------------------------
USE par_oce
USE oce
USE dom_oce
USE zdf_oce ! vertical physics: ocean variables
USE agrif_oce
USE dom_oce
!
USE in_out_manager ! I/O manager
USE lib_mpp ! MPP library
USE domvvl ! Need interpolation routines
USE vremap ! Vertical remapping
USE lbclnk
#if defined key_qco
USE domqco
#endif
IMPLICIT NONE
PRIVATE
PUBLIC Agrif_Update_Tra, Agrif_Update_Dyn, Agrif_Update_vvl, Agrif_Update_ssh
PUBLIC Agrif_Check_parent_bat
Tomas Lovato
committed
PUBLIC update_tmask_agrif
!! * Substitutions
# include "domzgr_substitute.h90"
!!----------------------------------------------------------------------
!! NEMO/NST 4.0 , NEMO Consortium (2018)
!! $Id: agrif_oce_update.F90 15317 2021-10-01 16:09:36Z jchanut $
!! Software governed by the CeCILL license (see ./LICENSE)
!!----------------------------------------------------------------------
CONTAINS
SUBROUTINE Agrif_Update_Tra( )
!!----------------------------------------------------------------------
!! *** ROUTINE Agrif_Update_Tra ***
!!----------------------------------------------------------------------
!
IF (Agrif_Root()) RETURN
!
IF (lwp.AND.lk_agrif_debug) Write(*,*) 'Update tracers from grid Number', Agrif_Fixed()
Agrif_UseSpecialValueInUpdate = .FALSE.
!
# if ! defined DECAL_FEEDBACK
CALL Agrif_Update_Variable(ts_update_id, procname=updateTS)
! near boundary update:
! CALL Agrif_Update_Variable(ts_update_id,locupdate=(/0,2/), procname=updateTS)
# else
CALL Agrif_Update_Variable(ts_update_id, locupdate=(/1,0/),procname=updateTS)
! near boundary update:
! CALL Agrif_Update_Variable(ts_update_id,locupdate=(/1,2/), procname=updateTS)
# endif
!
l_vremap = .FALSE.
!
!
END SUBROUTINE Agrif_Update_Tra
SUBROUTINE Agrif_Update_Dyn( )
!!----------------------------------------------------------------------
!! *** ROUTINE Agrif_Update_Dyn ***
!!----------------------------------------------------------------------
!
IF (Agrif_Root()) RETURN
!
IF (lwp.AND.lk_agrif_debug) Write(*,*) 'Update momentum from grid Number', Agrif_Fixed()
Agrif_UseSpecialValueInUpdate = .FALSE.
Agrif_SpecialValueFineGrid = 0._wp
l_vremap = ln_vert_remap
use_sign_north = .TRUE.
sign_north = -1._wp
!
# if ! defined DECAL_FEEDBACK_2D
CALL Agrif_Update_Variable(unb_update_id,locupdate1=(/ nn_shift_bar,-2/),locupdate2=(/ nn_shift_bar,-2/),procname = updateU2d)
CALL Agrif_Update_Variable(vnb_update_id,locupdate1=(/ nn_shift_bar,-2/),locupdate2=(/ nn_shift_bar,-2/),procname = updateV2d)
# else
CALL Agrif_Update_Variable(unb_update_id,locupdate1=(/ nn_shift_bar,-2/),locupdate2=(/1+nn_shift_bar,-2/),procname = updateU2d)
CALL Agrif_Update_Variable(vnb_update_id,locupdate1=(/1+nn_shift_bar,-2/),locupdate2=(/ nn_shift_bar,-2/),procname = updateV2d)
# endif
!
IF ( ln_dynspg_ts .AND. ln_bt_fw ) THEN
! Update time integrated transports
# if ! defined DECAL_FEEDBACK_2D
CALL Agrif_Update_Variable(ub2b_update_id,locupdate1=(/ nn_shift_bar,-2/),locupdate2=(/ nn_shift_bar,-2/),procname = updateub2b)
CALL Agrif_Update_Variable(vb2b_update_id,locupdate1=(/ nn_shift_bar,-2/),locupdate2=(/ nn_shift_bar,-2/),procname = updatevb2b)
# else
CALL Agrif_Update_Variable(ub2b_update_id,locupdate1=(/ nn_shift_bar,-2/),locupdate2=(/1+nn_shift_bar,-2/),procname = updateub2b)
CALL Agrif_Update_Variable(vb2b_update_id,locupdate1=(/1+nn_shift_bar,-2/),locupdate2=(/ nn_shift_bar,-2/),procname = updatevb2b)
# endif
IF (lk_agrif_fstep) THEN
CALL Agrif_Update_Variable(ub2b_update_id,locupdate1=(/ nn_shift_bar+nn_dist_par_bc-1,-2/),locupdate2=(/ nn_shift_bar+nn_dist_par_bc ,-2/),procname = updateumsk)
CALL Agrif_Update_Variable(vb2b_update_id,locupdate1=(/ nn_shift_bar+nn_dist_par_bc ,-2/),locupdate2=(/ nn_shift_bar+nn_dist_par_bc-1,-2/),procname = updatevmsk)
ENDIF
END IF
# if ! defined DECAL_FEEDBACK
CALL Agrif_Update_Variable(un_update_id,procname = updateU)
CALL Agrif_Update_Variable(vn_update_id,procname = updateV)
! near boundary update:
! CALL Agrif_Update_Variable(un_update_id,locupdate=(/0,1/),procname = updateU)
! CALL Agrif_Update_Variable(vn_update_id,locupdate=(/0,1/),procname = updateV)
# else
CALL Agrif_Update_Variable(un_update_id,locupdate1=(/0,-1/),locupdate2=(/1,-2/),procname = updateU)
CALL Agrif_Update_Variable(vn_update_id,locupdate1=(/1,-2/),locupdate2=(/0,-1/),procname = updateV)
! near boundary update:
! CALL Agrif_Update_Variable(un_update_id,locupdate1=(/0,1/),locupdate2=(/1,1/),procname = updateU)
! CALL Agrif_Update_Variable(vn_update_id,locupdate1=(/1,1/),locupdate2=(/0,1/),procname = updateV)
# endif
!
use_sign_north = .FALSE.
l_vremap = .FALSE.
!
END SUBROUTINE Agrif_Update_Dyn
SUBROUTINE Agrif_Update_ssh( )
!!---------------------------------------------
!! *** ROUTINE Agrif_Update_ssh ***
!!---------------------------------------------
!
IF (Agrif_Root()) RETURN
!
Agrif_UseSpecialValueInUpdate = .FALSE.
Agrif_SpecialValueFineGrid = 0._wp
# if ! defined DECAL_FEEDBACK_2D
CALL Agrif_Update_Variable(sshn_id,locupdate=(/ nn_shift_bar,-2/), procname = updateSSH)
# else
CALL Agrif_Update_Variable(sshn_id,locupdate=(/1+nn_shift_bar,-2/), procname = updateSSH)
IF (lk_agrif_fstep) THEN
CALL Agrif_Update_Variable(sshn_id,locupdate=(/1+nn_shift_bar+nn_dist_par_bc-1,-2/),procname = updatetmsk)
ENDIF
!
# if defined VOL_REFLUX
IF ( ln_dynspg_ts.AND.ln_bt_fw ) THEN
use_sign_north = .TRUE.
sign_north = -1._wp
! Refluxing on ssh:
# if defined DECAL_FEEDBACK_2D
CALL Agrif_Update_Variable(ub2b_update_id,locupdate1=(/nn_shift_bar,nn_shift_bar/),locupdate2=(/1+nn_shift_bar,1+nn_shift_bar/),procname = reflux_sshu)
CALL Agrif_Update_Variable(vb2b_update_id,locupdate1=(/1+nn_shift_bar,1+nn_shift_bar/),locupdate2=(/nn_shift_bar,nn_shift_bar/),procname = reflux_sshv)
# else
CALL Agrif_Update_Variable(ub2b_update_id,locupdate1=(/-1+nn_shift_bar,-1+nn_shift_bar/),locupdate2=(/nn_shift_bar, nn_shift_bar/),procname = reflux_sshu)
CALL Agrif_Update_Variable(vb2b_update_id,locupdate1=(/ nn_shift_bar, nn_shift_bar/),locupdate2=(/-1+nn_shift_bar,-1+nn_shift_bar/),procname = reflux_sshv)
# endif
use_sign_north = .FALSE.
END IF
# endif
Agrif_UseSpecialValueInUpdate = .FALSE.
!
END SUBROUTINE Agrif_Update_ssh
SUBROUTINE Agrif_Update_Tke( )
!!---------------------------------------------
!! *** ROUINE Agrif_Update_Tke ***
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
!!---------------------------------------------
!!
!
IF (Agrif_Root()) RETURN
!
Agrif_UseSpecialValueInUpdate = .TRUE.
Agrif_SpecialValueFineGrid = 0._wp
CALL Agrif_Update_Variable( en_id, locupdate=(/0,0/), procname=updateEN )
CALL Agrif_Update_Variable(avt_id, locupdate=(/0,0/), procname=updateAVT )
CALL Agrif_Update_Variable(avm_id, locupdate=(/0,0/), procname=updateAVM )
Agrif_UseSpecialValueInUpdate = .FALSE.
END SUBROUTINE Agrif_Update_Tke
SUBROUTINE Agrif_Update_vvl( )
!!---------------------------------------------
!! *** ROUTINE Agrif_Update_vvl ***
!!---------------------------------------------
!
IF (Agrif_Root()) RETURN
!
IF (lwp.AND.lk_agrif_debug) Write(*,*) 'Update e3 from grid Number',Agrif_Fixed(), 'Step', Agrif_Nb_Step()
!
#if defined key_qco
!
Agrif_UseSpecialValueInUpdate = .FALSE.
#if ! defined DECAL_FEEDBACK_2D
CALL Agrif_Update_Variable(r3t_id, locupdate=(/ nn_shift_bar,-2/), procname=update_r3t)
CALL Agrif_Update_Variable(r3f_id, locupdate=(/ nn_shift_bar,-2/), procname=update_r3f)
CALL Agrif_Update_Variable(r3u_id, locupdate1=(/ nn_shift_bar,-2/), locupdate2=(/ nn_shift_bar,-2/), procname=update_r3u)
CALL Agrif_Update_Variable(r3v_id, locupdate1=(/ nn_shift_bar,-2/), locupdate2=(/ nn_shift_bar,-2/), procname=update_r3v)
#else
CALL Agrif_Update_Variable(r3t_id, locupdate=(/1+nn_shift_bar,-2/), procname=update_r3t)
CALL Agrif_Update_Variable(r3f_id, locupdate=(/1+nn_shift_bar,-2/), procname=update_r3f)
CALL Agrif_Update_Variable(r3u_id, locupdate1=(/ nn_shift_bar,-2/), locupdate2=(/1+nn_shift_bar,-2/), procname=update_r3u)
CALL Agrif_Update_Variable(r3v_id, locupdate1=(/1+nn_shift_bar,-2/), locupdate2=(/ nn_shift_bar,-2/), procname=update_r3v)
#endif
!
! Old way (update e3 at UVF-points everywhere on parent domain):
! CALL Agrif_ChildGrid_To_ParentGrid()
! CALL Agrif_Update_qco
! CALL Agrif_ParentGrid_To_ChildGrid()
#elif defined key_linssh
! DO NOTHING HERE
#else
l_vremap = ln_vert_remap
#if ! defined DECAL_FEEDBACK_2D
CALL Agrif_Update_Variable(e3t_id, locupdate=(/ nn_shift_bar,-2/), procname=update_e3t)
CALL Agrif_Update_Variable(e3f_id, locupdate=(/ nn_shift_bar,-2/), procname=update_e3f)
CALL Agrif_Update_Variable(e3u_id, locupdate1=(/ nn_shift_bar,-2/), locupdate2=(/ nn_shift_bar,-2/), procname=update_e3u)
CALL Agrif_Update_Variable(e3v_id, locupdate1=(/ nn_shift_bar,-2/), locupdate2=(/ nn_shift_bar,-2/), procname=update_e3v)
#else
CALL Agrif_Update_Variable(e3t_id, locupdate=(/1+nn_shift_bar,-2/), procname=update_e3t)
CALL Agrif_Update_Variable(e3f_id, locupdate=(/1+nn_shift_bar,-2/), procname=update_e3f)
CALL Agrif_Update_Variable(e3u_id, locupdate1=(/ nn_shift_bar,-2/), locupdate2=(/1+nn_shift_bar,-2/), procname=update_e3u)
CALL Agrif_Update_Variable(e3v_id, locupdate1=(/1+nn_shift_bar,-2/), locupdate2=(/ nn_shift_bar,-2/), procname=update_e3v)
#endif
l_vremap = .FALSE.
! Old way (update e3 at UVF-points everywhere on parent domain):
! CALL Agrif_ChildGrid_To_ParentGrid()
! CALL dom_vvl_update_UVF
! CALL Agrif_ParentGrid_To_ChildGrid()
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
#endif
!
END SUBROUTINE Agrif_Update_vvl
#if defined key_qco
SUBROUTINE Agrif_Update_qco
!!---------------------------------------------
!! *** ROUTINE dom_Update_qco ***
!!---------------------------------------------
!
! Save arrays prior update (needed for asselin correction)
r3t(:,:,Krhs_a) = r3t(:,:,Kmm_a)
r3u(:,:,Krhs_a) = r3u(:,:,Kmm_a)
r3v(:,:,Krhs_a) = r3v(:,:,Kmm_a)
! Update r3x arrays from updated ssh
CALL dom_qco_zgr( Kbb_a, Kmm_a )
!
END SUBROUTINE Agrif_Update_qco
#endif
#if ! defined key_qco && ! defined key_linssh
SUBROUTINE dom_vvl_update_UVF
!!---------------------------------------------
!! *** ROUTINE dom_vvl_update_UVF ***
!!---------------------------------------------
!!
INTEGER :: jk
REAL(wp):: zcoef
!!---------------------------------------------
IF (lwp.AND.lk_agrif_debug) Write(*,*) 'Finalize e3 on grid Number', &
& Agrif_Fixed(), 'Step', Agrif_Nb_Step()
! Save "old" scale factor (prior update) for subsequent asselin correction
! of prognostic variables
! -----------------------
!
e3u(:,:,:,Krhs_a) = e3u(:,:,:,Kmm_a)
e3v(:,:,:,Krhs_a) = e3v(:,:,:,Kmm_a)
hu(:,:,Krhs_a) = hu(:,:,Kmm_a)
hv(:,:,Krhs_a) = hv(:,:,Kmm_a)
! 1) NOW fields
!--------------
! Vertical scale factor interpolations
! ------------------------------------
CALL dom_vvl_interpol( e3t(:,:,:,Kmm_a), e3u(:,:,:,Kmm_a) , 'U' )
CALL dom_vvl_interpol( e3t(:,:,:,Kmm_a), e3v(:,:,:,Kmm_a) , 'V' )
CALL dom_vvl_interpol( e3u(:,:,:,Kmm_a), e3f(:,:,:) , 'F' )
CALL dom_vvl_interpol( e3u(:,:,:,Kmm_a), e3uw(:,:,:,Kmm_a), 'UW' )
CALL dom_vvl_interpol( e3v(:,:,:,Kmm_a), e3vw(:,:,:,Kmm_a), 'VW' )
! Update total depths:
! --------------------
hu(:,:,Kmm_a) = 0._wp ! Ocean depth at U-points
hv(:,:,Kmm_a) = 0._wp ! Ocean depth at V-points
DO jk = 1, jpkm1
hu(:,:,Kmm_a) = hu(:,:,Kmm_a) + e3u(:,:,jk,Kmm_a) * umask(:,:,jk)
hv(:,:,Kmm_a) = hv(:,:,Kmm_a) + e3v(:,:,jk,Kmm_a) * vmask(:,:,jk)
END DO
! ! Inverse of the local depth
r1_hu(:,:,Kmm_a) = ssumask(:,:) / ( hu(:,:,Kmm_a) + 1._wp - ssumask(:,:) )
r1_hv(:,:,Kmm_a) = ssvmask(:,:) / ( hv(:,:,Kmm_a) + 1._wp - ssvmask(:,:) )
! 2) BEFORE fields:
!------------------
IF (.NOT.(lk_agrif_fstep.AND.(l_1st_euler) )) THEN
!
! Vertical scale factor interpolations
! ------------------------------------
CALL dom_vvl_interpol( e3t(:,:,:,Kbb_a), e3u(:,:,:,Kbb_a), 'U' )
CALL dom_vvl_interpol( e3t(:,:,:,Kbb_a), e3v(:,:,:,Kbb_a), 'V' )
CALL dom_vvl_interpol( e3u(:,:,:,Kbb_a), e3uw(:,:,:,Kbb_a), 'UW' )
CALL dom_vvl_interpol( e3v(:,:,:,Kbb_a), e3vw(:,:,:,Kbb_a), 'VW' )
! Update total depths:
! --------------------
hu(:,:,Kbb_a) = 0._wp ! Ocean depth at U-points
hv(:,:,Kbb_a) = 0._wp ! Ocean depth at V-points
DO jk = 1, jpkm1
hu(:,:,Kbb_a) = hu(:,:,Kbb_a) + e3u(:,:,jk,Kbb_a) * umask(:,:,jk)
hv(:,:,Kbb_a) = hv(:,:,Kbb_a) + e3v(:,:,jk,Kbb_a) * vmask(:,:,jk)
END DO
! ! Inverse of the local depth
r1_hu(:,:,Kbb_a) = ssumask(:,:) / ( hu(:,:,Kbb_a) + 1._wp - ssumask(:,:) )
r1_hv(:,:,Kbb_a) = ssvmask(:,:) / ( hv(:,:,Kbb_a) + 1._wp - ssvmask(:,:) )
ENDIF
!
END SUBROUTINE dom_vvl_update_UVF
#endif
SUBROUTINE updateTS( tabres, i1, i2, j1, j2, k1, k2, n1, n2, before )
!!----------------------------------------------------------------------
!! *** ROUTINE updateT ***
!!---------------------------------------------
INTEGER, INTENT(in) :: i1,i2,j1,j2,k1,k2,n1,n2
REAL(wp),DIMENSION(i1:i2,j1:j2,k1:k2,n1:n2), INTENT(inout) :: tabres
LOGICAL, INTENT(in) :: before
!!
INTEGER :: ji,jj,jk,jn
REAL(wp) :: ztb, ztnu, ztno, ze3b
REAL(wp) :: h_in(k1:k2)
REAL(wp) :: h_out(1:jpk)
REAL(wp) :: tabin(k1:k2,1:jpts)
REAL(wp), DIMENSION(i1:i2,j1:j2,1:jpk,1:jpts) :: tabres_child
!!---------------------------------------------
!
IF (before) THEN
DO jn = n1,n2-1
DO jk=k1,k2-1
tabres(ji,jj,jk,jn) = ts(ji,jj,jk,jn,Kmm_a) * e3t(ji,jj,jk,Kmm_a) &
& * e1e2t_frac(ji,jj)
END DO
IF ( l_vremap ) THEN
DO jk=k1,k2-1
DO jj=j1,j2
DO ji=i1,i2
tabres(ji,jj,jk,n2) = tmask(ji,jj,jk) * e3t(ji,jj,jk,Kmm_a) &
& * e1e2t_frac(ji,jj)
tabres_child(:,:,:,:) = 0._wp
IF ( l_vremap ) THEN
AGRIF_SpecialValue = 0._wp
DO jj=j1,j2
DO ji=i1,i2
N_in = 0
DO jk=k1,k2-1 !k2 = jpk of child grid
IF (tabres(ji,jj,jk,n2) <= 1.e-6_wp ) EXIT
N_in = N_in + 1
DO jn=n1,n2-1
tabin(jk,jn) = tabres(ji,jj,jk,jn)/tabres(ji,jj,jk,n2)
END DO
h_in(N_in) = tabres(ji,jj,jk,n2)
ENDDO
N_out = 0
DO jk=1,jpkm1 ! jpk of parent grid
IF (tmask(ji,jj,jk) == 0 ) EXIT ! TODO: Will not work with ISF
N_out = N_out + 1
h_out(N_out) = e3t(ji,jj,jk,Kmm_a)
ENDDO
IF (N_in*N_out > 0) THEN !Remove this?
CALL reconstructandremap(tabin(1:N_in,1:jpts),h_in(1:N_in),tabres_child(ji,jj,1:N_out,1:jpts),h_out(1:N_out),N_in,N_out,jpts)
ENDIF
ENDDO
ENDDO
ELSE
DO jn = 1, jpts
DO jk = k1, k2-1
tabres_child(i1:i2,j1:j2,jk,jn) = tabres(i1:i2,j1:j2,jk,jn) / e3t(i1:i2,j1:j2,jk,Kmm_a) * tmask(i1:i2,j1:j2,jk)
ENDDO
ENDDO
ENDIF
IF (.NOT.(lk_agrif_fstep.AND.(l_1st_euler))) THEN
! Add asselin part
DO jn = 1, jpts
DO jk = 1, jpkm1
DO jj = j1, j2
DO ji = i1, i2
ze3b = e3t(ji,jj,jk,Kbb_a) & ! Recover e3tb before update
& - rn_atfp * ( e3t(ji,jj,jk,Kmm_a) - e3t(ji,jj,jk,Krhs_a) )
ztb = ts(ji,jj,jk,jn,Kbb_a) * ze3b
ztnu = tabres_child(ji,jj,jk,jn) * e3t(ji,jj,jk,Kmm_a)
ztno = ts(ji,jj,jk,jn,Kmm_a) * e3t(ji,jj,jk,Krhs_a)
ts(ji,jj,jk,jn,Kbb_a) = ( ztb + rn_atfp * ( ztnu - ztno) ) &
& / e3t(ji,jj,jk,Kbb_a)
ENDIF
DO jn = 1,jpts
DO jk = 1, jpkm1
DO jj = j1, j2
DO ji = i1, i2
ts(ji,jj,jk,jn,Kmm_a) = tabres_child(ji,jj,jk,jn)
END DO
!
IF ((l_1st_euler).AND.(Agrif_Nb_Step()==0) ) THEN
ts(i1:i2,j1:j2,1:jpkm1,1:jpts,Kbb_a) = ts(i1:i2,j1:j2,1:jpkm1,1:jpts,Kmm_a)
ENDIF
ENDIF
!
END SUBROUTINE updateTS
SUBROUTINE updateu( tabres, i1, i2, j1, j2, k1, k2, n1, n2, before )
!!---------------------------------------------
!! *** ROUTINE updateu ***
!!---------------------------------------------
INTEGER , INTENT(in ) :: i1, i2, j1, j2, k1, k2, n1, n2
REAL(wp), DIMENSION(i1:i2,j1:j2,k1:k2,n1:n2), INTENT(inout) :: tabres
LOGICAL , INTENT(in ) :: before
!
INTEGER :: ji, jj, jk
REAL(wp):: zub, zunu, zuno, ze3b
REAL(wp), DIMENSION(jpi,jpj) :: zpgu ! 2D workspace
! VERTICAL REFINEMENT BEGIN
REAL(wp), DIMENSION(i1:i2,j1:j2,1:jpk) :: tabres_child
REAL(wp) :: h_in(k1:k2)
REAL(wp) :: h_out(1:jpk)
INTEGER :: N_in, N_out, N_in_save, N_out_save
REAL(wp) :: zhmin, zd
REAL(wp) :: tabin(k1:k2)
! VERTICAL REFINEMENT END
!!---------------------------------------------
!
IF( before ) THEN
DO jk=k1,k2
tabres(i1:i2,j1:j2,jk,1) = e2u_frac(i1:i2,j1:j2) * e3u(i1:i2,j1:j2,jk,Kmm_a) &
& * umask(i1:i2,j1:j2,jk) * uu(i1:i2,j1:j2,jk,Kmm_a)
END DO
IF ( l_vremap ) THEN
DO jk=k1,k2
tabres(i1:i2,j1:j2,jk,2) = e2u_frac(i1:i2,j1:j2) * e3u(i1:i2,j1:j2,jk,Kmm_a) &
& * umask(i1:i2,j1:j2,jk)
END DO
ENDIF
ELSE
tabres_child(:,:,:) = 0._wp
IF ( l_vremap ) THEN
DO jj=j1,j2
DO ji=i1,i2
N_in = 0
h_in(:) = 0._wp
tabin(:) = 0._wp
DO jk=k1,k2-1 !k2=jpk of child grid
IF( tabres(ji,jj,jk,2) <= 1.e-6_wp ) EXIT
N_in = N_in + 1
tabin(jk) = tabres(ji,jj,jk,1)/tabres(ji,jj,jk,2)
h_in(N_in) = tabres(ji,jj,jk,2)
DO jk=1,jpkm1
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
IF (umask(ji,jj,jk) == 0._wp) EXIT
N_out = N_out + 1
h_out(N_out) = e3u(ji,jj,jk,Kmm_a)
ENDDO
IF (N_in * N_out > 0) THEN
! Deal with potentially different depths at velocity points:
N_in_save = N_in
N_out_save = N_out
IF ( ABS(sum(h_out(1:N_out))-sum(h_in(1:N_in))) > 1.e-6_wp ) THEN
zhmin = MIN(sum(h_out(1:N_out)), sum(h_in(1:N_in)))
zd = 0._wp
DO jk=1, N_in_save
IF ( (zd + h_in(jk)) > zhmin-1.e-6) THEN
N_in = jk
h_in(jk) = zhmin - zd
EXIT
ENDIF
zd = zd + h_in(jk)
END DO
zd = 0._wp
DO jk=1, N_out_save
IF ( (zd + h_out(jk)) > zhmin-1.e-6) THEN
N_out = jk
h_out(jk) = zhmin - zd
EXIT
ENDIF
zd = zd + h_out(jk)
END DO
END IF
CALL reconstructandremap(tabin(1:N_in),h_in(1:N_in),tabres_child(ji,jj,1:N_out),h_out(1:N_out),N_in,N_out,1)
IF (N_out < N_out_save) tabres_child(ji,jj,N_out+1:N_out_save) = tabres_child(ji,jj,N_out)
ENDIF
ENDDO
ENDDO
ELSE
DO jk=k1,k2-1
tabres_child(ji,jj,jk) = tabres(ji,jj,jk,1) / e3u(ji,jj,jk,Kmm_a)
DO jk=1,jpkm1
DO jj=j1,j2
DO ji=i1,i2
IF (.NOT.(lk_agrif_fstep.AND.(l_1st_euler))) THEN ! Add asselin part
ze3b = e3u(ji,jj,jk,Kbb_a) & ! Recover e3ub before update
& - rn_atfp * ( e3u(ji,jj,jk,Kmm_a) - e3u(ji,jj,jk,Krhs_a) )
zub = uu(ji,jj,jk,Kbb_a) * ze3b
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
zuno = uu(ji,jj,jk,Kmm_a) * e3u(ji,jj,jk,Krhs_a)
zunu = tabres_child(ji,jj,jk) * e3u(ji,jj,jk,Kmm_a)
uu(ji,jj,jk,Kbb_a) = ( zub + rn_atfp * ( zunu - zuno) ) &
& * umask(ji,jj,jk) / e3u(ji,jj,jk,Kbb_a)
ENDIF
!
uu(ji,jj,jk,Kmm_a) = tabres_child(ji,jj,jk) * umask(ji,jj,jk)
END DO
END DO
END DO
!
! Correct now and before transports:
DO jj=j1,j2
DO ji=i1,i2
zpgu(ji,jj) = 0._wp
DO jk=1,jpkm1
zpgu(ji,jj) = zpgu(ji,jj) + e3u(ji,jj,jk,Kmm_a) * uu(ji,jj,jk,Kmm_a)
END DO
!
DO jk=1,jpkm1
uu(ji,jj,jk,Kmm_a) = uu(ji,jj,jk,Kmm_a) + &
& (uu_b(ji,jj,Kmm_a) - zpgu(ji,jj) * r1_hu(ji,jj,Kmm_a)) * umask(ji,jj,jk)
END DO
!
zpgu(ji,jj) = 0._wp
DO jk=1,jpkm1
zpgu(ji,jj) = zpgu(ji,jj) + e3u(ji,jj,jk,Kbb_a) * uu(ji,jj,jk,Kbb_a)
END DO
!
DO jk=1,jpkm1
uu(ji,jj,jk,Kbb_a) = uu(ji,jj,jk,Kbb_a) + &
& (uu_b(ji,jj,Kbb_a) - zpgu(ji,jj) * r1_hu(ji,jj,Kbb_a)) * umask(ji,jj,jk)
END DO
!
END DO
END DO
!
IF ((l_1st_euler).AND.(Agrif_Nb_Step()==0) ) THEN
uu(i1:i2,j1:j2,1:jpkm1,Kbb_a) = uu(i1:i2,j1:j2,1:jpkm1,Kmm_a)
ENDIF
!
ENDIF
!
END SUBROUTINE updateu
SUBROUTINE updatev( tabres, i1, i2, j1, j2, k1, k2, n1, n2, before )
!!---------------------------------------------
!! *** ROUTINE updatev ***
!!---------------------------------------------
INTEGER , INTENT(in ) :: i1, i2, j1, j2, k1, k2, n1, n2
REAL(wp), DIMENSION(i1:i2,j1:j2,k1:k2,n1:n2), INTENT(inout) :: tabres
LOGICAL , INTENT(in ) :: before
!
INTEGER :: ji, jj, jk
REAL(wp) :: zvb, zvnu, zvno, ze3b
REAL(wp), DIMENSION(jpi,jpj) :: zpgv ! 2D workspace
! VERTICAL REFINEMENT BEGIN
REAL(wp), DIMENSION(i1:i2,j1:j2,1:jpk) :: tabres_child
REAL(wp) :: h_in(k1:k2)
REAL(wp) :: h_out(1:jpk)
INTEGER :: N_in, N_out, N_in_save, N_out_save
REAL(wp) :: zhmin, zd
REAL(wp) :: tabin(k1:k2)
! VERTICAL REFINEMENT END
!!---------------------------------------------
!
IF( before ) THEN
DO jk=k1,k2
tabres(i1:i2,j1:j2,jk,1) = e1v_frac(i1:i2,j1:j2) * e3v(i1:i2,j1:j2,jk,Kmm_a) &
& * vmask(i1:i2,j1:j2,jk) * vv(i1:i2,j1:j2,jk,Kmm_a)
END DO
IF ( l_vremap ) THEN
DO jk=k1,k2
tabres(i1:i2,j1:j2,jk,2) = e1v_frac(i1:i2,j1:j2) * e3v(i1:i2,j1:j2,jk,Kmm_a) &
& * vmask(i1:i2,j1:j2,jk)
END DO
ENDIF
ELSE
tabres_child(:,:,:) = 0._wp
IF ( l_vremap ) THEN
DO jj=j1,j2
DO ji=i1,i2
N_in = 0
DO jk=k1,k2-1
IF (tabres(ji,jj,jk,2) <= 1.e-6_wp) EXIT
N_in = N_in + 1
tabin(jk) = tabres(ji,jj,jk,1)/tabres(ji,jj,jk,2)
h_in(N_in) = tabres(ji,jj,jk,2)
DO jk=1,jpkm1
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
IF (vmask(ji,jj,jk) == 0._wp) EXIT
N_out = N_out + 1
h_out(N_out) = e3v(ji,jj,jk,Kmm_a)
ENDDO
IF (N_in * N_out > 0) THEN
! Deal with potentially different depths at velocity points:
N_in_save = N_in
N_out_save = N_out
IF ( ABS(sum(h_out(1:N_out))-sum(h_in(1:N_in))) > 1.e-6_wp ) THEN
zhmin = MIN(sum(h_out(1:N_out)), sum(h_in(1:N_in)))
zd = 0._wp
DO jk=1, N_in_save
IF ( (zd + h_in(jk)) > zhmin-1.e-6) THEN
N_in = jk
h_in(jk) = zhmin - zd
EXIT
ENDIF
zd = zd + h_in(jk)
END DO
zd = 0._wp
DO jk=1, N_out_save
IF ( (zd + h_out(jk)) > zhmin-1.e-6) THEN
N_out = jk
h_out(jk) = zhmin - zd
EXIT
ENDIF
zd = zd + h_out(jk)
END DO
END IF
CALL reconstructandremap(tabin(1:N_in),h_in(1:N_in),tabres_child(ji,jj,1:N_out),h_out(1:N_out),N_in,N_out,1)
IF (N_out < N_out_save) tabres_child(ji,jj,N_out+1:N_out_save) = tabres_child(ji,jj,N_out)
ENDIF
ENDDO
ENDDO
ELSE
DO jk=k1,k2-1
tabres_child(ji,jj,jk) = tabres(ji,jj,jk,1) / e3v(ji,jj,jk,Kmm_a)
END DO
END DO
END DO
ENDIF
!
DO jk=1,jpkm1
DO jj=j1,j2
DO ji=i1,i2
IF (.NOT.(lk_agrif_fstep.AND.(l_1st_euler))) THEN ! Add asselin part
ze3b = e3v(ji,jj,jk,Kbb_a) & ! Recover e3vb before update
& - rn_atfp * ( e3v(ji,jj,jk,Kmm_a) - e3v(ji,jj,jk,Krhs_a) )
zvb = vv(ji,jj,jk,Kbb_a) * ze3b
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
zvno = vv(ji,jj,jk,Kmm_a) * e3v(ji,jj,jk,Krhs_a)
zvnu = tabres_child(ji,jj,jk) * e3v(ji,jj,jk,Kmm_a)
vv(ji,jj,jk,Kbb_a) = ( zvb + rn_atfp * ( zvnu - zvno) ) &
& * vmask(ji,jj,jk) / e3v(ji,jj,jk,Kbb_a)
ENDIF
!
vv(ji,jj,jk,Kmm_a) = tabres_child(ji,jj,jk) * vmask(ji,jj,jk)
END DO
END DO
END DO
!
! Correct now and before transports:
DO jj=j1,j2
DO ji=i1,i2
zpgv(ji,jj) = 0._wp
DO jk=1,jpkm1
zpgv(ji,jj) = zpgv(ji,jj) + e3v(ji,jj,jk,Kmm_a) * vv(ji,jj,jk,Kmm_a)
END DO
!
DO jk=1,jpkm1
vv(ji,jj,jk,Kmm_a) = vv(ji,jj,jk,Kmm_a) + &
& (vv_b(ji,jj,Kmm_a) - zpgv(ji,jj) * r1_hv(ji,jj,Kmm_a)) * vmask(ji,jj,jk)
END DO
!
zpgv(ji,jj) = 0._wp
DO jk=1,jpkm1
zpgv(ji,jj) = zpgv(ji,jj) + e3v(ji,jj,jk,Kbb_a) * vv(ji,jj,jk,Kbb_a)
END DO
!
DO jk=1,jpkm1
vv(ji,jj,jk,Kbb_a) = vv(ji,jj,jk,Kbb_a) + &
& (vv_b(ji,jj,Kbb_a) - zpgv(ji,jj) * r1_hv(ji,jj,Kbb_a)) * vmask(ji,jj,jk)
END DO
!
END DO
END DO
!
IF ((l_1st_euler).AND.(Agrif_Nb_Step()==0) ) THEN
vv(i1:i2,j1:j2,1:jpkm1,Kbb_a) = vv(i1:i2,j1:j2,1:jpkm1,Kmm_a)
ENDIF
!
ENDIF
!
END SUBROUTINE updatev
SUBROUTINE updateu2d( tabres, i1, i2, j1, j2, before )
!!----------------------------------------------------------------------
!! *** ROUTINE updateu2d ***
!!----------------------------------------------------------------------
INTEGER , INTENT(in ) :: i1, i2, j1, j2
REAL(wp), DIMENSION(i1:i2,j1:j2), INTENT(inout) :: tabres
LOGICAL , INTENT(in ) :: before
!!
REAL(wp), DIMENSION(jpi,jpj) :: zpgu ! 2D workspace
!!
INTEGER :: ji, jj, jk
REAL(wp) :: zcorr
!!---------------------------------------------
!
IF( before ) THEN
DO jj=j1,j2
DO ji=i1,i2
tabres(ji,jj) = uu_b(ji,jj,Kmm_a) * hu(ji,jj,Kmm_a) * e2u_frac(ji,jj)
END DO
END DO
ELSE
DO jj=j1,j2
DO ji=i1,i2
!
! Update barotropic velocities:
IF ( .NOT.ln_dynspg_ts .OR. (ln_dynspg_ts.AND.(.NOT.ln_bt_fw)) ) THEN
IF (.NOT.(lk_agrif_fstep.AND.(l_1st_euler))) THEN ! Add asselin part
zcorr = (tabres(ji,jj) - uu_b(ji,jj,Kmm_a) * hu(ji,jj,Krhs_a)) * r1_hu(ji,jj,Kbb_a)
uu_b(ji,jj,Kbb_a) = uu_b(ji,jj,Kbb_a) + rn_atfp * zcorr * umask(ji,jj,1)
END IF
ENDIF
uu_b(ji,jj,Kmm_a) = tabres(ji,jj) * r1_hu(ji,jj,Kmm_a) * umask(ji,jj,1)
!
END DO
END DO
!
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
! Correct now and before 3d velocities (needed in case of interface shift)
DO jj=j1,j2
DO ji=i1,i2
zpgu(ji,jj) = 0._wp
DO jk=1,jpkm1
zpgu(ji,jj) = zpgu(ji,jj) + e3u(ji,jj,jk,Kmm_a) * uu(ji,jj,jk,Kmm_a)
END DO
!
DO jk=1,jpkm1
uu(ji,jj,jk,Kmm_a) = uu(ji,jj,jk,Kmm_a) + &
& (uu_b(ji,jj,Kmm_a) - zpgu(ji,jj) * r1_hu(ji,jj,Kmm_a)) * umask(ji,jj,jk)
END DO
!
zpgu(ji,jj) = 0._wp
DO jk=1,jpkm1
zpgu(ji,jj) = zpgu(ji,jj) + e3u(ji,jj,jk,Kbb_a) * uu(ji,jj,jk,Kbb_a)
END DO
!
DO jk=1,jpkm1
uu(ji,jj,jk,Kbb_a) = uu(ji,jj,jk,Kbb_a) + &
& (uu_b(ji,jj,Kbb_a) - zpgu(ji,jj) * r1_hu(ji,jj,Kbb_a)) * umask(ji,jj,jk)
END DO
!
END DO
END DO
!
IF ((l_1st_euler).AND.(Agrif_Nb_Step()==0) ) THEN
uu_b(i1:i2,j1:j2,Kbb_a) = uu_b(i1:i2,j1:j2,Kmm_a)
ENDIF
ENDIF
!
END SUBROUTINE updateu2d
SUBROUTINE updatev2d( tabres, i1, i2, j1, j2, before )
!!----------------------------------------------------------------------
!! *** ROUTINE updatev2d ***
!!----------------------------------------------------------------------
INTEGER , INTENT(in ) :: i1, i2, j1, j2
REAL(wp), DIMENSION(i1:i2,j1:j2), INTENT(inout) :: tabres
LOGICAL , INTENT(in ) :: before
!
REAL(wp), DIMENSION(jpi,jpj) :: zpgv ! 2D workspace
!
INTEGER :: ji, jj, jk
REAL(wp) :: zcorr
!!----------------------------------------------------------------------
!
IF( before ) THEN
DO jj=j1,j2
DO ji=i1,i2
tabres(ji,jj) = vv_b(ji,jj,Kmm_a) * hv(ji,jj,Kmm_a) * e1v_frac(ji,jj)
END DO
END DO
ELSE
DO jj=j1,j2
DO ji=i1,i2
! Update barotropic velocities:
IF ( .NOT.ln_dynspg_ts .OR. (ln_dynspg_ts.AND.(.NOT.ln_bt_fw)) ) THEN
IF (.NOT.(lk_agrif_fstep.AND.(l_1st_euler))) THEN ! Add asselin part
zcorr = (tabres(ji,jj) - vv_b(ji,jj,Kmm_a) * hv(ji,jj,Krhs_a)) * r1_hv(ji,jj,Kbb_a)
vv_b(ji,jj,Kbb_a) = vv_b(ji,jj,Kbb_a) + rn_atfp * zcorr * vmask(ji,jj,1)
END IF
ENDIF
vv_b(ji,jj,Kmm_a) = tabres(ji,jj) * r1_hv(ji,jj,Kmm_a) * vmask(ji,jj,1)
!
END DO
END DO
!
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
! Correct now and before 3d velocities (in case of interface shift):
DO jj=j1,j2
DO ji=i1,i2
zpgv(ji,jj) = 0._wp
DO jk=1,jpkm1
zpgv(ji,jj) = zpgv(ji,jj) + e3v(ji,jj,jk,Kmm_a) * vv(ji,jj,jk,Kmm_a)
END DO
!
DO jk=1,jpkm1
vv(ji,jj,jk,Kmm_a) = vv(ji,jj,jk,Kmm_a) + &
& (vv_b(ji,jj,Kmm_a) - zpgv(ji,jj) * r1_hv(ji,jj,Kmm_a)) * vmask(ji,jj,jk)
END DO
!
zpgv(ji,jj) = 0._wp
DO jk=1,jpkm1
zpgv(ji,jj) = zpgv(ji,jj) + e3v(ji,jj,jk,Kbb_a) * vv(ji,jj,jk,Kbb_a)
END DO
!
DO jk=1,jpkm1
vv(ji,jj,jk,Kbb_a) = vv(ji,jj,jk,Kbb_a) + &
& (vv_b(ji,jj,Kbb_a) - zpgv(ji,jj) * r1_hv(ji,jj,Kbb_a)) * vmask(ji,jj,jk)
END DO
!
END DO
END DO
!
IF ((l_1st_euler).AND.(Agrif_Nb_Step()==0) ) THEN
vv_b(i1:i2,j1:j2,Kbb_a) = vv_b(i1:i2,j1:j2,Kmm_a)
ENDIF
!
ENDIF
!
END SUBROUTINE updatev2d
SUBROUTINE updateSSH( tabres, i1, i2, j1, j2, before )
!!----------------------------------------------------------------------
!! *** ROUTINE updateSSH ***
!!----------------------------------------------------------------------
INTEGER , INTENT(in ) :: i1, i2, j1, j2
REAL(wp), DIMENSION(i1:i2,j1:j2), INTENT(inout) :: tabres
LOGICAL , INTENT(in ) :: before
!!
INTEGER :: ji, jj
!!----------------------------------------------------------------------
!
IF( before ) THEN
DO jj=j1,j2
DO ji=i1,i2
tabres(ji,jj) = e1e2t_frac(ji,jj) * ssh(ji,jj,Kmm_a)
IF (.NOT.(lk_agrif_fstep.AND.(l_1st_euler))) THEN
DO jj=j1,j2
DO ji=i1,i2
ssh(ji,jj,Kbb_a) = ssh(ji,jj,Kbb_a) &
& + rn_atfp * ( tabres(ji,jj) - ssh(ji,jj,Kmm_a) ) * tmask(ji,jj,1)
END DO
END DO
ENDIF
!
DO jj=j1,j2
DO ji=i1,i2
ssh(ji,jj,Kmm_a) = tabres(ji,jj) * tmask(ji,jj,1)
END DO
END DO
!
IF ((l_1st_euler).AND.(Agrif_Nb_Step()==0) ) THEN
ssh(i1:i2,j1:j2,Kbb_a) = ssh(i1:i2,j1:j2,Kmm_a)
ENDIF
!
ENDIF
!
END SUBROUTINE updateSSH
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
SUBROUTINE updatetmsk( tabres, i1, i2, j1, j2, before )
!!----------------------------------------------------------------------
!! *** ROUTINE updatetmsk ***
!!----------------------------------------------------------------------
INTEGER , INTENT(in ) :: i1, i2, j1, j2
REAL(wp), DIMENSION(i1:i2,j1:j2), INTENT(inout) :: tabres
LOGICAL , INTENT(in ) :: before
!!
!!----------------------------------------------------------------------
!
IF( .NOT.before ) THEN
tmask_upd(i1:i2,j1:j2) = 1._wp
ENDIF
!
END SUBROUTINE updatetmsk
SUBROUTINE updateumsk( tabres, i1, i2, j1, j2, before )
!!----------------------------------------------------------------------
!! *** ROUTINE updateumsk ***
!!----------------------------------------------------------------------
INTEGER , INTENT(in ) :: i1, i2, j1, j2
REAL(wp), DIMENSION(i1:i2,j1:j2), INTENT(inout) :: tabres
LOGICAL , INTENT(in ) :: before
!!
!!----------------------------------------------------------------------
!
IF( .NOT.before ) THEN
umask_upd(i1:i2,j1:j2) = 1._wp
ENDIF
!
END SUBROUTINE updateumsk
SUBROUTINE updatevmsk( tabres, i1, i2, j1, j2, before )
!!----------------------------------------------------------------------
!! *** ROUTINE updatevmsk ***
!!----------------------------------------------------------------------
INTEGER , INTENT(in ) :: i1, i2, j1, j2
REAL(wp), DIMENSION(i1:i2,j1:j2), INTENT(inout) :: tabres
LOGICAL , INTENT(in ) :: before
!!
!!----------------------------------------------------------------------
!
IF( .NOT.before ) THEN
vmask_upd(i1:i2,j1:j2) = 1._wp
ENDIF
!
END SUBROUTINE updatevmsk
SUBROUTINE updateub2b( tabres, i1, i2, j1, j2, before )
!!----------------------------------------------------------------------
!! *** ROUTINE updateub2b ***
!!----------------------------------------------------------------------
INTEGER , INTENT(in) :: i1, i2, j1, j2
REAL(wp), DIMENSION(i1:i2,j1:j2), INTENT(inout) :: tabres
LOGICAL , INTENT(in) :: before
!!
INTEGER :: ji, jj
REAL(wp) :: za1, zcor
!!---------------------------------------------
!
IF (before) THEN
DO jj=j1,j2
DO ji=i1,i2
tabres(ji,jj) = ub2_i_b(ji,jj) * e2u_frac(ji,jj)