[11930] | 1 | MODULE stpctl |
---|
| 2 | !!====================================================================== |
---|
| 3 | !! *** MODULE stpctl *** |
---|
| 4 | !! Ocean run control : gross check of the ocean time stepping |
---|
| 5 | !! version for STATION_ASF test-case |
---|
| 6 | !!====================================================================== |
---|
| 7 | !! History : OPA ! 1991-03 (G. Madec) Original code |
---|
| 8 | !! 6.0 ! 1992-06 (M. Imbard) |
---|
| 9 | !! 8.0 ! 1997-06 (A.M. Treguier) |
---|
| 10 | !! NEMO 1.0 ! 2002-06 (G. Madec) F90: Free form and module |
---|
| 11 | !! 2.0 ! 2009-07 (G. Madec) Add statistic for time-spliting |
---|
| 12 | !! 3.7 ! 2016-09 (G. Madec) Remove solver |
---|
| 13 | !! 4.0 ! 2017-04 (G. Madec) regroup global communications |
---|
| 14 | !!---------------------------------------------------------------------- |
---|
| 15 | |
---|
| 16 | !!---------------------------------------------------------------------- |
---|
| 17 | !! stp_ctl : Control the run |
---|
| 18 | !!---------------------------------------------------------------------- |
---|
| 19 | USE dom_oce ! ocean space and time domain variables |
---|
| 20 | USE sbc_oce ! surface fluxes and stuff |
---|
[13540] | 21 | ! |
---|
[12249] | 22 | USE diawri ! Standard run outputs (dia_wri_state routine) |
---|
[11930] | 23 | USE in_out_manager ! I/O manager |
---|
| 24 | USE lbclnk ! ocean lateral boundary conditions (or mpp link) |
---|
| 25 | USE lib_mpp ! distributed memory computing |
---|
[13540] | 26 | ! |
---|
[11930] | 27 | USE netcdf ! NetCDF library |
---|
| 28 | IMPLICIT NONE |
---|
| 29 | PRIVATE |
---|
| 30 | |
---|
| 31 | PUBLIC stp_ctl ! routine called by step.F90 |
---|
| 32 | |
---|
[13540] | 33 | INTEGER :: nrunid ! netcdf file id |
---|
| 34 | INTEGER, DIMENSION(3) :: nvarid ! netcdf variable id |
---|
[11930] | 35 | !!---------------------------------------------------------------------- |
---|
| 36 | !! NEMO/SAS 4.0 , NEMO Consortium (2018) |
---|
| 37 | !! $Id: stpctl.F90 10603 2019-01-29 11:18:09Z acc $ |
---|
| 38 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
| 39 | !!---------------------------------------------------------------------- |
---|
| 40 | CONTAINS |
---|
| 41 | |
---|
[13540] | 42 | SUBROUTINE stp_ctl( kt, Kmm ) |
---|
[11930] | 43 | !!---------------------------------------------------------------------- |
---|
| 44 | !! *** ROUTINE stp_ctl *** |
---|
[13540] | 45 | !! |
---|
[11930] | 46 | !! ** Purpose : Control the run |
---|
| 47 | !! |
---|
| 48 | !! ** Method : - Save the time step in numstp |
---|
[13540] | 49 | !! - Stop the run IF problem encountered by setting nstop > 0 |
---|
| 50 | !! Problems checked: wind stress module max larger than 5 N/m^2 |
---|
| 51 | !! non-solar heat flux max larger than 2000 W/m^2 |
---|
| 52 | !! Evaporation-Precip max larger than 1.E-3 kg/m^2/s |
---|
[11930] | 53 | !! |
---|
| 54 | !! ** Actions : "time.step" file = last ocean time-step |
---|
| 55 | !! "run.stat" file = run statistics |
---|
[13540] | 56 | !! nstop indicator sheared among all local domain |
---|
[11930] | 57 | !!---------------------------------------------------------------------- |
---|
| 58 | INTEGER, INTENT(in ) :: kt ! ocean time-step index |
---|
[13540] | 59 | INTEGER, INTENT(in ) :: Kmm ! ocean time level index |
---|
[11930] | 60 | !! |
---|
[13540] | 61 | INTEGER :: ji ! dummy loop indices |
---|
| 62 | INTEGER :: idtime, istatus |
---|
| 63 | INTEGER , DIMENSION(4) :: iareasum, iareamin, iareamax |
---|
| 64 | INTEGER , DIMENSION(3,3) :: iloc ! min/max loc indices |
---|
| 65 | REAL(wp) :: zzz ! local real |
---|
| 66 | REAL(wp), DIMENSION(4) :: zmax, zmaxlocal |
---|
| 67 | LOGICAL :: ll_wrtstp, ll_colruns, ll_wrtruns |
---|
| 68 | LOGICAL, DIMENSION(jpi,jpj) :: llmsk |
---|
| 69 | CHARACTER(len=20) :: clname |
---|
[11930] | 70 | !!---------------------------------------------------------------------- |
---|
[13540] | 71 | IF( nstop > 0 .AND. ngrdstop > -1 ) RETURN ! stpctl was already called by a child grid |
---|
[11930] | 72 | ! |
---|
[13540] | 73 | ll_wrtstp = ( MOD( kt-nit000, sn_cfctl%ptimincr ) == 0 ) .OR. ( kt == nitend ) |
---|
| 74 | ll_colruns = ll_wrtstp .AND. sn_cfctl%l_runstat .AND. jpnij > 1 |
---|
| 75 | ll_wrtruns = ( ll_colruns .OR. jpnij == 1 ) .AND. lwm |
---|
| 76 | ! |
---|
| 77 | IF( kt == nit000 ) THEN |
---|
| 78 | ! |
---|
| 79 | IF( lwp ) THEN |
---|
| 80 | WRITE(numout,*) |
---|
| 81 | WRITE(numout,*) 'stp_ctl : time-stepping control' |
---|
| 82 | WRITE(numout,*) '~~~~~~~' |
---|
| 83 | ENDIF |
---|
| 84 | ! ! open time.step ascii file, done only by 1st subdomain |
---|
| 85 | IF( lwm ) CALL ctl_opn( numstp, 'time.step', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, numout, lwp, narea ) |
---|
| 86 | ! |
---|
| 87 | IF( ll_wrtruns ) THEN |
---|
| 88 | ! ! open run.stat ascii file, done only by 1st subdomain |
---|
[11930] | 89 | CALL ctl_opn( numrun, 'run.stat', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, numout, lwp, narea ) |
---|
[13540] | 90 | ! ! open run.stat.nc netcdf file, done only by 1st subdomain |
---|
[11930] | 91 | clname = 'run.stat.nc' |
---|
| 92 | IF( .NOT. Agrif_Root() ) clname = TRIM(Agrif_CFixed())//"_"//TRIM(clname) |
---|
[13540] | 93 | istatus = NF90_CREATE( TRIM(clname), NF90_CLOBBER, nrunid ) |
---|
| 94 | istatus = NF90_DEF_DIM( nrunid, 'time', NF90_UNLIMITED, idtime ) |
---|
| 95 | istatus = NF90_DEF_VAR( nrunid, 'tau_max', NF90_DOUBLE, (/ idtime /), nvarid(1) ) |
---|
| 96 | istatus = NF90_DEF_VAR( nrunid, 'qns_max', NF90_DOUBLE, (/ idtime /), nvarid(2) ) |
---|
| 97 | istatus = NF90_DEF_VAR( nrunid, 'emp_max', NF90_DOUBLE, (/ idtime /), nvarid(3) ) |
---|
| 98 | istatus = NF90_ENDDEF(nrunid) |
---|
[11930] | 99 | ENDIF |
---|
[13540] | 100 | ! |
---|
[11930] | 101 | ENDIF |
---|
| 102 | ! |
---|
[13540] | 103 | ! !== write current time step ==! |
---|
| 104 | ! !== done only by 1st subdomain at writting timestep ==! |
---|
| 105 | IF( lwm .AND. ll_wrtstp ) THEN |
---|
[11930] | 106 | WRITE ( numstp, '(1x, i8)' ) kt |
---|
| 107 | REWIND( numstp ) |
---|
| 108 | ENDIF |
---|
[13540] | 109 | ! !== test of local extrema ==! |
---|
| 110 | ! !== done by all processes at every time step ==! |
---|
[11930] | 111 | ! |
---|
[13540] | 112 | llmsk( 1:Nis1,:) = .FALSE. ! exclude halos from the checked region |
---|
| 113 | llmsk(Nie1: jpi,:) = .FALSE. |
---|
| 114 | llmsk(:, 1:Njs1) = .FALSE. |
---|
| 115 | llmsk(:,Nje1: jpj) = .FALSE. |
---|
[11930] | 116 | ! |
---|
[13540] | 117 | llmsk(Nis0:Nie0,Njs0:Nje0) = tmask(Nis0:Nie0,Njs0:Nje0,1) == 1._wp ! test only the inner domain |
---|
| 118 | IF( COUNT( llmsk(:,:) ) > 0 ) THEN ! avoid huge values sent back for land processors... |
---|
| 119 | zmax(1) = MAXVAL( taum(:,:) , mask = llmsk ) ! max wind stress module |
---|
| 120 | zmax(2) = MAXVAL( ABS( qns(:,:) ) , mask = llmsk ) ! max non-solar heat flux |
---|
| 121 | zmax(3) = MAXVAL( ABS( emp(:,:) ) , mask = llmsk ) ! max E-P |
---|
| 122 | ELSE |
---|
| 123 | IF( ll_colruns ) THEN ! default value: must not be kept when calling mpp_max -> must be as small as possible |
---|
| 124 | zmax(1:3) = -HUGE(1._wp) |
---|
| 125 | ELSE ! default value: must not give true for any of the tests bellow (-> avoid manipulating HUGE...) |
---|
| 126 | zmax(1:3) = 0._wp |
---|
| 127 | ENDIF |
---|
| 128 | ENDIF |
---|
| 129 | zmax(4) = REAL( nstop, wp ) ! stop indicator |
---|
| 130 | ! !== get global extrema ==! |
---|
| 131 | ! !== done by all processes if writting run.stat ==! |
---|
[11930] | 132 | IF( ll_colruns ) THEN |
---|
[13540] | 133 | zmaxlocal(:) = zmax(:) |
---|
[11930] | 134 | CALL mpp_max( "stpctl", zmax ) ! max over the global domain |
---|
[13540] | 135 | nstop = NINT( zmax(4) ) ! update nstop indicator (now sheared among all local domains) |
---|
[11930] | 136 | ENDIF |
---|
[13540] | 137 | ! !== write "run.stat" files ==! |
---|
| 138 | ! !== done only by 1st subdomain at writting timestep ==! |
---|
[11930] | 139 | IF( ll_wrtruns ) THEN |
---|
| 140 | WRITE(numrun,9500) kt, zmax(1), zmax(2), zmax(3) |
---|
[13540] | 141 | istatus = NF90_PUT_VAR( nrunid, nvarid(1), (/ zmax(1)/), (/kt/), (/1/) ) |
---|
| 142 | istatus = NF90_PUT_VAR( nrunid, nvarid(2), (/ zmax(2)/), (/kt/), (/1/) ) |
---|
| 143 | istatus = NF90_PUT_VAR( nrunid, nvarid(3), (/ zmax(3)/), (/kt/), (/1/) ) |
---|
| 144 | IF( kt == nitend ) istatus = NF90_CLOSE(nrunid) |
---|
[11930] | 145 | END IF |
---|
[13540] | 146 | ! !== error handling ==! |
---|
| 147 | ! !== done by all processes at every time step ==! |
---|
| 148 | ! |
---|
| 149 | IF( zmax(1) > 5._wp .OR. & ! too large wind stress ( > 5 N/m^2 ) |
---|
| 150 | & zmax(2) > 2000._wp .OR. & ! too large non-solar heat flux ( > 2000 W/m^2 ) |
---|
| 151 | & zmax(3) > 1.E-3_wp .OR. & ! too large net freshwater flux ( > 1.E-3 kg/m^2/s ) |
---|
| 152 | & ISNAN( zmax(1) + zmax(2) + zmax(3) ) .OR. & ! NaN encounter in the tests |
---|
| 153 | & ABS( zmax(1) + zmax(2) + zmax(3) ) > HUGE(1._wp) ) THEN ! Infinity encounter in the tests |
---|
| 154 | ! |
---|
| 155 | iloc(:,:) = 0 |
---|
| 156 | IF( ll_colruns ) THEN ! zmax is global, so it is the same on all subdomains -> no dead lock with mpp_maxloc |
---|
| 157 | ! first: close the netcdf file, so we can read it |
---|
| 158 | IF( lwm .AND. kt /= nitend ) istatus = NF90_CLOSE(nrunid) |
---|
| 159 | ! get global loc on the min/max |
---|
| 160 | CALL mpp_maxloc( 'stpctl', taum(:,:) , llmsk, zzz, iloc(1:2,1) ) ! mpp_maxloc ok if mask = F |
---|
| 161 | CALL mpp_maxloc( 'stpctl',ABS( qns(:,:) ), llmsk, zzz, iloc(1:2,2) ) |
---|
| 162 | CALL mpp_minloc( 'stpctl',ABS( emp(:,:) ), llmsk, zzz, iloc(1:2,3) ) |
---|
| 163 | ! find which subdomain has the max. |
---|
| 164 | iareamin(:) = jpnij+1 ; iareamax(:) = 0 ; iareasum(:) = 0 |
---|
| 165 | DO ji = 1, 4 |
---|
| 166 | IF( zmaxlocal(ji) == zmax(ji) ) THEN |
---|
| 167 | iareamin(ji) = narea ; iareamax(ji) = narea ; iareasum(ji) = 1 |
---|
| 168 | ENDIF |
---|
| 169 | END DO |
---|
| 170 | CALL mpp_min( "stpctl", iareamin ) ! min over the global domain |
---|
| 171 | CALL mpp_max( "stpctl", iareamax ) ! max over the global domain |
---|
| 172 | CALL mpp_sum( "stpctl", iareasum ) ! sum over the global domain |
---|
| 173 | ELSE ! find local min and max locations: |
---|
| 174 | ! if we are here, this means that the subdomain contains some oce points -> no need to test the mask used in maxloc |
---|
| 175 | iloc(1:2,1) = MAXLOC( taum(:,:) , mask = llmsk ) |
---|
| 176 | iloc(1:2,2) = MAXLOC( ABS( qns(:,:) ), mask = llmsk ) |
---|
| 177 | iloc(1:2,3) = MINLOC( ABS( emp(:,:) ), mask = llmsk ) |
---|
| 178 | DO ji = 1, 3 ! local domain indices ==> global domain indices, excluding halos |
---|
| 179 | iloc(1:2,ji) = (/ mig0(iloc(1,ji)), mjg0(iloc(2,ji)) /) |
---|
| 180 | END DO |
---|
| 181 | iareamin(:) = narea ; iareamax(:) = narea ; iareasum(:) = 1 ! this is local information |
---|
| 182 | ENDIF |
---|
| 183 | ! |
---|
[11930] | 184 | WRITE(ctmp1,*) ' stp_ctl: |tau_mod| > 5 N/m2 or |qns| > 2000 W/m2 or |emp| > 1.E-3 or NaN encounter in the tests' |
---|
[13540] | 185 | CALL wrt_line( ctmp2, kt, '|tau| max', zmax(1), iloc(:,1), iareasum(1), iareamin(1), iareamax(1) ) |
---|
| 186 | CALL wrt_line( ctmp3, kt, '|qns| max', zmax(2), iloc(:,2), iareasum(2), iareamin(2), iareamax(2) ) |
---|
| 187 | CALL wrt_line( ctmp4, kt, 'emp max', zmax(3), iloc(:,3), iareasum(3), iareamin(3), iareamax(3) ) |
---|
| 188 | IF( Agrif_Root() ) THEN |
---|
| 189 | WRITE(ctmp6,*) ' ===> output of last computed fields in output.abort* files' |
---|
[11930] | 190 | ELSE |
---|
[13540] | 191 | WRITE(ctmp6,*) ' ===> output of last computed fields in '//TRIM(Agrif_CFixed())//'_output.abort* files' |
---|
[11930] | 192 | ENDIF |
---|
| 193 | ! |
---|
[13540] | 194 | CALL dia_wri_state( Kmm, 'output.abort' ) ! create an output.abort file |
---|
| 195 | ! |
---|
| 196 | IF( ll_colruns .or. jpnij == 1 ) THEN ! all processes synchronized -> use lwp to print in opened ocean.output files |
---|
| 197 | IF(lwp) THEN ; CALL ctl_stop( ctmp1, ' ', ctmp2, ctmp3, ctmp4, ctmp5, ' ', ctmp6 ) |
---|
| 198 | ELSE ; nstop = MAX(1, nstop) ! make sure nstop > 0 (automatically done when calling ctl_stop) |
---|
| 199 | ENDIF |
---|
| 200 | ELSE ! only mpi subdomains with errors are here -> STOP now |
---|
| 201 | CALL ctl_stop( 'STOP', ctmp1, ' ', ctmp2, ctmp3, ctmp4, ctmp5, ' ', ctmp6 ) |
---|
| 202 | ENDIF |
---|
| 203 | ! |
---|
[11930] | 204 | ENDIF |
---|
| 205 | ! |
---|
[13540] | 206 | IF( nstop > 0 ) THEN ! an error was detected and we did not abort yet... |
---|
| 207 | ngrdstop = Agrif_Fixed() ! store which grid got this error |
---|
| 208 | IF( .NOT. ll_colruns .AND. jpnij > 1 ) CALL ctl_stop( 'STOP' ) ! we must abort here to avoid MPI deadlock |
---|
| 209 | ENDIF |
---|
| 210 | ! |
---|
[11930] | 211 | 9500 FORMAT(' it :', i8, ' tau_max: ', D23.16, ' |qns|_max: ', D23.16,' |emp|_max: ', D23.16) |
---|
| 212 | ! |
---|
| 213 | END SUBROUTINE stp_ctl |
---|
| 214 | |
---|
[13540] | 215 | |
---|
| 216 | SUBROUTINE wrt_line( cdline, kt, cdprefix, pval, kloc, ksum, kmin, kmax ) |
---|
| 217 | !!---------------------------------------------------------------------- |
---|
| 218 | !! *** ROUTINE wrt_line *** |
---|
| 219 | !! |
---|
| 220 | !! ** Purpose : write information line |
---|
| 221 | !! |
---|
| 222 | !!---------------------------------------------------------------------- |
---|
| 223 | CHARACTER(len=*), INTENT( out) :: cdline |
---|
| 224 | CHARACTER(len=*), INTENT(in ) :: cdprefix |
---|
| 225 | REAL(wp), INTENT(in ) :: pval |
---|
| 226 | INTEGER, DIMENSION(3), INTENT(in ) :: kloc |
---|
| 227 | INTEGER, INTENT(in ) :: kt, ksum, kmin, kmax |
---|
| 228 | ! |
---|
| 229 | CHARACTER(len=80) :: clsuff |
---|
| 230 | CHARACTER(len=9 ) :: clkt, clsum, clmin, clmax |
---|
| 231 | CHARACTER(len=9 ) :: cli, clj, clk |
---|
| 232 | CHARACTER(len=1 ) :: clfmt |
---|
| 233 | CHARACTER(len=4 ) :: cl4 ! needed to be able to compile with Agrif, I don't know why |
---|
| 234 | INTEGER :: ifmtk |
---|
| 235 | !!---------------------------------------------------------------------- |
---|
| 236 | WRITE(clkt , '(i9)') kt |
---|
| 237 | |
---|
| 238 | WRITE(clfmt, '(i1)') INT(LOG10(REAL(jpnij ,wp))) + 1 ! how many digits to we need to write ? (we decide max = 9) |
---|
| 239 | !!! WRITE(clsum, '(i'//clfmt//')') ksum ! this is creating a compilation error with AGRIF |
---|
| 240 | cl4 = '(i'//clfmt//')' ; WRITE(clsum, cl4) ksum |
---|
| 241 | WRITE(clfmt, '(i1)') INT(LOG10(REAL(MAX(1,jpnij-1),wp))) + 1 ! how many digits to we need to write ? (we decide max = 9) |
---|
| 242 | cl4 = '(i'//clfmt//')' ; WRITE(clmin, cl4) kmin-1 |
---|
| 243 | WRITE(clmax, cl4) kmax-1 |
---|
| 244 | ! |
---|
| 245 | WRITE(clfmt, '(i1)') INT(LOG10(REAL(jpiglo,wp))) + 1 ! how many digits to we need to write jpiglo? (we decide max = 9) |
---|
| 246 | cl4 = '(i'//clfmt//')' ; WRITE(cli, cl4) kloc(1) ! this is ok with AGRIF |
---|
| 247 | WRITE(clfmt, '(i1)') INT(LOG10(REAL(jpjglo,wp))) + 1 ! how many digits to we need to write jpjglo? (we decide max = 9) |
---|
| 248 | cl4 = '(i'//clfmt//')' ; WRITE(clj, cl4) kloc(2) ! this is ok with AGRIF |
---|
| 249 | ! |
---|
| 250 | IF( ksum == 1 ) THEN ; WRITE(clsuff,9100) TRIM(clmin) |
---|
| 251 | ELSE ; WRITE(clsuff,9200) TRIM(clsum), TRIM(clmin), TRIM(clmax) |
---|
| 252 | ENDIF |
---|
| 253 | IF(kloc(3) == 0) THEN |
---|
| 254 | ifmtk = INT(LOG10(REAL(jpk,wp))) + 1 ! how many digits to we need to write jpk? (we decide max = 9) |
---|
| 255 | clk = REPEAT(' ', ifmtk) ! create the equivalent in blank string |
---|
| 256 | WRITE(cdline,9300) TRIM(ADJUSTL(clkt)), TRIM(ADJUSTL(cdprefix)), pval, TRIM(cli), TRIM(clj), clk(1:ifmtk), TRIM(clsuff) |
---|
| 257 | ELSE |
---|
| 258 | WRITE(clfmt, '(i1)') INT(LOG10(REAL(jpk,wp))) + 1 ! how many digits to we need to write jpk? (we decide max = 9) |
---|
| 259 | !!! WRITE(clk, '(i'//clfmt//')') kloc(3) ! this is creating a compilation error with AGRIF |
---|
| 260 | cl4 = '(i'//clfmt//')' ; WRITE(clk, cl4) kloc(3) ! this is ok with AGRIF |
---|
| 261 | WRITE(cdline,9400) TRIM(ADJUSTL(clkt)), TRIM(ADJUSTL(cdprefix)), pval, TRIM(cli), TRIM(clj), TRIM(clk), TRIM(clsuff) |
---|
| 262 | ENDIF |
---|
| 263 | ! |
---|
| 264 | 9100 FORMAT('MPI rank ', a) |
---|
| 265 | 9200 FORMAT('found in ', a, ' MPI tasks, spread out among ranks ', a, ' to ', a) |
---|
| 266 | 9300 FORMAT('kt ', a, ' ', a, ' ', 1pg11.4, ' at i j ', a, ' ', a, ' ', a, ' ', a) |
---|
| 267 | 9400 FORMAT('kt ', a, ' ', a, ' ', 1pg11.4, ' at i j k ', a, ' ', a, ' ', a, ' ', a) |
---|
| 268 | ! |
---|
| 269 | END SUBROUTINE wrt_line |
---|
| 270 | |
---|
| 271 | |
---|
[11930] | 272 | !!====================================================================== |
---|
| 273 | END MODULE stpctl |
---|