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.
usrdef_zgr.F90 in NEMO/branches/2020/dev_r13327_KERNEL-06_2_techene_e3/tests/AM98/MY_SRC – NEMO

source: NEMO/branches/2020/dev_r13327_KERNEL-06_2_techene_e3/tests/AM98/MY_SRC/usrdef_zgr.F90 @ 13503

Last change on this file since 13503 was 13503, checked in by techene, 4 years ago

files copied from dev_r12527_Gurvan_ShallowWater see #2385
File size: 12.8 KB
Line 
1MODULE usrdef_zgr
2   !!======================================================================
3   !!                       ***  MODULE  usrdef_zgr  ***
4   !!
5   !!                       ===  AM98 configuration  ===
6   !!
7   !! User defined : vertical coordinate system of a user configuration
8   !!======================================================================
9   !! History :  4.0  ! 2016-06  (G. Madec)  Original code
10   !!----------------------------------------------------------------------
11
12   !!----------------------------------------------------------------------
13   !!   usr_def_zgr   : user defined vertical coordinate system
14   !!      zgr_z      : reference 1D z-coordinate
15   !!      zgr_top_bot: ocean top and bottom level indices
16   !!      zgr_zco    : 3D verticl coordinate in pure z-coordinate case
17   !!---------------------------------------------------------------------
18   USE oce            ! ocean variables
19   USE dom_oce        ! ocean domain
20   USE depth_e3       ! depth <=> e3
21   USE usrdef_nam
22   !
23   USE in_out_manager ! I/O manager
24   USE lbclnk         ! ocean lateral boundary conditions (or mpp link)
25   USE lib_mpp        ! distributed memory computing library
26
27   IMPLICIT NONE
28   PRIVATE
29
30   PUBLIC   usr_def_zgr        ! called by domzgr.F90
31
32   !!----------------------------------------------------------------------
33   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
34   !! $Id: usrdef_zgr.F90 10425 2018-12-19 21:54:16Z smasson $
35   !! Software governed by the CeCILL license (see ./LICENSE)
36   !!----------------------------------------------------------------------
37CONTAINS             
38
39   SUBROUTINE usr_def_zgr( ld_zco  , ld_zps  , ld_sco  , ld_isfcav,    &   ! type of vertical coordinate
40      &                    pdept_1d, pdepw_1d, pe3t_1d , pe3w_1d  ,    &   ! 1D reference vertical coordinate
41      &                    pdept , pdepw ,                             &   ! 3D t & w-points depth
42      &                    pe3t  , pe3u  , pe3v   , pe3f ,             &   ! vertical scale factors
43      &                    pe3w  , pe3uw , pe3vw         ,             &   !     -      -      -
44      &                    k_top , k_bot                 )                 ! top & bottom ocean level
45      !!---------------------------------------------------------------------
46      !!              ***  ROUTINE usr_def_zgr  ***
47      !!
48      !! ** Purpose :   User defined the vertical coordinates
49      !!
50      !!----------------------------------------------------------------------
51      LOGICAL                   , INTENT(out) ::   ld_zco, ld_zps, ld_sco      ! vertical coordinate flags
52      LOGICAL                   , INTENT(out) ::   ld_isfcav                   ! under iceshelf cavity flag
53      REAL(wp), DIMENSION(:)    , INTENT(out) ::   pdept_1d, pdepw_1d          ! 1D grid-point depth     [m]
54      REAL(wp), DIMENSION(:)    , INTENT(out) ::   pe3t_1d , pe3w_1d           ! 1D grid-point depth     [m]
55      REAL(wp), DIMENSION(:,:,:), INTENT(out) ::   pdept, pdepw                ! grid-point depth        [m]
56      REAL(wp), DIMENSION(:,:,:), INTENT(out) ::   pe3t , pe3u , pe3v , pe3f   ! vertical scale factors  [m]
57      REAL(wp), DIMENSION(:,:,:), INTENT(out) ::   pe3w , pe3uw, pe3vw         ! i-scale factors
58      INTEGER , DIMENSION(:,:)  , INTENT(out) ::   k_top, k_bot                ! first & last ocean level
59      !
60      INTEGER  ::   inum   ! local logical unit
61      REAL(WP) ::   z_zco, z_zps, z_sco, z_cav
62      REAL(wp), DIMENSION(jpi,jpj) ::   z2d   ! 2D workspace
63      !!----------------------------------------------------------------------
64      !
65      IF(lwp) WRITE(numout,*)
66      IF(lwp) WRITE(numout,*) 'usr_def_zgr : AM98 configuration (z-coordinate closed flat box ocean without cavities)'
67      IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
68      !
69      !
70      ! type of vertical coordinate
71      ! ---------------------------
72      ld_zco    = .FALSE.         ! AM98 case:  z-coordinate without ocean cavities
73      ld_zps    = .FALSE.
74      ld_sco    = .TRUE.
75      ld_isfcav = .FALSE.
76      !
77      !
78      ! Build the vertical coordinate system
79      ! ------------------------------------
80      CALL zgr_z( pdept_1d, pdepw_1d, pe3t_1d , pe3w_1d )   ! Reference z-coordinate system
81      !
82      CALL zgr_msk_top_bot( k_top , k_bot)                 ! masked top and bottom ocean t-level indices
83      !
84      !                                                     ! z-coordinate (3D arrays) from the 1D z-coord.
85      CALL zgr_zco( pdept_1d, pdepw_1d, pe3t_1d, pe3w_1d,   &   ! in  : 1D reference vertical coordinate
86         &          pdept   , pdepw   ,                     &   ! out : 3D t & w-points depth
87         &          pe3t    , pe3u    , pe3v   , pe3f   ,   &   !       vertical scale factors
88         &          pe3w    , pe3uw   , pe3vw             )     !           -      -      -
89      !
90   END SUBROUTINE usr_def_zgr
91
92
93   SUBROUTINE zgr_z( pdept_1d, pdepw_1d, pe3t_1d , pe3w_1d )   ! 1D reference vertical coordinate
94      !!----------------------------------------------------------------------
95      !!                   ***  ROUTINE zgr_z  ***
96      !!
97      !! ** Purpose :   set the 1D depth of model levels and the resulting
98      !!              vertical scale factors.
99      !!
100      !! ** Method  :   1D z-coordinate system (use in all type of coordinate)
101      !!       The depth of model levels is set from dep(k), an analytical function:
102      !!                   w-level: depw_1d  = dep(k)
103      !!                   t-level: dept_1d  = dep(k+0.5)
104      !!       The scale factors are the discrete derivative of the depth:
105      !!                   e3w_1d(jk) = dk[ dept_1d ]
106      !!                   e3t_1d(jk) = dk[ depw_1d ]
107      !!           with at top and bottom :
108      !!                   e3w_1d( 1 ) = 2 * ( dept_1d( 1 ) - depw_1d( 1 ) )
109      !!                   e3t_1d(jpk) = 2 * ( dept_1d(jpk) - depw_1d(jpk) )
110      !!       The depth are then re-computed from the sum of e3. This ensures
111      !!    that depths are identical when reading domain configuration file.
112      !!    Indeed, only e3. are saved in this file, depth are compute by a call
113      !!    to the e3_to_depth subroutine.
114      !!
115      !!       Here the Madec & Imbard (1996) function is used.
116      !!
117      !! ** Action  : - pdept_1d, pdepw_1d : depth of T- and W-point (m)
118      !!              - pe3t_1d , pe3w_1d  : scale factors at T- and W-levels (m)
119      !!
120      !! Reference : Marti, Madec & Delecluse, 1992, JGR, 97, No8, 12,763-12,766.
121      !!             Madec and Imbard, 1996, Clim. Dyn.
122      !!----------------------------------------------------------------------
123      REAL(wp), DIMENSION(:)    , INTENT(out) ::   pdept_1d, pdepw_1d   ! 1D grid-point depth        [m]
124      REAL(wp), DIMENSION(:)    , INTENT(out) ::   pe3t_1d , pe3w_1d    ! 1D vertical scale factors  [m]
125      !
126      INTEGER  ::   jk       ! dummy loop indices
127        !!----------------------------------------------------------------------
128      !
129        !
130      IF(lwp) THEN            ! Parameter print
131         WRITE(numout,*)
132         WRITE(numout,*) '    zgr_z   : Reference vertical z-coordinates '
133         WRITE(numout,*) '    ~~~~~~~'
134      ENDIF
135
136      !
137      ! 1D Reference z-coordinate    (using Madec & Imbard 1996 function)
138      ! -------------------------
139      !
140      ! depth at T and W-points
141      pdepw_1d(1) =   0._wp
142      pdept_1d(1) = 250._wp
143      !
144      pdepw_1d(2) = 500._wp
145      pdept_1d(2) = 750._wp
146      !
147      !                       ! e3t and e3w from depth
148      CALL depth_to_e3( pdept_1d, pdepw_1d, pe3t_1d, pe3w_1d ) 
149      !
150      !                       ! recompute depths from SUM(e3)  <== needed
151      CALL e3_to_depth( pe3t_1d, pe3w_1d, pdept_1d, pdepw_1d ) 
152      !
153      IF(lwp) THEN                        ! control print
154         WRITE(numout,*)
155         WRITE(numout,*) '              Reference 1D z-coordinate depth and scale factors:'
156         WRITE(numout, "(9x,' level  gdept_1d  gdepw_1d  e3t_1d   e3w_1d  ')" )
157         WRITE(numout, "(10x, i4, 4f9.2)" ) ( jk, pdept_1d(jk), pdepw_1d(jk), pe3t_1d(jk), pe3w_1d(jk), jk = 1, jpk )
158      ENDIF
159      !
160   END SUBROUTINE zgr_z
161
162
163
164
165   SUBROUTINE zgr_msk_top_bot( k_top , k_bot)
166      !!----------------------------------------------------------------------
167      !!                    ***  ROUTINE zgr_msk_top_bot  ***
168      !!
169      !! ** Purpose :   set the masked top and bottom ocean t-levels
170      !!
171      !! ** Method  :   AM98 case = closed flat box ocean without ocean cavities
172      !!                   k_top = 1     except along north, south, east and west boundaries
173      !!                   k_bot = jpk-1 except along north, south, east and west boundaries
174      !!
175      !! ** Action  : - k_top : first wet ocean level index
176      !!              - k_bot : last  wet ocean level index
177      !!----------------------------------------------------------------------
178      INTEGER , DIMENSION(:,:), INTENT(out) ::   k_top , k_bot   ! first & last wet ocean level
179      !
180      REAL(wp), DIMENSION(jpi,jpj) ::   z2d   ! 2D local workspace
181      INTEGER  ::   ji, jj                    ! dummy loop indices
182      REAL(wp) ::   zylim0, zylim1, zxlim0, zxlim1 ! limit of the domain [m]
183      REAL(WP) ::   zcoeff    ! local scalar
184      !!----------------------------------------------------------------------
185      !
186      IF(lwp) WRITE(numout,*)
187      IF(lwp) WRITE(numout,*) '    zgr_top_bot : defines the top and bottom wet ocean levels.'
188      IF(lwp) WRITE(numout,*) '    ~~~~~~~~~~~'
189      IF(lwp) WRITE(numout,*) '       AM98 case : closed flat box ocean without ocean cavities'
190      !
191      z2d(:,:) = REAL( jpkm1 , wp )          ! flat bottom
192      !
193      CALL lbc_lnk( 'usrdef_zgr', z2d, 'T', 1. )           ! set surrounding land to zero (here jperio=0 ==>> closed)
194      !
195      !
196      zylim0 =   10000._wp    ! +10km
197      zylim1 = 2010000._wp    ! 2010km
198      zxlim0 =   10000._wp    ! +10km
199      zxlim1 = 2010000._wp    ! 2010km
200      !
201      DO jj = 1, jpj
202         DO ji = 1, jpi
203         ! if T point in the 2000 km x 2000 km domain
204         ! IF ( gphit(ji,jj) > zylim0 .AND. gphit(ji,jj) < zylim1 .AND. &
205         !   & glamt(ji,jj) > zxlim0 .AND. glamt(ji,jj) < zxlim1       )  THEN
206         ! if U,V points are in the 2000 km x 2000 km domain
207         IF ( gphiv(ji,jj) > zylim0 .AND. gphiv(ji,jj) < zylim1 .AND. & 
208            & glamu(ji,jj) > zxlim0 .AND. glamu(ji,jj) < zxlim1       )  THEN
209         k_top(ji,jj) = 1    ! = ocean
210         k_bot(ji,jj) = NINT( z2d(ji,jj) )
211         ELSE
212         k_top(ji,jj) = 0    ! = land
213         k_bot(ji,jj) = 0
214         END IF
215         END DO
216      END DO
217      ! mask the lonely corners
218      DO jj = 2, jpim1
219         DO ji = 2, jpim1
220         zcoeff = k_top(ji+1,jj) + k_top(ji,jj+1)   &
221            +     k_top(ji-1,jj) + k_top(ji,jj-1)
222         IF ( zcoeff <= 1._wp )   THEN
223            k_top(ji,jj) = 0    ! = land
224            k_bot(ji,jj) = 0
225         END IF
226         END DO
227      END DO
228      !
229      !
230   END SUBROUTINE zgr_msk_top_bot
231   
232
233   SUBROUTINE zgr_zco( pdept_1d, pdepw_1d, pe3t_1d, pe3w_1d,   &   ! in : 1D reference vertical coordinate
234      &                pdept   , pdepw   ,                     &   ! out: 3D t & w-points depth
235      &                pe3t    , pe3u    , pe3v   , pe3f   ,   &   !      vertical scale factors
236      &                pe3w    , pe3uw   , pe3vw             )     !          -      -      -
237      !!----------------------------------------------------------------------
238      !!                  ***  ROUTINE zgr_zco  ***
239      !!
240      !! ** Purpose :   define the reference z-coordinate system
241      !!
242      !! ** Method  :   set 3D coord. arrays to reference 1D array
243      !!----------------------------------------------------------------------
244      REAL(wp), DIMENSION(:)    , INTENT(in   ) ::   pdept_1d, pdepw_1d          ! 1D grid-point depth       [m]
245      REAL(wp), DIMENSION(:)    , INTENT(in   ) ::   pe3t_1d , pe3w_1d           ! 1D vertical scale factors [m]
246      REAL(wp), DIMENSION(:,:,:), INTENT(  out) ::   pdept, pdepw                ! grid-point depth          [m]
247      REAL(wp), DIMENSION(:,:,:), INTENT(  out) ::   pe3t , pe3u , pe3v , pe3f   ! vertical scale factors    [m]
248      REAL(wp), DIMENSION(:,:,:), INTENT(  out) ::   pe3w , pe3uw, pe3vw         !    -       -      -
249      !
250      INTEGER  ::   jk
251      !!----------------------------------------------------------------------
252      !
253      DO jk = 1, jpk
254         pdept(:,:,jk) = pdept_1d(jk)
255         pdepw(:,:,jk) = pdepw_1d(jk)
256         pe3t (:,:,jk) = pe3t_1d (jk)
257         pe3u (:,:,jk) = pe3t_1d (jk)
258         pe3v (:,:,jk) = pe3t_1d (jk)
259         pe3f (:,:,jk) = pe3t_1d (jk)
260         pe3w (:,:,jk) = pe3w_1d (jk)
261         pe3uw(:,:,jk) = pe3w_1d (jk)
262         pe3vw(:,:,jk) = pe3w_1d (jk)
263      END DO
264      !
265   END SUBROUTINE zgr_zco
266
267   !!======================================================================
268END MODULE usrdef_zgr
Note: See TracBrowser for help on using the repository browser.