source: trunk/NEMOGCM/NEMO/OPA_SRC/DIA/dia25h.F90 @ 7753

Last change on this file since 7753 was 7753, checked in by mocavero, 4 years ago

Reverting trunk to remove OpenMP

File size: 13.4 KB
Line 
1MODULE dia25h 
2   !!======================================================================
3   !!                       ***  MODULE  diaharm  ***
4   !! Harmonic analysis of tidal constituents
5   !!======================================================================
6   !! History :  3.6  !  2014  (E O'Dea)  Original code
7   !!----------------------------------------------------------------------
8   USE oce             ! ocean dynamics and tracers variables
9   USE dom_oce         ! ocean space and time domain
10   USE in_out_manager  ! I/O units
11   USE iom             ! I/0 library
12   USE wrk_nemo        ! working arrays
13#if defined key_zdftke 
14   USE zdf_oce, ONLY: en
15#endif
16   USE zdf_oce, ONLY: avt, avm
17#if defined key_zdfgls
18   USE zdf_oce, ONLY: en
19   USE zdfgls, ONLY: mxln
20#endif
21
22   IMPLICIT NONE
23   PRIVATE
24
25   LOGICAL , PUBLIC ::   ln_dia25h     !:  25h mean output
26   PUBLIC   dia_25h_init               ! routine called by nemogcm.F90
27   PUBLIC   dia_25h                    ! routine called by diawri.F90
28
29  !! * variables for calculating 25-hourly means
30   REAL(wp),SAVE, ALLOCATABLE,   DIMENSION(:,:,:) ::   tn_25h  , sn_25h
31   REAL(wp),SAVE, ALLOCATABLE,   DIMENSION(:,:)   ::   sshn_25h 
32   REAL(wp),SAVE, ALLOCATABLE,   DIMENSION(:,:,:) ::   un_25h  , vn_25h  , wn_25h
33   REAL(wp),SAVE, ALLOCATABLE,   DIMENSION(:,:,:) ::   avt_25h , avm_25h
34#if defined key_zdfgls || key_zdftke
35   REAL(wp),SAVE, ALLOCATABLE,   DIMENSION(:,:,:) ::   en_25h
36#endif
37#if defined key_zdfgls 
38   REAL(wp),SAVE, ALLOCATABLE,   DIMENSION(:,:,:) ::   rmxln_25h
39#endif
40   INTEGER, SAVE :: cnt_25h     ! Counter for 25 hour means
41
42
43
44   !!----------------------------------------------------------------------
45   !! NEMO/OPA 3.6 , NEMO Consortium (2014)
46   !! $Id:$
47   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
48   !!----------------------------------------------------------------------
49CONTAINS
50
51   SUBROUTINE dia_25h_init 
52      !!---------------------------------------------------------------------------
53      !!                  ***  ROUTINE dia_25h_init  ***
54      !!     
55      !! ** Purpose: Initialization of 25h mean namelist
56      !!       
57      !! ** Method : Read namelist
58      !!   History
59      !!   3.6  !  08-14  (E. O'Dea) Routine to initialize dia_25h
60      !!---------------------------------------------------------------------------
61      !!
62      INTEGER ::   ios                 ! Local integer output status for namelist read
63      INTEGER ::   ierror              ! Local integer for memory allocation
64      !
65      NAMELIST/nam_dia25h/ ln_dia25h
66      !!----------------------------------------------------------------------
67      !
68      REWIND ( numnam_ref )              ! Read Namelist nam_dia25h in reference namelist : 25hour mean diagnostics
69      READ   ( numnam_ref, nam_dia25h, IOSTAT=ios, ERR= 901 )
70901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'nam_dia25h in reference namelist', lwp )
71
72      REWIND( numnam_cfg )              ! Namelist nam_dia25h in configuration namelist  25hour diagnostics
73      READ  ( numnam_cfg, nam_dia25h, IOSTAT = ios, ERR = 902 )
74902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'nam_dia25h in configuration namelist', lwp )
75      IF(lwm) WRITE ( numond, nam_dia25h )
76
77      IF(lwp) THEN                   ! Control print
78         WRITE(numout,*)
79         WRITE(numout,*) 'dia_25h_init : Output 25 hour mean diagnostics'
80         WRITE(numout,*) '~~~~~~~~~~~~'
81         WRITE(numout,*) 'Namelist nam_dia25h : set 25h outputs '
82         WRITE(numout,*) 'Switch for 25h diagnostics (T) or not (F)  ln_dia25h  = ', ln_dia25h
83      ENDIF
84      IF( .NOT. ln_dia25h )   RETURN
85      ! ------------------- !
86      ! 1 - Allocate memory !
87      ! ------------------- !
88      ALLOCATE( tn_25h(jpi,jpj,jpk), STAT=ierror )
89      IF( ierror > 0 ) THEN
90         CALL ctl_stop( 'dia_25h: unable to allocate tn_25h' )   ;   RETURN
91      ENDIF
92      ALLOCATE( sn_25h(jpi,jpj,jpk), STAT=ierror )
93      IF( ierror > 0 ) THEN
94         CALL ctl_stop( 'dia_25h: unable to allocate sn_25h' )   ;   RETURN
95      ENDIF
96      ALLOCATE( un_25h(jpi,jpj,jpk), STAT=ierror )
97      IF( ierror > 0 ) THEN
98         CALL ctl_stop( 'dia_25h: unable to allocate un_25h' )   ;   RETURN
99      ENDIF
100      ALLOCATE( vn_25h(jpi,jpj,jpk), STAT=ierror )
101      IF( ierror > 0 ) THEN
102         CALL ctl_stop( 'dia_25h: unable to allocate vn_25h' )   ;   RETURN
103      ENDIF
104      ALLOCATE( wn_25h(jpi,jpj,jpk), STAT=ierror )
105      IF( ierror > 0 ) THEN
106         CALL ctl_stop( 'dia_25h: unable to allocate wn_25h' )   ;   RETURN
107      ENDIF
108      ALLOCATE( avt_25h(jpi,jpj,jpk), STAT=ierror )
109      IF( ierror > 0 ) THEN
110         CALL ctl_stop( 'dia_25h: unable to allocate avt_25h' )   ;   RETURN
111      ENDIF
112      ALLOCATE( avm_25h(jpi,jpj,jpk), STAT=ierror )
113      IF( ierror > 0 ) THEN
114         CALL ctl_stop( 'dia_25h: unable to allocate avm_25h' )   ;   RETURN
115      ENDIF
116# if defined key_zdfgls || defined key_zdftke
117      ALLOCATE( en_25h(jpi,jpj,jpk), STAT=ierror )
118      IF( ierror > 0 ) THEN
119         CALL ctl_stop( 'dia_25h: unable to allocate en_25h' )   ;   RETURN
120      ENDIF
121#endif
122# if defined key_zdfgls 
123      ALLOCATE( rmxln_25h(jpi,jpj,jpk), STAT=ierror )
124      IF( ierror > 0 ) THEN
125         CALL ctl_stop( 'dia_25h: unable to allocate rmxln_25h' )   ;   RETURN
126      ENDIF
127#endif
128      ALLOCATE( sshn_25h(jpi,jpj), STAT=ierror )
129      IF( ierror > 0 ) THEN
130         CALL ctl_stop( 'dia_25h: unable to allocate sshn_25h' )   ;   RETURN
131      ENDIF
132      ! ------------------------- !
133      ! 2 - Assign Initial Values !
134      ! ------------------------- !
135      cnt_25h = 1  ! sets the first value of sum at timestep 1 (note - should strictly be at timestep zero so before values used where possible)
136      tn_25h(:,:,:) = tsb(:,:,:,jp_tem)
137      sn_25h(:,:,:) = tsb(:,:,:,jp_sal)
138      sshn_25h(:,:) = sshb(:,:)
139      un_25h(:,:,:) = ub(:,:,:)
140      vn_25h(:,:,:) = vb(:,:,:)
141      wn_25h(:,:,:) = wn(:,:,:)
142      avt_25h(:,:,:) = avt(:,:,:)
143      avm_25h(:,:,:) = avm(:,:,:)
144# if defined key_zdfgls || defined key_zdftke
145         en_25h(:,:,:) = en(:,:,:)
146#endif
147# if defined key_zdfgls
148         rmxln_25h(:,:,:) = mxln(:,:,:)
149#endif
150#if defined key_lim3 || defined key_lim2
151         CALL ctl_stop('STOP', 'dia_25h not setup yet to do tidemean ice')
152#endif 
153
154      ! -------------------------- !
155      ! 3 - Return to dia_wri      !
156      ! -------------------------- !
157
158
159   END SUBROUTINE dia_25h_init
160
161
162   SUBROUTINE dia_25h( kt ) 
163      !!----------------------------------------------------------------------
164      !!                 ***  ROUTINE dia_25h  ***
165      !!         
166      !!
167      !!--------------------------------------------------------------------
168      !!                   
169      !! ** Purpose :   Write diagnostics with M2/S2 tide removed
170      !!
171      !! ** Method  :   
172      !!      25hr mean outputs for shelf seas
173      !!
174      !! History :
175      !!   ?.0  !  07-04  (A. Hines) New routine, developed from dia_wri_foam
176      !!   3.4  !  02-13  (J. Siddorn) Routine taken from old dia_wri_foam
177      !!   3.6  !  08-14  (E. O'Dea) adapted for VN3.6
178      !!----------------------------------------------------------------------
179      !! * Modules used
180
181      IMPLICIT NONE
182
183      !! * Arguments
184      INTEGER, INTENT( in ) ::   kt      ! ocean time-step index
185
186
187      !! * Local declarations
188      INTEGER ::   ji, jj, jk
189
190      LOGICAL ::   ll_print = .FALSE.    ! =T print and flush numout
191      REAL(wp)                         ::   zsto, zout, zmax, zjulian, zmdi       ! temporary reals
192      INTEGER                          ::   i_steps                               ! no of timesteps per hour
193      REAL(wp), DIMENSION(jpi,jpj    ) ::   zw2d, un_dm, vn_dm                    ! temporary workspace
194      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   zw3d                                  ! temporary workspace
195      REAL(wp), DIMENSION(jpi,jpj,3)   ::   zwtmb                                 ! temporary workspace
196      INTEGER                          ::   iyear0, nimonth0,iday0                ! start year,imonth,day
197
198      !!----------------------------------------------------------------------
199
200      ! 0. Initialisation
201      ! -----------------
202      ! Define frequency of summing to create 25 h mean
203      IF( MOD( 3600,INT(rdt) ) == 0 ) THEN
204         i_steps = 3600/INT(rdt)
205      ELSE
206         CALL ctl_stop('STOP', 'dia_wri_tide: timestep must give MOD(3600,rdt) = 0 otherwise no hourly values are possible')
207      ENDIF
208
209#if defined key_lim3 || defined key_lim2
210      CALL ctl_stop('STOP', 'dia_wri_tide not setup yet to do tidemean ice')
211#endif
212
213      ! local variable for debugging
214      ll_print = ll_print .AND. lwp
215
216      ! Sum of 25 hourly instantaneous values to give a 25h mean from 24hours
217      ! every day
218      IF( MOD( kt, i_steps ) == 0  .and. kt .ne. nn_it000 ) THEN
219
220         IF (lwp) THEN
221              WRITE(numout,*) 'dia_wri_tide : Summing instantaneous hourly diagnostics at timestep ',kt
222              WRITE(numout,*) '~~~~~~~~~~~~ '
223         ENDIF
224
225         tn_25h(:,:,:)        = tn_25h(:,:,:) + tsn(:,:,:,jp_tem)
226         sn_25h(:,:,:)        = sn_25h(:,:,:) + tsn(:,:,:,jp_sal)
227         sshn_25h(:,:)        = sshn_25h(:,:) + sshn (:,:)
228         un_25h(:,:,:)        = un_25h(:,:,:) + un(:,:,:)
229         vn_25h(:,:,:)        = vn_25h(:,:,:) + vn(:,:,:)
230         wn_25h(:,:,:)        = wn_25h(:,:,:) + wn(:,:,:)
231         avt_25h(:,:,:)       = avt_25h(:,:,:) + avt(:,:,:)
232         avm_25h(:,:,:)       = avm_25h(:,:,:) + avm(:,:,:)
233# if defined key_zdfgls || defined key_zdftke
234         en_25h(:,:,:)        = en_25h(:,:,:) + en(:,:,:)
235#endif
236# if defined key_zdfgls
237         rmxln_25h(:,:,:)      = rmxln_25h(:,:,:) + mxln(:,:,:)
238#endif
239         cnt_25h = cnt_25h + 1
240
241         IF (lwp) THEN
242            WRITE(numout,*) 'dia_tide : Summed the following number of hourly values so far',cnt_25h
243         ENDIF
244
245      ENDIF ! MOD( kt, i_steps ) == 0
246
247         ! Write data for 25 hour mean output streams
248      IF( cnt_25h .EQ. 25 .AND.  MOD( kt, i_steps*24) == 0 .AND. kt .NE. nn_it000 ) THEN
249
250            IF(lwp) THEN
251               WRITE(numout,*) 'dia_wri_tide : Writing 25 hour mean tide diagnostics at timestep', kt
252               WRITE(numout,*) '~~~~~~~~~~~~ '
253            ENDIF
254
255            tn_25h(:,:,:)        = tn_25h(:,:,:) / 25.0_wp
256            sn_25h(:,:,:)        = sn_25h(:,:,:) / 25.0_wp
257            sshn_25h(:,:)        = sshn_25h(:,:) / 25.0_wp
258            un_25h(:,:,:)        = un_25h(:,:,:) / 25.0_wp
259            vn_25h(:,:,:)        = vn_25h(:,:,:) / 25.0_wp
260            wn_25h(:,:,:)        = wn_25h(:,:,:) / 25.0_wp
261            avt_25h(:,:,:)       = avt_25h(:,:,:) / 25.0_wp
262            avm_25h(:,:,:)       = avm_25h(:,:,:) / 25.0_wp
263# if defined key_zdfgls || defined key_zdftke
264            en_25h(:,:,:)        = en_25h(:,:,:) / 25.0_wp
265#endif
266# if defined key_zdfgls
267            rmxln_25h(:,:,:)       = rmxln_25h(:,:,:) / 25.0_wp
268#endif
269
270            IF (lwp)  WRITE(numout,*) 'dia_wri_tide : Mean calculated by dividing 25 hour sums and writing output'
271            zmdi=1.e+20 !missing data indicator for masking
272            ! write tracers (instantaneous)
273            zw3d(:,:,:) = tn_25h(:,:,:)*tmask(:,:,:) + zmdi*(1.0-tmask(:,:,:))
274            CALL iom_put("temper25h", zw3d)   ! potential temperature
275            zw3d(:,:,:) = sn_25h(:,:,:)*tmask(:,:,:) + zmdi*(1.0-tmask(:,:,:))
276            CALL iom_put( "salin25h", zw3d  )   ! salinity
277            zw2d(:,:) = sshn_25h(:,:)*tmask(:,:,1) + zmdi*(1.0-tmask(:,:,1))
278            CALL iom_put( "ssh25h", zw2d )   ! sea surface
279
280
281            ! Write velocities (instantaneous)
282            zw3d(:,:,:) = un_25h(:,:,:)*umask(:,:,:) + zmdi*(1.0-umask(:,:,:))
283            CALL iom_put("vozocrtx25h", zw3d)    ! i-current
284            zw3d(:,:,:) = vn_25h(:,:,:)*vmask(:,:,:) + zmdi*(1.0-vmask(:,:,:))
285            CALL iom_put("vomecrty25h", zw3d  )   ! j-current
286
287            zw3d(:,:,:) = wn_25h(:,:,:)*tmask(:,:,:) + zmdi*(1.0-tmask(:,:,:))
288            CALL iom_put("vomecrtz25h", zw3d )   ! k-current
289            zw3d(:,:,:) = avt_25h(:,:,:)*tmask(:,:,:) + zmdi*(1.0-tmask(:,:,:))
290            CALL iom_put("avt25h", zw3d )   ! diffusivity
291            zw3d(:,:,:) = avm_25h(:,:,:)*tmask(:,:,:) + zmdi*(1.0-tmask(:,:,:))
292            CALL iom_put("avm25h", zw3d)   ! viscosity
293#if defined key_zdftke || defined key_zdfgls 
294            zw3d(:,:,:) = en_25h(:,:,:)*tmask(:,:,:) + zmdi*(1.0-tmask(:,:,:))
295            CALL iom_put("tke25h", zw3d)   ! tke
296#endif
297#if defined key_zdfgls 
298            zw3d(:,:,:) = rmxln_25h(:,:,:)*tmask(:,:,:) + zmdi*(1.0-tmask(:,:,:))
299            CALL iom_put( "mxln25h",zw3d)
300#endif
301
302            ! After the write reset the values to cnt=1 and sum values equal current value
303            tn_25h(:,:,:) = tsn(:,:,:,jp_tem)
304            sn_25h(:,:,:) = tsn(:,:,:,jp_sal)
305            sshn_25h(:,:) = sshn (:,:)
306            un_25h(:,:,:) = un(:,:,:)
307            vn_25h(:,:,:) = vn(:,:,:)
308            wn_25h(:,:,:) = wn(:,:,:)
309            avt_25h(:,:,:) = avt(:,:,:)
310            avm_25h(:,:,:) = avm(:,:,:)
311# if defined key_zdfgls || defined key_zdftke
312            en_25h(:,:,:) = en(:,:,:)
313#endif
314# if defined key_zdfgls
315            rmxln_25h(:,:,:) = mxln(:,:,:)
316#endif
317            cnt_25h = 1
318            IF (lwp)  WRITE(numout,*) 'dia_wri_tide : After 25hr mean write, reset sum to current value and cnt_25h to one for overlapping average',cnt_25h
319
320      ENDIF !  cnt_25h .EQ. 25 .AND.  MOD( kt, i_steps * 24) == 0 .AND. kt .NE. nn_it000
321
322
323   END SUBROUTINE dia_25h 
324
325   !!======================================================================
326END MODULE dia25h
Note: See TracBrowser for help on using the repository browser.