source: branches/2017/dev_r7881_no_wrk_alloc/NEMOGCM/NEMO/OPA_SRC/DOM/dommsk.F90 @ 7910

Last change on this file since 7910 was 7910, checked in by timgraham, 4 years ago

All wrk_alloc removed

  • Property svn:keywords set to Id
File size: 14.0 KB
RevLine 
[3]1MODULE dommsk
[1566]2   !!======================================================================
[3]3   !!                       ***  MODULE dommsk   ***
4   !! Ocean initialization : domain land/sea mask
[1566]5   !!======================================================================
6   !! History :  OPA  ! 1987-07  (G. Madec)  Original code
[2528]7   !!            6.0  ! 1993-03  (M. Guyon)  symetrical conditions (M. Guyon)
8   !!            7.0  ! 1996-01  (G. Madec)  suppression of common work arrays
[6140]9   !!             -   ! 1996-05  (G. Madec)  mask computed from tmask
[2528]10   !!            8.0  ! 1997-02  (G. Madec)  mesh information put in domhgr.F
[7646]11   !!            8.1  ! 1997-07  (G. Madec)  modification of kbat and fmask
[1566]12   !!             -   ! 1998-05  (G. Roullet)  free surface
[2528]13   !!            8.2  ! 2000-03  (G. Madec)  no slip accurate
[1566]14   !!             -   ! 2001-09  (J.-M. Molines)  Open boundaries
15   !!   NEMO     1.0  ! 2002-08  (G. Madec)  F90: Free form and module
16   !!             -   ! 2005-11  (V. Garnier) Surface pressure gradient organization
17   !!            3.2  ! 2009-07  (R. Benshila) Suppression of rigid-lid option
[5836]18   !!            3.6  ! 2015-05  (P. Mathiot) ISF: add wmask,wumask and wvmask
[7646]19   !!            4.0  ! 2016-06  (G. Madec, S. Flavoni)  domain configuration / user defined interface
[1566]20   !!----------------------------------------------------------------------
[3]21
22   !!----------------------------------------------------------------------
[7646]23   !!   dom_msk       : compute land/ocean mask
[3]24   !!----------------------------------------------------------------------
[7646]25   USE oce            ! ocean dynamics and tracers
26   USE dom_oce        ! ocean space and time domain
27   USE usrdef_fmask   ! user defined fmask
28   USE bdy_oce     
29   USE in_out_manager ! I/O manager
30   USE lbclnk         ! ocean lateral boundary conditions (or mpp link)
31   USE lib_mpp        ! Massively Parallel Processing library
32   USE timing         ! Timing
[3]33
34   IMPLICIT NONE
35   PRIVATE
36
[6140]37   PUBLIC   dom_msk    ! routine called by inidom.F90
[3]38
[1601]39   !                            !!* Namelist namlbc : lateral boundary condition *
[4147]40   REAL(wp)        :: rn_shlat   ! type of lateral boundary condition on velocity
41   LOGICAL, PUBLIC :: ln_vorlat  !  consistency of vorticity boundary condition
[3294]42   !                                            with analytical eqs.
[2715]43
[3]44   !! * Substitutions
45#  include "vectopt_loop_substitute.h90"
[1566]46   !!----------------------------------------------------------------------
47   !! NEMO/OPA 3.2 , LODYC-IPSL  (2009)
[7753]48   !! $Id$
[2528]49   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
[1566]50   !!----------------------------------------------------------------------
[3]51CONTAINS
[2715]52
[7646]53   SUBROUTINE dom_msk( k_top, k_bot )
[3]54      !!---------------------------------------------------------------------
55      !!                 ***  ROUTINE dom_msk  ***
56      !!
57      !! ** Purpose :   Compute land/ocean mask arrays at tracer points, hori-
[6125]58      !!      zontal velocity points (u & v), vorticity points (f) points.
[3]59      !!
[7646]60      !! ** Method  :   The ocean/land mask  at t-point is deduced from ko_top
61      !!      and ko_bot, the indices of the fist and last ocean t-levels which
62      !!      are either defined in usrdef_zgr or read in zgr_read.
63      !!                The velocity masks (umask, vmask, wmask, wumask, wvmask)
64      !!      are deduced from a product of the two neighboring tmask.
65      !!                The vorticity mask (fmask) is deduced from tmask taking
66      !!      into account the choice of lateral boundary condition (rn_shlat) :
[1601]67      !!         rn_shlat = 0, free slip  (no shear along the coast)
68      !!         rn_shlat = 2, no slip  (specified zero velocity at the coast)
69      !!         0 < rn_shlat < 2, partial slip   | non-linear velocity profile
70      !!         2 < rn_shlat, strong slip        | in the lateral boundary layer
[3]71      !!
[7646]72      !!      tmask_i : interior ocean mask at t-point, i.e. excluding duplicated
73      !!                rows/lines due to cyclic or North Fold boundaries as well
74      !!                as MPP halos.
75      !!      tmask_h : halo mask at t-point, i.e. excluding duplicated rows/lines
76      !!                due to cyclic or North Fold boundaries as well as MPP halos.
[3]77      !!
[7646]78      !! ** Action :   tmask, umask, vmask, wmask, wumask, wvmask : land/ocean mask
79      !!                         at t-, u-, v- w, wu-, and wv-points (=0. or 1.)
80      !!               fmask   : land/ocean mask at f-point (=0., or =1., or
81      !!                         =rn_shlat along lateral boundaries)
82      !!               tmask_i : interior ocean mask
83      !!               tmask_h : halo mask
84      !!               ssmask , ssumask, ssvmask, ssfmask : 2D ocean mask
[3]85      !!----------------------------------------------------------------------
[7646]86      INTEGER, DIMENSION(:,:), INTENT(in) ::   k_top, k_bot   ! first and last ocean level
87      !
88      INTEGER  ::   ji, jj, jk     ! dummy loop indices
89      INTEGER  ::   iif, iil       ! local integers
90      INTEGER  ::   ijf, ijl       !   -       -
91      INTEGER  ::   iktop, ikbot   !   -       -
92      INTEGER  ::   ios, inum
[7910]93      REAL(wp), DIMENSION(jpi,jpj) ::   zwf   ! 2D workspace
[1601]94      !!
[3294]95      NAMELIST/namlbc/ rn_shlat, ln_vorlat
[7646]96      NAMELIST/nambdy/ ln_bdy ,nb_bdy, ln_coords_file, cn_coords_file,         &
97         &             ln_mask_file, cn_mask_file, cn_dyn2d, nn_dyn2d_dta,     &
98         &             cn_dyn3d, nn_dyn3d_dta, cn_tra, nn_tra_dta,             &
99         &             ln_tra_dmp, ln_dyn3d_dmp, rn_time_dmp, rn_time_dmp_out, &
100         &             cn_ice_lim, nn_ice_lim_dta,                           &
101         &             rn_ice_tem, rn_ice_sal, rn_ice_age,                 &
102         &             ln_vol, nn_volctl, nn_rimwidth, nb_jpk_bdy
[3]103      !!---------------------------------------------------------------------
[3294]104      !
105      IF( nn_timing == 1 )  CALL timing_start('dom_msk')
106      !
[4147]107      REWIND( numnam_ref )              ! Namelist namlbc in reference namelist : Lateral momentum boundary condition
108      READ  ( numnam_ref, namlbc, IOSTAT = ios, ERR = 901 )
109901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namlbc in reference namelist', lwp )
110
111      REWIND( numnam_cfg )              ! Namelist namlbc in configuration namelist : Lateral momentum boundary condition
112      READ  ( numnam_cfg, namlbc, IOSTAT = ios, ERR = 902 )
113902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namlbc in configuration namelist', lwp )
[4624]114      IF(lwm) WRITE ( numond, namlbc )
[1566]115     
116      IF(lwp) THEN                  ! control print
[3]117         WRITE(numout,*)
118         WRITE(numout,*) 'dommsk : ocean mask '
119         WRITE(numout,*) '~~~~~~'
[1566]120         WRITE(numout,*) '   Namelist namlbc'
[3294]121         WRITE(numout,*) '      lateral momentum boundary cond.    rn_shlat  = ',rn_shlat
122         WRITE(numout,*) '      consistency with analytical form   ln_vorlat = ',ln_vorlat 
[3]123      ENDIF
124
[2528]125      IF     (      rn_shlat == 0.               ) THEN   ;   IF(lwp) WRITE(numout,*) '   ocean lateral  free-slip '
[1601]126      ELSEIF (      rn_shlat == 2.               ) THEN   ;   IF(lwp) WRITE(numout,*) '   ocean lateral  no-slip '
127      ELSEIF ( 0. < rn_shlat .AND. rn_shlat < 2. ) THEN   ;   IF(lwp) WRITE(numout,*) '   ocean lateral  partial-slip '
128      ELSEIF ( 2. < rn_shlat                     ) THEN   ;   IF(lwp) WRITE(numout,*) '   ocean lateral  strong-slip '
129      ELSE
130         WRITE(ctmp1,*) ' rn_shlat is negative = ', rn_shlat
131         CALL ctl_stop( ctmp1 )
[3]132      ENDIF
133
[7646]134
135      !  Ocean/land mask at t-point  (computed from ko_top and ko_bot)
136      ! ----------------------------
[1566]137      !
[7753]138      tmask(:,:,:) = 0._wp
[7646]139      DO jj = 1, jpj
140         DO ji = 1, jpi
141            iktop = k_top(ji,jj)
142            ikbot = k_bot(ji,jj)
143            IF( iktop /= 0 ) THEN       ! water in the column
144               tmask(ji,jj,iktop:ikbot  ) = 1._wp
145            ENDIF
[3]146         END DO 
147      END DO 
[7646]148!SF  add here lbc_lnk: bug not still understood : cause now domain configuration is read !
149!!gm I don't understand why... 
150      CALL lbc_lnk( tmask  , 'T', 1._wp )      ! Lateral boundary conditions
[3]151
[7646]152     ! Mask corrections for bdy (read in mppini2)
153      REWIND( numnam_ref )              ! Namelist nambdy in reference namelist :Unstructured open boundaries
154      READ  ( numnam_ref, nambdy, IOSTAT = ios, ERR = 903)
155903   IF( ios /= 0 ) CALL ctl_nam ( ios , 'nambdy in reference namelist', lwp )
[6140]156
[7646]157      REWIND( numnam_cfg )              ! Namelist nambdy in configuration namelist :Unstructured open boundaries
158      READ  ( numnam_cfg, nambdy, IOSTAT = ios, ERR = 904 )
159904   IF( ios /= 0 ) CALL ctl_nam ( ios , 'nambdy in configuration namelist', lwp )
160      ! ------------------------
161      IF ( ln_bdy .AND. ln_mask_file ) THEN
162         DO jk = 1, jpkm1
163            DO jj = 1, jpj
164               DO ji = 1, jpi
165                  tmask(ji,jj,jk) = tmask(ji,jj,jk) * bdytmask(ji,jj)
166               END DO
[291]167            END DO
[7646]168         END DO
[3]169      ENDIF
[7646]170         
171      !  Ocean/land mask at u-, v-, and f-points   (computed from tmask)
172      ! ----------------------------------------
173      ! NB: at this point, fmask is designed for free slip lateral boundary condition
[3]174      DO jk = 1, jpk
175         DO jj = 1, jpjm1
176            DO ji = 1, fs_jpim1   ! vector loop
177               umask(ji,jj,jk) = tmask(ji,jj  ,jk) * tmask(ji+1,jj  ,jk)
178               vmask(ji,jj,jk) = tmask(ji,jj  ,jk) * tmask(ji  ,jj+1,jk)
[1271]179            END DO
[1694]180            DO ji = 1, jpim1      ! NO vector opt.
[3]181               fmask(ji,jj,jk) = tmask(ji,jj  ,jk) * tmask(ji+1,jj  ,jk)   &
[62]182                  &            * tmask(ji,jj+1,jk) * tmask(ji+1,jj+1,jk)
[3]183            END DO
184         END DO
185      END DO
[6140]186      CALL lbc_lnk( umask  , 'U', 1._wp )      ! Lateral boundary conditions
187      CALL lbc_lnk( vmask  , 'V', 1._wp )
188      CALL lbc_lnk( fmask  , 'F', 1._wp )
[3]189
[7646]190 
191      ! Ocean/land mask at wu-, wv- and w points    (computed from tmask)
192      !-----------------------------------------
[7753]193      wmask (:,:,1) = tmask(:,:,1)     ! surface
194      wumask(:,:,1) = umask(:,:,1)
195      wvmask(:,:,1) = vmask(:,:,1)
[5836]196      DO jk = 2, jpk                   ! interior values
[7753]197         wmask (:,:,jk) = tmask(:,:,jk) * tmask(:,:,jk-1)
198         wumask(:,:,jk) = umask(:,:,jk) * umask(:,:,jk-1)   
199         wvmask(:,:,jk) = vmask(:,:,jk) * vmask(:,:,jk-1)
[5120]200      END DO
[3]201
[7646]202
203      ! Ocean/land column mask at t-, u-, and v-points   (i.e. at least 1 wet cell in the vertical)
204      ! ----------------------------------------------
205      ssmask (:,:) = MAXVAL( tmask(:,:,:), DIM=3 )
206      ssumask(:,:) = MAXVAL( umask(:,:,:), DIM=3 )
207      ssvmask(:,:) = MAXVAL( vmask(:,:,:), DIM=3 )
208
209
210      ! Interior domain mask  (used for global sum)
211      ! --------------------
212      !
213      iif = jpreci   ;   iil = nlci - jpreci + 1
214      ijf = jprecj   ;   ijl = nlcj - jprecj + 1
215      !
216      !                          ! halo mask : 0 on the halo and 1 elsewhere
[7753]217      tmask_h(:,:) = 1._wp                 
[7646]218      tmask_h( 1 :iif,   :   ) = 0._wp      ! first columns
219      tmask_h(iil:jpi,   :   ) = 0._wp      ! last  columns (including mpp extra columns)
220      tmask_h(   :   , 1 :ijf) = 0._wp      ! first rows
221      tmask_h(   :   ,ijl:jpj) = 0._wp      ! last  rows (including mpp extra rows)
222      !
223      !                          ! north fold mask
224      tpol(1:jpiglo) = 1._wp 
225      fpol(1:jpiglo) = 1._wp
226      IF( jperio == 3 .OR. jperio == 4 ) THEN      ! T-point pivot
227         tpol(jpiglo/2+1:jpiglo) = 0._wp
228         fpol(     1    :jpiglo) = 0._wp
229         IF( mjg(nlej) == jpjglo ) THEN                  ! only half of the nlcj-1 row for tmask_h
230            DO ji = iif+1, iil-1
231               tmask_h(ji,nlej-1) = tmask_h(ji,nlej-1) * tpol(mig(ji))
232            END DO
233         ENDIF
234      ENDIF
235      !
236      IF( jperio == 5 .OR. jperio == 6 ) THEN      ! F-point pivot
237         tpol(     1    :jpiglo) = 0._wp
238         fpol(jpiglo/2+1:jpiglo) = 0._wp
239      ENDIF
240      !
241      !                          ! interior mask : 2D ocean mask x halo mask
[7753]242      tmask_i(:,:) = ssmask(:,:) * tmask_h(:,:)
[7646]243
244
[3]245      ! Lateral boundary conditions on velocity (modify fmask)
[7646]246      ! --------------------------------------- 
247      IF( rn_shlat /= 0 ) THEN      ! Not free-slip lateral boundary condition
248         !
249         !
250         DO jk = 1, jpk
[7753]251            zwf(:,:) = fmask(:,:,jk)         
[7646]252            DO jj = 2, jpjm1
253               DO ji = fs_2, fs_jpim1   ! vector opt.
254                  IF( fmask(ji,jj,jk) == 0._wp ) THEN
255                     fmask(ji,jj,jk) = rn_shlat * MIN( 1._wp , MAX( zwf(ji+1,jj), zwf(ji,jj+1),   &
256                        &                                           zwf(ji-1,jj), zwf(ji,jj-1)  )  )
257                  ENDIF
258               END DO
259            END DO
260            DO jj = 2, jpjm1
261               IF( fmask(1,jj,jk) == 0._wp ) THEN
262                  fmask(1  ,jj,jk) = rn_shlat * MIN( 1._wp , MAX( zwf(2,jj), zwf(1,jj+1), zwf(1,jj-1) ) )
[3]263               ENDIF
[7646]264               IF( fmask(jpi,jj,jk) == 0._wp ) THEN
265                  fmask(jpi,jj,jk) = rn_shlat * MIN( 1._wp , MAX( zwf(jpi,jj+1), zwf(jpim1,jj), zwf(jpi,jj-1) ) )
266               ENDIF
267            END DO         
268            DO ji = 2, jpim1
269               IF( fmask(ji,1,jk) == 0._wp ) THEN
270                  fmask(ji, 1 ,jk) = rn_shlat * MIN( 1._wp , MAX( zwf(ji+1,1), zwf(ji,2), zwf(ji-1,1) ) )
271               ENDIF
272               IF( fmask(ji,jpj,jk) == 0._wp ) THEN
273                  fmask(ji,jpj,jk) = rn_shlat * MIN( 1._wp , MAX( zwf(ji+1,jpj), zwf(ji-1,jpj), zwf(ji,jpjm1) ) )
274               ENDIF
[3]275            END DO
276         END DO
[5836]277         !
278         !
[7646]279         CALL lbc_lnk( fmask, 'F', 1._wp )      ! Lateral boundary conditions on fmask
[3]280         !
[7646]281         ! CAUTION : The fmask may be further modified in dyn_vor_init ( dynvor.F90 ) depending on ln_vorlat
[5506]282         !
[2528]283      ENDIF
[7646]284     
285      ! User defined alteration of fmask (use to reduce ocean transport in specified straits)
286      ! --------------------------------
[2528]287      !
[7646]288      CALL usr_def_fmask( cn_cfg, nn_cfg, fmask )
[6140]289      !
[1566]290      !
[3294]291      IF( nn_timing == 1 )  CALL timing_stop('dom_msk')
292      !
[3]293   END SUBROUTINE dom_msk
294   
295   !!======================================================================
296END MODULE dommsk
Note: See TracBrowser for help on using the repository browser.