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.
limmsh_2.F90 in NEMO/branches/UKMO/r8395_restart_datestamp/NEMOGCM/NEMO/LIM_SRC_2 – NEMO

source: NEMO/branches/UKMO/r8395_restart_datestamp/NEMOGCM/NEMO/LIM_SRC_2/limmsh_2.F90 @ 10758

Last change on this file since 10758 was 10758, checked in by jcastill, 5 years ago

Remove svn keywords

File size: 12.1 KB
Line 
1MODULE limmsh_2
2   !!======================================================================
3   !!                     ***  MODULE  limmsh_2  ***
4   !! LIM 2.0 ice model :   definition of the ice mesh parameters
5   !!======================================================================
6   !! History :   -   ! 2001-04 (LIM) original code
7   !!            1.0  ! 2002-08 (C. Ethe, G. Madec) F90, module
8   !!            3.3  ! 2009-05 (G. Garric, C. Bricaud) addition of the lim2_evp case
9   !!----------------------------------------------------------------------
10#if defined key_lim2
11   !!----------------------------------------------------------------------
12   !!   'key_lim2'                                     LIM 2.0sea-ice model
13   !!----------------------------------------------------------------------
14   !!   lim_msh_2   : definition of the ice mesh
15   !!----------------------------------------------------------------------
16   USE phycst
17   USE dom_oce
18   USE dom_ice_2
19   USE lbclnk
20   USE in_out_manager
21   USE lib_mpp          ! MPP library
22#if defined key_lim2_vp
23   USE wrk_nemo         ! work arrays
24#endif
25   USE lib_fortran    ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined) 
26
27   IMPLICIT NONE
28   PRIVATE
29
30   PUBLIC lim_msh_2      ! routine called by ice_ini_2.F90
31
32   !!----------------------------------------------------------------------
33   !! NEMO/LIM2 3.3 , UCL - NEMO Consortium (2010)
34   !! $Id$
35   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
36   !!----------------------------------------------------------------------
37CONTAINS
38
39   SUBROUTINE lim_msh_2
40      !!-------------------------------------------------------------------
41      !!                  ***  ROUTINE lim_msh_2  ***
42      !!             
43      !! ** Purpose : Definition of the charact. of the numerical grid
44      !!       
45      !! ** Action  : - Initialisation of some variables
46      !!              - Definition of some constants linked with the grid
47      !!              - Definition of the metric coef. for the sea/ice
48      !!              - Initialization of the ice masks (tmsk, umsk)
49      !!
50      !! ** Refer.  : Deleersnijder et al. Ocean Modelling 100, 7-10
51      !!---------------------------------------------------------------------
52      INTEGER :: ji, jj      ! dummy loop indices
53      REAL(wp) ::   zusden   ! local scalars
54#if defined key_lim2_vp
55      REAL(wp) ::   zusden2           ! local scalars
56      REAL(wp) ::   zh1p  , zh2p      !   -      -
57      REAL(wp) ::   zd2d1p, zd1d2p    !   -      -
58      REAL(wp), POINTER, DIMENSION(:,:) ::   zd2d1, zd1d2   ! 2D workspace
59#endif
60      !!---------------------------------------------------------------------
61
62#if defined key_lim2_vp
63      CALL wrk_alloc( jpi, jpj, zd2d1, zd1d2 )
64#endif
65
66      IF(lwp) THEN
67         WRITE(numout,*)
68         WRITE(numout,*) 'lim_msh_2 : LIM 2.0 sea-ice model, mesh initialization'
69         WRITE(numout,*) '~~~~~~~~~'
70      ENDIF
71     
72      !----------------------------------------------------------                         
73      !    Initialization of local and some global (common) variables
74      !------------------------------------------------------------------
75     
76      njeq   = INT( jpj / 2 )   !i bug mpp potentiel
77      njeqm1 = njeq - 1 
78 
79!i    DO jj = 1, jpj
80!i       zmsk(jj) = SUM( tmask(:,jj,:) )   ! = 0          if land  everywhere on a j-line
81!!ii     write(numout,*) jj, zind(jj)
82!i    END DO
83
84      IF( ff_t(1,1) * ff_t(1,nlcj) < 0.e0 ) THEN   ! local domain include both hemisphere
85         l_jeq = .TRUE.
86         njeq  = 1
87         DO WHILE ( njeq <= jpj .AND. ff_t(1,njeq) < 0.e0 )
88            njeq = njeq + 1
89         END DO
90         IF(lwp ) WRITE(numout,*) '          the equator is inside the domain at about njeq = ', njeq
91      ELSEIF( ff_t(1,1) < 0.e0 ) THEN
92         l_jeq = .FALSE.
93         njeq = jpj
94         IF(lwp ) WRITE(numout,*) '          the model domain is entirely in the southern hemisphere: njeq = ', njeq
95      ELSE
96         l_jeq = .FALSE.
97         njeq = 2
98         IF(lwp ) WRITE(numout,*) '          the model domain is entirely in the northern hemisphere: njeq = ', njeq
99      ENDIF
100
101      njeqm1 = njeq - 1
102
103
104      !   For each grid, definition of geometric tables
105      !------------------------------------------------------------------
106     
107      !-------------------
108      ! Conventions :    !
109      !-------------------
110      !  indices 1 \ 2 <-> localisation in the 2 direction x \ y
111      !  3rd indice <-> localisation on the mesh :
112      !  0 = Centre ;  1 = corner W x(i-1/2) ; 2 = corner S y(j-1/2) ;
113      !  3 = corner SW x(i-1/2),y(j-1/2)
114      !-------------------
115!!ibug ???
116      wght(:,:,:,:) = 0.e0
117      tmu(:,:)      = 0.e0
118#if defined key_lim2_vp 
119      akappa(:,:,:,:)     = 0.e0
120      alambd(:,:,:,:,:,:) = 0.e0
121#else
122      tmv(:,:) = 0.e0
123      tmf(:,:) = 0.e0
124#endif
125!!i
126     
127
128#if defined key_lim2_vp     
129      ! metric coefficients for sea ice dynamic
130      !----------------------------------------
131      !                                                       ! akappa
132      DO jj = 2, jpj
133         zd1d2(:,jj) = e1v(:,jj) - e1v(:,jj-1)
134      END DO
135      CALL lbc_lnk( zd1d2, 'T', -1. )
136
137      DO ji = 2, jpi
138         zd2d1(ji,:) = e2u(ji,:) - e2u(ji-1,:)
139      END DO
140      CALL lbc_lnk( zd2d1, 'T', -1. )
141
142      akappa(:,:,1,1) =        1.0 / ( 2.0 * e1t(:,:) )
143      akappa(:,:,1,2) = zd1d2(:,:) / ( 4.0 * e1t(:,:) * e2t(:,:) )
144      akappa(:,:,2,1) = zd2d1(:,:) / ( 4.0 * e1t(:,:) * e2t(:,:) )
145      akappa(:,:,2,2) =        1.0 / ( 2.0 * e2t(:,:) )
146     
147      !                                                      ! weights (wght)
148      DO jj = 2, jpj
149         DO ji = 2, jpi
150            zusden = 1. / (  ( e1t(ji,jj) + e1t(ji-1,jj  ) )   &
151               &           * ( e2t(ji,jj) + e2t(ji  ,jj-1) ) )
152            wght(ji,jj,1,1) = zusden * e1t(ji  ,jj) * e2t(ji,jj  )
153            wght(ji,jj,1,2) = zusden * e1t(ji  ,jj) * e2t(ji,jj-1)
154            wght(ji,jj,2,1) = zusden * e1t(ji-1,jj) * e2t(ji,jj  )
155            wght(ji,jj,2,2) = zusden * e1t(ji-1,jj) * e2t(ji,jj-1)
156         END DO
157      END DO
158      CALL lbc_lnk( wght(:,:,1,1), 'I', 1. )      ! CAUTION: even with the lbc_lnk at ice U-V-point
159      CALL lbc_lnk( wght(:,:,1,2), 'I', 1. )      ! the value of wght at jpj is wrong
160      CALL lbc_lnk( wght(:,:,2,1), 'I', 1. )      ! but it is never used
161      CALL lbc_lnk( wght(:,:,2,2), 'I', 1. )
162#else
163      ! metric coefficients for sea ice dynamic (EVP rheology)
164      !----------------------------------------
165      DO jj = 1, jpjm1                                       ! weights (wght) at F-points
166         DO ji = 1, jpim1
167            zusden = 1. / (  ( e1t(ji+1,jj  ) + e1t(ji,jj) )   &
168               &           * ( e2t(ji  ,jj+1) + e2t(ji,jj) ) ) 
169            wght(ji,jj,1,1) = zusden * e1t(ji+1,jj) * e2t(ji,jj+1)
170            wght(ji,jj,1,2) = zusden * e1t(ji+1,jj) * e2t(ji,jj  )
171            wght(ji,jj,2,1) = zusden * e1t(ji  ,jj) * e2t(ji,jj+1)
172            wght(ji,jj,2,2) = zusden * e1t(ji  ,jj) * e2t(ji,jj  )
173         END DO
174      END DO
175      CALL lbc_lnk( wght(:,:,1,1), 'F', 1. )   ;   CALL lbc_lnk( wght(:,:,1,2),'F', 1. )       ! lateral boundary cond.   
176      CALL lbc_lnk( wght(:,:,2,1), 'F', 1. )   ;   CALL lbc_lnk( wght(:,:,2,2),'F', 1. )
177#endif
178   
179      ! Coefficients for divergence of the stress tensor
180      !-------------------------------------------------
181
182#if defined key_lim2_vp
183      DO jj = 2, jpj
184         DO ji = 2, jpi   ! NO vector opt.
185            zh1p  =  e1t(ji  ,jj  ) * wght(ji,jj,2,2)   &
186               &   + e1t(ji-1,jj  ) * wght(ji,jj,1,2)   &
187               &   + e1t(ji  ,jj-1) * wght(ji,jj,2,1)   &
188               &   + e1t(ji-1,jj-1) * wght(ji,jj,1,1)
189
190            zh2p  =  e2t(ji  ,jj  ) * wght(ji,jj,2,2)   &
191               &   + e2t(ji-1,jj  ) * wght(ji,jj,1,2)   &
192               &   + e2t(ji  ,jj-1) * wght(ji,jj,2,1)   &
193               &   + e2t(ji-1,jj-1) * wght(ji,jj,1,1)
194
195! better written but change the last digit and thus solver in less than 100 timestep
196!           zh1p  = e1t(ji-1,jj  ) * wght(ji,jj,1,2) + e1t(ji,jj  ) * wght(ji,jj,2,2)   &
197!              &  + e1t(ji-1,jj-1) * wght(ji,jj,1,1) + e1t(ji,jj-1) * wght(ji,jj,2,1)
198
199!           zh2p  = e2t(ji-1,jj  ) * wght(ji,jj,1,2) + e2t(ji,jj  ) * wght(ji,jj,2,2)   &
200!              &  + e2t(ji-1,jj-1) * wght(ji,jj,1,1) + e2t(ji,jj-1) * wght(ji,jj,2,1)
201
202!!ibug =0   zusden = 1.0 / ( zh1p * zh2p * 4.e0 )
203            zusden = 1.0 / MAX( zh1p * zh2p * 4.e0 , 1.e-20 )
204            zusden2 = zusden * 2.0 
205
206            zd1d2p = zusden * 0.5 * ( -e1t(ji-1,jj-1) + e1t(ji-1,jj  ) - e1t(ji,jj-1) + e1t(ji  ,jj)   )
207            zd2d1p = zusden * 0.5 * (  e2t(ji  ,jj-1) - e2t(ji-1,jj-1) + e2t(ji,jj  ) - e2t(ji-1,jj)   )
208
209            alambd(ji,jj,2,2,2,1) = zusden2 * e2t(ji  ,jj-1)
210            alambd(ji,jj,2,2,2,2) = zusden2 * e2t(ji  ,jj  )
211            alambd(ji,jj,2,2,1,1) = zusden2 * e2t(ji-1,jj-1)
212            alambd(ji,jj,2,2,1,2) = zusden2 * e2t(ji-1,jj  )
213
214            alambd(ji,jj,1,1,2,1) = zusden2 * e1t(ji  ,jj-1)
215            alambd(ji,jj,1,1,2,2) = zusden2 * e1t(ji  ,jj  )
216            alambd(ji,jj,1,1,1,1) = zusden2 * e1t(ji-1,jj-1)
217            alambd(ji,jj,1,1,1,2) = zusden2 * e1t(ji-1,jj  )
218
219            alambd(ji,jj,1,2,2,1) = zd1d2p
220            alambd(ji,jj,1,2,2,2) = zd1d2p
221            alambd(ji,jj,1,2,1,1) = zd1d2p
222            alambd(ji,jj,1,2,1,2) = zd1d2p
223
224            alambd(ji,jj,2,1,2,1) = zd2d1p
225            alambd(ji,jj,2,1,2,2) = zd2d1p
226            alambd(ji,jj,2,1,1,1) = zd2d1p
227            alambd(ji,jj,2,1,1,2) = zd2d1p
228         END DO
229      END DO
230
231      CALL lbc_lnk( alambd(:,:,2,2,2,1), 'I', 1. )      ! CAUTION: even with the lbc_lnk at ice U-V point
232      CALL lbc_lnk( alambd(:,:,2,2,2,2), 'I', 1. )      ! the value of wght at jpj is wrong
233      CALL lbc_lnk( alambd(:,:,2,2,1,1), 'I', 1. )      ! but it is never used
234      CALL lbc_lnk( alambd(:,:,2,2,1,2), 'I', 1. )      !
235
236      CALL lbc_lnk( alambd(:,:,1,1,2,1), 'I', 1. )      ! CAUTION: idem
237      CALL lbc_lnk( alambd(:,:,1,1,2,2), 'I', 1. )      !
238      CALL lbc_lnk( alambd(:,:,1,1,1,1), 'I', 1. )      !
239      CALL lbc_lnk( alambd(:,:,1,1,1,2), 'I', 1. )      !
240
241      CALL lbc_lnk( alambd(:,:,1,2,2,1), 'I', 1. )      ! CAUTION: idem
242      CALL lbc_lnk( alambd(:,:,1,2,2,2), 'I', 1. )      !
243      CALL lbc_lnk( alambd(:,:,1,2,1,1), 'I', 1. )      !
244      CALL lbc_lnk( alambd(:,:,1,2,1,2), 'I', 1. )      !
245
246      CALL lbc_lnk( alambd(:,:,2,1,2,1), 'I', 1. )      ! CAUTION: idem
247      CALL lbc_lnk( alambd(:,:,2,1,2,2), 'I', 1. )      !
248      CALL lbc_lnk( alambd(:,:,2,1,1,1), 'I', 1. )      !
249      CALL lbc_lnk( alambd(:,:,2,1,1,2), 'I', 1. )      !
250#endif
251           
252
253      ! Initialization of ice masks
254      !----------------------------
255     
256      tms(:,:) = tmask(:,:,1)      ! ice T-point  : use surface tmask
257
258#if defined key_lim2_vp
259      ! VP rheology : ice velocity point is I-point
260!i here we can use umask with a i and j shift of -1,-1
261      tmu(:,1) = 0.e0
262      tmu(1,:) = 0.e0
263      DO jj = 2, jpj               ! ice U.V-point: computed from ice T-point mask
264         DO ji = 2, jpim1   ! NO vector opt.
265            tmu(ji,jj) =  tms(ji,jj) * tms(ji-1,jj) * tms(ji,jj-1) * tms(ji-1,jj-1)           
266         END DO
267      END DO
268      CALL lbc_lnk( tmu(:,:), 'I', 1. )      !--lateral boundary conditions   
269#else
270      ! EVP rheology : ice velocity point are U- & V-points ; ice vorticity
271      ! point is F-point
272      tmu(:,:) = umask(:,:,1)
273      tmv(:,:) = vmask(:,:,1)
274      tmf(:,:) = 0.e0                        ! used of fmask except its special value along the coast (rn_shlat)
275      WHERE( fmask(:,:,1) == 1.e0 )   tmf(:,:) = 1.e0
276#endif
277      !
278      ! unmasked and masked area of T-grid cell
279      area(:,:) = e1t(:,:) * e2t(:,:)
280      !
281#if defined key_lim2_vp
282      CALL wrk_dealloc( jpi, jpj, zd2d1, zd1d2 )
283#endif
284      !
285   END SUBROUTINE lim_msh_2
286
287#else
288   !!----------------------------------------------------------------------
289   !!   Default option            Dummy Module         NO LIM sea-ice model
290   !!----------------------------------------------------------------------
291CONTAINS
292   SUBROUTINE lim_msh_2           ! Dummy routine
293   END SUBROUTINE lim_msh_2
294#endif
295
296   !!======================================================================
297END MODULE limmsh_2
Note: See TracBrowser for help on using the repository browser.