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.
diacfl.F90 in NEMO/branches/2018/dev_r9838_ENHANCE04_MLF/src/OCE/DIA – NEMO

source: NEMO/branches/2018/dev_r9838_ENHANCE04_MLF/src/OCE/DIA/diacfl.F90 @ 9923

Last change on this file since 9923 was 9923, checked in by gm, 6 years ago

#1911 (ENHANCE-04): step I.2: dev_r9838_ENHANCE04_MLF
  • Property svn:keywords set to Id
File size: 8.1 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 timing          ! Performance output
20
21   IMPLICIT NONE
22   PRIVATE
23
24   CHARACTER(LEN=50) :: clname="cfl_diagnostics.ascii"    ! ascii filename
25   INTEGER           :: numcfl                            ! outfile unit
26   !
27   INTEGER, DIMENSION(3) ::   nCu_loc, nCv_loc, nCw_loc   ! U, V, and W run max locations in the global domain
28   REAL(wp)              ::   rCu_max, rCv_max, rCw_max   ! associated run max Courant number
29
30!!gm CAUTION: need to declare these arrays here, otherwise the calculation fails in multi-proc !
31!!gm          I don't understand why.
32   REAL(wp), ALLOCATABLE, DIMENSION(:,:,:) ::   zCu_cfl, zCv_cfl, zCw_cfl         ! workspace
33!!gm end
34
35   PUBLIC   dia_cfl       ! routine called by step.F90
36   PUBLIC   dia_cfl_init  ! routine called by nemogcm
37
38   !! * Substitutions
39#  include "vectopt_loop_substitute.h90"
40   !!----------------------------------------------------------------------
41   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
42   !! $Id$
43   !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt)
44   !!----------------------------------------------------------------------
45CONTAINS
46
47   SUBROUTINE dia_cfl ( kt )
48      !!----------------------------------------------------------------------
49      !!                  ***  ROUTINE dia_cfl  ***
50      !!
51      !! ** Purpose :  Compute the Courant numbers Cu=u*dt/dx and Cv=v*dt/dy
52      !!               and output to ascii file 'cfl_diagnostics.ascii'
53      !!----------------------------------------------------------------------
54      INTEGER, INTENT(in) ::   kt   ! ocean time-step index
55      !
56      INTEGER :: ji, jj, jk   ! dummy loop indices
57      REAL(wp)::   zCu_max, zCv_max, zCw_max       ! local scalars
58      INTEGER , DIMENSION(3)           ::   iloc_u , iloc_v , iloc_w , iloc   ! workspace
59!!gm this does not work      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   zCu_cfl, zCv_cfl, zCw_cfl         ! workspace
60      !!----------------------------------------------------------------------
61      !
62      IF( ln_timing )   CALL timing_start('dia_cfl')
63      !
64      !               
65      DO jk = 1, jpk       ! calculate Courant numbers
66         DO jj = 1, jpj
67            DO ji = 1, fs_jpim1   ! vector opt.
68               zCu_cfl(ji,jj,jk) = ABS( un(ji,jj,jk) ) * rDt / e1u  (ji,jj)      ! for i-direction
69               zCv_cfl(ji,jj,jk) = ABS( vn(ji,jj,jk) ) * rDt / e2v  (ji,jj)      ! for j-direction
70               zCw_cfl(ji,jj,jk) = ABS( wn(ji,jj,jk) ) * rDt / e3w_n(ji,jj,jk)   ! for k-direction
71            END DO
72         END DO         
73      END DO
74      !
75      !                    ! calculate maximum values and locations
76      IF( lk_mpp ) THEN
77         CALL mpp_maxloc( zCu_cfl, umask, zCu_max, iloc_u(1), iloc_u(2), iloc_u(3) )
78         CALL mpp_maxloc( zCv_cfl, vmask, zCv_max, iloc_v(1), iloc_v(2), iloc_v(3) )
79         CALL mpp_maxloc( zCw_cfl, wmask, zCw_max, iloc_w(1), iloc_w(2), iloc_w(3) )
80      ELSE
81         iloc = MAXLOC( ABS( zcu_cfl(:,:,:) ) )
82         iloc_u(1) = iloc(1) + nimpp - 1
83         iloc_u(2) = iloc(2) + njmpp - 1
84         iloc_u(3) = iloc(3)
85         zCu_max = zCu_cfl(iloc(1),iloc(2),iloc(3))
86         !
87         iloc = MAXLOC( ABS( zcv_cfl(:,:,:) ) )
88         iloc_v(1) = iloc(1) + nimpp - 1
89         iloc_v(2) = iloc(2) + njmpp - 1
90         iloc_v(3) = iloc(3)
91         zCv_max = zCv_cfl(iloc(1),iloc(2),iloc(3))
92         !
93         iloc = MAXLOC( ABS( zcw_cfl(:,:,:) ) )
94         iloc_w(1) = iloc(1) + nimpp - 1
95         iloc_w(2) = iloc(2) + njmpp - 1
96         iloc_w(3) = iloc(3)
97         zCw_max = zCw_cfl(iloc(1),iloc(2),iloc(3))
98      ENDIF
99      !
100      !                    ! write out to file
101      IF( lwp ) THEN
102         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)
103         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)
104         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)
105      ENDIF
106      !
107      !                    ! update maximum Courant numbers from whole run if applicable
108      IF( zCu_max > rCu_max ) THEN   ;   rCu_max = zCu_max   ;   nCu_loc(:) = iloc_u(:)   ;   ENDIF
109      IF( zCv_max > rCv_max ) THEN   ;   rCv_max = zCv_max   ;   nCv_loc(:) = iloc_v(:)   ;   ENDIF
110      IF( zCw_max > rCw_max ) THEN   ;   rCw_max = zCw_max   ;   nCw_loc(:) = iloc_w(:)   ;   ENDIF
111
112      !                    ! at end of run output max Cu and Cv and close ascii file
113      IF( kt == nitend .AND. lwp ) THEN
114         ! to ascii file
115         WRITE(numcfl,*) '******************************************'
116         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)
117         WRITE(numcfl,FMT='(3x,a8,11x,f15.1)') ' => dt/C', rDt/rCu_max
118         WRITE(numcfl,*) '******************************************'
119         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)
120         WRITE(numcfl,FMT='(3x,a8,11x,f15.1)') ' => dt/C', rDt/rCv_max
121         WRITE(numcfl,*) '******************************************'
122         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)
123         WRITE(numcfl,FMT='(3x,a8,11x,f15.1)') ' => dt/C', rDt/rCw_max
124         CLOSE( numcfl ) 
125         !
126         ! to ocean output
127         WRITE(numout,*)
128         WRITE(numout,*) 'dia_cfl : Maximum Courant number information for the run '
129         WRITE(numout,*) '~~~~~~~'
130         WRITE(numout,*) '   Max Cu = ', rCu_max, ' at (i,j,k) = (',nCu_loc(1),nCu_loc(2),nCu_loc(3),') => dt/C = ', rDt/rCu_max
131         WRITE(numout,*) '   Max Cv = ', rCv_max, ' at (i,j,k) = (',nCv_loc(1),nCv_loc(2),nCv_loc(3),') => dt/C = ', rDt/rCv_max
132         WRITE(numout,*) '   Max Cw = ', rCw_max, ' at (i,j,k) = (',nCw_loc(1),nCw_loc(2),nCw_loc(3),') => dt/C = ', rDt/rCw_max
133      ENDIF
134      !
135      IF( ln_timing )   CALL timing_stop('dia_cfl')
136      !
137   END SUBROUTINE dia_cfl
138
139
140   SUBROUTINE dia_cfl_init
141      !!----------------------------------------------------------------------
142      !!                  ***  ROUTINE dia_cfl_init  ***
143      !!                   
144      !! ** Purpose :   create output file, initialise arrays
145      !!----------------------------------------------------------------------
146      !
147      IF(lwp) THEN
148         WRITE(numout,*)
149         WRITE(numout,*) 'dia_cfl : Outputting CFL diagnostics to ',TRIM(clname), ' file'
150         WRITE(numout,*) '~~~~~~~'
151         WRITE(numout,*)
152         !
153         ! create output ascii file
154         CALL ctl_opn( numcfl, clname, 'UNKNOWN', 'FORMATTED', 'SEQUENTIAL', 1, numout, lwp, 1 )
155         WRITE(numcfl,*) 'Timestep  Direction  Max C     i    j    k'
156         WRITE(numcfl,*) '******************************************'
157      ENDIF
158      !
159      rCu_max = 0._wp
160      rCv_max = 0._wp
161      rCw_max = 0._wp
162      !
163!!gm required to work
164      ALLOCATE ( zCu_cfl(jpi,jpj,jpk), zCv_cfl(jpi,jpj,jpk), zCw_cfl(jpi,jpj,jpk) )
165!!gm end
166      !     
167   END SUBROUTINE dia_cfl_init
168
169   !!======================================================================
170END MODULE diacfl
Note: See TracBrowser for help on using the repository browser.