source: NEMO/releases/release-4.0/src/OCE/DIA/diacfl.F90 @ 10823

Last change on this file since 10823 was 10823, checked in by clem, 19 months ago

output cfl diagnostics (courant numbers) in netcdf ⇒ add cfl_cu, cfl_cv, cfl_cw

  • Property svn:keywords set to Id
File size: 8.6 KB
Line 
1MODULE diacfl
2   !!======================================================================
3   !!                       ***  MODULE  diacfl  ***
4   !! Output CFL diagnostics to ascii file
5   !!======================================================================
6   !! History :  3.4  !  2010-03  (E. Blockley)  Original code
7   !!            3.6  !  2014-06  (T. Graham)  Removed CPP key & Updated to vn3.6
8   !!            4.0  !  2017-09  (G. Madec)  style + comments
9   !!----------------------------------------------------------------------
10   !!   dia_cfl        : Compute and output Courant numbers at each timestep
11   !!----------------------------------------------------------------------
12   USE oce             ! ocean dynamics and active tracers
13   USE dom_oce         ! ocean space and time domain
14   USE domvvl          !
15   !
16   USE lib_mpp         ! distribued memory computing
17   USE lbclnk          ! ocean lateral boundary condition (or mpp link)
18   USE in_out_manager  ! I/O manager
19   USE iom             !
20   USE timing          ! Performance output
21
22   IMPLICIT NONE
23   PRIVATE
24
25   CHARACTER(LEN=50) :: clname="cfl_diagnostics.ascii"    ! ascii filename
26   INTEGER           :: numcfl                            ! outfile unit
27   !
28   INTEGER, DIMENSION(3) ::   nCu_loc, nCv_loc, nCw_loc   ! U, V, and W run max locations in the global domain
29   REAL(wp)              ::   rCu_max, rCv_max, rCw_max   ! associated run max Courant number
30
31!!gm CAUTION: need to declare these arrays here, otherwise the calculation fails in multi-proc !
32!!gm          I don't understand why.
33   REAL(wp), ALLOCATABLE, DIMENSION(:,:,:) ::   zCu_cfl, zCv_cfl, zCw_cfl         ! workspace
34!!gm end
35
36   PUBLIC   dia_cfl       ! routine called by step.F90
37   PUBLIC   dia_cfl_init  ! routine called by nemogcm
38
39   !! * Substitutions
40#  include "vectopt_loop_substitute.h90"
41   !!----------------------------------------------------------------------
42   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
43   !! $Id$
44   !! Software governed by the CeCILL license (see ./LICENSE)
45   !!----------------------------------------------------------------------
46CONTAINS
47
48   SUBROUTINE dia_cfl ( kt )
49      !!----------------------------------------------------------------------
50      !!                  ***  ROUTINE dia_cfl  ***
51      !!
52      !! ** Purpose :  Compute the Courant numbers Cu=u*dt/dx and Cv=v*dt/dy
53      !!               and output to ascii file 'cfl_diagnostics.ascii'
54      !!----------------------------------------------------------------------
55      INTEGER, INTENT(in) ::   kt   ! ocean time-step index
56      !
57      INTEGER                ::   ji, jj, jk                            ! dummy loop indices
58      REAL(wp)               ::   z2dt, zCu_max, zCv_max, zCw_max       ! local scalars
59      INTEGER , DIMENSION(3) ::   iloc_u , iloc_v , iloc_w , iloc       ! workspace
60!!gm this does not work      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   zCu_cfl, zCv_cfl, zCw_cfl         ! workspace
61      !!----------------------------------------------------------------------
62      !
63      IF( ln_timing )   CALL timing_start('dia_cfl')
64      !
65      !                       ! setup timestep multiplier to account for initial Eulerian timestep
66      IF( neuler == 0 .AND. kt == nit000 ) THEN   ;    z2dt = rdt
67      ELSE                                        ;    z2dt = rdt * 2._wp
68      ENDIF
69      !
70      !               
71      DO jk = 1, jpk       ! calculate Courant numbers
72         DO jj = 1, jpj
73            DO ji = 1, fs_jpim1   ! vector opt.
74               zCu_cfl(ji,jj,jk) = ABS( un(ji,jj,jk) ) * z2dt / e1u  (ji,jj)      ! for i-direction
75               zCv_cfl(ji,jj,jk) = ABS( vn(ji,jj,jk) ) * z2dt / e2v  (ji,jj)      ! for j-direction
76               zCw_cfl(ji,jj,jk) = ABS( wn(ji,jj,jk) ) * z2dt / e3w_n(ji,jj,jk)   ! for k-direction
77            END DO
78         END DO         
79      END DO
80      !
81      ! write outputs
82      IF( iom_use('cfl_cu') )   CALL iom_put( 'cfl_cu', MAXVAL( zCu_cfl, dim=3 ) )
83      IF( iom_use('cfl_cv') )   CALL iom_put( 'cfl_cv', MAXVAL( zCv_cfl, dim=3 ) )
84      IF( iom_use('cfl_cw') )   CALL iom_put( 'cfl_cw', MAXVAL( zCw_cfl, dim=3 ) )
85
86      !                    ! calculate maximum values and locations
87      IF( lk_mpp ) THEN
88         CALL mpp_maxloc( 'diacfl', zCu_cfl, umask, zCu_max, iloc_u )
89         CALL mpp_maxloc( 'diacfl', zCv_cfl, vmask, zCv_max, iloc_v )
90         CALL mpp_maxloc( 'diacfl', zCw_cfl, wmask, zCw_max, iloc_w )
91      ELSE
92         iloc = MAXLOC( ABS( zcu_cfl(:,:,:) ) )
93         iloc_u(1) = iloc(1) + nimpp - 1
94         iloc_u(2) = iloc(2) + njmpp - 1
95         iloc_u(3) = iloc(3)
96         zCu_max = zCu_cfl(iloc(1),iloc(2),iloc(3))
97         !
98         iloc = MAXLOC( ABS( zcv_cfl(:,:,:) ) )
99         iloc_v(1) = iloc(1) + nimpp - 1
100         iloc_v(2) = iloc(2) + njmpp - 1
101         iloc_v(3) = iloc(3)
102         zCv_max = zCv_cfl(iloc(1),iloc(2),iloc(3))
103         !
104         iloc = MAXLOC( ABS( zcw_cfl(:,:,:) ) )
105         iloc_w(1) = iloc(1) + nimpp - 1
106         iloc_w(2) = iloc(2) + njmpp - 1
107         iloc_w(3) = iloc(3)
108         zCw_max = zCw_cfl(iloc(1),iloc(2),iloc(3))
109      ENDIF
110      !
111      !                    ! write out to file
112      IF( lwp ) THEN
113         WRITE(numcfl,FMT='(2x,i4,5x,a6,4x,f7.4,1x,i4,1x,i4,1x,i4)') kt, 'Max Cu', zCu_max, iloc_u(1), iloc_u(2), iloc_u(3)
114         WRITE(numcfl,FMT='(11x,     a6,4x,f7.4,1x,i4,1x,i4,1x,i4)')     'Max Cv', zCv_max, iloc_v(1), iloc_v(2), iloc_v(3)
115         WRITE(numcfl,FMT='(11x,     a6,4x,f7.4,1x,i4,1x,i4,1x,i4)')     'Max Cw', zCw_max, iloc_w(1), iloc_w(2), iloc_w(3)
116      ENDIF
117      !
118      !                    ! update maximum Courant numbers from whole run if applicable
119      IF( zCu_max > rCu_max ) THEN   ;   rCu_max = zCu_max   ;   nCu_loc(:) = iloc_u(:)   ;   ENDIF
120      IF( zCv_max > rCv_max ) THEN   ;   rCv_max = zCv_max   ;   nCv_loc(:) = iloc_v(:)   ;   ENDIF
121      IF( zCw_max > rCw_max ) THEN   ;   rCw_max = zCw_max   ;   nCw_loc(:) = iloc_w(:)   ;   ENDIF
122
123      !                    ! at end of run output max Cu and Cv and close ascii file
124      IF( kt == nitend .AND. lwp ) THEN
125         ! to ascii file
126         WRITE(numcfl,*) '******************************************'
127         WRITE(numcfl,FMT='(3x,a12,6x,f7.4,1x,i4,1x,i4,1x,i4)') 'Run Max Cu', rCu_max, nCu_loc(1), nCu_loc(2), nCu_loc(3)
128         WRITE(numcfl,FMT='(3x,a8,11x,f15.1)') ' => dt/C', z2dt/rCu_max
129         WRITE(numcfl,*) '******************************************'
130         WRITE(numcfl,FMT='(3x,a12,6x,f7.4,1x,i4,1x,i4,1x,i4)') 'Run Max Cv', rCv_max, nCv_loc(1), nCv_loc(2), nCv_loc(3)
131         WRITE(numcfl,FMT='(3x,a8,11x,f15.1)') ' => dt/C', z2dt/rCv_max
132         WRITE(numcfl,*) '******************************************'
133         WRITE(numcfl,FMT='(3x,a12,6x,f7.4,1x,i4,1x,i4,1x,i4)') 'Run Max Cw', rCw_max, nCw_loc(1), nCw_loc(2), nCw_loc(3)
134         WRITE(numcfl,FMT='(3x,a8,11x,f15.1)') ' => dt/C', z2dt/rCw_max
135         CLOSE( numcfl ) 
136         !
137         ! to ocean output
138         WRITE(numout,*)
139         WRITE(numout,*) 'dia_cfl : Maximum Courant number information for the run '
140         WRITE(numout,*) '~~~~~~~'
141         WRITE(numout,*) '   Max Cu = ', rCu_max, ' at (i,j,k) = (',nCu_loc(1),nCu_loc(2),nCu_loc(3),') => dt/C = ', z2dt/rCu_max
142         WRITE(numout,*) '   Max Cv = ', rCv_max, ' at (i,j,k) = (',nCv_loc(1),nCv_loc(2),nCv_loc(3),') => dt/C = ', z2dt/rCv_max
143         WRITE(numout,*) '   Max Cw = ', rCw_max, ' at (i,j,k) = (',nCw_loc(1),nCw_loc(2),nCw_loc(3),') => dt/C = ', z2dt/rCw_max
144      ENDIF
145      !
146      IF( ln_timing )   CALL timing_stop('dia_cfl')
147      !
148   END SUBROUTINE dia_cfl
149
150
151   SUBROUTINE dia_cfl_init
152      !!----------------------------------------------------------------------
153      !!                  ***  ROUTINE dia_cfl_init  ***
154      !!                   
155      !! ** Purpose :   create output file, initialise arrays
156      !!----------------------------------------------------------------------
157      !
158      IF(lwp) THEN
159         WRITE(numout,*)
160         WRITE(numout,*) 'dia_cfl : Outputting CFL diagnostics to ',TRIM(clname), ' file'
161         WRITE(numout,*) '~~~~~~~'
162         WRITE(numout,*)
163         !
164         ! create output ascii file
165         CALL ctl_opn( numcfl, clname, 'UNKNOWN', 'FORMATTED', 'SEQUENTIAL', 1, numout, lwp, 1 )
166         WRITE(numcfl,*) 'Timestep  Direction  Max C     i    j    k'
167         WRITE(numcfl,*) '******************************************'
168      ENDIF
169      !
170      rCu_max = 0._wp
171      rCv_max = 0._wp
172      rCw_max = 0._wp
173      !
174!!gm required to work
175      ALLOCATE ( zCu_cfl(jpi,jpj,jpk), zCv_cfl(jpi,jpj,jpk), zCw_cfl(jpi,jpj,jpk) )
176!!gm end
177      !     
178   END SUBROUTINE dia_cfl_init
179
180   !!======================================================================
181END MODULE diacfl
Note: See TracBrowser for help on using the repository browser.