| 1 | MODULE dommsk |
|---|
| 2 | !!====================================================================== |
|---|
| 3 | !! *** MODULE dommsk *** |
|---|
| 4 | !! Ocean initialization : domain land/sea masks, off-line case |
|---|
| 5 | !!====================================================================== |
|---|
| 6 | !! History : 3.3 ! 2010-10 (C. Ethe) adapted from OPA_SRC/DOM/dommsk |
|---|
| 7 | !!---------------------------------------------------------------------- |
|---|
| 8 | |
|---|
| 9 | !!---------------------------------------------------------------------- |
|---|
| 10 | !! dom_msk : compute land/ocean mask |
|---|
| 11 | !!---------------------------------------------------------------------- |
|---|
| 12 | USE oce ! ocean dynamics and tracers |
|---|
| 13 | USE dom_oce ! ocean space and time domain |
|---|
| 14 | USE lib_mpp ! MPP library |
|---|
| 15 | USE in_out_manager ! I/O manager |
|---|
| 16 | USE wrk_nemo |
|---|
| 17 | USE lbclnk |
|---|
| 18 | |
|---|
| 19 | IMPLICIT NONE |
|---|
| 20 | PRIVATE |
|---|
| 21 | |
|---|
| 22 | PUBLIC dom_msk ! routine called by inidom.F90 |
|---|
| 23 | |
|---|
| 24 | REAL(wp) :: rn_shlat = 2. ! type of lateral boundary condition on velocity |
|---|
| 25 | LOGICAL, PUBLIC :: ln_vorlat = .false. ! consistency of vorticity boundary condition |
|---|
| 26 | |
|---|
| 27 | !! * Substitutions |
|---|
| 28 | # include "vectopt_loop_substitute.h90" |
|---|
| 29 | !!---------------------------------------------------------------------- |
|---|
| 30 | !! NEMO/OFF 3.3 , NEMO Consortium (2010) |
|---|
| 31 | !! $Id$ |
|---|
| 32 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
|---|
| 33 | !!---------------------------------------------------------------------- |
|---|
| 34 | CONTAINS |
|---|
| 35 | |
|---|
| 36 | SUBROUTINE dom_msk |
|---|
| 37 | !!--------------------------------------------------------------------- |
|---|
| 38 | !! *** ROUTINE dom_msk *** |
|---|
| 39 | !! |
|---|
| 40 | !! ** Purpose : Off-line case: defines the interior domain T-mask. |
|---|
| 41 | !! |
|---|
| 42 | !! ** Method : The interior ocean/land mask is computed from tmask |
|---|
| 43 | !! setting to zero the duplicated row and lines due to |
|---|
| 44 | !! MPP exchange halos, est-west cyclic and north fold |
|---|
| 45 | !! boundary conditions. |
|---|
| 46 | !! |
|---|
| 47 | !! ** Action : tmask_i : interiorland/ocean mask at t-point |
|---|
| 48 | !! tpol : ??? |
|---|
| 49 | !!---------------------------------------------------------------------- |
|---|
| 50 | ! |
|---|
| 51 | INTEGER :: ji, jj, jk ! dummy loop indices |
|---|
| 52 | INTEGER :: iif, iil, ijf, ijl ! local integers |
|---|
| 53 | ! |
|---|
| 54 | !!--------------------------------------------------------------------- |
|---|
| 55 | |
|---|
| 56 | ! |
|---|
| 57 | ! Interior domain mask (used for global sum) |
|---|
| 58 | ! -------------------- |
|---|
| 59 | ssmask(:,:) = tmask(:,:,1) |
|---|
| 60 | tmask_i(:,:) = tmask(:,:,1) |
|---|
| 61 | iif = jpreci ! thickness of exchange halos in i-axis |
|---|
| 62 | iil = nlci - jpreci + 1 |
|---|
| 63 | ijf = jprecj ! thickness of exchange halos in j-axis |
|---|
| 64 | ijl = nlcj - jprecj + 1 |
|---|
| 65 | ! |
|---|
| 66 | tmask_i( 1 :iif, : ) = 0._wp ! first columns |
|---|
| 67 | tmask_i(iil:jpi, : ) = 0._wp ! last columns (including mpp extra columns) |
|---|
| 68 | tmask_i( : , 1 :ijf) = 0._wp ! first rows |
|---|
| 69 | tmask_i( : ,ijl:jpj) = 0._wp ! last rows (including mpp extra rows) |
|---|
| 70 | ! |
|---|
| 71 | ! ! north fold mask |
|---|
| 72 | tpol(1:jpiglo) = 1._wp |
|---|
| 73 | ! |
|---|
| 74 | IF( jperio == 3 .OR. jperio == 4 ) tpol(jpiglo/2+1:jpiglo) = 0._wp ! T-point pivot |
|---|
| 75 | IF( jperio == 5 .OR. jperio == 6 ) tpol( 1 :jpiglo) = 0._wp ! F-point pivot |
|---|
| 76 | IF( jperio == 3 .OR. jperio == 4 ) THEN ! T-point pivot: only half of the nlcj-1 row |
|---|
| 77 | IF( mjg(ijl-1) == jpjglo-1 ) THEN |
|---|
| 78 | DO ji = iif+1, iil-1 |
|---|
| 79 | tmask_i(ji,ijl-1) = tmask_i(ji,ijl-1) * tpol(mig(ji)) |
|---|
| 80 | END DO |
|---|
| 81 | ENDIF |
|---|
| 82 | ENDIF |
|---|
| 83 | ! |
|---|
| 84 | ! (ISF) MIN(1,SUM(umask)) is here to check if you have effectively at |
|---|
| 85 | ! least 1 wet u point |
|---|
| 86 | DO jj = 1, jpjm1 |
|---|
| 87 | DO ji = 1, fs_jpim1 ! vector loop |
|---|
| 88 | ssumask(ji,jj) = ssmask(ji,jj) * ssmask(ji+1,jj ) * MIN(1._wp,SUM(umask(ji,jj,:))) |
|---|
| 89 | ssvmask(ji,jj) = ssmask(ji,jj) * ssmask(ji ,jj+1) * MIN(1._wp,SUM(vmask(ji,jj,:))) |
|---|
| 90 | END DO |
|---|
| 91 | DO ji = 1, jpim1 ! NO vector opt. |
|---|
| 92 | ssfmask(ji,jj) = ssmask(ji,jj ) * ssmask(ji+1,jj ) & |
|---|
| 93 | & * ssmask(ji,jj+1) * ssmask(ji+1,jj+1) * MIN(1._wp,SUM(fmask(ji,jj,:))) |
|---|
| 94 | END DO |
|---|
| 95 | END DO |
|---|
| 96 | CALL lbc_lnk( ssumask, 'U', 1._wp ) ! Lateral boundary conditions |
|---|
| 97 | CALL lbc_lnk( ssvmask, 'V', 1._wp ) |
|---|
| 98 | CALL lbc_lnk( ssfmask, 'F', 1._wp ) |
|---|
| 99 | |
|---|
| 100 | ! 3. Ocean/land mask at wu-, wv- and w points |
|---|
| 101 | !---------------------------------------------- |
|---|
| 102 | wmask (:,:,1) = tmask(:,:,1) ! ???????? |
|---|
| 103 | wumask(:,:,1) = umask(:,:,1) ! ???????? |
|---|
| 104 | wvmask(:,:,1) = vmask(:,:,1) ! ???????? |
|---|
| 105 | DO jk=2,jpk |
|---|
| 106 | wmask (:,:,jk)=tmask(:,:,jk) * tmask(:,:,jk-1) |
|---|
| 107 | wumask(:,:,jk)=umask(:,:,jk) * umask(:,:,jk-1) |
|---|
| 108 | wvmask(:,:,jk)=vmask(:,:,jk) * vmask(:,:,jk-1) |
|---|
| 109 | END DO |
|---|
| 110 | ! |
|---|
| 111 | ! |
|---|
| 112 | ! |
|---|
| 113 | END SUBROUTINE dom_msk |
|---|
| 114 | !!====================================================================== |
|---|
| 115 | END MODULE dommsk |
|---|
