Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
MODULE isfcpl
!!======================================================================
!! *** MODULE isfcpl ***
!!
!! iceshelf coupling module : module managing the coupling between NEMO and an ice sheet model
!!
!!======================================================================
!! History : 4.1 ! 2019-07 (P. Mathiot) Original code
!!----------------------------------------------------------------------
!!----------------------------------------------------------------------
!! isfrst : read/write iceshelf variables in/from restart
!!----------------------------------------------------------------------
USE oce ! ocean dynamics and tracers
#if defined key_qco
USE domqco , ONLY : dom_qco_zgr ! vertical scale factor interpolation
#elif defined key_linssh
! ! fix in time coordinate
#else
USE domvvl , ONLY : dom_vvl_zgr ! vertical scale factor interpolation
#endif
USE domutl , ONLY : dom_ngb ! find the closest grid point from a given lon/lat position
USE isf_oce ! ice shelf variable
USE isfutils, ONLY : debug
!
USE in_out_manager ! I/O manager
USE iom ! I/O library
USE lib_mpp , ONLY : mpp_sum, mpp_max ! mpp routine
!
IMPLICIT NONE
PRIVATE
PUBLIC isfcpl_rst_write, isfcpl_init ! iceshelf restart read and write
PUBLIC isfcpl_ssh, isfcpl_tra, isfcpl_vol, isfcpl_cons ! iceshelf correction for ssh, tra, dyn and conservation
TYPE isfcons
INTEGER :: ii ! i global
INTEGER :: jj ! j global
INTEGER :: kk ! k level
REAL(wp):: dvol ! volume increment
REAL(wp):: dsal ! salt increment
REAL(wp):: dtem ! heat increment
REAL(wp):: lon ! lon
REAL(wp):: lat ! lat
INTEGER :: ngb ! 0/1 (valid location or not (ie on halo or no neigbourg))
END TYPE
!
!! * Substitutions
# include "do_loop_substitute.h90"
sparonuz
committed
# include "single_precision_substitute.h90"
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
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
202
203
# include "domzgr_substitute.h90"
!!----------------------------------------------------------------------
!! NEMO/OCE 4.0 , NEMO Consortium (2018)
!! $Id: sbcisf.F90 10536 2019-01-16 19:21:09Z mathiot $
!! Software governed by the CeCILL license (see ./LICENSE)
!!----------------------------------------------------------------------
CONTAINS
SUBROUTINE isfcpl_init(Kbb, Kmm, Kaa)
!!---------------------------------------------------------------------
!! *** ROUTINE iscpl_init ***
!!
!! ** Purpose : correct ocean state for new wet cell and horizontal divergence
!! correction for the dynamical adjustement
!!
!! ** Action : - compute ssh on new wet cell
!! - compute T/S on new wet cell
!! - compute horizontal divergence correction as a volume flux
!! - compute the T/S/vol correction increment to keep trend to 0
!!
!!---------------------------------------------------------------------
INTEGER, INTENT(in) :: Kbb, Kmm, Kaa ! ocean time level indices
!!---------------------------------------------------------------------
INTEGER :: id
!!----------------------------------------------------------------------
!
! start on an euler time step
l_1st_euler = .TRUE.
!
! allocation and initialisation to 0
CALL isf_alloc_cpl()
!
! check presence of variable needed for coupling
! iom_varid return 0 if not found
id = 1
id = id * iom_varid(numror, 'ssmask', ldstop = .false.)
id = id * iom_varid(numror, 'tmask' , ldstop = .false.)
id = id * iom_varid(numror, 'e3t_n' , ldstop = .false.)
id = id * iom_varid(numror, 'e3u_n' , ldstop = .false.)
id = id * iom_varid(numror, 'e3v_n' , ldstop = .false.)
IF(lwp) WRITE(numout,*) ' isfcpl_init:', id
IF (id == 0) THEN
IF(lwp) WRITE(numout,*) ' isfcpl_init: restart variables for ice sheet coupling are missing, skip coupling for this leg '
IF(lwp) WRITE(numout,*) ' ~~~~~~~~~~~'
IF(lwp) WRITE(numout,*) ''
ELSE
! extrapolation ssh
CALL isfcpl_ssh(Kbb, Kmm, Kaa)
!
! extrapolation tracer properties
CALL isfcpl_tra(Kmm)
!
! correction of the horizontal divergence and associated temp. and salt content flux
! Need to : - include in the cpl cons the risfcpl_vol/tsc contribution
! - decide how to manage thickness level change in conservation
CALL isfcpl_vol(Kmm)
!
! apply the 'conservation' method
IF ( ln_isfcpl_cons ) CALL isfcpl_cons(Kmm)
!
END IF
!
! mask velocity properly (mask used in restart not compatible with new mask)
uu(:,:,:,Kmm) = uu(:,:,:,Kmm) * umask(:,:,:)
vv(:,:,:,Kmm) = vv(:,:,:,Kmm) * vmask(:,:,:)
!
! all before fields set to now values
ts (:,:,:,:,Kbb) = ts (:,:,:,:,Kmm)
uu (:,:,:,Kbb) = uu (:,:,:,Kmm)
vv (:,:,:,Kbb) = vv (:,:,:,Kmm)
ssh (:,:,Kbb) = ssh (:,:,Kmm)
#if ! defined key_qco && ! defined key_linssh
e3t(:,:,:,Kbb) = e3t(:,:,:,Kmm)
#endif
END SUBROUTINE isfcpl_init
SUBROUTINE isfcpl_rst_write( kt, Kmm )
!!---------------------------------------------------------------------
!! *** ROUTINE iscpl_rst_write ***
!!
!! ** Purpose : write icesheet coupling variables in restart
!!
!!-------------------------- IN --------------------------------------
INTEGER, INTENT(in) :: kt
INTEGER, INTENT(in) :: Kmm ! ocean time level index
!!----------------------------------------------------------------------
INTEGER :: jk ! loop index
REAL(wp), DIMENSION(jpi,jpj,jpk) :: ze3t, ze3u, ze3v, zgdepw ! for qco substitution
!!----------------------------------------------------------------------
!
DO jk = 1, jpk
ze3t(:,:,jk) = e3t(:,:,jk,Kmm)
ze3u(:,:,jk) = e3u(:,:,jk,Kmm)
ze3v(:,:,jk) = e3v(:,:,jk,Kmm)
!
zgdepw(:,:,jk) = gdepw(:,:,jk,Kmm)
END DO
!
CALL iom_rstput( kt, nitrst, numrow, 'tmask' , tmask )
CALL iom_rstput( kt, nitrst, numrow, 'ssmask' , ssmask )
CALL iom_rstput( kt, nitrst, numrow, 'e3t_n' , ze3t )
CALL iom_rstput( kt, nitrst, numrow, 'e3u_n' , ze3u )
CALL iom_rstput( kt, nitrst, numrow, 'e3v_n' , ze3v )
CALL iom_rstput( kt, nitrst, numrow, 'gdepw_n', zgdepw )
!
END SUBROUTINE isfcpl_rst_write
SUBROUTINE isfcpl_ssh(Kbb, Kmm, Kaa)
!!----------------------------------------------------------------------
!! *** ROUTINE iscpl_ssh ***
!!
!! ** Purpose : basic guess of ssh in new wet cell
!!
!! ** Method : basic extrapolation from neigbourg cells
!!
!!----------------------------------------------------------------------
!!
INTEGER, INTENT(in) :: Kbb, Kmm, Kaa ! ocean time level indices
!!----------------------------------------------------------------------
INTEGER :: ji, jj, jd, jk !! loop index
INTEGER :: jip1, jim1, jjp1, jjm1
!!
REAL(wp):: zsummsk
REAL(wp), DIMENSION(jpi,jpj) :: zdssmask, zssmask0, zssmask_b, zssh
!!----------------------------------------------------------------------
!
CALL iom_get( numror, jpdom_auto, 'ssmask' , zssmask_b ) ! need to extrapolate T/S
! compute new ssh if we open a full water column
! rude average of the closest neigbourgs (e1e2t not taking into account)
!
zssh(:,:) = ssh(:,:,Kmm)
zssmask0(:,:) = zssmask_b(:,:)
!
DO jd = 1, nn_drown
!
zdssmask(:,:) = ssmask(:,:) - zssmask0(:,:)
DO_2D( 0, 0, 0, 0 )
jip1=ji+1 ; jim1=ji-1
jjp1=jj+1 ; jjm1=jj-1
!
zsummsk = zssmask0(jip1,jj) + zssmask0(jim1,jj) + zssmask0(ji,jjp1) + zssmask0(ji,jjm1)
!
IF (zdssmask(ji,jj) == 1._wp .AND. zsummsk /= 0._wp) THEN
ssh(ji,jj,Kmm)=( zssh(jip1,jj)*zssmask0(jip1,jj) &
& + zssh(jim1,jj)*zssmask0(jim1,jj) &
& + zssh(ji,jjp1)*zssmask0(ji,jjp1) &
& + zssh(ji,jjm1)*zssmask0(ji,jjm1)) / zsummsk
zssmask_b(ji,jj) = 1._wp
ENDIF
END_2D
sparonuz
committed
CALL lbc_lnk( 'isfcpl', ssh(:,:,Kmm), 'T', 1.0_dp)
CALL lbc_lnk( 'isfcpl', zssmask_b(:,:), 'T', 1.0_wp )
!
zssh(:,:) = ssh(:,:,Kmm)
zssmask0(:,:) = zssmask_b(:,:)
!
!
END DO
!
! update ssh(:,:,Kmm)
ssh(:,:,Kmm) = zssh(:,:) * ssmask(:,:)
!
ssh(:,:,Kbb) = ssh(:,:,Kmm)
!
sparonuz
committed
IF ( ln_isfdebug ) CALL debug('isfcpl_ssh: sshn',CASTSP(ssh(:,:,Kmm)))
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
!
! recompute the vertical scale factor, depth and water thickness
IF(lwp) write(numout,*) 'isfcpl_ssh : recompute scale factor from ssh (new wet cell,Kmm)'
IF(lwp) write(numout,*) '~~~~~~~~~~~'
#if defined key_qco
CALL dom_qco_zgr(Kbb, Kmm)
#elif defined key_linssh
! linear ssh : fix in time coord.
#else
DO jk = 1, jpk
e3t(:,:,jk,Kmm) = e3t_0(:,:,jk) * ( 1._wp + (ht_0(:,:) + ssh(:,:,Kmm)) * r1_ht_0(:,:) )
END DO
e3t(:,:,:,Kbb) = e3t(:,:,:,Kmm)
CALL dom_vvl_zgr(Kbb, Kmm, Kaa)
#endif
!
END SUBROUTINE isfcpl_ssh
SUBROUTINE isfcpl_tra(Kmm)
!!----------------------------------------------------------------------
!! *** ROUTINE iscpl_tra ***
!!
!! ** Purpose : compute new tn, sn in case of evolving geometry of ice shelves
!!
!! ** Method : tn, sn : basic extrapolation from neigbourg cells
!!
!!----------------------------------------------------------------------
INTEGER, INTENT(in) :: Kmm ! ocean time level index
!!----------------------------------------------------------------------
REAL(wp), DIMENSION(jpi,jpj,jpk) :: ztmask_b
!REAL(wp), DIMENSION(:,:,: ), INTENT(in ) :: pdepw_b !! depth w before
!!
INTEGER :: ji, jj, jk, jd !! loop index
INTEGER :: jip1, jim1, jjp1, jjm1, jkp1, jkm1
!!
REAL(wp):: zsummsk
REAL(wp):: zdz, zdzm1, zdzp1
!!
REAL(wp), DIMENSION(jpi,jpj) :: zdmask
REAL(wp), DIMENSION(jpi,jpj,jpk) :: ztmask0, zwmaskn
REAL(wp), DIMENSION(jpi,jpj,jpk) :: ztmask1, zwmaskb, ztmp3d
REAL(wp), DIMENSION(jpi,jpj,jpk,jpts) :: zts0
!!----------------------------------------------------------------------
!
CALL iom_get( numror, jpdom_auto, 'tmask' , ztmask_b ) ! need to extrapolate T/S
!CALL iom_get( numror, jpdom_auto, 'wmask' , zwmask_b ) ! need to extrapolate T/S
!CALL iom_get( numror, jpdom_auto, 'gdepw_n', zdepw_b(:,:,:) ) ! need to interpol vertical profile (vvl)
!
!
! compute new T/S (interpolation) if vvl only for common wet cell in before and after wmask
!PM: Is this IF needed since change to VVL by default
!bugged : to be corrected (PM)
! back up original t/s/mask
!tsb (:,:,:,:) = ts(:,:,:,:,Kmm)
!
! compute new T/S (interpolation) if vvl only for common wet cell in before and after wmask
! IF (.NOT.ln_linssh) THEN
! DO jk = 2,jpk-1
! DO jj = 1,jpj
! DO ji = 1,jpi
! 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
!
! !compute weight
! zdzp1 = MAX(0._wp,pdepw_b(ji,jj,jk+1) - gdepw(ji,jj,jk+1,Kmm))
! zdzm1 = MAX(0._wp,gdepw(ji,jj,jk ,Kmm) - pdepw_b(ji,jj,jk ))
! zdz = e3t(ji,jj,jk,Kmm) - zdzp1 - zdzm1 ! if isf : e3t = gdepw(ji,jj,jk+1,Kmm)- gdepw(ji,jj,jk,Kmm)
!
! IF (zdz .LT. 0._wp) THEN
! CALL ctl_stop( 'STOP', 'rst_iscpl : unable to compute the interpolation' )
! END IF
!
! ts(ji,jj,jk,jp_tem,Kmm) = ( zdzp1*ts(ji,jj,jk+1,jp_tem,Kbb) &
! & + zdz *ts(ji,jj,jk ,jp_tem,Kbb) &
! & + zdzm1*ts(ji,jj,jk-1,jp_tem,Kbb) )/e3t(ji,jj,jk,Kmm)
!
! ts(ji,jj,jk,jp_sal,Kmm) = ( zdzp1*ts(ji,jj,jk+1,jp_sal,Kbb) &
! & + zdz *ts(ji,jj,jk ,jp_sal,Kbb) &
! & + zdzm1*ts(ji,jj,jk-1,jp_sal,Kbb) )/e3t(ji,jj,jk,Kmm)
!
! END IF
! END DO
! END DO
! END DO
! END IF
zts0(:,:,:,:) = ts(:,:,:,:,Kmm)
ztmask0(:,:,:) = ztmask_b(:,:,:)
ztmask1(:,:,:) = ztmask_b(:,:,:)
!
! iterate the extrapolation processes nn_drown times
DO jd = 1,nn_drown ! resolution dependent (OK for ISOMIP+ case)
DO jk = 1,jpk-1
!
! define new wet cell
zdmask(:,:) = tmask(:,:,jk) - ztmask0(:,:,jk);
!
DO_2D( 0, 0, 0, 0 )
jip1=ji+1; jim1=ji-1;
jjp1=jj+1; jjm1=jj-1;
!
! check if a wet neigbourg cell is present
zsummsk = ztmask0(jip1,jj ,jk) + ztmask0(jim1,jj ,jk) &
+ ztmask0(ji ,jjp1,jk) + ztmask0(ji ,jjm1,jk)
!
! if neigbourg wet cell available at the same level
IF ( zdmask(ji,jj) == 1._wp .AND. zsummsk /= 0._wp ) THEN
!
! horizontal basic extrapolation
ts(ji,jj,jk,1,Kmm)=( zts0(jip1,jj ,jk,1) * ztmask0(jip1,jj ,jk) &
& + zts0(jim1,jj ,jk,1) * ztmask0(jim1,jj ,jk) &
& + zts0(ji ,jjp1,jk,1) * ztmask0(ji ,jjp1,jk) &
& + zts0(ji ,jjm1,jk,1) * ztmask0(ji ,jjm1,jk) ) / zsummsk
ts(ji,jj,jk,2,Kmm)=( zts0(jip1,jj ,jk,2) * ztmask0(jip1,jj ,jk) &
& + zts0(jim1,jj ,jk,2) * ztmask0(jim1,jj ,jk) &
& + zts0(ji ,jjp1,jk,2) * ztmask0(ji ,jjp1,jk) &
& + zts0(ji ,jjm1,jk,2) * ztmask0(ji ,jjm1,jk) ) / zsummsk
!
! update mask for next pass
ztmask1(ji,jj,jk)=1
!
! in case no neigbourg wet cell available at the same level
! check if a wet cell is available below
ELSEIF (zdmask(ji,jj) == 1._wp .AND. zsummsk == 0._wp) THEN
!
! vertical extrapolation if horizontal extrapolation failed
jkm1=max(1,jk-1) ; jkp1=min(jpk,jk+1)
!
! check if a wet neigbourg cell is present
zsummsk = ztmask0(ji,jj,jkm1) + ztmask0(ji,jj,jkp1)
IF (zdmask(ji,jj) == 1._wp .AND. zsummsk /= 0._wp ) THEN
ts(ji,jj,jk,1,Kmm)=( zts0(ji,jj,jkp1,1)*ztmask0(ji,jj,jkp1) &
& + zts0(ji,jj,jkm1,1)*ztmask0(ji,jj,jkm1)) / zsummsk
ts(ji,jj,jk,2,Kmm)=( zts0(ji,jj,jkp1,2)*ztmask0(ji,jj,jkp1) &
& + zts0(ji,jj,jkm1,2)*ztmask0(ji,jj,jkm1)) / zsummsk
!
! update mask for next pass
ztmask1(ji,jj,jk)=1._wp
END IF
END IF
END_2D
END DO
!
sparonuz
committed
CALL lbc_lnk( 'isfcpl', ts(:,:,:,jp_tem,Kmm), 'T', 1.0_dp, ts(:,:,:,jp_sal,Kmm), 'T', 1.0_dp)
CALL lbc_lnk( 'isfcpl', ztmask1, 'T', 1.0_wp)
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
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
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
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
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
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
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
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
!
! update temperature and salinity and mask
zts0(:,:,:,:) = ts(:,:,:,:,Kmm)
ztmask0(:,:,:) = ztmask1(:,:,:)
!
!
END DO ! nn_drown
!
! mask new ts(:,:,:,:,Kmm) field
ts(:,:,:,jp_tem,Kmm) = zts0(:,:,:,jp_tem) * tmask(:,:,:)
ts(:,:,:,jp_sal,Kmm) = zts0(:,:,:,jp_sal) * tmask(:,:,:)
!
! sanity check
! -----------------------------------------------------------------------------------------
! case we open a cell but no neigbour cells available to get an estimate of T and S
DO_3D( 0, 0, 0, 0, 1,jpk-1 )
IF (tmask(ji,jj,jk) == 1._wp .AND. ts(ji,jj,jk,2,Kmm) == 0._wp) &
& CALL ctl_stop('STOP', 'failing to fill all new weet cell, &
& try increase nn_drown or activate XXXX &
& in your domain cfg computation' )
END_3D
!
END SUBROUTINE isfcpl_tra
SUBROUTINE isfcpl_vol(Kmm)
!!----------------------------------------------------------------------
!! *** ROUTINE iscpl_vol ***
!!
!! ** Purpose : compute the correction of the local divergence to apply
!! during the first time step after the coupling.
!!
!! ** Method : - compute horizontal vol div. before/after coupling
!! - compute vertical input
!! - compute correction
!!
!!----------------------------------------------------------------------
!!
INTEGER, INTENT(in) :: Kmm ! ocean time level index
!!----------------------------------------------------------------------
INTEGER :: ji, jj, jk
INTEGER :: ikb, ikt
!!
REAL(wp), DIMENSION(jpi,jpj,jpk) :: zqvolb, zqvoln ! vol flux div. before/after coupling
REAL(wp), DIMENSION(jpi,jpj,jpk) :: ze3u_b, ze3v_b ! vertical scale factor before/after coupling
REAL(wp), DIMENSION(jpi,jpj,jpk) :: ztmask_b ! mask before coupling
!!----------------------------------------------------------------------
!
CALL iom_get( numror, jpdom_auto, 'tmask' , ztmask_b )
CALL iom_get( numror, jpdom_auto, 'e3u_n' , ze3u_b )
CALL iom_get( numror, jpdom_auto, 'e3v_n' , ze3v_b )
!
! 1.0: compute horizontal volume flux divergence difference before-after coupling
!
DO jk = 1, jpk ! Horizontal slab
! 1.1: get volume flux before coupling (>0 out)
DO_2D( 0, 0, 0, 0 )
zqvolb(ji,jj,jk) = &
& ( e2u(ji ,jj ) * ze3u_b(ji ,jj ,jk) * uu(ji ,jj ,jk,Kmm) &
& - e2u(ji-1,jj ) * ze3u_b(ji-1,jj ,jk) * uu(ji-1,jj ,jk,Kmm) &
& + e1v(ji ,jj ) * ze3v_b(ji ,jj ,jk) * vv(ji ,jj ,jk,Kmm) &
& - e1v(ji ,jj-1) * ze3v_b(ji ,jj-1,jk) * vv(ji ,jj-1,jk,Kmm) ) &
& * ztmask_b(ji,jj,jk)
END_2D
!
! 1.2: get volume flux after coupling (>0 out)
! properly mask velocity
! (velocity are still mask with old mask at this stage)
uu(:,:,jk,Kmm) = uu(:,:,jk,Kmm) * umask(:,:,jk)
vv(:,:,jk,Kmm) = vv(:,:,jk,Kmm) * vmask(:,:,jk)
! compute volume flux divergence after coupling
DO_2D( 0, 0, 0, 0 )
zqvoln(ji,jj,jk) = &
& ( e2u(ji ,jj ) * e3u(ji ,jj ,jk,Kmm) * uu(ji ,jj ,jk,Kmm) &
& - e2u(ji-1,jj ) * e3u(ji-1,jj ,jk,Kmm) * uu(ji-1,jj ,jk,Kmm) &
& + e1v(ji ,jj ) * e3v(ji ,jj ,jk,Kmm) * vv(ji ,jj ,jk,Kmm) &
& - e1v(ji ,jj-1) * e3v(ji ,jj-1,jk,Kmm) * vv(ji ,jj-1,jk,Kmm) ) &
& * tmask(ji,jj,jk)
!
! 1.3: get 3d volume flux difference (before - after cpl) (>0 out)
! correction to add is _b - _n
risfcpl_vol(ji,jj,jk) = zqvolb(ji,jj,jk) - zqvoln(ji,jj,jk)
END_2D
END DO
!
! 2.0: include the contribution of the vertical velocity in the volume flux correction
!
DO_2D( 0, 0, 0, 0 )
!
ikt = mikt(ji,jj)
IF ( ikt > 1 .AND. ssmask(ji,jj) == 1 ) THEN
risfcpl_vol(ji,jj,ikt) = risfcpl_vol(ji,jj,ikt) + SUM(zqvolb(ji,jj,1:ikt-1)) ! test sign
ENDIF
!
END_2D
!
CALL lbc_lnk( 'isfcpl', risfcpl_vol, 'T', 1.0_wp )
!
! 3.0: set total correction (div, tr(:,:,:,:,Krhs), ssh)
!
! 3.1: mask volume flux divergence correction
risfcpl_vol(:,:,:) = risfcpl_vol(:,:,:) * tmask(:,:,:)
!
! 3.2: get 3d tr(:,:,:,:,Krhs) increment to apply at the first time step
! temperature and salt content flux computed using local ts(:,:,:,:,Kmm)
! (very simple advection scheme)
! (>0 out)
risfcpl_tsc(:,:,:,jp_tem) = -risfcpl_vol(:,:,:) * ts(:,:,:,jp_tem,Kmm)
risfcpl_tsc(:,:,:,jp_sal) = -risfcpl_vol(:,:,:) * ts(:,:,:,jp_sal,Kmm)
!
! 3.3: ssh correction (for dynspg_ts)
risfcpl_ssh(:,:) = 0.0
DO jk = 1,jpk
risfcpl_ssh(:,:) = risfcpl_ssh(:,:) + risfcpl_vol(:,:,jk) * r1_e1e2t(:,:)
END DO
!
END SUBROUTINE isfcpl_vol
SUBROUTINE isfcpl_cons(Kmm)
!!----------------------------------------------------------------------
!! *** ROUTINE iscpl_cons ***
!!
!! ** Purpose : compute the corrective increment in volume/salt/heat to put back the vol/heat/salt
!! removed or added during the coupling processes (wet or dry new cell)
!!
!! ** Method : - compare volume/heat/salt before and after
!! - look for the closest wet cells (share amoung neigbourgs if there are)
!! - build the correction increment to applied at each time step
!!
!!----------------------------------------------------------------------
!
TYPE(isfcons), DIMENSION(:),ALLOCATABLE :: zisfpts ! list of point receiving a correction
!
!!----------------------------------------------------------------------
INTEGER, INTENT(in) :: Kmm ! ocean time level index
!!----------------------------------------------------------------------
INTEGER :: ji , jj , jk , jproc ! loop index
INTEGER :: jip1 , jim1, jjp1, jjm1 ! dummy indices
INTEGER :: iig , ijg, ik ! dummy indices
INTEGER :: jisf ! start, end and current position in the increment array
INTEGER :: ingb, ifind ! 0/1 target found or need to be found
INTEGER :: nisfl_area ! global number of cell concerned by the wet->dry case
INTEGER, DIMENSION(jpnij) :: nisfl ! local number of cell concerned by the wet->dry case
!
REAL(wp) :: z1_sum, z1_rdtiscpl
REAL(wp) :: zdtem, zdsal, zdvol, zratio ! tem, sal, vol increment
REAL(wp) :: zlon , zlat ! target location
REAL(wp), DIMENSION(jpi,jpj,jpk) :: ztmask_b ! mask before
REAL(wp), DIMENSION(jpi,jpj,jpk) :: ze3t_b ! scale factor before
REAL(wp), DIMENSION(jpi,jpj,jpk) :: zt_b ! scale factor before
REAL(wp), DIMENSION(jpi,jpj,jpk) :: zs_b ! scale factor before
!!----------------------------------------------------------------------
!==============================================================================
! 1.0: initialisation
!==============================================================================
! get restart variable
CALL iom_get( numror, jpdom_auto, 'tmask' , ztmask_b(:,:,:) ) ! need to extrapolate T/S
CALL iom_get( numror, jpdom_auto, 'e3t_n' , ze3t_b(:,:,:) )
CALL iom_get( numror, jpdom_auto, 'tn' , zt_b(:,:,:) )
CALL iom_get( numror, jpdom_auto, 'sn' , zs_b(:,:,:) )
! compute run length
nstp_iscpl = nitend - nit000 + 1
rdt_iscpl = nstp_iscpl * rn_Dt
z1_rdtiscpl = 1._wp / rdt_iscpl
IF (lwp) WRITE(numout,*) ' nb of stp for cons = ', nstp_iscpl
IF (lwp) WRITE(numout,*) ' coupling time step = ', rdt_iscpl
! initialisation correction
risfcpl_cons_vol = 0.0
risfcpl_cons_ssh = 0.0
risfcpl_cons_tsc = 0.0
!==============================================================================
! 2.0: diagnose the heat, salt and volume input and compute the correction variable
! for case where we wet a cell or cell still wet (no change in cell status)
!==============================================================================
DO jk = 1,jpk-1
DO jj = Njs0,Nje0
DO ji = Nis0,Nie0
! volume diff
zdvol = e3t(ji,jj,jk,Kmm) * tmask (ji,jj,jk) &
& - ze3t_b(ji,jj,jk ) * ztmask_b(ji,jj,jk)
! heat diff
zdtem = ts (ji,jj,jk,jp_tem,Kmm) * e3t(ji,jj,jk,Kmm) * tmask (ji,jj,jk) &
- zt_b(ji,jj,jk) * ze3t_b(ji,jj,jk) * ztmask_b(ji,jj,jk)
! salt diff
zdsal = ts(ji,jj,jk,jp_sal,Kmm) * e3t(ji,jj,jk,Kmm) * tmask (ji,jj,jk) &
- zs_b(ji,jj,jk) * ze3t_b(ji,jj,jk) * ztmask_b(ji,jj,jk)
! volume, heat and salt differences in each cell (>0 means correction is an outward flux)
! in addition to the geometry change unconservation, need to add the divergence correction as it is flux across the boundary
risfcpl_cons_vol(ji,jj,jk) = ( zdvol * e1e2t(ji,jj) + risfcpl_vol(ji,jj,jk) ) * z1_rdtiscpl
risfcpl_cons_tsc(ji,jj,jk,jp_sal) = ( - zdsal * e1e2t(ji,jj) + risfcpl_tsc(ji,jj,jk,jp_sal) ) * z1_rdtiscpl
risfcpl_cons_tsc(ji,jj,jk,jp_tem) = ( - zdtem * e1e2t(ji,jj) + risfcpl_tsc(ji,jj,jk,jp_tem) ) * z1_rdtiscpl
END DO
END DO
END DO
!
!==============================================================================
! 3.0: diagnose the heat, salt and volume input and compute the correction variable
! for case where we close a cell
!==============================================================================
!
! compute the total number of point receiving a correction increment for each processor
! local
nisfl(:)=0
DO jk = 1,jpk-1
DO jj = Njs0,Nje0
DO ji = Nis0,Nie0
jip1=MIN(ji+1,jpi) ; jim1=MAX(ji-1,1) ; jjp1=MIN(jj+1,jpj) ; jjm1=MAX(jj-1,1) ;
IF ( tmask(ji,jj,jk) == 0._wp .AND. ztmask_b(ji,jj,jk) == 1._wp ) THEN
nisfl(narea) = nisfl(narea) + MAX(SUM(tmask(jim1:jip1,jjm1:jjp1,jk)),1._wp)
ENDIF
ENDDO
ENDDO
ENDDO
!
! global
CALL mpp_sum('isfcpl',nisfl )
!
! allocate list of point receiving correction
ALLOCATE(zisfpts(nisfl(narea)))
!
zisfpts(:) = isfcons(0,0,0,-HUGE(1.0), -HUGE(1.0), -HUGE(1.0), -HUGE(1.0), -HUGE(1.0), 0)
!
! start computing the correction and fill zisfpts
! local
jisf = 0
DO jk = 1,jpk-1
DO jj = Njs0,Nje0
DO ji = Nis0,Nie0
IF ( tmask(ji,jj,jk) == 0._wp .AND. ztmask_b(ji,jj,jk) == 1._wp ) THEN
jip1=MIN(ji+1,jpi) ; jim1=MAX(ji-1,1) ; jjp1=MIN(jj+1,jpj) ; jjm1=MAX(jj-1,1) ;
zdvol = risfcpl_cons_vol(ji,jj,jk )
zdsal = risfcpl_cons_tsc(ji,jj,jk,jp_sal)
zdtem = risfcpl_cons_tsc(ji,jj,jk,jp_tem)
IF ( SUM( tmask(jim1:jip1,jjm1:jjp1,jk) ) > 0._wp ) THEN
! spread correction amoung neigbourg wet cells (horizontal direction first)
! as it is a rude correction corner and lateral cell have the same weight
!
z1_sum = 1._wp / SUM( tmask(jim1:jip1,jjm1:jjp1,jk) )
!
! lateral cells
IF (tmask(jip1,jj ,jk) == 1) CALL update_isfpts(zisfpts, jisf, jip1, jj , jk, zdvol, zdsal, zdtem, z1_sum)
IF (tmask(jim1,jj ,jk) == 1) CALL update_isfpts(zisfpts, jisf, jim1, jj , jk, zdvol, zdsal, zdtem, z1_sum)
IF (tmask(ji ,jjp1,jk) == 1) CALL update_isfpts(zisfpts, jisf, ji , jjp1, jk, zdvol, zdsal, zdtem, z1_sum)
IF (tmask(ji ,jjm1,jk) == 1) CALL update_isfpts(zisfpts, jisf, ji , jjm1, jk, zdvol, zdsal, zdtem, z1_sum)
!
! corner cells
IF (tmask(jip1,jjm1,jk) == 1) CALL update_isfpts(zisfpts, jisf, jip1, jjm1, jk, zdvol, zdsal, zdtem, z1_sum)
IF (tmask(jim1,jjm1,jk) == 1) CALL update_isfpts(zisfpts, jisf, jim1, jjm1, jk, zdvol, zdsal, zdtem, z1_sum)
IF (tmask(jim1,jjp1,jk) == 1) CALL update_isfpts(zisfpts, jisf, jim1, jjp1, jk, zdvol, zdsal, zdtem, z1_sum)
IF (tmask(jip1,jjp1,jk) == 1) CALL update_isfpts(zisfpts, jisf, jip1, jjp1, jk, zdvol, zdsal, zdtem, z1_sum)
!
ELSE IF ( tmask(ji,jj,jk+1) == 1._wp ) THEN
! spread correction amoung neigbourg wet cells (vertical direction)
CALL update_isfpts(zisfpts, jisf, ji , jj , jk+1, zdvol, zdsal, zdtem, 1.0_wp, 0)
ELSE
! need to find where to put correction in later on
CALL update_isfpts(zisfpts, jisf, ji , jj , jk , zdvol, zdsal, zdtem, 1.0_wp, 1)
END IF
END IF
END DO
END DO
END DO
!
! share data among all processes because for some point we need to find the closest wet point (could be on other process)
DO jproc=1,jpnij
!
! share total number of isf point treated for proc jproc
IF (jproc==narea) THEN
nisfl_area=nisfl(jproc)
ELSE
nisfl_area=0
END IF
CALL mpp_max('isfcpl',nisfl_area)
!
DO jisf = 1,nisfl_area
!
IF (jproc==narea) THEN
! indices (conversion to global indices and sharing)
iig = zisfpts(jisf)%ii ; ijg = zisfpts(jisf)%jj ; ik = zisfpts(jisf)%kk
!
! data
zdvol = zisfpts(jisf)%dvol ; zdsal = zisfpts(jisf)%dsal ; zdtem = zisfpts(jisf)%dtem
!
! location
zlat = zisfpts(jisf)%lat ; zlon = zisfpts(jisf)%lon
!
! find flag
ingb = zisfpts(jisf)%ngb
ELSE
iig =0 ; ijg =0 ; ik =0
zdvol=-HUGE(1.0) ; zdsal=-HUGE(1.0) ; zdtem=-HUGE(1.0)
zlat =-HUGE(1.0) ; zlon =-HUGE(1.0)
ingb = 0
END IF
!
! share data (need synchronisation of data as get_correction call a global com)
CALL mpp_max('isfcpl',iig) ; CALL mpp_max('isfcpl',ijg) ; CALL mpp_max('isfcpl',ik)
CALL mpp_max('isfcpl',zdvol) ; CALL mpp_max('isfcpl',zdsal) ; CALL mpp_max('isfcpl',zdtem)
CALL mpp_max('isfcpl',zlat) ; CALL mpp_max('isfcpl',zlon)
CALL mpp_max('isfcpl',ingb)
!
! fill the 3d correction array
CALL get_correction(iig, ijg, ik, zlon, zlat, zdvol, zdsal, zdtem, ingb)
END DO
END DO
!
!==============================================================================
! 4.0: finalisation and compute ssh equivalent of the volume correction
!==============================================================================
!
! mask
risfcpl_cons_vol(:,:,: ) = risfcpl_cons_vol(:,:,: ) * tmask(:,:,:)
risfcpl_cons_tsc(:,:,:,jp_sal) = risfcpl_cons_tsc(:,:,:,jp_sal) * tmask(:,:,:)
risfcpl_cons_tsc(:,:,:,jp_tem) = risfcpl_cons_tsc(:,:,:,jp_tem) * tmask(:,:,:)
!
! add lbclnk
CALL lbc_lnk( 'isfcpl', risfcpl_cons_tsc(:,:,:,jp_tem), 'T', 1.0_wp, risfcpl_cons_tsc(:,:,:,jp_sal), 'T', 1.0_wp, &
& risfcpl_cons_vol(:,:,:) , 'T', 1.0_wp)
!
! ssh correction (for dynspg_ts)
DO jk = 1,jpk
risfcpl_cons_ssh(:,:) = risfcpl_cons_ssh(:,:) + risfcpl_cons_vol(:,:,jk)
END DO
risfcpl_cons_ssh(:,:) = risfcpl_cons_ssh(:,:) * r1_e1e2t(:,:)
!
END SUBROUTINE isfcpl_cons
!
SUBROUTINE update_isfpts(sisfpts, kpts, ki, kj, kk, pdvol, pdsal, pdtem, pratio, kfind)
!!---------------------------------------------------------------------
!! *** ROUTINE update_isfpts ***
!!
!! ** Purpose : if a cell become dry, we need to put the corrective increment elsewhere
!!
!! ** Action : update the list of point
!!
!!----------------------------------------------------------------------
!!----------------------------------------------------------------------
TYPE(isfcons), DIMENSION(:), INTENT(inout) :: sisfpts
INTEGER, INTENT(inout) :: kpts
!!----------------------------------------------------------------------
INTEGER, INTENT(in ) :: ki, kj, kk ! target location (kfind=0)
! ! or source location (kfind=1)
INTEGER, INTENT(in ), OPTIONAL :: kfind ! 0 target cell already found
! ! 1 target to be determined
REAL(wp), INTENT(in ) :: pdvol, pdsal, pdtem, pratio ! vol/sal/tem increment
! ! and ratio in case increment span over multiple cells.
!!----------------------------------------------------------------------
INTEGER :: ifind
!!----------------------------------------------------------------------
!
! increment position
kpts = kpts + 1
!
! define if we need to look for closest valid wet cell (no neighbours or neigbourg on halo)
IF ( PRESENT(kfind) ) THEN
ifind = kfind
ELSE
ifind = ( 1 - tmask_i(ki,kj) ) * tmask(ki,kj,kk)
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
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
END IF
!
! update isfpts structure
sisfpts(kpts) = isfcons(mig(ki), mjg(kj), kk, pratio * pdvol, pratio * pdsal, pratio * pdtem, glamt(ki,kj), gphit(ki,kj), ifind )
!
END SUBROUTINE update_isfpts
!
SUBROUTINE get_correction( ki, kj, kk, plon, plat, pvolinc, psalinc, pteminc, kfind)
!!---------------------------------------------------------------------
!! *** ROUTINE get_correction ***
!!
!! ** Action : - Find the closest valid cell if needed (wet and not on the halo)
!! - Scale the correction depending of pratio (case where multiple wet neigbourgs)
!! - Fill the correction array
!!
!!----------------------------------------------------------------------
INTEGER , INTENT(in) :: ki, kj, kk, kfind ! target point indices
REAL(wp), INTENT(in) :: plon, plat ! target point lon/lat
REAL(wp), INTENT(in) :: pvolinc, pteminc,psalinc ! correction increment for vol/temp/salt
!!----------------------------------------------------------------------
INTEGER :: jj, ji, iig, ijg
!!----------------------------------------------------------------------
!
! define global indice of correction location
iig = ki ; ijg = kj
IF ( kfind == 1 ) CALL dom_ngb( plon, plat, iig, ijg,'T', kk)
!
! fill the correction array
DO jj = mj0(ijg),mj1(ijg)
DO ji = mi0(iig),mi1(iig)
! correct the vol_flx and corresponding heat/salt flx in the closest cell
risfcpl_cons_vol(ji,jj,kk) = risfcpl_cons_vol(ji,jj,kk ) + pvolinc
risfcpl_cons_tsc(ji,jj,kk,jp_sal) = risfcpl_cons_tsc(ji,jj,kk,jp_sal) + psalinc
risfcpl_cons_tsc(ji,jj,kk,jp_tem) = risfcpl_cons_tsc(ji,jj,kk,jp_tem) + pteminc
END DO
END DO
END SUBROUTINE get_correction
END MODULE isfcpl