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.
diaharm.F90 in NEMO/branches/2019/dev_r10742_ENHANCE-12_SimonM-Tides/src/OCE/DIA – NEMO

source: NEMO/branches/2019/dev_r10742_ENHANCE-12_SimonM-Tides/src/OCE/DIA/diaharm.F90 @ 10811

Last change on this file since 10811 was 10811, checked in by smueller, 5 years ago

Replacement of the module variable used to store information about all available tidal components (variable Wave in module tide_mod) by an array used to store information about the selected components only (variable tide_components in module tide_mod), replacement of the corresponding initialisation subroutine, as well as related adjustments in various modules (bdytides, diaharm, sbctide, and tide_mod) and in one include file (tide.h90) (ticket #2194)
  • Property svn:keywords set to Id
File size: 18.7 KB
Line 
1MODULE diaharm 
2   !!======================================================================
3   !!                       ***  MODULE  diaharm  ***
4   !! Harmonic analysis of tidal constituents
5   !!======================================================================
6   !! History :  3.1  !  2007  (O. Le Galloudec, J. Chanut)  Original code
7   !!----------------------------------------------------------------------
8#if defined key_diaharm
9   !!----------------------------------------------------------------------
10   !!   'key_diaharm'
11   !!----------------------------------------------------------------------
12   USE oce             ! ocean dynamics and tracers variables
13   USE dom_oce         ! ocean space and time domain
14   USE phycst
15   USE daymod
16   USE tide_mod
17   USE sbctide         ! Tidal forcing or not
18   !
19   USE in_out_manager  ! I/O units
20   USE iom             ! I/0 library
21   USE ioipsl          ! NetCDF IPSL library
22   USE lbclnk          ! ocean lateral boundary conditions (or mpp link)
23   USE timing          ! preformance summary
24   USE lib_mpp           ! MPP library
25
26   IMPLICIT NONE
27   PRIVATE
28
29   LOGICAL, PUBLIC, PARAMETER :: lk_diaharm  = .TRUE.
30   
31   INTEGER, PARAMETER :: jpincomax    = 2.*jpmax_harmo
32   INTEGER, PARAMETER :: jpdimsparse  = jpincomax*300*24
33
34   !                         !!** namelist variables **
35   INTEGER ::   nit000_han    ! First time step used for harmonic analysis
36   INTEGER ::   nitend_han    ! Last time step used for harmonic analysis
37   INTEGER ::   nstep_han     ! Time step frequency for harmonic analysis
38   INTEGER ::   nb_ana        ! Number of harmonics to analyse
39
40   REAL(wp), ALLOCATABLE, DIMENSION(:,:,:,:) ::   ana_temp
41   REAL(wp), ALLOCATABLE, DIMENSION(:)       ::   ana_freq, ut   , vt   , ft
42   REAL(wp), ALLOCATABLE, DIMENSION(:,:,:)   ::   out_eta , out_u, out_v
43
44   INTEGER ::   ninco, nsparse
45   INTEGER ,       DIMENSION(jpdimsparse)         ::   njsparse, nisparse
46   INTEGER , SAVE, DIMENSION(jpincomax)           ::   ipos1
47   REAL(wp),       DIMENSION(jpdimsparse)         ::   valuesparse
48   REAL(wp),       DIMENSION(jpincomax)           ::   ztmp4 , ztmp7
49   REAL(wp), SAVE, DIMENSION(jpincomax,jpincomax) ::   ztmp3 , zpilier
50   REAL(wp), SAVE, DIMENSION(jpincomax)           ::   zpivot
51
52   CHARACTER (LEN=4), DIMENSION(jpmax_harmo) ::   tname   ! Names of tidal constituents ('M2', 'K1',...)
53
54   PUBLIC   dia_harm   ! routine called by step.F90
55
56   !!----------------------------------------------------------------------
57   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
58   !! $Id$
59   !! Software governed by the CeCILL license (see ./LICENSE)
60   !!----------------------------------------------------------------------
61CONTAINS
62
63   SUBROUTINE dia_harm_init 
64      !!----------------------------------------------------------------------
65      !!                 ***  ROUTINE dia_harm_init  ***
66      !!         
67      !! ** Purpose :   Initialization of tidal harmonic analysis
68      !!
69      !! ** Method  :   Initialize frequency array and  nodal factor for nit000_han
70      !!
71      !!--------------------------------------------------------------------
72      INTEGER :: jh, nhan, jk, ji
73      INTEGER ::   ios                 ! Local integer output status for namelist read
74      TYPE(tide), PUBLIC, DIMENSION(:), POINTER ::   tide_components ! Selected tidal components
75
76      NAMELIST/nam_diaharm/ nit000_han, nitend_han, nstep_han, tname
77      !!----------------------------------------------------------------------
78
79      IF(lwp) THEN
80         WRITE(numout,*)
81         WRITE(numout,*) 'dia_harm_init: Tidal harmonic analysis initialization'
82         WRITE(numout,*) '~~~~~~~ '
83      ENDIF
84      !
85      IF( .NOT. ln_tide )   CALL ctl_stop( 'dia_harm_init : ln_tide must be true for harmonic analysis')
86      !
87      REWIND( numnam_ref )              ! Namelist nam_diaharm in reference namelist : Tidal harmonic analysis
88      READ  ( numnam_ref, nam_diaharm, IOSTAT = ios, ERR = 901)
89901   IF( ios /= 0 )   CALL ctl_nam ( ios , 'nam_diaharm in reference namelist', lwp )
90      REWIND( numnam_cfg )              ! Namelist nam_diaharm in configuration namelist : Tidal harmonic analysis
91      READ  ( numnam_cfg, nam_diaharm, IOSTAT = ios, ERR = 902 )
92902   IF( ios >  0 )   CALL ctl_nam ( ios , 'nam_diaharm in configuration namelist', lwp )
93      IF(lwm) WRITE ( numond, nam_diaharm )
94      !
95      IF(lwp) THEN
96         WRITE(numout,*) 'First time step used for analysis:  nit000_han= ', nit000_han
97         WRITE(numout,*) 'Last  time step used for analysis:  nitend_han= ', nitend_han
98         WRITE(numout,*) 'Time step frequency for harmonic analysis:  nstep_han= ', nstep_han
99      ENDIF
100
101      ! Basic checks on harmonic analysis time window:
102      ! ----------------------------------------------
103      IF( nit000 > nit000_han )   CALL ctl_stop( 'dia_harm_init : nit000_han must be greater than nit000',   &
104         &                                       ' restart capability not implemented' )
105      IF( nitend < nitend_han )   CALL ctl_stop( 'dia_harm_init : nitend_han must be lower than nitend',   &
106         &                                       'restart capability not implemented' )
107
108      IF( MOD( nitend_han-nit000_han+1 , nstep_han ) /= 0 )   &
109         &                        CALL ctl_stop( 'dia_harm_init : analysis time span must be a multiple of nstep_han' )
110
111      ! Request parameters for tidal components that have been selected for
112      ! harmonic analysis
113      CALL tide_init_components(tname, tide_components)
114      ! Number of tidal components selected for harmonic analysis
115      nb_ana = size(tide_components)
116      !
117      IF(lwp) THEN
118         WRITE(numout,*) '        Namelist nam_diaharm'
119         WRITE(numout,*) '        nb_ana    = ', nb_ana
120         CALL flush(numout)
121      ENDIF
122      !
123      IF (nb_ana > jpmax_harmo) THEN
124         WRITE(ctmp1,*) 'Can not use XIOS in iom_g0d, file: '//TRIM(clname)//', var:'//TRIM(cdvar)
125         WRITE(ctmp2,*) ' jpmax_harmo= ', jpmax_harmo
126         CALL ctl_stop( 'dia_harm_init', ctmp1, ctmp2 )
127      ENDIF
128
129      ! Initialize frequency array:
130      ! ---------------------------
131      ALLOCATE( ana_freq(nb_ana), ut(nb_ana), vt(nb_ana), ft(nb_ana) )
132
133      CALL tide_harmo( ana_freq, vt, ut, ft, nb_ana )
134
135      IF(lwp) WRITE(numout,*) 'Analysed frequency  : ',nb_ana ,'Frequency '
136
137      DO jh = 1, nb_ana
138        IF(lwp) WRITE(numout,*) '                    : ',tname(jh),' ',ana_freq(jh)
139      END DO
140
141      ! Initialize temporary arrays:
142      ! ----------------------------
143      ALLOCATE( ana_temp(jpi,jpj,2*nb_ana,3) )
144      ana_temp(:,:,:,:) = 0._wp
145
146   END SUBROUTINE dia_harm_init
147
148
149   SUBROUTINE dia_harm ( kt )
150      !!----------------------------------------------------------------------
151      !!                 ***  ROUTINE dia_harm  ***
152      !!         
153      !! ** Purpose :   Tidal harmonic analysis main routine
154      !!
155      !! ** Action  :   Sums ssh/u/v over time analysis [nit000_han,nitend_han]
156      !!
157      !!--------------------------------------------------------------------
158      INTEGER, INTENT( IN ) :: kt
159      !
160      INTEGER  :: ji, jj, jh, jc, nhc
161      REAL(wp) :: ztime, ztemp
162      !!--------------------------------------------------------------------
163      IF( ln_timing )   CALL timing_start('dia_harm')
164      !
165      IF( kt == nit000 )   CALL dia_harm_init
166      !
167      IF( kt >= nit000_han .AND. kt <= nitend_han .AND. MOD(kt,nstep_han) == 0 ) THEN
168         !
169         ztime = (kt-nit000+1) * rdt 
170         !
171         nhc = 0
172         DO jh = 1, nb_ana
173            DO jc = 1, 2
174               nhc = nhc+1
175               ztemp =(     MOD(jc,2) * ft(jh) *COS(ana_freq(jh)*ztime + vt(jh) + ut(jh))  &
176                  &    +(1.-MOD(jc,2))* ft(jh) *SIN(ana_freq(jh)*ztime + vt(jh) + ut(jh)))
177                  !
178               DO jj = 1,jpj
179                  DO ji = 1,jpi
180                     ! Elevation
181                     ana_temp(ji,jj,nhc,1) = ana_temp(ji,jj,nhc,1) + ztemp*sshn(ji,jj)*ssmask (ji,jj)       
182                     ana_temp(ji,jj,nhc,2) = ana_temp(ji,jj,nhc,2) + ztemp*un_b(ji,jj)*ssumask(ji,jj)
183                     ana_temp(ji,jj,nhc,3) = ana_temp(ji,jj,nhc,3) + ztemp*vn_b(ji,jj)*ssvmask(ji,jj)
184                  END DO
185               END DO
186               !
187            END DO
188         END DO
189         !       
190      END IF
191      !
192      IF( kt == nitend_han )   CALL dia_harm_end
193      !
194      IF( ln_timing )   CALL timing_stop('dia_harm')
195      !
196   END SUBROUTINE dia_harm
197
198
199   SUBROUTINE dia_harm_end
200      !!----------------------------------------------------------------------
201      !!                 ***  ROUTINE diaharm_end  ***
202      !!         
203      !! ** Purpose :  Compute the Real and Imaginary part of tidal constituents
204      !!
205      !! ** Action  :  Decompose the signal on the harmonic constituents
206      !!
207      !!--------------------------------------------------------------------
208      INTEGER :: ji, jj, jh, jc, jn, nhan, jl
209      INTEGER :: ksp, kun, keq
210      REAL(wp) :: ztime, ztime_ini, ztime_end
211      REAL(wp) :: X1, X2
212      REAL(wp), DIMENSION(jpi,jpj,jpmax_harmo,2) ::   ana_amp   ! workspace
213      !!--------------------------------------------------------------------
214      !
215      IF(lwp) WRITE(numout,*)
216      IF(lwp) WRITE(numout,*) 'anharmo_end: kt=nitend_han: Perform harmonic analysis'
217      IF(lwp) WRITE(numout,*) '~~~~~~~~~~~~'
218
219      ztime_ini = nit000_han*rdt                 ! Initial time in seconds at the beginning of analysis
220      ztime_end = nitend_han*rdt                 ! Final time in seconds at the end of analysis
221      nhan = (nitend_han-nit000_han+1)/nstep_han ! Number of dumps used for analysis
222
223      ninco = 2*nb_ana
224
225      ksp = 0
226      keq = 0       
227      DO jn = 1, nhan
228         ztime=( (nhan-jn)*ztime_ini + (jn-1)*ztime_end )/FLOAT(nhan-1)
229         keq = keq + 1
230         kun = 0
231         DO jh = 1, nb_ana
232            DO jc = 1, 2
233               kun = kun + 1
234               ksp = ksp + 1
235               nisparse(ksp) = keq
236               njsparse(ksp) = kun
237               valuesparse(ksp) = (   MOD(jc,2) * ft(jh) * COS(ana_freq(jh)*ztime + vt(jh) + ut(jh))   &
238                  &             + (1.-MOD(jc,2))* ft(jh) * SIN(ana_freq(jh)*ztime + vt(jh) + ut(jh)) )
239            END DO
240         END DO
241      END DO
242
243      nsparse = ksp
244
245      ! Elevation:
246      DO jj = 1, jpj
247         DO ji = 1, jpi
248            ! Fill input array
249            kun = 0
250            DO jh = 1, nb_ana
251               DO jc = 1, 2
252                  kun = kun + 1
253                  ztmp4(kun)=ana_temp(ji,jj,kun,1)
254               END DO
255            END DO
256
257            CALL SUR_DETERMINE(jj)
258
259            ! Fill output array
260            DO jh = 1, nb_ana
261               ana_amp(ji,jj,jh,1)=ztmp7((jh-1)*2+1)
262               ana_amp(ji,jj,jh,2)=ztmp7((jh-1)*2+2)
263            END DO
264         END DO
265      END DO
266
267      ALLOCATE( out_eta(jpi,jpj,2*nb_ana),   & 
268         &      out_u  (jpi,jpj,2*nb_ana),   &
269         &      out_v  (jpi,jpj,2*nb_ana)  )
270
271      DO jj = 1, jpj
272         DO ji = 1, jpi
273            DO jh = 1, nb_ana 
274               X1 = ana_amp(ji,jj,jh,1)
275               X2 =-ana_amp(ji,jj,jh,2)
276               out_eta(ji,jj,jh       ) = X1 * tmask_i(ji,jj)
277               out_eta(ji,jj,jh+nb_ana) = X2 * tmask_i(ji,jj)
278            END DO
279         END DO
280      END DO
281
282      ! ubar:
283      DO jj = 1, jpj
284         DO ji = 1, jpi
285            ! Fill input array
286            kun=0
287            DO jh = 1,nb_ana
288               DO jc = 1,2
289                  kun = kun + 1
290                  ztmp4(kun)=ana_temp(ji,jj,kun,2)
291               END DO
292            END DO
293
294            CALL SUR_DETERMINE(jj+1)
295
296            ! Fill output array
297            DO jh = 1, nb_ana
298               ana_amp(ji,jj,jh,1) = ztmp7((jh-1)*2+1)
299               ana_amp(ji,jj,jh,2) = ztmp7((jh-1)*2+2)
300            END DO
301
302         END DO
303      END DO
304
305      DO jj = 1, jpj
306         DO ji = 1, jpi
307            DO jh = 1, nb_ana 
308               X1= ana_amp(ji,jj,jh,1)
309               X2=-ana_amp(ji,jj,jh,2)
310               out_u(ji,jj,       jh) = X1 * ssumask(ji,jj)
311               out_u(ji,jj,nb_ana+jh) = X2 * ssumask(ji,jj)
312            ENDDO
313         ENDDO
314      ENDDO
315
316      ! vbar:
317      DO jj = 1, jpj
318         DO ji = 1, jpi
319            ! Fill input array
320            kun=0
321            DO jh = 1,nb_ana
322               DO jc = 1,2
323                  kun = kun + 1
324                  ztmp4(kun)=ana_temp(ji,jj,kun,3)
325               END DO
326            END DO
327
328            CALL SUR_DETERMINE(jj+1)
329
330            ! Fill output array
331            DO jh = 1, nb_ana
332               ana_amp(ji,jj,jh,1)=ztmp7((jh-1)*2+1)
333               ana_amp(ji,jj,jh,2)=ztmp7((jh-1)*2+2)
334            END DO
335
336         END DO
337      END DO
338
339      DO jj = 1, jpj
340         DO ji = 1, jpi
341            DO jh = 1, nb_ana 
342               X1=ana_amp(ji,jj,jh,1)
343               X2=-ana_amp(ji,jj,jh,2)
344               out_v(ji,jj,       jh)=X1 * ssvmask(ji,jj)
345               out_v(ji,jj,nb_ana+jh)=X2 * ssvmask(ji,jj)
346            END DO
347         END DO
348      END DO
349      !
350      CALL dia_wri_harm ! Write results in files
351      !
352   END SUBROUTINE dia_harm_end
353
354
355   SUBROUTINE dia_wri_harm
356      !!--------------------------------------------------------------------
357      !!                 ***  ROUTINE dia_wri_harm  ***
358      !!         
359      !! ** Purpose : Write tidal harmonic analysis results in a netcdf file
360      !!--------------------------------------------------------------------
361      CHARACTER(LEN=lc) :: cltext
362      CHARACTER(LEN=lc) ::   &
363         cdfile_name_T   ,   & ! name of the file created (T-points)
364         cdfile_name_U   ,   & ! name of the file created (U-points)
365         cdfile_name_V         ! name of the file created (V-points)
366      INTEGER  ::   jh
367      !!----------------------------------------------------------------------
368
369      IF(lwp) WRITE(numout,*) '  '
370      IF(lwp) WRITE(numout,*) 'dia_wri_harm : Write harmonic analysis results'
371      IF(lwp) WRITE(numout,*) '  '
372
373      ! A) Elevation
374      !/////////////
375      !
376      DO jh = 1, nb_ana
377      CALL iom_put( TRIM(tname(jh))//'x', out_eta(:,:,jh) )
378      CALL iom_put( TRIM(tname(jh))//'y', out_eta(:,:,nb_ana+jh) )
379      END DO
380
381      ! B) ubar
382      !/////////
383      !
384      DO jh = 1, nb_ana
385      CALL iom_put( TRIM(tname(jh))//'x_u', out_u(:,:,jh) )
386      CALL iom_put( TRIM(tname(jh))//'y_u', out_u(:,:,nb_ana+jh) )
387      END DO
388
389      ! C) vbar
390      !/////////
391      !
392      DO jh = 1, nb_ana
393         CALL iom_put( TRIM(tname(jh))//'x_v', out_v(:,:,jh       ) )
394         CALL iom_put( TRIM(tname(jh))//'y_v', out_v(:,:,jh+nb_ana) )
395      END DO
396      !
397   END SUBROUTINE dia_wri_harm
398
399
400   SUBROUTINE SUR_DETERMINE(init)
401      !!---------------------------------------------------------------------------------
402      !!                      *** ROUTINE SUR_DETERMINE ***
403      !!   
404      !!   
405      !!       
406      !!---------------------------------------------------------------------------------
407      INTEGER, INTENT(in) ::   init 
408      !
409      INTEGER                         :: ji_sd, jj_sd, ji1_sd, ji2_sd, jk1_sd, jk2_sd
410      REAL(wp)                        :: zval1, zval2, zx1
411      REAL(wp), DIMENSION(jpincomax) :: ztmpx, zcol1, zcol2
412      INTEGER , DIMENSION(jpincomax) :: ipos2, ipivot
413      !---------------------------------------------------------------------------------
414      !           
415      IF( init == 1 ) THEN
416         IF( nsparse > jpdimsparse )   CALL ctl_stop( 'STOP', 'SUR_DETERMINE : nsparse .GT. jpdimsparse')
417         IF( ninco   > jpincomax   )   CALL ctl_stop( 'STOP', 'SUR_DETERMINE : ninco .GT. jpincomax')
418         !
419         ztmp3(:,:) = 0._wp
420         !
421         DO jk1_sd = 1, nsparse
422            DO jk2_sd = 1, nsparse
423               nisparse(jk2_sd) = nisparse(jk2_sd)
424               njsparse(jk2_sd) = njsparse(jk2_sd)
425               IF( nisparse(jk2_sd) == nisparse(jk1_sd) ) THEN
426                  ztmp3(njsparse(jk1_sd),njsparse(jk2_sd)) = ztmp3(njsparse(jk1_sd),njsparse(jk2_sd))  &
427                     &                                     + valuesparse(jk1_sd)*valuesparse(jk2_sd)
428               ENDIF
429            END DO
430         END DO
431         !
432         DO jj_sd = 1 ,ninco
433            ipos1(jj_sd) = jj_sd
434            ipos2(jj_sd) = jj_sd
435         END DO
436         !
437         DO ji_sd = 1 , ninco
438            !
439            !find greatest non-zero pivot:
440            zval1 = ABS(ztmp3(ji_sd,ji_sd))
441            !
442            ipivot(ji_sd) = ji_sd
443            DO jj_sd = ji_sd, ninco
444               zval2 = ABS(ztmp3(ji_sd,jj_sd))
445               IF( zval2 >= zval1 )THEN
446                  ipivot(ji_sd) = jj_sd
447                  zval1         = zval2
448               ENDIF
449            END DO
450            !
451            DO ji1_sd = 1, ninco
452               zcol1(ji1_sd)               = ztmp3(ji1_sd,ji_sd)
453               zcol2(ji1_sd)               = ztmp3(ji1_sd,ipivot(ji_sd))
454               ztmp3(ji1_sd,ji_sd)         = zcol2(ji1_sd)
455               ztmp3(ji1_sd,ipivot(ji_sd)) = zcol1(ji1_sd)
456            END DO
457            !
458            ipos2(ji_sd)         = ipos1(ipivot(ji_sd))
459            ipos2(ipivot(ji_sd)) = ipos1(ji_sd)
460            ipos1(ji_sd)         = ipos2(ji_sd)
461            ipos1(ipivot(ji_sd)) = ipos2(ipivot(ji_sd))
462            zpivot(ji_sd)        = ztmp3(ji_sd,ji_sd)
463            DO jj_sd = 1, ninco
464               ztmp3(ji_sd,jj_sd) = ztmp3(ji_sd,jj_sd) / zpivot(ji_sd)
465            END DO
466            !
467            DO ji2_sd = ji_sd+1, ninco
468               zpilier(ji2_sd,ji_sd)=ztmp3(ji2_sd,ji_sd)
469               DO jj_sd=1,ninco
470                  ztmp3(ji2_sd,jj_sd)=  ztmp3(ji2_sd,jj_sd) - ztmp3(ji_sd,jj_sd) * zpilier(ji2_sd,ji_sd)
471               END DO
472            END DO
473            !
474         END DO
475         !
476      ENDIF ! End init==1
477
478      DO ji_sd = 1, ninco
479         ztmp4(ji_sd) = ztmp4(ji_sd) / zpivot(ji_sd)
480         DO ji2_sd = ji_sd+1, ninco
481            ztmp4(ji2_sd) = ztmp4(ji2_sd) - ztmp4(ji_sd) * zpilier(ji2_sd,ji_sd)
482         END DO
483      END DO
484
485      !system solving:
486      ztmpx(ninco) = ztmp4(ninco) / ztmp3(ninco,ninco)
487      ji_sd = ninco
488      DO ji_sd = ninco-1, 1, -1
489         zx1 = 0._wp
490         DO jj_sd = ji_sd+1, ninco
491            zx1 = zx1 + ztmpx(jj_sd) * ztmp3(ji_sd,jj_sd)
492         END DO
493         ztmpx(ji_sd) = ztmp4(ji_sd)-zx1
494      END DO
495
496      DO jj_sd =1, ninco
497         ztmp7(ipos1(jj_sd))=ztmpx(jj_sd)
498      END DO
499      !
500   END SUBROUTINE SUR_DETERMINE
501
502#else
503   !!----------------------------------------------------------------------
504   !!   Default case :   Empty module
505   !!----------------------------------------------------------------------
506   LOGICAL, PUBLIC, PARAMETER ::   lk_diaharm = .FALSE.
507CONTAINS
508   SUBROUTINE dia_harm ( kt )     ! Empty routine
509      INTEGER, INTENT( IN ) :: kt 
510      WRITE(*,*) 'dia_harm: you should not have seen this print'
511   END SUBROUTINE dia_harm
512#endif
513
514   !!======================================================================
515END MODULE diaharm
Note: See TracBrowser for help on using the repository browser.