source: branches/2017/dev_r7832_HPC08_lbclnk_3rd_dim/NEMOGCM/NEMO/OPA_SRC/stpctl.F90 @ 7902

Last change on this file since 7902 was 7902, checked in by gm, 3 years ago

#1880: (HPC-08) stp_cfl, check |ssh| instead of ssh2

  • Property svn:keywords set to Id
File size: 6.4 KB
Line 
1MODULE 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   !!            3.7  ! 2016-09  (G. Madec)  Remove solver
12   !!            4.0  ! 2017-04  (G. Madec)  regroup global communications
13   !!----------------------------------------------------------------------
14
15   !!----------------------------------------------------------------------
16   !!   stp_ctl      : Control the run
17   !!----------------------------------------------------------------------
18   USE oce             ! ocean dynamics and tracers variables
19   USE dom_oce         ! ocean space and time domain variables
20   USE c1d             ! 1D vertical configuration
21   !
22   USE in_out_manager  ! I/O manager
23   USE lbclnk          ! ocean lateral boundary conditions (or mpp link)
24   USE lib_mpp         ! distributed memory computing
25
26   IMPLICIT NONE
27   PRIVATE
28
29   PUBLIC stp_ctl           ! routine called by step.F90
30   !!----------------------------------------------------------------------
31   !! NEMO/OPA 4.0 , NEMO Consortium (2017)
32   !! $Id$
33   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
34   !!----------------------------------------------------------------------
35CONTAINS
36
37   SUBROUTINE stp_ctl( kt, kindic )
38      !!----------------------------------------------------------------------
39      !!                    ***  ROUTINE stp_ctl  ***
40      !!                     
41      !! ** Purpose :   Control the run
42      !!
43      !! ** Method  : - Save the time step in numstp
44      !!              - Print it each 50 time steps
45      !!              - Stop the run IF problem encountered by setting indic=-3
46      !!                Problems checked: |U| maximum larger than 10 m/s
47      !!                                  negative sea surface salinity
48      !!
49      !! ** Actions :   "time.step" file = last ocean time-step
50      !!                "run.stat"  file = run statistics
51      !!----------------------------------------------------------------------
52      INTEGER, INTENT(in   ) ::   kt       ! ocean time-step index
53      INTEGER, INTENT(inout) ::   kindic   ! error indicator
54      !!
55      INTEGER  ::   ji, jj, jk             ! dummy loop indices
56      INTEGER  ::   iih, ijh               ! local integers
57      INTEGER  ::   iiu, iju, iku          !   -       -
58      INTEGER  ::   iis, ijs               !   -       -
59      REAL(wp) ::   zzz                    ! local real
60      INTEGER , DIMENSION(3) ::   ilocu
61      INTEGER , DIMENSION(2) ::   ilocs, iloch
62      REAL(wp), DIMENSION(3) ::   zmax
63      !!----------------------------------------------------------------------
64      !
65      IF( kt == nit000 .AND. lwp ) THEN
66         WRITE(numout,*)
67         WRITE(numout,*) 'stp_ctl : time-stepping control'
68         WRITE(numout,*) '~~~~~~~'
69         !                                ! open time.step file
70         CALL ctl_opn( numstp, 'time.step', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, numout, lwp, narea )
71         !                                ! open run.stat file
72         CALL ctl_opn( numrun, 'run.stat', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, numout, lwp, narea )
73      ENDIF
74      !
75      IF(lwp) THEN                        !==  current time step  ==!   ("time.step" file)
76         WRITE ( numstp, '(1x, i8)' )   kt
77         REWIND( numstp )
78      ENDIF
79      !
80      !                                   !==  test of extrema  ==!
81      zmax(1) = MAXVAL(  ABS( sshn(:,:) )  )                                  ! ssh max
82      zmax(2) = MAXVAL(  ABS( un(:,:,:) )  )                                  ! velocity max (zonal only)
83      zmax(3) = MAXVAL( -tsn(:,:,1,jp_sal) , mask = tmask(:,:,1) == 1._wp )   ! minus surface salinity max
84      !
85      IF( lk_mpp )   CALL mpp_max_multiple( zmax(:), 3 ) ! max over the global domain
86      !
87      IF( MOD( kt, nwrite ) == 1 .AND. lwp ) THEN
88         WRITE(numout,*) ' ==>> time-step= ',kt,' |U| max: ', zmax(1), ' SSS min:', - zmax(2)
89      ENDIF
90      !
91      IF ( zmax(2) > 10._wp .OR.   &                     ! too large sea surface height ( > 10 m)
92         & zmax(2) > 10._wp .OR.   &                     ! too large velocity ( > 10 m/s)
93         & zmax(3) >  0._wp ) THEN                       ! negative sea surface salinity
94         IF( lk_mpp ) THEN
95            CALL mpp_maxloc( ABS(sshn)        , tmask(:,:,1), zzz, iih, ijh )
96            CALL mpp_maxloc( ABS(un)          , umask       , zzz, iiu, iju, iku )
97            CALL mpp_minloc( tsn(:,:,1,jp_sal), tmask(:,:,1), zzz, iis, ijs )
98         ELSE
99            iloch = MINLOC( ABS( sshn(:,:) ) )
100            ilocu = MAXLOC( ABS( un(:,:,:) ) )
101            ilocs = MINLOC( tsn(:,:,1,jp_sal), mask = tmask(:,:,1) == 1._wp )
102            iih = iloch(1) + nimpp - 1   ;   ijh = iloch(2) + njmpp - 1
103            iiu = ilocu(1) + nimpp - 1   ;   iju = ilocu(2) + njmpp - 1   ;   iku = ilocu(3)
104            iis = ilocs(1) + nimpp - 1   ;   ijs = ilocs(2) + njmpp - 1
105         ENDIF
106         IF(lwp) THEN
107            WRITE(numout,cform_err)
108            WRITE(numout,*) ' stpctl: |ssh| > 10 m   or   |U| > 10 m/s   or   SSS < 0'
109            WRITE(numout,*) ' ====== '
110            WRITE(numout,9100) kt,   zmax(1), iih, ijh
111            WRITE(numout,9200) kt,   zmax(2), iiu, iju, iku
112            WRITE(numout,9300) kt, - zmax(3), iis, ijs
113            WRITE(numout,*)
114            WRITE(numout,*) '          output of last computed fields in output.abort.nc file'
115         ENDIF
116         kindic = -3
117      ENDIF
1189100  FORMAT (' kt=',i8,'   |ssh| max: ',1pg11.4,', at  i j  : ',2i5)
1199200  FORMAT (' kt=',i8,'   |U|   max: ',1pg11.4,', at  i j k: ',3i5)
1209300  FORMAT (' kt=',i8,'   SSS   min: ',1pg11.4,', at  i j  : ',2i5)
121      !
122      !                                            !==  run statistics  ==!   ("run.stat" file)
123      IF(lwp) WRITE(numrun,9400) kt, zmax(1), zmax(2), - zmax(3)
124      !
1259400  FORMAT(' it :', i8, '    |ssh|max: ', e16.10, ' |U|max: ',e16.10,' SSS min: ',e16.10)
126      !
127   END SUBROUTINE stp_ctl
128
129   !!======================================================================
130END MODULE stpctl
Note: See TracBrowser for help on using the repository browser.