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.
dia25h.F90 in branches/2014/dev_r4650_UKMO10_Tidally_Meaned_Diagnostics/NEMOGCM/NEMO/OPA_SRC/DIA – NEMO

source: branches/2014/dev_r4650_UKMO10_Tidally_Meaned_Diagnostics/NEMOGCM/NEMO/OPA_SRC/DIA/dia25h.F90 @ 6032

Last change on this file since 6032 was 6032, checked in by timgraham, 8 years ago

Remove insitu temperature for now to be replaced with a versios consistent with EOS later
File size: 13.5 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      CALL theta2t
139      sshn_25h(:,:) = sshb(:,:)
140      un_25h(:,:,:) = ub(:,:,:)
141      vn_25h(:,:,:) = vb(:,:,:)
142      wn_25h(:,:,:) = wn(:,:,:)
143      avt_25h(:,:,:) = avt(:,:,:)
144      avm_25h(:,:,:) = avm(:,:,:)
145# if defined key_zdfgls || defined key_zdftke
146         en_25h(:,:,:) = en(:,:,:)
147#endif
148# if defined key_zdfgls
149         rmxln_25h(:,:,:) = mxln(:,:,:)
150#endif
151#if defined key_lim3 || defined key_lim2
152         CALL ctl_stop('STOP', 'dia_25h not setup yet to do tidemean ice')
153#endif 
154
155      ! -------------------------- !
156      ! 3 - Return to dia_wri      !
157      ! -------------------------- !
158
159
160   END SUBROUTINE dia_25h_init
161
162
163   SUBROUTINE dia_25h( kt ) 
164      !!----------------------------------------------------------------------
165      !!                 ***  ROUTINE dia_25h  ***
166      !!         
167      !!
168      !!--------------------------------------------------------------------
169      !!                   
170      !! ** Purpose :   Write diagnostics with M2/S2 tide removed
171      !!
172      !! ** Method  :   
173      !!      25hr mean outputs for shelf seas
174      !!
175      !! History :
176      !!   ?.0  !  07-04  (A. Hines) New routine, developed from dia_wri_foam
177      !!   3.4  !  02-13  (J. Siddorn) Routine taken from old dia_wri_foam
178      !!   3.6  !  08-14  (E. O'Dea) adapted for VN3.6
179      !!----------------------------------------------------------------------
180      !! * Modules used
181
182      IMPLICIT NONE
183
184      !! * Arguments
185      INTEGER, INTENT( in ) ::   kt      ! ocean time-step index
186
187
188      !! * Local declarations
189      INTEGER ::   ji, jj, jk
190
191      LOGICAL ::   ll_print = .FALSE.    ! =T print and flush numout
192      REAL(wp)                         ::   zsto, zout, zmax, zjulian, zdt, zmdi  ! temporary reals
193      INTEGER                          ::   i_steps                               ! no of timesteps per hour
194      REAL(wp), DIMENSION(jpi,jpj    ) ::   zw2d, un_dm, vn_dm                    ! temporary workspace
195      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   zw3d                                  ! temporary workspace
196      REAL(wp), DIMENSION(jpi,jpj,3)   ::   zwtmb                                 ! temporary workspace
197      INTEGER                          ::   iyear0, nimonth0,iday0                ! start year,imonth,day
198
199      !!----------------------------------------------------------------------
200
201      ! 0. Initialisation
202      ! -----------------
203      ! Define frequency of summing to create 25 h mean
204      zdt = rdt
205      IF( nacc == 1 ) zdt = rdtmin
206
207      IF( MOD( 3600,INT(zdt) ) == 0 ) THEN
208         i_steps = 3600/INT(zdt)
209      ELSE
210         CALL ctl_stop('STOP', 'dia_wri_tide: timestep must give MOD(3600,rdt) = 0 otherwise no hourly values are possible')
211      ENDIF
212
213#if defined key_lim3 || defined key_lim2
214      CALL ctl_stop('STOP', 'dia_wri_tide not setup yet to do tidemean ice')
215#endif
216
217      ! local variable for debugging
218      ll_print = ll_print .AND. lwp
219
220      ! Sum of 25 hourly instantaneous values to give a 25h mean from 24hours
221      ! every day
222      IF( MOD( kt, i_steps ) == 0  .and. kt .ne. nn_it000 ) THEN
223
224         IF (lwp) THEN
225              WRITE(numout,*) 'dia_wri_tide : Summing instantaneous hourly diagnostics at timestep ',kt
226              WRITE(numout,*) '~~~~~~~~~~~~ '
227         ENDIF
228
229         tn_25h(:,:,:)        = tn_25h(:,:,:) + tsn(:,:,:,jp_tem)
230         sn_25h(:,:,:)        = sn_25h(:,:,:) + tsn(:,:,:,jp_sal)
231         sshn_25h(:,:)        = sshn_25h(:,:) + sshn (:,:)
232         un_25h(:,:,:)        = un_25h(:,:,:) + un(:,:,:)
233         vn_25h(:,:,:)        = vn_25h(:,:,:) + vn(:,:,:)
234         wn_25h(:,:,:)        = wn_25h(:,:,:) + wn(:,:,:)
235         avt_25h(:,:,:)       = avt_25h(:,:,:) + avt(:,:,:)
236         avm_25h(:,:,:)       = avm_25h(:,:,:) + avm(:,:,:)
237# if defined key_zdfgls || defined key_zdftke
238         en_25h(:,:,:)        = en_25h(:,:,:) + en(:,:,:)
239#endif
240# if defined key_zdfgls
241         rmxln_25h(:,:,:)      = rmxln_25h(:,:,:) + mxln(:,:,:)
242#endif
243         cnt_25h = cnt_25h + 1
244
245         IF (lwp) THEN
246            WRITE(numout,*) 'dia_tide : Summed the following number of hourly values so far',cnt_25h
247         ENDIF
248
249      ENDIF ! MOD( kt, i_steps ) == 0
250
251         ! Write data for 25 hour mean output streams
252      IF( cnt_25h .EQ. 25 .AND.  MOD( kt, i_steps*24) == 0 .AND. kt .NE. nn_it000 ) THEN
253
254            IF(lwp) THEN
255               WRITE(numout,*) 'dia_wri_tide : Writing 25 hour mean tide diagnostics at timestep', kt
256               WRITE(numout,*) '~~~~~~~~~~~~ '
257            ENDIF
258
259            tn_25h(:,:,:)        = tn_25h(:,:,:) / 25.0_wp
260            sn_25h(:,:,:)        = sn_25h(:,:,:) / 25.0_wp
261            sshn_25h(:,:)        = sshn_25h(:,:) / 25.0_wp
262            un_25h(:,:,:)        = un_25h(:,:,:) / 25.0_wp
263            vn_25h(:,:,:)        = vn_25h(:,:,:) / 25.0_wp
264            wn_25h(:,:,:)        = wn_25h(:,:,:) / 25.0_wp
265            avt_25h(:,:,:)       = avt_25h(:,:,:) / 25.0_wp
266            avm_25h(:,:,:)       = avm_25h(:,:,:) / 25.0_wp
267# if defined key_zdfgls || defined key_zdftke
268            en_25h(:,:,:)        = en_25h(:,:,:) / 25.0_wp
269#endif
270# if defined key_zdfgls
271            rmxln_25h(:,:,:)       = rmxln_25h(:,:,:) / 25.0_wp
272#endif
273
274            IF (lwp)  WRITE(numout,*) 'dia_wri_tide : Mean calculated by dividing 25 hour sums and writing output'
275            zmdi=1.e+20 !missing data indicator for masking
276            ! write tracers (instantaneous)
277            zw3d(:,:,:) = tn_25h(:,:,:)*tmask(:,:,:) + zmdi*(1.0-tmask(:,:,:))
278            CALL iom_put("temper25h", zw3d)   ! potential temperature
279            zw3d(:,:,:) = sn_25h(:,:,:)*tmask(:,:,:) + zmdi*(1.0-tmask(:,:,:))
280            CALL iom_put( "salin25h", zw3d  )   ! salinity
281            zw2d(:,:) = sshn_25h(:,:)*tmask(:,:,1) + zmdi*(1.0-tmask(:,:,1))
282            CALL iom_put( "ssh25h", zw2d )   ! sea surface
283
284
285            ! Write velocities (instantaneous)
286            zw3d(:,:,:) = un_25h(:,:,:)*umask(:,:,:) + zmdi*(1.0-umask(:,:,:))
287            CALL iom_put("vozocrtx25h", zw3d)    ! i-current
288            zw3d(:,:,:) = vn_25h(:,:,:)*vmask(:,:,:) + zmdi*(1.0-vmask(:,:,:))
289            CALL iom_put("vomecrty25h", zw3d  )   ! j-current
290
291            zw3d(:,:,:) = wn_25h(:,:,:)*tmask(:,:,:) + zmdi*(1.0-tmask(:,:,:))
292            CALL iom_put("vomecrtz25h", zw3d )   ! k-current
293            zw3d(:,:,:) = avt_25h(:,:,:)*tmask(:,:,:) + zmdi*(1.0-tmask(:,:,:))
294            CALL iom_put("avt25h", zw3d )   ! diffusivity
295            zw3d(:,:,:) = avm_25h(:,:,:)*tmask(:,:,:) + zmdi*(1.0-tmask(:,:,:))
296            CALL iom_put("avm25h", zw3d)   ! viscosity
297#if defined key_zdftke || defined key_zdfgls 
298            zw3d(:,:,:) = en_25h(:,:,:)*tmask(:,:,:) + zmdi*(1.0-tmask(:,:,:))
299            CALL iom_put("tke25h", zw3d)   ! tke
300#endif
301#if defined key_zdfgls 
302            zw3d(:,:,:) = rmxln_25h(:,:,:)*tmask(:,:,:) + zmdi*(1.0-tmask(:,:,:))
303            CALL iom_put( "mxln25h",zw3d)
304#endif
305
306            ! After the write reset the values to cnt=1 and sum values equal current value
307            tn_25h(:,:,:) = tsn(:,:,:,jp_tem)
308            sn_25h(:,:,:) = tsn(:,:,:,jp_sal)
309            sshn_25h(:,:) = sshn (:,:)
310            un_25h(:,:,:) = un(:,:,:)
311            vn_25h(:,:,:) = vn(:,:,:)
312            wn_25h(:,:,:) = wn(:,:,:)
313            avt_25h(:,:,:) = avt(:,:,:)
314            avm_25h(:,:,:) = avm(:,:,:)
315# if defined key_zdfgls || defined key_zdftke
316            en_25h(:,:,:) = en(:,:,:)
317#endif
318# if defined key_zdfgls
319            rmxln_25h(:,:,:) = mxln(:,:,:)
320#endif
321            cnt_25h = 1
322            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
323
324      ENDIF !  cnt_25h .EQ. 25 .AND.  MOD( kt, i_steps * 24) == 0 .AND. kt .NE. nn_it000
325
326
327   END SUBROUTINE dia_25h 
328
329   !!======================================================================
330END MODULE dia25h
Note: See TracBrowser for help on using the repository browser.