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.
iscplhsb.f90 in branches/UKMO/dev_r8864_restart_date/NEMOGCM/TOOLS/DOMAINcfg/src – NEMO

source: branches/UKMO/dev_r8864_restart_date/NEMOGCM/TOOLS/DOMAINcfg/src/iscplhsb.f90 @ 9235

Last change on this file since 9235 was 9235, checked in by davestorkey, 6 years ago

UKMO/dev_r8864_restart_date : clear SVN keywords.

File size: 16.1 KB
Line 
1MODULE iscplhsb
2   !!======================================================================
3   !!                       ***  MODULE  iscplhsb***
4   !! Ocean forcing: ice sheet/ocean coupling (conservation)
5   !!=====================================================================
6   !! History :  NEMO  ! 2015-01 P. Mathiot: original
7   !!----------------------------------------------------------------------
8
9   !!----------------------------------------------------------------------
10   !!   iscpl_alloc    : variable allocation
11   !!   iscpl_hsb      : compute and store the input of heat/salt/volume
12   !!                    into the system due to the coupling process
13   !!   iscpl_div      : correction of divergence to keep volume conservation
14   !!----------------------------------------------------------------------
15   USE dom_oce         ! ocean space and time domain
16   USE domwri          ! ocean space and time domain
17   USE phycst          ! physical constants
18   USE sbc_oce         ! surface boundary condition variables
19   USE oce             ! global tra/dyn variable
20   USE in_out_manager  ! I/O manager
21   USE lib_mpp         ! MPP library
22   USE lib_fortran     ! MPP library
23   USE wrk_nemo        ! Memory allocation
24   USE lbclnk          !
25   USE domngb          !
26   USE iscplini
27
28   IMPLICIT NONE
29   PRIVATE
30   
31   PUBLIC   iscpl_div   
32   PUBLIC   iscpl_cons       
33   !! * Substitutions 
34   !!----------------------------------------------------------------------
35   !!                   ***  vectopt_loop_substitute  ***
36   !!----------------------------------------------------------------------
37   !! ** purpose :   substitute the inner loop start/end indices with CPP macro
38   !!                allow unrolling of do-loop (useful with vector processors)
39   !!----------------------------------------------------------------------
40   !!----------------------------------------------------------------------
41   !! NEMO/OPA 3.7 , NEMO Consortium (2014)
42   !! $Id$
43   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
44   !!----------------------------------------------------------------------
45   !!----------------------------------------------------------------------
46   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
47   !! $Id$
48   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
49   !!----------------------------------------------------------------------
50CONTAINS
51
52   SUBROUTINE iscpl_cons(ptmask_b, psmask_b, pe3t_b, pts_flx, pvol_flx, prdt_iscpl)
53      !!----------------------------------------------------------------------
54      !!                   ***  ROUTINE iscpl_cons  ***
55      !!
56      !! ** Purpose :   compute input into the system during the coupling step
57      !!                compute the correction term
58      !!                compute where the correction have to be applied
59      !!
60      !! ** Method  :   compute tsn*e3t-tsb*e3tb and e3t-e3t_b
61      !!----------------------------------------------------------------------
62      REAL(wp), DIMENSION(:,:,:  ), INTENT(in ) :: ptmask_b    !! mask before
63      REAL(wp), DIMENSION(:,:,:  ), INTENT(in ) :: pe3t_b      !! scale factor before
64      REAL(wp), DIMENSION(:,:    ), INTENT(in ) :: psmask_b    !! mask before
65      REAL(wp), DIMENSION(:,:,:,:), INTENT(out) :: pts_flx     !! corrective flux to have tracer conservation
66      REAL(wp), DIMENSION(:,:,:  ), INTENT(out) :: pvol_flx    !! corrective flux to have volume conservation
67      REAL(wp),                     INTENT(in ) :: prdt_iscpl  !! coupling period
68      !!
69      INTEGER :: ji, jj, jk                                    !! loop index
70      INTEGER :: jip1, jim1, jjp1, jjm1
71      !!
72      REAL(wp):: summsk, zsum, zsum1, zarea, zsumn, zsumb
73      REAL(wp):: r1_rdtiscpl
74      REAL(wp):: zjip1_ratio  , zjim1_ratio  , zjjp1_ratio  , zjjm1_ratio
75      !!
76      REAL(wp):: zde3t, zdtem, zdsal
77      REAL(wp), DIMENSION(:,:), POINTER :: zdssh
78      !!
79      REAL(wp), DIMENSION(:), ALLOCATABLE :: zlon, zlat
80      REAL(wp), DIMENSION(:), ALLOCATABLE :: zcorr_vol, zcorr_tem, zcorr_sal
81      INTEGER , DIMENSION(:), ALLOCATABLE :: ixpts, iypts, izpts, inpts
82      INTEGER :: jpts, npts
83
84      CALL wrk_alloc(jpi,jpj, zdssh )
85
86      ! get imbalance (volume heat and salt)
87      ! initialisation difference
88      zde3t = 0.0_wp; zdsal = 0.0_wp ; zdtem = 0.0_wp
89
90      ! initialisation correction term
91      pvol_flx(:,:,:  ) = 0.0_wp
92      pts_flx (:,:,:,:) = 0.0_wp
93     
94      r1_rdtiscpl = 1._wp / prdt_iscpl 
95
96      ! mask tsn and tsb
97      tsb(:,:,:,jp_tem)=tsb(:,:,:,jp_tem)*ptmask_b(:,:,:); tsn(:,:,:,jp_tem)=tsn(:,:,:,jp_tem)*tmask(:,:,:);
98      tsb(:,:,:,jp_sal)=tsb(:,:,:,jp_sal)*ptmask_b(:,:,:); tsn(:,:,:,jp_sal)=tsn(:,:,:,jp_sal)*tmask(:,:,:);
99
100      !==============================================================================
101      ! diagnose the heat, salt and volume input and compute the correction variable
102      !==============================================================================
103
104      !
105      zdssh(:,:) = sshn(:,:) * ssmask(:,:) - sshb(:,:) * psmask_b(:,:)
106      IF (.NOT. ln_linssh ) zdssh = 0.0_wp ! already included in the levels by definition
107     
108      DO jk = 1,jpk-1
109         DO jj = 2,jpj-1
110            DO ji = 2,jpim1
111               IF (tmask_h(ji,jj) == 1._wp) THEN
112
113                  ! volume differences
114                  zde3t = e3t_n(ji,jj,jk) * tmask(ji,jj,jk) - pe3t_b(ji,jj,jk) * ptmask_b(ji,jj,jk)
115
116                  ! heat diff
117                  zdtem = tsn(ji,jj,jk,jp_tem) * e3t_n(ji,jj,jk) *  tmask  (ji,jj,jk)   &
118                        - tsb(ji,jj,jk,jp_tem) * pe3t_b (ji,jj,jk) * ptmask_b(ji,jj,jk)
119                  ! salt diff
120                  zdsal = tsn(ji,jj,jk,jp_sal) * e3t_n(ji,jj,jk) *  tmask  (ji,jj,jk)   &
121                        - tsb(ji,jj,jk,jp_sal) * pe3t_b (ji,jj,jk) * ptmask_b(ji,jj,jk)
122               
123                  ! shh changes
124                  IF ( ptmask_b(ji,jj,jk) == 1._wp .OR. tmask(ji,jj,jk) == 1._wp ) THEN
125                     zde3t = zde3t + zdssh(ji,jj) ! zdssh = 0 if vvl
126                     zdssh(ji,jj) = 0._wp
127                  END IF
128
129                  ! volume, heat and salt differences in each cell
130                  pvol_flx(ji,jj,jk)       =   pvol_flx(ji,jj,jk)        + zde3t * r1_rdtiscpl
131                  pts_flx (ji,jj,jk,jp_sal)=   pts_flx (ji,jj,jk,jp_sal) + zdsal * r1_rdtiscpl 
132                  pts_flx (ji,jj,jk,jp_tem)=   pts_flx (ji,jj,jk,jp_tem) + zdtem * r1_rdtiscpl
133
134                  ! case where we close a cell: check if the neighbour cells are wet
135                  IF ( tmask(ji,jj,jk) == 0._wp .AND. ptmask_b(ji,jj,jk) == 1._wp ) THEN
136
137                     jip1=ji+1 ; jim1=ji-1 ; jjp1=jj+1 ; jjm1=jj-1 ;
138
139                     zsum =   e1e2t(ji  ,jjp1) * tmask(ji  ,jjp1,jk) + e1e2t(ji  ,jjm1) * tmask(ji  ,jjm1,jk) &
140                       &    + e1e2t(jim1,jj  ) * tmask(jim1,jj  ,jk) + e1e2t(jip1,jj  ) * tmask(jip1,jj  ,jk)
141
142                     IF ( zsum /= 0._wp ) THEN
143                        zjip1_ratio   = e1e2t(jip1,jj  ) * tmask(jip1,jj  ,jk) / zsum
144                        zjim1_ratio   = e1e2t(jim1,jj  ) * tmask(jim1,jj  ,jk) / zsum
145                        zjjp1_ratio   = e1e2t(ji  ,jjp1) * tmask(ji  ,jjp1,jk) / zsum
146                        zjjm1_ratio   = e1e2t(ji  ,jjm1) * tmask(ji  ,jjm1,jk) / zsum
147
148                        pvol_flx(ji  ,jjp1,jk       ) = pvol_flx(ji  ,jjp1,jk       ) + pvol_flx(ji,jj,jk       ) * zjjp1_ratio
149                        pvol_flx(ji  ,jjm1,jk       ) = pvol_flx(ji  ,jjm1,jk       ) + pvol_flx(ji,jj,jk       ) * zjjm1_ratio
150                        pvol_flx(jip1,jj  ,jk       ) = pvol_flx(jip1,jj  ,jk       ) + pvol_flx(ji,jj,jk       ) * zjip1_ratio
151                        pvol_flx(jim1,jj  ,jk       ) = pvol_flx(jim1,jj  ,jk       ) + pvol_flx(ji,jj,jk       ) * zjim1_ratio
152                        pts_flx (ji  ,jjp1,jk,jp_sal) = pts_flx (ji  ,jjp1,jk,jp_sal) + pts_flx (ji,jj,jk,jp_sal) * zjjp1_ratio
153                        pts_flx (ji  ,jjm1,jk,jp_sal) = pts_flx (ji  ,jjm1,jk,jp_sal) + pts_flx (ji,jj,jk,jp_sal) * zjjm1_ratio
154                        pts_flx (jip1,jj  ,jk,jp_sal) = pts_flx (jip1,jj  ,jk,jp_sal) + pts_flx (ji,jj,jk,jp_sal) * zjip1_ratio
155                        pts_flx (jim1,jj  ,jk,jp_sal) = pts_flx (jim1,jj  ,jk,jp_sal) + pts_flx (ji,jj,jk,jp_sal) * zjim1_ratio
156                        pts_flx (ji  ,jjp1,jk,jp_tem) = pts_flx (ji  ,jjp1,jk,jp_tem) + pts_flx (ji,jj,jk,jp_tem) * zjjp1_ratio
157                        pts_flx (ji  ,jjm1,jk,jp_tem) = pts_flx (ji  ,jjm1,jk,jp_tem) + pts_flx (ji,jj,jk,jp_tem) * zjjm1_ratio
158                        pts_flx (jip1,jj  ,jk,jp_tem) = pts_flx (jip1,jj  ,jk,jp_tem) + pts_flx (ji,jj,jk,jp_tem) * zjip1_ratio
159                        pts_flx (jim1,jj  ,jk,jp_tem) = pts_flx (jim1,jj  ,jk,jp_tem) + pts_flx (ji,jj,jk,jp_tem) * zjim1_ratio
160
161                        ! set to 0 the cell we distributed over neigbourg cells
162                        pvol_flx(ji,jj,jk       ) = 0._wp
163                        pts_flx (ji,jj,jk,jp_sal) = 0._wp
164                        pts_flx (ji,jj,jk,jp_tem) = 0._wp
165
166                     ELSE IF (zsum == 0._wp ) THEN
167                        ! case where we close a cell and no adjacent cell open
168                        ! check if the cell beneath is wet
169                        IF ( tmask(ji,jj,jk+1) == 1._wp ) THEN
170                           pvol_flx(ji,jj,jk+1)       =  pvol_flx(ji,jj,jk+1)        + pvol_flx(ji,jj,jk)
171                           pts_flx (ji,jj,jk+1,jp_sal)=  pts_flx (ji,jj,jk+1,jp_sal) + pts_flx (ji,jj,jk,jp_sal)
172                           pts_flx (ji,jj,jk+1,jp_tem)=  pts_flx (ji,jj,jk+1,jp_tem) + pts_flx (ji,jj,jk,jp_tem)
173
174                           ! set to 0 the cell we distributed over neigbourg cells
175                           pvol_flx(ji,jj,jk       ) = 0._wp
176                           pts_flx (ji,jj,jk,jp_sal) = 0._wp
177                           pts_flx (ji,jj,jk,jp_tem) = 0._wp
178                        ELSE
179                        ! case no adjacent cell on the horizontal and on the vertical
180                           IF ( lwp ) THEN   ! JMM : cAution this warning may occur on any mpp subdomain but numout is only
181                                             ! open for narea== 1 (lwp=T)
182                           WRITE(numout,*) 'W A R N I N G iscpl: no adjacent cell on the vertical and horizontal'
183                           WRITE(numout,*) '                     ',mig(ji),' ',mjg(jj),' ',jk
184                           WRITE(numout,*) '                     ',ji,' ',jj,' ',jk,' ',narea
185                           WRITE(numout,*) ' we are now looking for the closest wet cell on the horizontal '
186                           ENDIF
187                        ! We deal with these points later.
188                        END IF
189                     END IF
190                  END IF
191               END IF
192            END DO
193         END DO
194      END DO
195
196      CALL lbc_sum(pvol_flx(:,:,:       ),'T',1.)
197      CALL lbc_sum(pts_flx (:,:,:,jp_sal),'T',1.)
198      CALL lbc_sum(pts_flx (:,:,:,jp_tem),'T',1.)
199
200      ! if no neighbour wet cell in case of 2close a cell", need to find the nearest wet point
201      ! allocation and initialisation of the list of problematic point
202      ALLOCATE(inpts(jpnij))
203      inpts(:)=0
204
205      ! fill narea location with the number of problematic point
206      DO jk = 1,jpk-1
207         DO jj = 2,jpj-1
208            DO ji = 2,jpim1
209               IF (     ptmask_b(ji,jj,jk) == 1._wp .AND. tmask(ji,jj,jk+1)  == 0._wp .AND. tmask_h(ji,jj) == 1._wp  &
210                  .AND. SUM(tmask(ji-1:ji+1,jj,jk)) + SUM(tmask(ji,jj-1:jj+1,jk)) == 0._wp) THEN
211                  inpts(narea) = inpts(narea) + 1 
212               END IF
213            END DO
214         END DO
215      END DO
216
217      ! build array of total problematic point on each cpu (share to each cpu)
218      CALL mpp_max(inpts,jpnij) 
219
220      ! size of the new variable
221      npts  = SUM(inpts)   
222     
223      ! allocation of the coordinates, correction, index vector for the problematic points
224      ALLOCATE(ixpts(npts), iypts(npts), izpts(npts), zcorr_vol(npts), zcorr_sal(npts), zcorr_tem(npts), zlon(npts), zlat(npts))
225      ixpts(:) = -9999 ; iypts(:) = -9999 ; izpts(:) = -9999 ; zlon(:) = -1.0e20_wp ; zlat(:) = -1.0e20_wp
226      zcorr_vol(:) = -1.0e20_wp
227      zcorr_sal(:) = -1.0e20_wp
228      zcorr_tem(:) = -1.0e20_wp
229
230      ! fill new variable
231      jpts = SUM(inpts(1:narea-1))
232      DO jk = 1,jpk-1
233         DO jj = 2,jpj-1
234            DO ji = 2,jpim1
235               IF (     ptmask_b(ji,jj,jk) == 1._wp .AND. tmask(ji,jj,jk+1)  == 0._wp .AND. tmask_h(ji,jj) == 1._wp  &
236                  .AND. SUM(tmask(ji-1:ji+1,jj,jk)) + SUM(tmask(ji,jj-1:jj+1,jk)) == 0._wp) THEN
237                  jpts = jpts + 1  ! positioning in the inpts vector for the area narea
238                  ixpts(jpts) = ji           ; iypts(jpts) = jj ; izpts(jpts) = jk
239                  zlon (jpts) = glamt(ji,jj) ; zlat (jpts) = gphit(ji,jj)
240                  zcorr_vol(jpts) = pvol_flx(ji,jj,jk)
241                  zcorr_sal(jpts) = pts_flx (ji,jj,jk,jp_sal)
242                  zcorr_tem(jpts) = pts_flx (ji,jj,jk,jp_tem)
243
244                  ! set flx to 0 (safer)
245                  pvol_flx(ji,jj,jk       ) = 0.0_wp
246                  pts_flx (ji,jj,jk,jp_sal) = 0.0_wp
247                  pts_flx (ji,jj,jk,jp_tem) = 0.0_wp
248               END IF
249            END DO
250         END DO
251      END DO
252
253      ! build array of total problematic point on each cpu (share to each cpu)
254      ! point coordinates
255      CALL mpp_max(zlat ,npts)
256      CALL mpp_max(zlon ,npts)
257      CALL mpp_max(izpts,npts)
258
259      ! correction values
260      CALL mpp_max(zcorr_vol,npts)
261      CALL mpp_max(zcorr_sal,npts)
262      CALL mpp_max(zcorr_tem,npts)
263
264      ! put correction term in the closest cell         
265      DO jpts = 1,npts
266         CALL dom_ngb(zlon(jpts), zlat(jpts), ixpts(jpts), iypts(jpts),'T', izpts(jpts))
267         DO jj = mj0(iypts(jpts)),mj1(iypts(jpts))
268            DO ji = mi0(ixpts(jpts)),mi1(ixpts(jpts))
269               jk = izpts(jpts)
270
271               IF (tmask_h(ji,jj) == 1._wp) THEN
272                  ! correct the vol_flx in the closest cell
273                  pvol_flx(ji,jj,jk)        =  pvol_flx(ji,jj,jk       ) + zcorr_vol(jpts)
274                  pts_flx (ji,jj,jk,jp_sal) =  pts_flx (ji,jj,jk,jp_sal) + zcorr_sal(jpts)
275                  pts_flx (ji,jj,jk,jp_tem) =  pts_flx (ji,jj,jk,jp_tem) + zcorr_tem(jpts)
276
277                  ! set correction to 0
278                  zcorr_vol(jpts) = 0.0_wp
279                  zcorr_sal(jpts) = 0.0_wp
280                  zcorr_tem(jpts) = 0.0_wp
281               END IF
282            END DO
283         END DO
284      END DO
285
286      ! deallocate variables
287      DEALLOCATE(inpts)
288      DEALLOCATE(ixpts, iypts, izpts, zcorr_vol, zcorr_sal, zcorr_tem, zlon, zlat)
289   
290      ! add contribution store on the hallo (lbclnk remove one of the contribution)
291      pvol_flx(:,:,:       ) = pvol_flx(:,:,:       ) * tmask(:,:,:)
292      pts_flx (:,:,:,jp_sal) = pts_flx (:,:,:,jp_sal) * tmask(:,:,:)
293      pts_flx (:,:,:,jp_tem) = pts_flx (:,:,:,jp_tem) * tmask(:,:,:)
294
295      ! compute sum over the halo and set it to 0.
296      CALL lbc_sum(pvol_flx(:,:,:       ),'T',1._wp)
297      CALL lbc_sum(pts_flx (:,:,:,jp_sal),'T',1._wp)
298      CALL lbc_sum(pts_flx (:,:,:,jp_tem),'T',1._wp)
299
300      ! deallocate variables
301      CALL wrk_dealloc(jpi,jpj, zdssh ) 
302
303   END SUBROUTINE iscpl_cons
304
305   SUBROUTINE iscpl_div( phdivn )
306      !!----------------------------------------------------------------------
307      !!                  ***  ROUTINE iscpl_div  ***
308      !!
309      !! ** Purpose :   update the horizontal divergenc
310      !!
311      !! ** Method  :
312      !!                CAUTION : iscpl is positive (inflow) and expressed in m/s
313      !!
314      !! ** Action  :   phdivn   increase by the iscpl correction term
315      !!----------------------------------------------------------------------
316      REAL(wp), DIMENSION(:,:,:), INTENT(inout) ::   phdivn   ! horizontal divergence
317      !!
318      INTEGER  ::   ji, jj, jk   ! dummy loop indices
319      !!----------------------------------------------------------------------
320      !
321      DO jk = 1, jpk
322         DO jj = 1, jpj
323            DO ji = 1, jpi
324               phdivn(ji,jj,jk) = phdivn(ji,jj,jk) + hdiv_iscpl(ji,jj,jk) / e3t_n(ji,jj,jk)
325            END DO
326         END DO
327      END DO
328      !
329   END SUBROUTINE iscpl_div
330
331END MODULE iscplhsb
Note: See TracBrowser for help on using the repository browser.