source: NEMO/trunk/src/TOP/trcstp.F90

Last change on this file was 14086, checked in by cetlod, 11 months ago

Adding AGRIF branches into the trunk

  • Property svn:keywords set to Id
File size: 12.8 KB
Line 
1MODULE trcstp
2   !!======================================================================
3   !!                       ***  MODULE trcstp  ***
4   !! Time-stepping    : time loop of opa for passive tracer
5   !!======================================================================
6   !! History :  1.0  !  2004-03  (C. Ethe)  Original
7   !!            4.1  !  2019-08  (A. Coward, D. Storkey) rewrite in preparation for new timestepping scheme
8   !!----------------------------------------------------------------------
9#if defined key_top
10   !!----------------------------------------------------------------------
11   !!   trc_stp       : passive tracer system time-stepping
12   !!----------------------------------------------------------------------
13   USE par_trc        ! need jptra, number of passive tracers
14   USE oce_trc        ! ocean dynamics and active tracers variables
15   USE sbc_oce
16   USE trc
17   USE trctrp         ! passive tracers transport
18   USE trcsms         ! passive tracers sources and sinks
19   USE trcwri
20   USE trcrst
21   USE trdtrc_oce
22   USE trdmxl_trc
23   USE sms_pisces,  ONLY : ln_check_mass
24   !
25   USE prtctl         ! Print control for debbuging
26   USE iom            !
27   USE in_out_manager !
28
29   IMPLICIT NONE
30   PRIVATE
31
32   PUBLIC   trc_stp    ! called by step
33
34   LOGICAL  ::   llnew                   ! ???
35   REAL(wp) ::   rdt_sampl               ! ???
36   INTEGER  ::   nb_rec_per_day, ktdcy   ! ???
37   REAL(wp) ::   rsecfst, rseclast       ! ???
38   REAL(wp), DIMENSION(:,:,:), SAVE, ALLOCATABLE ::   qsr_arr   ! save qsr during TOP time-step
39
40#  include "domzgr_substitute.h90"
41   !!----------------------------------------------------------------------
42   !! NEMO/TOP 4.0 , NEMO Consortium (2018)
43   !! $Id$
44   !! Software governed by the CeCILL license (see ./LICENSE)
45   !!----------------------------------------------------------------------
46CONTAINS
47
48   SUBROUTINE trc_stp( kt, Kbb, Kmm, Krhs, Kaa )
49      !!-------------------------------------------------------------------
50      !!                     ***  ROUTINE trc_stp  ***
51      !!                     
52      !! ** Purpose :   Time loop of opa for passive tracer
53      !!
54      !! ** Method  :   Compute the passive tracers trends
55      !!                Update the passive tracers
56      !!-------------------------------------------------------------------
57      INTEGER, INTENT( in ) :: kt                  ! ocean time-step index
58      INTEGER, INTENT( in ) :: Kbb, Kmm, Krhs, Kaa ! time level indices
59      !
60      INTEGER ::   jk, jn   ! dummy loop indices
61      REAL(wp)::   ztrai    ! local scalar
62      LOGICAL ::   ll_trcstat ! local logical
63      CHARACTER (len=25) ::   charout   !
64      !!-------------------------------------------------------------------
65      !
66      IF( ln_timing )   CALL timing_start('trc_stp')
67      !
68      IF( l_1st_euler .OR. ln_top_euler ) THEN     ! at nittrc000
69         rDt_trc =  rn_Dt           ! = rn_Dt (use or restarting with Euler time stepping)
70      ELSEIF( kt <= nittrc000 + 1 ) THEN                                     ! at nittrc000 or nittrc000+1
71         rDt_trc = 2. * rn_Dt       ! = 2 rn_Dt (leapfrog)
72      ENDIF
73      !
74      ll_trcstat  = ( sn_cfctl%l_trcstat ) .AND. &
75     &              ( ( MOD( kt, sn_cfctl%ptimincr ) == 0 ) .OR. ( kt == nitend ) )
76
77      IF( kt == nittrc000 )                      CALL trc_stp_ctl   ! control
78      IF( kt == nittrc000 .AND. lk_trdmxl_trc )  CALL trd_mxl_trc_init    ! trends: Mixed-layer
79      !
80      IF( .NOT.ln_linssh ) THEN                                           ! update ocean volume due to ssh temporal evolution
81         DO jk = 1, jpk
82            cvol(:,:,jk) = e1e2t(:,:) * e3t(:,:,jk,Kmm) * tmask(:,:,jk)
83         END DO
84         IF ( ll_trcstat .OR. kt == nitrst .OR. ( ln_check_mass .AND. kt == nitend )   &
85            & .OR. iom_use( "pno3tot" ) .OR. iom_use( "ppo4tot" ) .OR. iom_use( "psiltot" )   &
86            & .OR. iom_use( "palktot" ) .OR. iom_use( "pfertot" ) )                           &
87            &     areatot = glob_sum( 'trcstp', cvol(:,:,:) )
88      ENDIF
89      !
90      IF( l_trcdm2dc )   CALL trc_mean_qsr( kt )
91      !   
92      !
93      IF(sn_cfctl%l_prttrc) THEN
94         WRITE(charout,FMT="('kt =', I4,'  d/m/y =',I2,I2,I4)") kt, nday, nmonth, nyear
95         CALL prt_ctl_info( charout, cdcomp = 'top' )
96      ENDIF
97      !
98      tr(:,:,:,:,Krhs) = 0._wp
99      !
100      CALL trc_rst_opn  ( kt )                            ! Open tracer restart file
101      IF( lrst_trc )  CALL trc_rst_cal  ( kt, 'WRITE' )   ! calendar
102      CALL trc_wri      ( kt,      Kmm            )       ! output of passive tracers with iom I/O manager
103      CALL trc_sms      ( kt, Kbb, Kmm, Krhs      )       ! tracers: sinks and sources
104      CALL trc_trp      ( kt, Kbb, Kmm, Krhs, Kaa )       ! transport of passive tracers
105           !
106           ! Note passive tracers have been time-filtered in trc_trp but the time level
107           ! indices will not be swapped until after tra_atf/dyn_atf/ssh_atf in stp. Subsequent calls here
108           ! anticipate this update which will be: Nrhs= Nbb ; Nbb = Nnn ; Nnn = Naa ; Naa = Nrhs
109           ! and use the filtered levels explicitly.
110           !
111      IF( kt == nittrc000 ) THEN
112         CALL iom_close( numrtr )                         ! close input tracer restart file
113         IF(lrxios) CALL iom_context_finalize(      cr_toprst_cxt          )
114         IF(lwm) CALL FLUSH( numont )                     ! flush namelist output
115      ENDIF
116      IF( lrst_trc )            CALL trc_rst_wri  ( kt, Kmm, Kaa, Kbb  )       ! write tracer restart file
117      IF( lk_trdmxl_trc  )      CALL trd_mxl_trc  ( kt,      Kaa       )       ! trends: Mixed-layer
118      !
119      IF( ln_top_euler ) THEN 
120         ! For Euler timestepping for TOP we need to copy the "after" to the "now" fields
121         ! here then after the (leapfrog) swapping of the time-level indices in OCE/step.F90 we have
122         ! "before" fields = "now" fields.
123         tr(:,:,:,:,Kmm) = tr(:,:,:,:,Kaa)
124      ENDIF
125      !
126      IF (ll_trcstat) THEN
127         ztrai = 0._wp                                                   !  content of all tracers
128         DO jn = 1, jptra
129            ztrai = ztrai + glob_sum( 'trcstp', tr(:,:,:,jn,Kaa) * cvol(:,:,:)   )
130         END DO
131         IF( lwm ) WRITE(numstr,9300) kt,  ztrai / areatot
132      ENDIF
1339300  FORMAT(i10,D23.16)
134      !
135      IF( ln_timing )   CALL timing_stop('trc_stp')
136      !
137   END SUBROUTINE trc_stp
138
139
140   SUBROUTINE trc_stp_ctl
141      !!----------------------------------------------------------------------
142      !!                     ***  ROUTINE trc_stp_ctl  ***
143      !! ** Purpose :        Control  + ocean volume
144      !!----------------------------------------------------------------------
145      !
146      ! Define logical parameter ton control dirunal cycle in TOP
147      l_trcdm2dc = ln_dm2dc .OR. ( ln_cpl .AND. ncpl_qsr_freq /= 1 .AND. ncpl_qsr_freq /= 0 )
148      l_trcdm2dc = l_trcdm2dc .AND. .NOT. l_offline
149      !
150      IF( l_trcdm2dc .AND. lwp )   CALL ctl_warn( 'Coupling with passive tracers and used of diurnal cycle.',   &
151         &                           'Computation of a daily mean shortwave for some biogeochemical models ' )
152      !
153   END SUBROUTINE trc_stp_ctl
154
155
156   SUBROUTINE trc_mean_qsr( kt )
157      !!----------------------------------------------------------------------
158      !!             ***  ROUTINE trc_mean_qsr  ***
159      !!
160      !! ** Purpose :  Compute daily mean qsr for biogeochemical model in case
161      !!               of diurnal cycle
162      !!
163      !! ** Method  : store in TOP the qsr every hour ( or every time-step if the latter
164      !!              is greater than 1 hour ) and then, compute the  mean with
165      !!              a moving average over 24 hours.
166      !!              In coupled mode, the sampling is done at every coupling frequency
167      !!----------------------------------------------------------------------
168      INTEGER, INTENT( in ) ::   kt   ! ocean time-step index
169      !
170      INTEGER  ::   jn   ! dummy loop indices
171      REAL(wp) ::   zkt, zrec     ! local scalars
172      CHARACTER(len=1) ::   cl1   ! 1 character
173      CHARACTER(len=2) ::   cl2   ! 2 characters
174      !!----------------------------------------------------------------------
175      !
176      IF( ln_timing )   CALL timing_start('trc_mean_qsr')
177      !
178      IF( kt == nittrc000 ) THEN
179         IF( ln_cpl )  THEN 
180            rdt_sampl = rday / ncpl_qsr_freq
181            nb_rec_per_day = ncpl_qsr_freq
182         ELSE 
183            rdt_sampl = MAX( 3600., rn_Dt )
184            nb_rec_per_day = INT( rday / rdt_sampl )
185         ENDIF
186         !
187         IF(lwp) THEN
188            WRITE(numout,*) 
189            WRITE(numout,*) ' Sampling frequency dt = ', rdt_sampl, 's','   Number of sampling per day  nrec = ', nb_rec_per_day
190            WRITE(numout,*) 
191         ENDIF
192         !
193         ALLOCATE( qsr_arr(jpi,jpj,nb_rec_per_day ) )
194         !
195         !                                            !* Restart: read in restart file
196         IF( ln_rsttr .AND. nn_rsttr /= 0 .AND. iom_varid( numrtr, 'qsr_mean' , ldstop = .FALSE. ) > 0  &
197           &                              .AND. iom_varid( numrtr, 'qsr_arr_1', ldstop = .FALSE. ) > 0  &
198           &                              .AND. iom_varid( numrtr, 'ktdcy'    , ldstop = .FALSE. ) > 0  &
199           &                              .AND. iom_varid( numrtr, 'nrdcy'    , ldstop = .FALSE. ) > 0  ) THEN
200            CALL iom_get( numrtr, 'ktdcy', zkt ) 
201            rsecfst = INT( zkt ) * rn_Dt
202            IF(lwp) WRITE(numout,*) 'trc_qsr_mean:   qsr_mean read in the restart file at time-step rsecfst =', rsecfst, ' s '
203            CALL iom_get( numrtr, jpdom_auto, 'qsr_mean', qsr_mean )   !  A mean of qsr
204            CALL iom_get( numrtr, 'nrdcy', zrec )   !  Number of record per days
205            IF( INT( zrec ) == nb_rec_per_day ) THEN
206               DO jn = 1, nb_rec_per_day 
207                  IF( jn <= 9 )  THEN
208                    WRITE(cl1,'(i1)') jn
209                    CALL iom_get( numrtr, jpdom_auto, 'qsr_arr_'//cl1, qsr_arr(:,:,jn) )   !  A mean of qsr
210                  ELSE
211                    WRITE(cl2,'(i2.2)') jn
212                    CALL iom_get( numrtr, jpdom_auto, 'qsr_arr_'//cl2, qsr_arr(:,:,jn) )   !  A mean of qsr
213                  ENDIF
214              END DO
215            ELSE
216               DO jn = 1, nb_rec_per_day
217                  qsr_arr(:,:,jn) = qsr_mean(:,:)
218               ENDDO
219            ENDIF
220         ELSE                                         !* no restart: set from nit000 values
221            IF(lwp) WRITE(numout,*) 'trc_qsr_mean:   qsr_mean set to nit000 values'
222            rsecfst  = kt * rn_Dt
223            !
224            qsr_mean(:,:) = qsr(:,:)
225            DO jn = 1, nb_rec_per_day
226               qsr_arr(:,:,jn) = qsr_mean(:,:)
227            END DO
228         ENDIF
229         !
230      ENDIF
231      !
232      rseclast = kt * rn_Dt
233      !
234      llnew   = ( rseclast - rsecfst ) .ge.  rdt_sampl    !   new shortwave to store
235      IF( llnew ) THEN
236          ktdcy = kt
237          IF( lwp .AND. kt < nittrc000 + 100 ) WRITE(numout,*) ' New shortwave to sample for TOP at time kt = ', ktdcy, &
238             &                      ' time = ', rseclast/3600.,'hours '
239          rsecfst = rseclast
240          DO jn = 1, nb_rec_per_day - 1
241             qsr_arr(:,:,jn) = qsr_arr(:,:,jn+1)
242          ENDDO
243          qsr_arr (:,:,nb_rec_per_day) = qsr(:,:)
244          qsr_mean(:,:                ) = SUM( qsr_arr(:,:,:), 3 ) / nb_rec_per_day
245      ENDIF
246      !
247      IF( lrst_trc ) THEN    !* Write the mean of qsr in restart file
248         IF(lwp) WRITE(numout,*)
249         IF(lwp) WRITE(numout,*) 'trc_mean_qsr : write qsr_mean in restart file  kt =', kt
250         IF(lwp) WRITE(numout,*) '~~~~~~~'
251         zkt  = REAL( ktdcy, wp )
252         zrec = REAL( nb_rec_per_day, wp )
253         CALL iom_rstput( kt, nitrst, numrtw, 'ktdcy', zkt  )
254         CALL iom_rstput( kt, nitrst, numrtw, 'nrdcy', zrec )
255          DO jn = 1, nb_rec_per_day 
256             IF( jn <= 9 )  THEN
257               WRITE(cl1,'(i1)') jn
258               CALL iom_rstput( kt, nitrst, numrtw, 'qsr_arr_'//cl1, qsr_arr(:,:,jn) )
259             ELSE
260               WRITE(cl2,'(i2.2)') jn
261               CALL iom_rstput( kt, nitrst, numrtw, 'qsr_arr_'//cl2, qsr_arr(:,:,jn) )
262             ENDIF
263         END DO
264         CALL iom_rstput( kt, nitrst, numrtw, 'qsr_mean', qsr_mean(:,:) )
265      ENDIF
266      !
267      IF( ln_timing )   CALL timing_stop('trc_mean_qsr')
268      !
269   END SUBROUTINE trc_mean_qsr
270
271#else
272   !!----------------------------------------------------------------------
273   !!   Default key                                     NO passive tracers
274   !!----------------------------------------------------------------------
275CONTAINS
276   SUBROUTINE trc_stp( kt )        ! Empty routine
277      WRITE(*,*) 'trc_stp: You should not have seen this print! error?', kt
278   END SUBROUTINE trc_stp
279#endif
280
281   !!======================================================================
282END MODULE trcstp
Note: See TracBrowser for help on using the repository browser.