New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
isfcpl.F90 in NEMO/branches/2020/dev_r13327_KERNEL-06_2_techene_e3/src/OCE/ISF – NEMO

source: NEMO/branches/2020/dev_r13327_KERNEL-06_2_techene_e3/src/OCE/ISF/isfcpl.F90 @ 13895

Last change on this file since 13895 was 13895, checked in by techene, 3 years ago

#2574 => led to restart reorganization and some cleaning

File size: 36.5 KB
Line 
1MODULE isfcpl
2   !!======================================================================
3   !!                       ***  MODULE  isfcpl  ***
4   !!
5   !! iceshelf coupling module : module managing the coupling between NEMO and an ice sheet model
6   !!
7   !!======================================================================
8   !! History :  4.1  !  2019-07  (P. Mathiot) Original code
9   !!----------------------------------------------------------------------
10
11   !!----------------------------------------------------------------------
12   !!   isfrst        : read/write iceshelf variables in/from restart
13   !!----------------------------------------------------------------------
14   USE oce            ! ocean dynamics and tracers
15#if defined key_qco
16   USE domqco  , ONLY : dom_qco_zgr      ! vertical scale factor interpolation
17#else
18   USE domvvl  , ONLY : dom_vvl_zgr      ! vertical scale factor interpolation
19#endif
20   USE domutl  , ONLY : dom_ngb          ! find the closest grid point from a given lon/lat position
21   USE isf_oce        ! ice shelf variable
22   USE isfutils, ONLY : debug
23   !
24   USE in_out_manager ! I/O manager
25   USE iom            ! I/O library
26   USE lib_mpp , ONLY : mpp_sum, mpp_max ! mpp routine
27   !
28   IMPLICIT NONE
29
30   PRIVATE
31
32   PUBLIC isfcpl_rst_write, isfcpl_init                    ! iceshelf restart read and write
33   PUBLIC isfcpl_ssh, isfcpl_tra, isfcpl_vol, isfcpl_cons  ! iceshelf correction for ssh, tra, dyn and conservation
34
35   TYPE isfcons
36      INTEGER ::   ii     ! i global
37      INTEGER ::   jj     ! j global
38      INTEGER ::   kk     ! k level
39      REAL(wp)::   dvol   ! volume increment
40      REAL(wp)::   dsal   ! salt increment
41      REAL(wp)::   dtem   ! heat increment
42      REAL(wp)::   lon    ! lon
43      REAL(wp)::   lat    ! lat
44      INTEGER ::   ngb    ! 0/1 (valid location or not (ie on halo or no neigbourg))
45   END TYPE
46   !
47   !! * Substitutions
48#  include "do_loop_substitute.h90"
49#  include "domzgr_substitute.h90"
50   !!----------------------------------------------------------------------
51   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
52   !! $Id: sbcisf.F90 10536 2019-01-16 19:21:09Z mathiot $
53   !! Software governed by the CeCILL license (see ./LICENSE)
54   !!----------------------------------------------------------------------
55CONTAINS
56   SUBROUTINE isfcpl_init(Kbb, Kmm, Kaa)
57      !!---------------------------------------------------------------------
58      !!                   ***  ROUTINE iscpl_init  ***
59      !!
60      !! ** Purpose : correct ocean state for new wet cell and horizontal divergence
61      !!              correction for the dynamical adjustement
62      !!
63      !! ** Action : - compute ssh on new wet cell
64      !!             - compute T/S on new wet cell
65      !!             - compute horizontal divergence correction as a volume flux
66      !!             - compute the T/S/vol correction increment to keep trend to 0
67      !!
68      !!---------------------------------------------------------------------
69      INTEGER, INTENT(in) :: Kbb, Kmm, Kaa      ! ocean time level indices
70      !!---------------------------------------------------------------------
71      INTEGER :: id
72      !!----------------------------------------------------------------------
73      !
74      ! start on an euler time step
75      l_1st_euler = .TRUE.
76      !
77      ! allocation and initialisation to 0
78      CALL isf_alloc_cpl()
79      !
80      ! check presence of variable needed for coupling
81      ! iom_varid return 0 if not found
82      id = 1
83      id = id * iom_varid(numror, 'ssmask', ldstop = .false.)
84      id = id * iom_varid(numror, 'tmask' , ldstop = .false.)
85      id = id * iom_varid(numror, 'e3t_n' , ldstop = .false.)
86      id = id * iom_varid(numror, 'e3u_n' , ldstop = .false.)
87      id = id * iom_varid(numror, 'e3v_n' , ldstop = .false.)
88      IF(lwp) WRITE(numout,*) ' isfcpl_init:', id
89      IF (id == 0) THEN
90         IF(lwp) WRITE(numout,*) ' isfcpl_init: restart variables for ice sheet coupling are missing, skip coupling for this leg ' 
91         IF(lwp) WRITE(numout,*) ' ~~~~~~~~~~~'
92         IF(lwp) WRITE(numout,*) ''
93      ELSE
94         ! extrapolation ssh
95         CALL isfcpl_ssh(Kbb, Kmm, Kaa)
96         !
97         ! extrapolation tracer properties
98         CALL isfcpl_tra(Kmm)
99         !
100         ! correction of the horizontal divergence and associated temp. and salt content flux
101         ! Need to : - include in the cpl cons the risfcpl_vol/tsc contribution
102         !           - decide how to manage thickness level change in conservation
103         CALL isfcpl_vol(Kmm)
104         !
105         ! apply the 'conservation' method
106         IF ( ln_isfcpl_cons ) CALL isfcpl_cons(Kmm)
107         !
108      END IF
109      !
110      ! mask velocity properly (mask used in restart not compatible with new mask)
111      uu(:,:,:,Kmm) = uu(:,:,:,Kmm) * umask(:,:,:)
112      vv(:,:,:,Kmm) = vv(:,:,:,Kmm) * vmask(:,:,:)
113      !
114      ! all before fields set to now values
115      ts  (:,:,:,:,Kbb) = ts  (:,:,:,:,Kmm)
116      uu   (:,:,:,Kbb)   = uu   (:,:,:,Kmm)
117      vv   (:,:,:,Kbb)   = vv   (:,:,:,Kmm)
118      ssh (:,:,Kbb)     = ssh (:,:,Kmm)
119#if ! defined key_qco
120      e3t(:,:,:,Kbb)   = e3t(:,:,:,Kmm)
121#endif 
122      ! prepare writing restart
123      IF( lwxios ) THEN
124         CALL iom_set_rstw_var_active('ssmask')
125         CALL iom_set_rstw_var_active('tmask')
126         CALL iom_set_rstw_var_active('e3t_n')
127         CALL iom_set_rstw_var_active('e3u_n')
128         CALL iom_set_rstw_var_active('e3v_n')
129      END IF
130      !
131   END SUBROUTINE isfcpl_init
132
133   
134   SUBROUTINE isfcpl_rst_write( kt, Kmm )
135      !!---------------------------------------------------------------------
136      !!                   ***  ROUTINE iscpl_rst_write  ***
137      !!
138      !! ** Purpose : write icesheet coupling variables in restart
139      !!
140      !!-------------------------- IN  --------------------------------------
141      INTEGER, INTENT(in) :: kt
142      INTEGER, INTENT(in) :: Kmm    ! ocean time level index
143      !!----------------------------------------------------------------------
144      INTEGER :: jk                               ! loop index
145      REAL(wp), DIMENSION(jpi,jpj,jpk) :: ze3t, ze3u, ze3v, zgdepw  ! for qco substitution
146      !!----------------------------------------------------------------------
147      !
148      DO jk = 1, jpk
149         ze3t(:,:,jk) = e3t(:,:,jk,Kmm)
150         ze3u(:,:,jk) = e3u(:,:,jk,Kmm)
151         ze3v(:,:,jk) = e3v(:,:,jk,Kmm)
152         !
153         zgdepw(:,:,jk) = gdepw(:,:,jk,Kmm)
154      END DO 
155      !
156      IF( lwxios ) CALL iom_swap( cwxios_context )
157      CALL iom_rstput( kt, nitrst, numrow, 'tmask'  , tmask , ldxios = lwxios )
158      CALL iom_rstput( kt, nitrst, numrow, 'ssmask' , ssmask, ldxios = lwxios )
159      CALL iom_rstput( kt, nitrst, numrow, 'e3t_n'  , ze3t , ldxios = lwxios )
160      CALL iom_rstput( kt, nitrst, numrow, 'e3u_n'  , ze3u , ldxios = lwxios )
161      CALL iom_rstput( kt, nitrst, numrow, 'e3v_n'  , ze3v , ldxios = lwxios )
162      CALL iom_rstput( kt, nitrst, numrow, 'gdepw_n', zgdepw , ldxios = lwxios )
163      IF( lwxios ) CALL iom_swap( cxios_context )
164      !
165   END SUBROUTINE isfcpl_rst_write
166
167   
168   SUBROUTINE isfcpl_ssh(Kbb, Kmm, Kaa)
169      !!----------------------------------------------------------------------
170      !!                   ***  ROUTINE iscpl_ssh  ***
171      !!
172      !! ** Purpose :   basic guess of ssh in new wet cell
173      !!
174      !! ** Method  :   basic extrapolation from neigbourg cells
175      !!
176      !!----------------------------------------------------------------------
177      !!
178      INTEGER, INTENT(in) :: Kbb, Kmm, Kaa    ! ocean time level indices
179      !!----------------------------------------------------------------------
180      INTEGER :: ji, jj, jd, jk      !! loop index
181      INTEGER :: jip1, jim1, jjp1, jjm1
182      !!
183      REAL(wp):: zsummsk
184      REAL(wp), DIMENSION(jpi,jpj) :: zdssmask, zssmask0, zssmask_b, zssh
185      !!----------------------------------------------------------------------
186      !
187      CALL iom_get( numror, jpdom_auto, 'ssmask'  , zssmask_b, ldxios = lrxios   ) ! need to extrapolate T/S
188
189      ! compute new ssh if we open a full water column
190      ! rude average of the closest neigbourgs (e1e2t not taking into account)
191      !
192      zssh(:,:)     = ssh(:,:,Kmm)
193      zssmask0(:,:) = zssmask_b(:,:)
194      !
195      DO jd = 1, nn_drown
196         !
197         zdssmask(:,:) = ssmask(:,:) - zssmask0(:,:)
198         DO_2D( 0, 0, 0, 0 )
199            jip1=ji+1   ;   jim1=ji-1
200            jjp1=jj+1   ;   jjm1=jj-1
201            !
202            zsummsk = zssmask0(jip1,jj) + zssmask0(jim1,jj) + zssmask0(ji,jjp1) + zssmask0(ji,jjm1)
203            !
204            IF (zdssmask(ji,jj) == 1._wp .AND. zsummsk /= 0._wp) THEN
205               ssh(ji,jj,Kmm)=( zssh(jip1,jj)*zssmask0(jip1,jj)     &
206                  &           + zssh(jim1,jj)*zssmask0(jim1,jj)     &
207                  &           + zssh(ji,jjp1)*zssmask0(ji,jjp1)     &
208                  &           + zssh(ji,jjm1)*zssmask0(ji,jjm1)) / zsummsk
209               zssmask_b(ji,jj) = 1._wp
210            ENDIF
211         END_2D
212         !
213         zssh(:,:) = ssh(:,:,Kmm)
214         zssmask0(:,:) = zssmask_b(:,:)
215         !
216         CALL lbc_lnk_multi( 'iscplrst', zssh, 'T', 1.0_wp, zssmask0, 'T', 1.0_wp )
217         !
218      END DO
219      !
220      ! update ssh(:,:,Kmm)
221      ssh(:,:,Kmm) = zssh(:,:) * ssmask(:,:)
222      !
223      ssh(:,:,Kbb) = ssh(:,:,Kmm)
224      !
225      IF ( ln_isfdebug ) CALL debug('isfcpl_ssh: sshn',ssh(:,:,Kmm))
226      !
227      ! recompute the vertical scale factor, depth and water thickness
228      IF(lwp) write(numout,*) 'isfcpl_ssh : recompute scale factor from ssh (new wet cell,Kmm)'
229      IF(lwp) write(numout,*) '~~~~~~~~~~~'
230#if ! defined key_qco
231      DO jk = 1, jpk
232         e3t(:,:,jk,Kmm) = e3t_0(:,:,jk) * ( 1._wp + (ht_0(:,:) + ssh(:,:,Kmm)) * r1_ht_0(:,:) )
233      END DO
234      e3t(:,:,:,Kbb) = e3t(:,:,:,Kmm)
235      CALL dom_vvl_zgr(Kbb, Kmm, Kaa)
236#else
237      CALL dom_qco_zgr(Kbb, Kmm)
238#endif
239      !
240   END SUBROUTINE isfcpl_ssh
241
242   
243   SUBROUTINE isfcpl_tra(Kmm)
244      !!----------------------------------------------------------------------
245      !!                   ***  ROUTINE iscpl_tra  ***
246      !!
247      !! ** Purpose :   compute new tn, sn in case of evolving geometry of ice shelves
248      !!
249      !! ** Method  :   tn, sn : basic extrapolation from neigbourg cells
250      !!
251      !!----------------------------------------------------------------------
252      INTEGER, INTENT(in) :: Kmm    ! ocean time level index
253      !!----------------------------------------------------------------------
254      REAL(wp), DIMENSION(jpi,jpj,jpk) :: ztmask_b
255      !REAL(wp), DIMENSION(:,:,:  ), INTENT(in ) :: pdepw_b                         !! depth w before
256      !!
257      INTEGER :: ji, jj, jk, jd          !! loop index
258      INTEGER :: jip1, jim1, jjp1, jjm1, jkp1, jkm1
259      !!
260      REAL(wp):: zsummsk
261      REAL(wp):: zdz, zdzm1, zdzp1
262      !!
263      REAL(wp), DIMENSION(jpi,jpj)          :: zdmask 
264      REAL(wp), DIMENSION(jpi,jpj,jpk)      :: ztmask0, zwmaskn
265      REAL(wp), DIMENSION(jpi,jpj,jpk)      :: ztmask1, zwmaskb, ztmp3d
266      REAL(wp), DIMENSION(jpi,jpj,jpk,jpts) :: zts0
267      !!----------------------------------------------------------------------
268      !
269      CALL iom_get( numror, jpdom_auto, 'tmask'  , ztmask_b, ldxios = lrxios   ) ! need to extrapolate T/S
270      !CALL iom_get( numror, jpdom_auto, 'wmask'  , zwmask_b, ldxios = lrxios   ) ! need to extrapolate T/S
271      !CALL iom_get( numror, jpdom_auto, 'gdepw_n', zdepw_b(:,:,:), ldxios = lrxios ) ! need to interpol vertical profile (vvl)
272      !
273      !
274      ! compute new T/S (interpolation) if vvl only for common wet cell in before and after wmask
275      !PM: Is this IF needed since change to VVL by default
276      !bugged : to be corrected (PM)
277      ! back up original t/s/mask
278      !tsb (:,:,:,:) = ts(:,:,:,:,Kmm)
279      !
280     ! compute new T/S (interpolation) if vvl only for common wet cell in before and after wmask
281
282!      IF (.NOT.ln_linssh) THEN
283!         DO jk = 2,jpk-1
284!            DO jj = 1,jpj
285!               DO ji = 1,jpi
286!                  IF (wmask(ji,jj,jk) * zwmaskb(ji,jj,jk) == 1._wp .AND. (tmask(ji,jj,1)==0._wp .OR. ztmask_b(ji,jj,1)==0._wp) ) THEN
287!
288!                     !compute weight
289!                     zdzp1 = MAX(0._wp,pdepw_b(ji,jj,jk+1) - gdepw(ji,jj,jk+1,Kmm))
290!                     zdzm1 = MAX(0._wp,gdepw(ji,jj,jk  ,Kmm) - pdepw_b(ji,jj,jk  ))
291!                     zdz   = e3t(ji,jj,jk,Kmm) - zdzp1 - zdzm1 ! if isf : e3t = gdepw(ji,jj,jk+1,Kmm)- gdepw(ji,jj,jk,Kmm)
292!
293!                     IF (zdz .LT. 0._wp) THEN
294!                        CALL ctl_stop( 'STOP', 'rst_iscpl : unable to compute the interpolation' )
295!                     END IF
296!
297!                     ts(ji,jj,jk,jp_tem,Kmm) = ( zdzp1*ts(ji,jj,jk+1,jp_tem,Kbb) &
298!                        &                   + zdz  *ts(ji,jj,jk  ,jp_tem,Kbb) &
299!                        &                   + zdzm1*ts(ji,jj,jk-1,jp_tem,Kbb) )/e3t(ji,jj,jk,Kmm)
300!
301!                     ts(ji,jj,jk,jp_sal,Kmm) = ( zdzp1*ts(ji,jj,jk+1,jp_sal,Kbb) &
302!                        &                   + zdz  *ts(ji,jj,jk  ,jp_sal,Kbb) &
303!                        &                   + zdzm1*ts(ji,jj,jk-1,jp_sal,Kbb) )/e3t(ji,jj,jk,Kmm)
304!
305!                  END IF
306!               END DO
307!            END DO
308!         END DO
309!      END IF
310
311      zts0(:,:,:,:)  = ts(:,:,:,:,Kmm)
312      ztmask0(:,:,:) = ztmask_b(:,:,:)
313      ztmask1(:,:,:) = ztmask_b(:,:,:)
314      !
315      ! iterate the extrapolation processes nn_drown times
316      DO jd = 1,nn_drown ! resolution dependent (OK for ISOMIP+ case)
317         DO jk = 1,jpk-1
318            !
319            ! define new wet cell
320            zdmask(:,:) = tmask(:,:,jk) - ztmask0(:,:,jk);
321            !
322            DO_2D( 0, 0, 0, 0 )
323               jip1=ji+1; jim1=ji-1;
324               jjp1=jj+1; jjm1=jj-1;
325               !
326               ! check if a wet neigbourg cell is present
327               zsummsk = ztmask0(jip1,jj  ,jk) + ztmask0(jim1,jj  ,jk) &
328                       + ztmask0(ji  ,jjp1,jk) + ztmask0(ji  ,jjm1,jk)
329               !
330               ! if neigbourg wet cell available at the same level
331               IF ( zdmask(ji,jj) == 1._wp  .AND. zsummsk /= 0._wp ) THEN
332                  !
333                  ! horizontal basic extrapolation
334                  ts(ji,jj,jk,1,Kmm)=( zts0(jip1,jj  ,jk,1) * ztmask0(jip1,jj  ,jk) &
335                  &               + zts0(jim1,jj  ,jk,1) * ztmask0(jim1,jj  ,jk) &
336                  &               + zts0(ji  ,jjp1,jk,1) * ztmask0(ji  ,jjp1,jk) &
337                  &               + zts0(ji  ,jjm1,jk,1) * ztmask0(ji  ,jjm1,jk) ) / zsummsk
338                  ts(ji,jj,jk,2,Kmm)=( zts0(jip1,jj  ,jk,2) * ztmask0(jip1,jj  ,jk) &
339                  &               + zts0(jim1,jj  ,jk,2) * ztmask0(jim1,jj  ,jk) &
340                  &               + zts0(ji  ,jjp1,jk,2) * ztmask0(ji  ,jjp1,jk) &
341                  &               + zts0(ji  ,jjm1,jk,2) * ztmask0(ji  ,jjm1,jk) ) / zsummsk
342                  !
343                  ! update mask for next pass
344                  ztmask1(ji,jj,jk)=1
345                  !
346               ! in case no neigbourg wet cell available at the same level
347               ! check if a wet cell is available below
348               ELSEIF (zdmask(ji,jj) == 1._wp .AND. zsummsk == 0._wp) THEN
349                  !
350                  ! vertical extrapolation if horizontal extrapolation failed
351                  jkm1=max(1,jk-1) ; jkp1=min(jpk,jk+1)
352                  !
353                  ! check if a wet neigbourg cell is present
354                  zsummsk = ztmask0(ji,jj,jkm1) + ztmask0(ji,jj,jkp1)
355                  IF (zdmask(ji,jj) == 1._wp .AND. zsummsk /= 0._wp ) THEN
356                     ts(ji,jj,jk,1,Kmm)=( zts0(ji,jj,jkp1,1)*ztmask0(ji,jj,jkp1)     &
357                     &               + zts0(ji,jj,jkm1,1)*ztmask0(ji,jj,jkm1)) / zsummsk
358                     ts(ji,jj,jk,2,Kmm)=( zts0(ji,jj,jkp1,2)*ztmask0(ji,jj,jkp1)     &
359                     &               + zts0(ji,jj,jkm1,2)*ztmask0(ji,jj,jkm1)) / zsummsk
360                     !
361                     ! update mask for next pass
362                     ztmask1(ji,jj,jk)=1._wp
363                  END IF
364               END IF
365            END_2D
366         END DO
367         !
368         ! update temperature and salinity and mask
369         zts0(:,:,:,:)  = ts(:,:,:,:,Kmm)
370         ztmask0(:,:,:) = ztmask1(:,:,:)
371         !
372         CALL lbc_lnk_multi( 'iscplrst', zts0(:,:,:,jp_tem), 'T', 1.0_wp, zts0(:,:,:,jp_sal), 'T', 1.0_wp, ztmask0, 'T', 1.0_wp)
373         !
374      END DO  ! nn_drown
375      !
376      ! mask new ts(:,:,:,:,Kmm) field
377      ts(:,:,:,jp_tem,Kmm) = zts0(:,:,:,jp_tem) * tmask(:,:,:)
378      ts(:,:,:,jp_sal,Kmm) = zts0(:,:,:,jp_sal) * tmask(:,:,:)
379      !
380      ! sanity check
381      ! -----------------------------------------------------------------------------------------
382      ! case we open a cell but no neigbour cells available to get an estimate of T and S
383      DO_3D( 1, 1, 1, 1, 1,jpk-1 )
384         IF (tmask(ji,jj,jk) == 1._wp .AND. ts(ji,jj,jk,2,Kmm) == 0._wp)              &
385            &   CALL ctl_stop('STOP', 'failing to fill all new weet cell,     &
386            &                          try increase nn_drown or activate XXXX &
387            &                         in your domain cfg computation'         )
388      END_3D
389      !
390   END SUBROUTINE isfcpl_tra
391   
392
393   SUBROUTINE isfcpl_vol(Kmm)
394      !!----------------------------------------------------------------------
395      !!                   ***  ROUTINE iscpl_vol  ***
396      !!
397      !! ** Purpose : compute the correction of the local divergence to apply 
398      !!              during the first time step after the coupling.
399      !!
400      !! ** Method  : - compute horizontal vol div. before/after coupling
401      !!              - compute vertical input
402      !!              - compute correction
403      !!               
404      !!----------------------------------------------------------------------
405      !!
406      INTEGER, INTENT(in) :: Kmm    ! ocean time level index
407      !!----------------------------------------------------------------------
408      INTEGER :: ji, jj, jk 
409      INTEGER :: ikb, ikt
410      !!
411      REAL(wp), DIMENSION(jpi,jpj,jpk) :: zqvolb, zqvoln  ! vol flux div.         before/after coupling
412      REAL(wp), DIMENSION(jpi,jpj,jpk) :: ze3u_b, ze3v_b  ! vertical scale factor before/after coupling
413      REAL(wp), DIMENSION(jpi,jpj,jpk) :: ztmask_b        ! mask                  before       coupling
414      !!----------------------------------------------------------------------
415      !
416      CALL iom_get( numror, jpdom_auto, 'tmask'  , ztmask_b, ldxios = lrxios )
417      CALL iom_get( numror, jpdom_auto, 'e3u_n'  , ze3u_b  , ldxios = lrxios )
418      CALL iom_get( numror, jpdom_auto, 'e3v_n'  , ze3v_b  , ldxios = lrxios )
419      !
420      ! 1.0: compute horizontal volume flux divergence difference before-after coupling
421      !
422      DO jk = 1, jpk                                 ! Horizontal slab
423         ! 1.1: get volume flux before coupling (>0 out)
424         DO_2D( 0, 0, 0, 0 )
425            zqvolb(ji,jj,jk) =    &
426               &  (   e2u(ji  ,jj  ) * ze3u_b(ji  ,jj  ,jk) * uu(ji  ,jj  ,jk,Kmm)      &
427               &    - e2u(ji-1,jj  ) * ze3u_b(ji-1,jj  ,jk) * uu(ji-1,jj  ,jk,Kmm)      &
428               &    + e1v(ji  ,jj  ) * ze3v_b(ji  ,jj  ,jk) * vv(ji  ,jj  ,jk,Kmm)      &
429               &    - e1v(ji  ,jj-1) * ze3v_b(ji  ,jj-1,jk) * vv(ji  ,jj-1,jk,Kmm)  )   &
430               &                * ztmask_b(ji,jj,jk)
431         END_2D
432         !
433         ! 1.2: get volume flux after coupling (>0 out)
434         ! properly mask velocity
435         ! (velocity are still mask with old mask at this stage)
436         uu(:,:,jk,Kmm) = uu(:,:,jk,Kmm) * umask(:,:,jk)
437         vv(:,:,jk,Kmm) = vv(:,:,jk,Kmm) * vmask(:,:,jk)
438         ! compute volume flux divergence after coupling
439         DO_2D( 0, 0, 0, 0 )
440            zqvoln(ji,jj,jk) =   &
441               &  (   e2u(ji  ,jj  ) * e3u(ji  ,jj  ,jk,Kmm) * uu(ji  ,jj  ,jk,Kmm)    &
442               &    - e2u(ji-1,jj  ) * e3u(ji-1,jj  ,jk,Kmm) * uu(ji-1,jj  ,jk,Kmm)    &
443               &    + e1v(ji  ,jj  ) * e3v(ji  ,jj  ,jk,Kmm) * vv(ji  ,jj  ,jk,Kmm)    &
444               &    - e1v(ji  ,jj-1) * e3v(ji  ,jj-1,jk,Kmm) * vv(ji  ,jj-1,jk,Kmm)  ) &
445               &               * tmask(ji,jj,jk)
446         END_2D
447         !
448         ! 1.3: get 3d volume flux difference (before - after cpl) (>0 out)
449         !      correction to add is _b - _n
450         risfcpl_vol(:,:,jk) = zqvolb(:,:,jk) - zqvoln(:,:,jk)
451      END DO
452      !
453      ! 2.0: include the contribution of the vertical velocity in the volume flux correction
454      !
455      DO_2D( 0, 0, 0, 0 )
456         !
457         ikt = mikt(ji,jj)
458         IF ( ikt > 1 .AND. ssmask(ji,jj) == 1 ) THEN
459            risfcpl_vol(ji,jj,ikt) = risfcpl_vol(ji,jj,ikt) + SUM(zqvolb(ji,jj,1:ikt-1))  ! test sign
460         ENDIF
461         !
462      END_2D
463      !
464      CALL lbc_lnk( 'iscpl', risfcpl_vol, 'T', 1.0_wp )
465      !
466      ! 3.0: set total correction (div, tr(:,:,:,:,Krhs), ssh)
467      !
468      ! 3.1: mask volume flux divergence correction
469      risfcpl_vol(:,:,:) = risfcpl_vol(:,:,:) * tmask(:,:,:)
470      !
471      ! 3.2: get 3d tr(:,:,:,:,Krhs) increment to apply at the first time step
472      ! temperature and salt content flux computed using local ts(:,:,:,:,Kmm)
473      ! (very simple advection scheme)
474      ! (>0 out)
475      risfcpl_tsc(:,:,:,jp_tem) = -risfcpl_vol(:,:,:) * ts(:,:,:,jp_tem,Kmm)
476      risfcpl_tsc(:,:,:,jp_sal) = -risfcpl_vol(:,:,:) * ts(:,:,:,jp_sal,Kmm)
477      !
478      ! 3.3: ssh correction (for dynspg_ts)
479      risfcpl_ssh(:,:) = 0.0
480      DO jk = 1,jpk
481         risfcpl_ssh(:,:) = risfcpl_ssh(:,:) + risfcpl_vol(:,:,jk) * r1_e1e2t(:,:)
482      END DO
483      !
484   END SUBROUTINE isfcpl_vol
485
486   
487   SUBROUTINE isfcpl_cons(Kmm)
488      !!----------------------------------------------------------------------
489      !!                   ***  ROUTINE iscpl_cons  ***
490      !!
491      !! ** Purpose :   compute the corrective increment in volume/salt/heat to put back the vol/heat/salt
492      !!                removed or added during the coupling processes (wet or dry new cell)
493      !!
494      !! ** Method  :   - compare volume/heat/salt before and after
495      !!                - look for the closest wet cells (share amoung neigbourgs if there are)
496      !!                - build the correction increment to applied at each time step
497      !!               
498      !!----------------------------------------------------------------------
499      !
500      TYPE(isfcons), DIMENSION(:),ALLOCATABLE :: zisfpts ! list of point receiving a correction
501      !
502      !!----------------------------------------------------------------------
503      INTEGER, INTENT(in) :: Kmm    ! ocean time level index
504      !!----------------------------------------------------------------------
505      INTEGER  ::   ji   , jj  , jk  , jproc          ! loop index
506      INTEGER  ::   jip1 , jim1, jjp1, jjm1           ! dummy indices
507      INTEGER  ::   iig  , ijg, ik                    ! dummy indices
508      INTEGER  ::   jisf                              ! start, end and current position in the increment array
509      INTEGER  ::   ingb, ifind                       ! 0/1 target found or need to be found
510      INTEGER  ::   nisfl_area                        ! global number of cell concerned by the wet->dry case
511      INTEGER, DIMENSION(jpnij) :: nisfl              ! local  number of cell concerned by the wet->dry case
512      !
513      REAL(wp) ::   z1_sum, z1_rdtiscpl
514      REAL(wp) ::   zdtem, zdsal, zdvol, zratio       ! tem, sal, vol increment
515      REAL(wp) ::   zlon , zlat                       ! target location 
516      REAL(wp), DIMENSION(jpi,jpj,jpk) :: ztmask_b    ! mask before
517      REAL(wp), DIMENSION(jpi,jpj,jpk) :: ze3t_b      ! scale factor before
518      REAL(wp), DIMENSION(jpi,jpj,jpk) :: zt_b      ! scale factor before
519      REAL(wp), DIMENSION(jpi,jpj,jpk) :: zs_b      ! scale factor before
520      !!----------------------------------------------------------------------
521
522      !==============================================================================
523      ! 1.0: initialisation
524      !==============================================================================
525
526      ! get restart variable
527      CALL iom_get( numror, jpdom_auto, 'tmask'  , ztmask_b(:,:,:), ldxios = lrxios   ) ! need to extrapolate T/S
528      CALL iom_get( numror, jpdom_auto, 'e3t_n'  , ze3t_b(:,:,:)  , ldxios = lrxios )
529      CALL iom_get( numror, jpdom_auto, 'tn'     , zt_b(:,:,:)    , ldxios = lrxios )
530      CALL iom_get( numror, jpdom_auto, 'sn'     , zs_b(:,:,:)    , ldxios = lrxios )
531
532      ! compute run length
533      nstp_iscpl  = nitend - nit000 + 1
534      rdt_iscpl   = nstp_iscpl * rn_Dt
535      z1_rdtiscpl = 1._wp / rdt_iscpl 
536
537      IF (lwp) WRITE(numout,*) '            nb of stp for cons  = ', nstp_iscpl
538      IF (lwp) WRITE(numout,*) '            coupling time step  = ', rdt_iscpl
539
540      ! initialisation correction
541      risfcpl_cons_vol = 0.0
542      risfcpl_cons_ssh = 0.0
543      risfcpl_cons_tsc = 0.0
544
545      !==============================================================================
546      ! 2.0: diagnose the heat, salt and volume input and compute the correction variable
547      !      for case where we wet a cell or cell still wet (no change in cell status)
548      !==============================================================================
549
550      DO jk = 1,jpk-1
551         DO jj = Njs0,Nje0
552            DO ji = Nis0,Nie0
553
554               ! volume diff
555               zdvol =   e3t  (ji,jj,jk,Kmm) *  tmask  (ji,jj,jk)   &
556                  &   - ze3t_b(ji,jj,jk    ) * ztmask_b(ji,jj,jk)
557
558               ! heat diff
559               zdtem = ts (ji,jj,jk,jp_tem,Kmm) *  e3t(ji,jj,jk,Kmm) *  tmask  (ji,jj,jk)   &
560                     - zt_b(ji,jj,jk)        * ze3t_b(ji,jj,jk) * ztmask_b(ji,jj,jk)
561
562               ! salt diff
563               zdsal = ts(ji,jj,jk,jp_sal,Kmm) *  e3t(ji,jj,jk,Kmm) *  tmask  (ji,jj,jk)   &
564                     - zs_b(ji,jj,jk)       * ze3t_b(ji,jj,jk) * ztmask_b(ji,jj,jk)
565           
566               ! volume, heat and salt differences in each cell (>0 means correction is an outward flux)
567               ! in addition to the geometry change unconservation, need to add the divergence correction as it is flux across the boundary
568               risfcpl_cons_vol(ji,jj,jk)        = (   zdvol * e1e2t(ji,jj) + risfcpl_vol(ji,jj,jk)        ) * z1_rdtiscpl
569               risfcpl_cons_tsc(ji,jj,jk,jp_sal) = ( - zdsal * e1e2t(ji,jj) + risfcpl_tsc(ji,jj,jk,jp_sal) ) * z1_rdtiscpl
570               risfcpl_cons_tsc(ji,jj,jk,jp_tem) = ( - zdtem * e1e2t(ji,jj) + risfcpl_tsc(ji,jj,jk,jp_tem) ) * z1_rdtiscpl
571
572            END DO
573         END DO
574      END DO
575      !
576      !==============================================================================
577      ! 3.0: diagnose the heat, salt and volume input and compute the correction variable
578      !      for case where we close a cell
579      !==============================================================================
580      !
581      ! compute the total number of point receiving a correction increment for each processor
582      ! local
583      nisfl(:)=0
584      DO jk = 1,jpk-1
585         DO jj = Njs0,Nje0
586            DO ji = Nis0,Nie0
587               jip1=MIN(ji+1,jpi) ; jim1=MAX(ji-1,1) ; jjp1=MIN(jj+1,jpj) ; jjm1=MAX(jj-1,1) ;
588               IF ( tmask(ji,jj,jk) == 0._wp .AND. ztmask_b(ji,jj,jk) == 1._wp ) THEN
589                  nisfl(narea) = nisfl(narea) + MAX(SUM(tmask(jim1:jip1,jjm1:jjp1,jk)),1._wp)
590               ENDIF
591            ENDDO
592         ENDDO
593      ENDDO
594      !
595      ! global
596      CALL mpp_sum('isfcpl',nisfl  )
597      !
598      ! allocate list of point receiving correction
599      ALLOCATE(zisfpts(nisfl(narea)))
600      !
601      zisfpts(:) = isfcons(0,0,0,-HUGE(1.0), -HUGE(1.0), -HUGE(1.0), -HUGE(1.0), -HUGE(1.0), 0)
602      !
603      ! start computing the correction and fill zisfpts
604      ! local
605      jisf = 0
606      DO jk = 1,jpk-1
607         DO jj = Njs0,Nje0
608            DO ji = Nis0,Nie0
609               IF ( tmask(ji,jj,jk) == 0._wp .AND. ztmask_b(ji,jj,jk) == 1._wp ) THEN
610
611                  jip1=MIN(ji+1,jpi) ; jim1=MAX(ji-1,1) ; jjp1=MIN(jj+1,jpj) ; jjm1=MAX(jj-1,1) ;
612
613                  zdvol = risfcpl_cons_vol(ji,jj,jk       )
614                  zdsal = risfcpl_cons_tsc(ji,jj,jk,jp_sal)
615                  zdtem = risfcpl_cons_tsc(ji,jj,jk,jp_tem)
616
617                  IF ( SUM( tmask(jim1:jip1,jjm1:jjp1,jk) ) > 0._wp ) THEN
618                     ! spread correction amoung neigbourg wet cells (horizontal direction first)
619                     ! as it is a rude correction corner and lateral cell have the same weight
620                     !
621                     z1_sum =  1._wp / SUM( tmask(jim1:jip1,jjm1:jjp1,jk) )
622                     !
623                     ! lateral cells
624                     IF (tmask(jip1,jj  ,jk) == 1) CALL update_isfpts(zisfpts, jisf, jip1, jj  , jk, zdvol, zdsal, zdtem, z1_sum)
625                     IF (tmask(jim1,jj  ,jk) == 1) CALL update_isfpts(zisfpts, jisf, jim1, jj  , jk, zdvol, zdsal, zdtem, z1_sum)
626                     IF (tmask(ji  ,jjp1,jk) == 1) CALL update_isfpts(zisfpts, jisf, ji  , jjp1, jk, zdvol, zdsal, zdtem, z1_sum)
627                     IF (tmask(ji  ,jjm1,jk) == 1) CALL update_isfpts(zisfpts, jisf, ji  , jjm1, jk, zdvol, zdsal, zdtem, z1_sum)
628                     !
629                     ! corner  cells
630                     IF (tmask(jip1,jjm1,jk) == 1) CALL update_isfpts(zisfpts, jisf, jip1, jjm1, jk, zdvol, zdsal, zdtem, z1_sum)
631                     IF (tmask(jim1,jjm1,jk) == 1) CALL update_isfpts(zisfpts, jisf, jim1, jjm1, jk, zdvol, zdsal, zdtem, z1_sum)
632                     IF (tmask(jim1,jjp1,jk) == 1) CALL update_isfpts(zisfpts, jisf, jim1, jjp1, jk, zdvol, zdsal, zdtem, z1_sum)
633                     IF (tmask(jip1,jjp1,jk) == 1) CALL update_isfpts(zisfpts, jisf, jip1, jjp1, jk, zdvol, zdsal, zdtem, z1_sum)
634                     !
635                  ELSE IF ( tmask(ji,jj,jk+1) == 1._wp ) THEN
636                     ! spread correction amoung neigbourg wet cells (vertical direction)
637                     CALL update_isfpts(zisfpts, jisf, ji  , jj  , jk+1, zdvol, zdsal, zdtem, 1.0_wp, 0)
638                  ELSE
639                     ! need to find where to put correction in later on
640                     CALL update_isfpts(zisfpts, jisf, ji  , jj  , jk  , zdvol, zdsal, zdtem, 1.0_wp, 1)
641                  END IF
642               END IF
643            END DO
644         END DO
645      END DO
646      !
647      ! share data among all processes because for some point we need to find the closest wet point (could be on other process)
648      DO jproc=1,jpnij
649         !
650         ! share total number of isf point treated for proc jproc
651         IF (jproc==narea) THEN
652            nisfl_area=nisfl(jproc)
653         ELSE
654            nisfl_area=0
655         END IF
656         CALL mpp_max('isfcpl',nisfl_area)
657         !
658         DO jisf = 1,nisfl_area
659            !
660            IF (jproc==narea) THEN
661               ! indices (conversion to global indices and sharing)
662               iig = zisfpts(jisf)%ii       ; ijg = zisfpts(jisf)%jj       ; ik = zisfpts(jisf)%kk
663               !
664               ! data
665               zdvol = zisfpts(jisf)%dvol   ; zdsal = zisfpts(jisf)%dsal   ; zdtem = zisfpts(jisf)%dtem
666               !
667               ! location
668               zlat = zisfpts(jisf)%lat     ; zlon = zisfpts(jisf)%lon
669               !
670               ! find flag
671               ingb = zisfpts(jisf)%ngb
672            ELSE
673               iig  =0   ; ijg  =0   ; ik   =0 
674               zdvol=-HUGE(1.0) ; zdsal=-HUGE(1.0) ; zdtem=-HUGE(1.0)
675               zlat =-HUGE(1.0) ; zlon =-HUGE(1.0)   
676               ingb = 0
677            END IF
678            !
679            ! share data (need synchronisation of data as get_correction call a global com)
680            CALL mpp_max('isfcpl',iig)   ; CALL mpp_max('isfcpl',ijg)   ; CALL mpp_max('isfcpl',ik)
681            CALL mpp_max('isfcpl',zdvol) ; CALL mpp_max('isfcpl',zdsal) ; CALL mpp_max('isfcpl',zdtem)
682            CALL mpp_max('isfcpl',zlat)  ; CALL mpp_max('isfcpl',zlon)
683            CALL mpp_max('isfcpl',ingb)
684            !
685            ! fill the 3d correction array
686            CALL get_correction(iig, ijg, ik, zlon, zlat, zdvol, zdsal, zdtem, ingb)
687         END DO
688      END DO
689      !
690      !==============================================================================
691      ! 4.0: finalisation and compute ssh equivalent of the volume correction
692      !==============================================================================
693      !
694      ! mask (>0 out)
695      risfcpl_cons_vol(:,:,:       ) = risfcpl_cons_vol(:,:,:       ) * tmask(:,:,:)
696      risfcpl_cons_tsc(:,:,:,jp_sal) = risfcpl_cons_tsc(:,:,:,jp_sal) * tmask(:,:,:)
697      risfcpl_cons_tsc(:,:,:,jp_tem) = risfcpl_cons_tsc(:,:,:,jp_tem) * tmask(:,:,:)
698      !
699      ! add lbclnk
700      CALL lbc_lnk_multi( 'iscplrst', risfcpl_cons_tsc(:,:,:,jp_tem), 'T', 1.0_wp, risfcpl_cons_tsc(:,:,:,jp_sal), 'T', 1.0_wp, &
701         &                            risfcpl_cons_vol(:,:,:)       , 'T', 1.0_wp)
702      !
703      ! ssh correction (for dynspg_ts)
704      DO jk = 1,jpk
705         risfcpl_cons_ssh(:,:) = risfcpl_cons_ssh(:,:) + risfcpl_cons_vol(:,:,jk)
706      END DO
707      risfcpl_cons_ssh(:,:) = risfcpl_cons_ssh(:,:) * r1_e1e2t(:,:)
708      !
709   END SUBROUTINE isfcpl_cons
710   !
711   SUBROUTINE update_isfpts(sisfpts, kpts, ki, kj, kk, pdvol, pdsal, pdtem, pratio, kfind)
712      !!---------------------------------------------------------------------
713      !!                  ***  ROUTINE update_isfpts  ***
714      !!
715      !! ** Purpose : if a cell become dry, we need to put the corrective increment elsewhere
716      !!
717      !! ** Action  : update the list of point
718      !!
719      !!----------------------------------------------------------------------
720      !!----------------------------------------------------------------------
721      TYPE(isfcons), DIMENSION(:), INTENT(inout) :: sisfpts
722      INTEGER,                     INTENT(inout) :: kpts
723      !!----------------------------------------------------------------------
724      INTEGER,      INTENT(in   )           :: ki, kj, kk                  !    target location (kfind=0)
725      !                                                                    ! or source location (kfind=1)
726      INTEGER,      INTENT(in   ), OPTIONAL :: kfind                       ! 0  target cell already found
727      !                                                                    ! 1  target to be determined
728      REAL(wp),     INTENT(in   )           :: pdvol, pdsal, pdtem, pratio ! vol/sal/tem increment
729      !                                                                    ! and ratio in case increment span over multiple cells.
730      !!----------------------------------------------------------------------
731      INTEGER :: ifind
732      !!----------------------------------------------------------------------
733      !
734      ! increment position
735      kpts = kpts + 1
736      !
737      ! define if we need to look for closest valid wet cell (no neighbours or neigbourg on halo)
738      IF ( PRESENT(kfind) ) THEN
739         ifind = kfind
740      ELSE
741         ifind = ( 1 - tmask_h(ki,kj) ) * tmask(ki,kj,kk)
742      END IF
743      !
744      ! update isfpts structure
745      sisfpts(kpts) = isfcons(mig(ki), mjg(kj), kk, pratio * pdvol, pratio * pdsal, pratio * pdtem, glamt(ki,kj), gphit(ki,kj), ifind )
746      !
747   END SUBROUTINE update_isfpts
748   !
749   SUBROUTINE get_correction( ki, kj, kk, plon, plat, pvolinc, psalinc, pteminc, kfind)
750      !!---------------------------------------------------------------------
751      !!                  ***  ROUTINE get_correction  ***
752      !!
753      !! ** Action : - Find the closest valid cell if needed (wet and not on the halo)
754      !!             - Scale the correction depending of pratio (case where multiple wet neigbourgs)
755      !!             - Fill the correction array
756      !!
757      !!----------------------------------------------------------------------
758      INTEGER , INTENT(in) :: ki, kj, kk, kfind        ! target point indices
759      REAL(wp), INTENT(in) :: plon, plat               ! target point lon/lat
760      REAL(wp), INTENT(in) :: pvolinc, pteminc,psalinc ! correction increment for vol/temp/salt
761      !!----------------------------------------------------------------------
762      INTEGER :: jj, ji, iig, ijg
763      !!----------------------------------------------------------------------
764      !
765      ! define global indice of correction location
766      iig = ki ; ijg = kj
767      IF ( kfind == 1 ) CALL dom_ngb( plon, plat, iig, ijg,'T', kk)
768      !
769      ! fill the correction array
770      DO jj = mj0(ijg),mj1(ijg)
771         DO ji = mi0(iig),mi1(iig)
772            ! correct the vol_flx and corresponding heat/salt flx in the closest cell
773            risfcpl_cons_vol(ji,jj,kk)        =  risfcpl_cons_vol(ji,jj,kk       ) + pvolinc
774            risfcpl_cons_tsc(ji,jj,kk,jp_sal) =  risfcpl_cons_tsc(ji,jj,kk,jp_sal) + psalinc
775            risfcpl_cons_tsc(ji,jj,kk,jp_tem) =  risfcpl_cons_tsc(ji,jj,kk,jp_tem) + pteminc
776         END DO
777      END DO
778
779   END SUBROUTINE get_correction
780
781END MODULE isfcpl
Note: See TracBrowser for help on using the repository browser.