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.
domwri.F90 in branches/UKMO/dev_isf_remapping_UKESM_GO6package_r9314/NEMOGCM/NEMO/OPA_SRC/DOM – NEMO

source: branches/UKMO/dev_isf_remapping_UKESM_GO6package_r9314/NEMOGCM/NEMO/OPA_SRC/DOM/domwri.F90 @ 11248

Last change on this file since 11248 was 9853, checked in by mathiot, 6 years ago

update to dev_r5518_GO6_package@9321 to avoid conflict during merge
File size: 19.0 KB
Line 
1MODULE domwri
2   !!======================================================================
3   !!                       ***  MODULE domwri  ***
4   !! Ocean initialization : write the ocean domain mesh file(s)
5   !!======================================================================
6   !! History :  OPA  ! 1997-02  (G. Madec)  Original code
7   !!            8.1  ! 1999-11  (M. Imbard)  NetCDF FORMAT with IOIPSL
8   !!   NEMO     1.0  ! 2002-08  (G. Madec)  F90 and several file
9   !!            3.0  ! 2008-01  (S. Masson) add dom_uniq
10   !!            4.0  ! 2011-01  (A. R. Porter, STFC Daresbury) dynamical allocation
11   !!----------------------------------------------------------------------
12
13   !!----------------------------------------------------------------------
14   !!   dom_wri        : create and write mesh and mask file(s)
15   !!   dom_uniq       :
16   !!----------------------------------------------------------------------
17   USE dom_oce         ! ocean space and time domain
18   USE in_out_manager  ! I/O manager
19   USE iom             ! I/O library
20   USE lbclnk          ! lateral boundary conditions - mpp exchanges
21   USE lib_mpp         ! MPP library
22   USE wrk_nemo        ! Memory allocation
23   USE timing          ! Timing
24
25   IMPLICIT NONE
26   PRIVATE
27
28   PUBLIC dom_wri        ! routine called by inidom.F90
29
30   !! * Substitutions
31#  include "vectopt_loop_substitute.h90"
32   !!----------------------------------------------------------------------
33   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
34   !! $Id$
35   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
36   !!----------------------------------------------------------------------
37CONTAINS
38
39   SUBROUTINE dom_wri
40      !!----------------------------------------------------------------------
41      !!                  ***  ROUTINE dom_wri  ***
42      !!                   
43      !! ** Purpose :   Create the NetCDF file(s) which contain(s) all the
44      !!      ocean domain informations (mesh and mask arrays). This (these)
45      !!      file(s) is (are) used for visualisation (SAXO software) and
46      !!      diagnostic computation.
47      !!
48      !! ** Method  :   Write in a file all the arrays generated in routines
49      !!      domhgr, domzgr, and dommsk. Note: the file contain depends on
50      !!      the vertical coord. used (z-coord, partial steps, s-coord)
51      !!            MOD(nmsh, 3) = 1  :   'mesh_mask.nc' file
52      !!                         = 2  :   'mesh.nc' and mask.nc' files
53      !!                         = 0  :   'mesh_hgr.nc', 'mesh_zgr.nc' and
54      !!                                  'mask.nc' files
55      !!      For huge size domain, use option 2 or 3 depending on your
56      !!      vertical coordinate.
57      !!
58      !!      if     nmsh <= 3: write full 3D arrays for e3[tuvw] and gdep[tuvw]
59      !!      if 3 < nmsh <= 6: write full 3D arrays for e3[tuvw] and 2D arrays
60      !!                        corresponding to the depth of the bottom t- and w-points
61      !!      if 6 < nmsh <= 9: write 2D arrays corresponding to the depth and the
62      !!                        thickness (e3[tw]_ps) of the bottom points
63      !!
64      !! ** output file :   meshmask.nc  : domain size, horizontal grid-point position,
65      !!                                   masks, depth and vertical scale factors
66      !!----------------------------------------------------------------------
67      !!
68      INTEGER           ::   inum0    ! temprary units for 'mesh_mask.nc' file
69      INTEGER           ::   inum1    ! temprary units for 'mesh.nc'      file
70      INTEGER           ::   inum2    ! temprary units for 'mask.nc'      file
71      INTEGER           ::   inum3    ! temprary units for 'mesh_hgr.nc'  file
72      INTEGER           ::   inum4    ! temprary units for 'mesh_zgr.nc'  file
73      CHARACTER(len=21) ::   clnam0   ! filename (mesh and mask informations)
74      CHARACTER(len=21) ::   clnam1   ! filename (mesh informations)
75      CHARACTER(len=21) ::   clnam2   ! filename (mask informations)
76      CHARACTER(len=21) ::   clnam3   ! filename (horizontal mesh informations)
77      CHARACTER(len=21) ::   clnam4   ! filename (vertical   mesh informations)
78      INTEGER           ::   ji, jj, jk   ! dummy loop indices
79      !                                   !  workspaces
80      REAL(wp), POINTER, DIMENSION(:,:  ) :: zprt, zprw 
81      REAL(wp), POINTER, DIMENSION(:,:,:) :: zdepu, zdepv
82      !!----------------------------------------------------------------------
83      !
84      IF( nn_timing == 1 )  CALL timing_start('dom_wri')
85      !
86      CALL wrk_alloc( jpi, jpj, zprt, zprw )
87      CALL wrk_alloc( jpi, jpj, jpk, zdepu, zdepv )
88      !
89      IF(lwp) WRITE(numout,*)
90      IF(lwp) WRITE(numout,*) 'dom_wri : create NetCDF mesh and mask information file(s)'
91      IF(lwp) WRITE(numout,*) '~~~~~~~'
92     
93      clnam0 = 'mesh_mask'  ! filename (mesh and mask informations)
94      clnam1 = 'mesh'       ! filename (mesh informations)
95      clnam2 = 'mask'       ! filename (mask informations)
96      clnam3 = 'mesh_hgr'   ! filename (horizontal mesh informations)
97      clnam4 = 'mesh_zgr'   ! filename (vertical   mesh informations)
98     
99      SELECT CASE ( MOD(nmsh, 3) )
100         !                                  ! ============================
101      CASE ( 1 )                            !  create 'mesh_mask.nc' file
102         !                                  ! ============================
103         CALL iom_open( TRIM(clnam0), inum0, ldwrt = .TRUE., kiolib = jprstlib )
104         inum2 = inum0                                            ! put all the informations
105         inum3 = inum0                                            ! in unit inum0
106         inum4 = inum0
107         
108         !                                  ! ============================
109      CASE ( 2 )                            !  create 'mesh.nc' and
110         !                                  !         'mask.nc' files
111         !                                  ! ============================
112         CALL iom_open( TRIM(clnam1), inum1, ldwrt = .TRUE., kiolib = jprstlib )
113         CALL iom_open( TRIM(clnam2), inum2, ldwrt = .TRUE., kiolib = jprstlib )
114         inum3 = inum1                                            ! put mesh informations
115         inum4 = inum1                                            ! in unit inum1
116         !                                  ! ============================
117      CASE ( 0 )                            !  create 'mesh_hgr.nc'
118         !                                  !         'mesh_zgr.nc' and
119         !                                  !         'mask.nc'     files
120         !                                  ! ============================
121         CALL iom_open( TRIM(clnam2), inum2, ldwrt = .TRUE., kiolib = jprstlib )
122         CALL iom_open( TRIM(clnam3), inum3, ldwrt = .TRUE., kiolib = jprstlib )
123         CALL iom_open( TRIM(clnam4), inum4, ldwrt = .TRUE., kiolib = jprstlib )
124         !
125      END SELECT
126     
127      !                                                         ! masks (inum2)
128      IF(nn_timing == 2)  CALL timing_start('iom_rstput')
129      CALL iom_rstput( 0, 0, inum2, 'tmask', tmask, ktype = jp_i1 )     !    ! land-sea mask
130      CALL iom_rstput( 0, 0, inum2, 'umask', umask, ktype = jp_i1 )
131      CALL iom_rstput( 0, 0, inum2, 'vmask', vmask, ktype = jp_i1 )
132      CALL iom_rstput( 0, 0, inum2, 'fmask', fmask, ktype = jp_i1 )
133      IF(nn_timing == 2)  CALL timing_stop('iom_rstput')
134     
135      CALL dom_uniq( zprw, 'T' )
136      DO jj = 1, jpj
137         DO ji = 1, jpi
138            jk=mikt(ji,jj) 
139            zprt(ji,jj) = tmask(ji,jj,jk) * zprw(ji,jj)                        !    ! unique point mask
140         END DO
141      END DO                             !    ! unique point mask
142      IF(nn_timing == 2)  CALL timing_start('iom_rstput')
143      CALL iom_rstput( 0, 0, inum2, 'tmaskutil', zprt, ktype = jp_i1 ) 
144      IF(nn_timing == 2)  CALL timing_stop('iom_rstput')
145      CALL dom_uniq( zprw, 'U' )
146      DO jj = 1, jpj
147         DO ji = 1, jpi
148            jk=miku(ji,jj) 
149            zprt(ji,jj) = umask(ji,jj,jk) * zprw(ji,jj)                        !    ! unique point mask
150         END DO
151      END DO
152      IF(nn_timing == 2)  CALL timing_start('iom_rstput')
153      CALL iom_rstput( 0, 0, inum2, 'umaskutil', zprt, ktype = jp_i1 ) 
154      IF(nn_timing == 2)  CALL timing_stop('iom_rstput')
155      CALL dom_uniq( zprw, 'V' )
156      DO jj = 1, jpj
157         DO ji = 1, jpi
158            jk=mikv(ji,jj) 
159            zprt(ji,jj) = vmask(ji,jj,jk) * zprw(ji,jj)                        !    ! unique point mask
160         END DO
161      END DO
162      IF(nn_timing == 2)  CALL timing_start('iom_rstput')
163      CALL iom_rstput( 0, 0, inum2, 'vmaskutil', zprt, ktype = jp_i1 ) 
164      IF(nn_timing == 2)  CALL timing_stop('iom_rstput')
165      CALL dom_uniq( zprw, 'F' )
166      DO jj = 1, jpj
167         DO ji = 1, jpi
168            jk=mikf(ji,jj) 
169            zprt(ji,jj) = fmask(ji,jj,jk) * zprw(ji,jj)                        !    ! unique point mask
170         END DO
171      END DO
172      IF(nn_timing == 2)  CALL timing_start('iom_rstput')
173      CALL iom_rstput( 0, 0, inum2, 'fmaskutil', zprt, ktype = jp_i1 ) 
174
175      !                                                         ! horizontal mesh (inum3)
176      CALL iom_rstput( 0, 0, inum3, 'glamt', glamt, ktype = jp_r4 )     !    ! latitude
177      CALL iom_rstput( 0, 0, inum3, 'glamu', glamu, ktype = jp_r4 )
178      CALL iom_rstput( 0, 0, inum3, 'glamv', glamv, ktype = jp_r4 )
179      CALL iom_rstput( 0, 0, inum3, 'glamf', glamf, ktype = jp_r4 )
180     
181      CALL iom_rstput( 0, 0, inum3, 'gphit', gphit, ktype = jp_r4 )     !    ! longitude
182      CALL iom_rstput( 0, 0, inum3, 'gphiu', gphiu, ktype = jp_r4 )
183      CALL iom_rstput( 0, 0, inum3, 'gphiv', gphiv, ktype = jp_r4 )
184      CALL iom_rstput( 0, 0, inum3, 'gphif', gphif, ktype = jp_r4 )
185     
186      CALL iom_rstput( 0, 0, inum3, 'e1t', e1t, ktype = jp_r8 )         !    ! e1 scale factors
187      CALL iom_rstput( 0, 0, inum3, 'e1u', e1u, ktype = jp_r8 )
188      CALL iom_rstput( 0, 0, inum3, 'e1v', e1v, ktype = jp_r8 )
189      CALL iom_rstput( 0, 0, inum3, 'e1f', e1f, ktype = jp_r8 )
190     
191      CALL iom_rstput( 0, 0, inum3, 'e2t', e2t, ktype = jp_r8 )         !    ! e2 scale factors
192      CALL iom_rstput( 0, 0, inum3, 'e2u', e2u, ktype = jp_r8 )
193      CALL iom_rstput( 0, 0, inum3, 'e2v', e2v, ktype = jp_r8 )
194      CALL iom_rstput( 0, 0, inum3, 'e2f', e2f, ktype = jp_r8 )
195     
196      CALL iom_rstput( 0, 0, inum3, 'ff', ff, ktype = jp_r8 )           !    ! coriolis factor
197     
198      ! note that mbkt is set to 1 over land ==> use surface tmask
199      zprt(:,:) = ssmask(:,:) * REAL( mbkt(:,:) , wp )
200      CALL iom_rstput( 0, 0, inum4, 'mbathy', zprt, ktype = jp_i2 )     !    ! nb of ocean T-points
201      zprt(:,:) = ssmask(:,:) * REAL( mikt(:,:) , wp )
202      CALL iom_rstput( 0, 0, inum4, 'misf', zprt, ktype = jp_i2 )       !    ! nb of ocean T-points
203      zprt(:,:) = ssmask(:,:) * REAL( risfdep(:,:) , wp )
204      CALL iom_rstput( 0, 0, inum4, 'isfdraft', zprt, ktype = jp_r4 )       !    ! nb of ocean T-points
205      zprt(:,:) = ssmask(:,:) * REAL( bathy(:,:) , wp )
206      CALL iom_rstput( 0, 0, inum4, 'bathy', zprt, ktype = jp_r4 )       !    ! nb of ocean T-points
207           
208           
209      IF( ln_sco ) THEN                                         ! s-coordinate
210         CALL iom_rstput( 0, 0, inum4, 'hbatt', hbatt )
211         CALL iom_rstput( 0, 0, inum4, 'hbatu', hbatu )
212         CALL iom_rstput( 0, 0, inum4, 'hbatv', hbatv )
213         CALL iom_rstput( 0, 0, inum4, 'hbatf', hbatf )
214         !
215         CALL iom_rstput( 0, 0, inum4, 'gsigt', gsigt )         !    ! scaling coef.
216         CALL iom_rstput( 0, 0, inum4, 'gsigw', gsigw ) 
217         CALL iom_rstput( 0, 0, inum4, 'gsi3w', gsi3w )
218         CALL iom_rstput( 0, 0, inum4, 'esigt', esigt )
219         CALL iom_rstput( 0, 0, inum4, 'esigw', esigw )
220         !
221         CALL iom_rstput( 0, 0, inum4, 'e3t_0', e3t_0 )         !    ! scale factors
222         CALL iom_rstput( 0, 0, inum4, 'e3u_0', e3u_0 )
223         CALL iom_rstput( 0, 0, inum4, 'e3v_0', e3v_0 )
224         CALL iom_rstput( 0, 0, inum4, 'e3w_0', e3w_0 )
225         CALL iom_rstput( 0, 0, inum4, 'rx1', rx1 )             !    ! Max. grid stiffness ratio
226         !
227         CALL iom_rstput( 0, 0, inum4, 'gdept_1d' , gdept_1d )  !    ! stretched system
228         CALL iom_rstput( 0, 0, inum4, 'gdepw_1d' , gdepw_1d )
229         CALL iom_rstput( 0, 0, inum4, 'gdept_0', gdept_0, ktype = jp_r4 )     
230         CALL iom_rstput( 0, 0, inum4, 'gdepw_0', gdepw_0, ktype = jp_r4 )     
231      ENDIF
232      IF(nn_timing == 2)  CALL timing_stop('iom_rstput') 
233      IF( ln_zps ) THEN                                         ! z-coordinate - partial steps
234         !
235         IF( nmsh <= 6 ) THEN                                   !    ! 3D vertical scale factors
236            IF(nn_timing == 2)  CALL timing_start('iom_rstput')
237            CALL iom_rstput( 0, 0, inum4, 'e3t_0', e3t_0 )         
238            CALL iom_rstput( 0, 0, inum4, 'e3u_0', e3u_0 )
239            CALL iom_rstput( 0, 0, inum4, 'e3v_0', e3v_0 )
240            CALL iom_rstput( 0, 0, inum4, 'e3w_0', e3w_0 )
241            IF(nn_timing == 2)  CALL timing_stop('iom_rstput')
242         ELSE                                                   !    ! 2D masked bottom ocean scale factors
243            DO jj = 1,jpj   
244               DO ji = 1,jpi
245                  e3tp(ji,jj) = e3t_0(ji,jj,mbkt(ji,jj)) * ssmask(ji,jj)
246                  e3wp(ji,jj) = e3w_0(ji,jj,mbkt(ji,jj)) * ssmask(ji,jj)
247               END DO
248            END DO
249            IF(nn_timing == 2)  CALL timing_start('iom_rstput')
250            CALL iom_rstput( 0, 0, inum4, 'e3t_ps', e3tp )     
251            CALL iom_rstput( 0, 0, inum4, 'e3w_ps', e3wp )
252            IF(nn_timing == 2)  CALL timing_stop('iom_rstput')
253         END IF
254         !
255         IF( nmsh <= 3 ) THEN                                   !    ! 3D depth
256            CALL iom_rstput( 0, 0, inum4, 'gdept_0', gdept_0, ktype = jp_r4 )     
257            DO jk = 1,jpk   
258               DO jj = 1, jpjm1   
259                  DO ji = 1, fs_jpim1   ! vector opt.
260                     zdepu(ji,jj,jk) = MIN( gdept_0(ji,jj,jk) , gdept_0(ji+1,jj  ,jk) )
261                     zdepv(ji,jj,jk) = MIN( gdept_0(ji,jj,jk) , gdept_0(ji  ,jj+1,jk) )
262                  END DO   
263               END DO   
264            END DO
265            CALL lbc_lnk( zdepu, 'U', 1. )   ;   CALL lbc_lnk( zdepv, 'V', 1. ) 
266            IF(nn_timing == 2)  CALL timing_start('iom_rstput')
267            CALL iom_rstput( 0, 0, inum4, 'gdepu', zdepu, ktype = jp_r4 )
268            CALL iom_rstput( 0, 0, inum4, 'gdepv', zdepv, ktype = jp_r4 )
269            CALL iom_rstput( 0, 0, inum4, 'gdepw_0', gdepw_0, ktype = jp_r4 )
270            IF(nn_timing == 2)  CALL timing_stop('iom_rstput')
271         ELSE                                                   !    ! 2D bottom depth
272            DO jj = 1,jpj   
273               DO ji = 1,jpi
274                  zprt(ji,jj) = gdept_0(ji,jj,mbkt(ji,jj)  ) * ssmask(ji,jj)
275                  zprw(ji,jj) = gdepw_0(ji,jj,mbkt(ji,jj)+1) * ssmask(ji,jj)
276               END DO
277            END DO
278            IF(nn_timing == 2)  CALL timing_start('iom_rstput')
279            CALL iom_rstput( 0, 0, inum4, 'hdept', zprt, ktype = jp_r4 )     
280            CALL iom_rstput( 0, 0, inum4, 'hdepw', zprw, ktype = jp_r4 ) 
281            IF(nn_timing == 2)  CALL timing_stop('iom_rstput')
282         ENDIF
283         !
284         IF(nn_timing == 2)  CALL timing_start('iom_rstput')
285         CALL iom_rstput( 0, 0, inum4, 'gdept_1d', gdept_1d )   !    ! reference z-coord.
286         CALL iom_rstput( 0, 0, inum4, 'gdepw_1d', gdepw_1d )
287         CALL iom_rstput( 0, 0, inum4, 'e3t_1d'  , e3t_1d   )
288         CALL iom_rstput( 0, 0, inum4, 'e3w_1d'  , e3w_1d   )
289         IF(nn_timing == 2)  CALL timing_stop('iom_rstput')
290      ENDIF
291     
292      IF( ln_zco ) THEN
293         !                                                      ! z-coordinate - full steps
294         IF(nn_timing == 2)  CALL timing_start('iom_rstput')
295         CALL iom_rstput( 0, 0, inum4, 'gdept_1d', gdept_1d )   !    ! depth
296         CALL iom_rstput( 0, 0, inum4, 'gdepw_1d', gdepw_1d )
297         CALL iom_rstput( 0, 0, inum4, 'e3t_1d'  , e3t_1d   )   !    ! scale factors
298         CALL iom_rstput( 0, 0, inum4, 'e3w_1d'  , e3w_1d   )
299         IF(nn_timing == 2)  CALL timing_stop('iom_rstput')
300      ENDIF
301      !                                     ! ============================
302      !                                     !        close the files
303      !                                     ! ============================
304      SELECT CASE ( MOD(nmsh, 3) )
305      CASE ( 1 )               
306         CALL iom_close( inum0 )
307      CASE ( 2 )
308         CALL iom_close( inum1 )
309         CALL iom_close( inum2 )
310      CASE ( 0 )
311         CALL iom_close( inum2 )
312         CALL iom_close( inum3 )
313         CALL iom_close( inum4 )
314      END SELECT
315      !
316      CALL wrk_dealloc( jpi, jpj, zprt, zprw )
317      CALL wrk_dealloc( jpi, jpj, jpk, zdepu, zdepv )
318      !
319      IF( nn_timing == 1 )  CALL timing_stop('dom_wri')
320      !
321   END SUBROUTINE dom_wri
322
323
324   SUBROUTINE dom_uniq( puniq, cdgrd )
325      !!----------------------------------------------------------------------
326      !!                  ***  ROUTINE dom_uniq  ***
327      !!                   
328      !! ** Purpose :   identify unique point of a grid (TUVF)
329      !!
330      !! ** Method  :   1) aplly lbc_lnk on an array with different values for each element
331      !!                2) check which elements have been changed
332      !!----------------------------------------------------------------------
333      !
334      CHARACTER(len=1)        , INTENT(in   ) ::   cdgrd   !
335      REAL(wp), DIMENSION(:,:), INTENT(inout) ::   puniq   !
336      !
337      REAL(wp) ::  zshift   ! shift value link to the process number
338      INTEGER  ::  ji       ! dummy loop indices
339      LOGICAL, DIMENSION(SIZE(puniq,1),SIZE(puniq,2),1) ::  lldbl  ! store whether each point is unique or not
340      REAL(wp), POINTER, DIMENSION(:,:) :: ztstref
341      !!----------------------------------------------------------------------
342      !
343      IF( nn_timing == 1 )  CALL timing_start('dom_uniq')
344      !
345      CALL wrk_alloc( jpi, jpj, ztstref )
346      !
347      ! build an array with different values for each element
348      ! in mpp: make sure that these values are different even between process
349      ! -> apply a shift value according to the process number
350      zshift = jpi * jpj * ( narea - 1 )
351      ztstref(:,:) = RESHAPE( (/ (zshift + REAL(ji,wp), ji = 1, jpi*jpj) /), (/ jpi, jpj /) )
352      !
353      puniq(:,:) = ztstref(:,:)                   ! default definition
354      CALL lbc_lnk( puniq, cdgrd, 1. )            ! apply boundary conditions
355      lldbl(:,:,1) = puniq(:,:) == ztstref(:,:)   ! check which values have been changed
356      !
357      puniq(:,:) = 1.                             ! default definition
358      ! fill only the inner part of the cpu with llbl converted into real
359      puniq(nldi:nlei,nldj:nlej) = REAL( COUNT( lldbl(nldi:nlei,nldj:nlej,:), dim = 3 ) , wp )
360      !
361      CALL wrk_dealloc( jpi, jpj, ztstref )
362      !
363      IF( nn_timing == 1 )  CALL timing_stop('dom_uniq')
364      !
365   END SUBROUTINE dom_uniq
366
367   !!======================================================================
368END MODULE domwri
Note: See TracBrowser for help on using the repository browser.