| 1 | MODULE stpctl |
|---|
| 2 | !!====================================================================== |
|---|
| 3 | !! *** MODULE stpctl *** |
|---|
| 4 | !! Ocean run control : gross check of the ocean time stepping |
|---|
| 5 | !!====================================================================== |
|---|
| 6 | !! History : OPA ! 1991-03 (G. Madec) Original code |
|---|
| 7 | !! 6.0 ! 1992-06 (M. Imbard) |
|---|
| 8 | !! 8.0 ! 1997-06 (A.M. Treguier) |
|---|
| 9 | !! NEMO 1.0 ! 2002-06 (G. Madec) F90: Free form and module |
|---|
| 10 | !! 2.0 ! 2009-07 (G. Madec) Add statistic for time-spliting |
|---|
| 11 | !!---------------------------------------------------------------------- |
|---|
| 12 | |
|---|
| 13 | !!---------------------------------------------------------------------- |
|---|
| 14 | !! stp_ctl : Control the run |
|---|
| 15 | !!---------------------------------------------------------------------- |
|---|
| 16 | USE oce ! ocean dynamics and tracers variables |
|---|
| 17 | USE dom_oce ! ocean space and time domain variables |
|---|
| 18 | USE sol_oce ! ocean space and time domain variables |
|---|
| 19 | USE sbc_oce ! surface boundary conditions variables |
|---|
| 20 | USE in_out_manager ! I/O manager |
|---|
| 21 | USE lbclnk ! ocean lateral boundary conditions (or mpp link) |
|---|
| 22 | USE lib_mpp ! distributed memory computing |
|---|
| 23 | USE dynspg_oce ! pressure gradient schemes |
|---|
| 24 | USE c1d ! 1D vertical configuration |
|---|
| 25 | |
|---|
| 26 | |
|---|
| 27 | USE yomhook, ONLY: lhook, dr_hook |
|---|
| 28 | USE parkind1, ONLY: jprb, jpim |
|---|
| 29 | |
|---|
| 30 | IMPLICIT NONE |
|---|
| 31 | PRIVATE |
|---|
| 32 | |
|---|
| 33 | PUBLIC stp_ctl ! routine called by step.F90 |
|---|
| 34 | !!---------------------------------------------------------------------- |
|---|
| 35 | !! NEMO/OPA 3.3 , NEMO Consortium (2010) |
|---|
| 36 | !! $Id$ |
|---|
| 37 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
|---|
| 38 | !!---------------------------------------------------------------------- |
|---|
| 39 | |
|---|
| 40 | CONTAINS |
|---|
| 41 | |
|---|
| 42 | SUBROUTINE stp_ctl( kt, kindic ) |
|---|
| 43 | !!---------------------------------------------------------------------- |
|---|
| 44 | !! *** ROUTINE stp_ctl *** |
|---|
| 45 | !! |
|---|
| 46 | !! ** Purpose : Control the run |
|---|
| 47 | !! |
|---|
| 48 | !! ** Method : - Save the time step in numstp |
|---|
| 49 | !! - Print it each 50 time steps |
|---|
| 50 | !! - Print solver statistics in numsol |
|---|
| 51 | !! - Stop the run IF problem for the solver ( indec < 0 ) |
|---|
| 52 | !! |
|---|
| 53 | !! ** Actions : 'time.step' file containing the last ocean time-step |
|---|
| 54 | !! |
|---|
| 55 | !!---------------------------------------------------------------------- |
|---|
| 56 | INTEGER, INTENT( in ) :: kt ! ocean time-step index |
|---|
| 57 | INTEGER, INTENT( inout ) :: kindic ! indicator of solver convergence |
|---|
| 58 | !! |
|---|
| 59 | CHARACTER(len = 32) :: clfname ! time stepping output file name |
|---|
| 60 | INTEGER :: ji, jj, jk ! dummy loop indices |
|---|
| 61 | INTEGER :: ii, ij, ik ! temporary integers |
|---|
| 62 | REAL(wp) :: zumax, zsmin, zssh2 ! temporary scalars |
|---|
| 63 | REAL(wp) :: ztmax, ztmin ! Scalar to get temperature extreme |
|---|
| 64 | ! values and warn if they're out of Range |
|---|
| 65 | INTEGER, DIMENSION(3) :: ilocu ! |
|---|
| 66 | INTEGER, DIMENSION(2) :: ilocs ! |
|---|
| 67 | INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0 |
|---|
| 68 | INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1 |
|---|
| 69 | REAL(KIND=jprb) :: zhook_handle |
|---|
| 70 | |
|---|
| 71 | CHARACTER(LEN=*), PARAMETER :: RoutineName='STP_CTL' |
|---|
| 72 | |
|---|
| 73 | IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle) |
|---|
| 74 | |
|---|
| 75 | !!---------------------------------------------------------------------- |
|---|
| 76 | |
|---|
| 77 | IF( kt == nit000 .AND. lwp ) THEN |
|---|
| 78 | WRITE(numout,*) |
|---|
| 79 | WRITE(numout,*) 'stp_ctl : time-stepping control' |
|---|
| 80 | WRITE(numout,*) '~~~~~~~' |
|---|
| 81 | ! open time.step file with special treatment for SAS |
|---|
| 82 | IF ( nn_components == jp_iam_sas ) THEN |
|---|
| 83 | clfname = 'time.step.sas' |
|---|
| 84 | ELSE |
|---|
| 85 | clfname = 'time.step' |
|---|
| 86 | ENDIF |
|---|
| 87 | CALL ctl_opn( numstp, TRIM(clfname), 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, numout, lwp, narea ) |
|---|
| 88 | ENDIF |
|---|
| 89 | |
|---|
| 90 | IF(lwp) WRITE ( numstp, '(1x, i8)' ) kt !* save the current time step in numstp |
|---|
| 91 | IF(lwp) REWIND( numstp ) ! -------------------------- |
|---|
| 92 | |
|---|
| 93 | ! !* Test maximum of velocity (zonal only) |
|---|
| 94 | ! ! ------------------------ |
|---|
| 95 | !! zumax = MAXVAL( ABS( un(:,:,:) ) ) ! slower than the following loop on NEC SX5 |
|---|
| 96 | zumax = 0.e0 |
|---|
| 97 | DO jk = 1, jpk |
|---|
| 98 | DO jj = 1, jpj |
|---|
| 99 | DO ji = 1, jpi |
|---|
| 100 | zumax = MAX(zumax,ABS(un(ji,jj,jk))) |
|---|
| 101 | END DO |
|---|
| 102 | END DO |
|---|
| 103 | END DO |
|---|
| 104 | IF( lk_mpp ) CALL mpp_max( zumax ) ! max over the global domain |
|---|
| 105 | ! |
|---|
| 106 | IF( MOD( kt, nwrite ) == 1 .AND. lwp ) WRITE(numout,*) ' ==>> time-step= ',kt,' abs(U) max: ', zumax |
|---|
| 107 | ! |
|---|
| 108 | IF( zumax > 20.e0 ) THEN |
|---|
| 109 | IF( lk_mpp ) THEN |
|---|
| 110 | CALL mpp_maxloc(ABS(un),umask,zumax,ii,ij,ik) |
|---|
| 111 | ELSE |
|---|
| 112 | ilocu = MAXLOC( ABS( un(:,:,:) ) ) |
|---|
| 113 | ii = ilocu(1) + nimpp - 1 |
|---|
| 114 | ij = ilocu(2) + njmpp - 1 |
|---|
| 115 | ik = ilocu(3) |
|---|
| 116 | ENDIF |
|---|
| 117 | IF(lwp) THEN |
|---|
| 118 | WRITE(numout,cform_err) |
|---|
| 119 | WRITE(numout,*) ' stpctl: the zonal velocity is larger than 20 m/s' |
|---|
| 120 | WRITE(numout,*) ' ====== ' |
|---|
| 121 | WRITE(numout,9400) kt, zumax, ii, ij, ik |
|---|
| 122 | WRITE(numout,*) |
|---|
| 123 | WRITE(numout,*) ' output of last fields in numwso' |
|---|
| 124 | ENDIF |
|---|
| 125 | kindic = -3 |
|---|
| 126 | ENDIF |
|---|
| 127 | 9400 FORMAT (' kt=',i6,' max abs(U): ',1pg11.4,', i j k: ',3i5) |
|---|
| 128 | |
|---|
| 129 | ! !* Test minimum of salinity |
|---|
| 130 | ! ! ------------------------ |
|---|
| 131 | !! zsmin = MINVAL( tsn(:,:,1,jp_sal), mask = tmask(:,:,1) == 1.e0 ) slower than the following loop on NEC SX5 |
|---|
| 132 | zsmin = 100.e0 |
|---|
| 133 | DO jj = 2, jpjm1 |
|---|
| 134 | DO ji = 1, jpi |
|---|
| 135 | IF( tmask(ji,jj,1) == 1) zsmin = MIN(zsmin,tsn(ji,jj,1,jp_sal)) |
|---|
| 136 | END DO |
|---|
| 137 | END DO |
|---|
| 138 | IF( lk_mpp ) CALL mpp_min( zsmin ) ! min over the global domain |
|---|
| 139 | ! |
|---|
| 140 | IF( MOD( kt, nwrite ) == 1 .AND. lwp ) WRITE(numout,*) ' ==>> time-step= ',kt,' SSS min:', zsmin |
|---|
| 141 | ! |
|---|
| 142 | IF( zsmin < 0.) THEN |
|---|
| 143 | IF (lk_mpp) THEN |
|---|
| 144 | CALL mpp_minloc ( tsn(:,:,1,jp_sal),tmask(:,:,1), zsmin, ii,ij ) |
|---|
| 145 | ELSE |
|---|
| 146 | ilocs = MINLOC( tsn(:,:,1,jp_sal), mask = tmask(:,:,1) == 1.e0 ) |
|---|
| 147 | ii = ilocs(1) + nimpp - 1 |
|---|
| 148 | ij = ilocs(2) + njmpp - 1 |
|---|
| 149 | ENDIF |
|---|
| 150 | ! |
|---|
| 151 | IF(lwp) THEN |
|---|
| 152 | WRITE(numout,cform_err) |
|---|
| 153 | WRITE(numout,*) 'stp_ctl : NEGATIVE sea surface salinity' |
|---|
| 154 | WRITE(numout,*) '======= ' |
|---|
| 155 | WRITE(numout,9500) kt, zsmin, ii, ij |
|---|
| 156 | WRITE(numout,*) |
|---|
| 157 | WRITE(numout,*) ' output of last fields in numwso' |
|---|
| 158 | ENDIF |
|---|
| 159 | kindic = -3 |
|---|
| 160 | ENDIF |
|---|
| 161 | 9500 FORMAT (' kt=',i6,' min SSS: ',1pg11.4,', i j: ',2i5) |
|---|
| 162 | |
|---|
| 163 | ! ==================================================================================================== |
|---|
| 164 | ! ==================================================================================================== |
|---|
| 165 | ! !AXY (25/10/17) |
|---|
| 166 | ! !* Test max/min limits of temperature |
|---|
| 167 | ! ! ---------------------------------- |
|---|
| 168 | ztmax = -5.e0 ! arbitrary low maximum value |
|---|
| 169 | ztmin = 100.e0 ! arbitrary high minimum value |
|---|
| 170 | DO jj = 2, jpjm1 |
|---|
| 171 | DO ji = 2, jpim1 |
|---|
| 172 | IF( tmask(ji,jj,1) == 1) THEN |
|---|
| 173 | ztmax = MAX(ztmax,tsn(ji,jj,1,jp_tem)) ! find local maximum |
|---|
| 174 | ztmin = MIN(ztmin,tsn(ji,jj,1,jp_tem)) ! find local minimum |
|---|
| 175 | ENDIF |
|---|
| 176 | END DO |
|---|
| 177 | END DO |
|---|
| 178 | IF( lk_mpp ) CALL mpp_max( ztmax ) ! max over the global domain |
|---|
| 179 | IF( lk_mpp ) CALL mpp_min( ztmin ) ! min over the global domain |
|---|
| 180 | ! |
|---|
| 181 | IF( ztmax > 40.) THEN ! we've got a problem |
|---|
| 182 | IF (lk_mpp) THEN |
|---|
| 183 | CALL mpp_maxloc ( tsn(:,:,1,jp_tem),tmask(:,:,1), ztmax, ii,ij ) |
|---|
| 184 | ELSE |
|---|
| 185 | ilocs = MAXLOC( tsn(:,:,1,jp_tem), mask = tmask(:,:,1) == 1.e0 ) |
|---|
| 186 | ii = ilocs(1) + nimpp - 1 |
|---|
| 187 | ij = ilocs(2) + njmpp - 1 |
|---|
| 188 | ENDIF |
|---|
| 189 | ! |
|---|
| 190 | IF(lwp) THEN |
|---|
| 191 | WRITE(numout,*) 'stp_ctl:tracer anomaly: ***** WARNING *****' |
|---|
| 192 | WRITE(numout,*) 'stp_ctl:tracer anomaly: sea surface temperature > 40C' |
|---|
| 193 | WRITE(numout,9600) kt, ztmax, ii, ij |
|---|
| 194 | WRITE(numout,*) 'stp_ctl:tracer anomaly: ***** END OF WARNING *****' |
|---|
| 195 | ENDIF |
|---|
| 196 | ENDIF |
|---|
| 197 | ! |
|---|
| 198 | IF( ztmin < -10.) THEN ! we've got a problem |
|---|
| 199 | IF (lk_mpp) THEN |
|---|
| 200 | CALL mpp_minloc ( tsn(:,:,1,jp_tem),tmask(:,:,1), ztmin, ii,ij ) |
|---|
| 201 | ELSE |
|---|
| 202 | ilocs = MINLOC( tsn(:,:,1,jp_tem), mask = tmask(:,:,1) == 1.e0 ) |
|---|
| 203 | ii = ilocs(1) + nimpp - 1 |
|---|
| 204 | ij = ilocs(2) + njmpp - 1 |
|---|
| 205 | ENDIF |
|---|
| 206 | ! |
|---|
| 207 | IF(lwp) THEN |
|---|
| 208 | WRITE(numout,*) 'stp_ctl:tracer anomaly: ***** WARNING *****' |
|---|
| 209 | WRITE(numout,*) 'stp_ctl:tracer anomaly: sea surface temperature < -10C' |
|---|
| 210 | WRITE(numout,9700) kt, ztmin, ii, ij |
|---|
| 211 | WRITE(numout,*) 'stp_ctl:tracer anomaly: ***** END OF WARNING *****' |
|---|
| 212 | ENDIF |
|---|
| 213 | ENDIF |
|---|
| 214 | 9600 FORMAT ('stp_ctl:tracer anomaly: kt=',i6,' max SST: ',f16.10,', i j: ',2i5) |
|---|
| 215 | 9700 FORMAT ('stp_ctl:tracer anomaly: kt=',i6,' min SST: ',f16.10,', i j: ',2i5) |
|---|
| 216 | ! ==================================================================================================== |
|---|
| 217 | ! ==================================================================================================== |
|---|
| 218 | |
|---|
| 219 | IF( lk_c1d ) RETURN ! No log file in case of 1D vertical configuration |
|---|
| 220 | |
|---|
| 221 | ! log file (solver or ssh statistics) |
|---|
| 222 | ! -------- |
|---|
| 223 | IF( lk_dynspg_flt ) THEN ! elliptic solver statistics (if required) |
|---|
| 224 | ! |
|---|
| 225 | IF(lwp) WRITE(numsol,9200) kt, niter, res, SQRT(epsr)/eps ! Solver |
|---|
| 226 | ! |
|---|
| 227 | IF( kindic < 0 .AND. zsmin > 0.e0 .AND. zumax <= 20.e0 ) THEN ! create a abort file if problem found |
|---|
| 228 | IF(lwp) THEN |
|---|
| 229 | WRITE(numout,*) ' stpctl: the elliptic solver DO not converge or explode' |
|---|
| 230 | WRITE(numout,*) ' ====== ' |
|---|
| 231 | WRITE(numout,9200) kt, niter, res, sqrt(epsr)/eps |
|---|
| 232 | WRITE(numout,*) |
|---|
| 233 | WRITE(numout,*) ' stpctl: output of last fields' |
|---|
| 234 | WRITE(numout,*) ' ====== ' |
|---|
| 235 | ENDIF |
|---|
| 236 | ENDIF |
|---|
| 237 | ! |
|---|
| 238 | ELSE !* ssh statistics (and others...) |
|---|
| 239 | IF( kt == nit000 .AND. lwp ) THEN ! open ssh statistics file (put in solver.stat file) |
|---|
| 240 | CALL ctl_opn( numsol, 'solver.stat', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, numout, lwp, narea ) |
|---|
| 241 | ENDIF |
|---|
| 242 | ! |
|---|
| 243 | zssh2 = SUM( sshn(:,:) * sshn(:,:) * tmask_i(:,:) ) |
|---|
| 244 | IF( lk_mpp ) CALL mpp_sum( zssh2 ) ! sum over the global domain |
|---|
| 245 | ! |
|---|
| 246 | IF(lwp) WRITE(numsol,9300) kt, zssh2, zumax, zsmin ! ssh statistics |
|---|
| 247 | ! |
|---|
| 248 | ENDIF |
|---|
| 249 | |
|---|
| 250 | 9200 FORMAT('it:', i8, ' iter:', i4, ' r: ',e16.10, ' b: ',e16.10 ) |
|---|
| 251 | 9300 FORMAT(' it :', i8, ' ssh2: ', e16.10, ' Umax: ',e16.10,' Smin: ',e16.10) |
|---|
| 252 | ! |
|---|
| 253 | IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle) |
|---|
| 254 | END SUBROUTINE stp_ctl |
|---|
| 255 | |
|---|
| 256 | !!====================================================================== |
|---|
| 257 | END MODULE stpctl |
|---|
