source: branches/UKMO/dev_r5518_GO6_package/NEMOGCM/NEMO/TOP_SRC/trcstp.F90 @ 8356

Last change on this file since 8356 was 8356, checked in by davestorkey, 3 years ago

UKMO/dev_r5518_GO6_package branch: merge in changes from rev 6917 to 6959 of the 3.6_stable branch.

File size: 11.4 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   !!----------------------------------------------------------------------
8#if defined key_top
9   !!----------------------------------------------------------------------
10   !!   trc_stp      : passive tracer system time-stepping
11   !!----------------------------------------------------------------------
12   USE oce_trc          ! ocean dynamics and active tracers variables
13   USE sbc_oce
14   USE trc
15   USE trctrp           ! passive tracers transport
16   USE trcsms           ! passive tracers sources and sinks
17   USE prtctl_trc       ! Print control for debbuging
18   USE trcdia
19   USE trcwri
20   USE trcrst
21   USE trdtrc_oce
22   USE trdmxl_trc
23   USE iom
24   USE in_out_manager
25   USE trcsub
26
27   IMPLICIT NONE
28   PRIVATE
29
30   PUBLIC   trc_stp    ! called by step
31
32   REAL(wp), DIMENSION(:,:,:), SAVE, ALLOCATABLE ::   qsr_arr ! save qsr during TOP time-step
33   REAL(wp) :: rdt_sampl
34   INTEGER  :: nb_rec_per_day
35   INTEGER  :: isecfst, iseclast
36   LOGICAL  :: llnew
37
38   !! * Substitutions
39#  include "domzgr_substitute.h90"
40   !!----------------------------------------------------------------------
41   !! NEMO/TOP 3.3 , NEMO Consortium (2010)
42   !! $Id$
43   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
44   !!----------------------------------------------------------------------
45CONTAINS
46
47   SUBROUTINE trc_stp( kt )
48      !!-------------------------------------------------------------------
49      !!                     ***  ROUTINE trc_stp  ***
50      !!                     
51      !! ** Purpose : Time loop of opa for passive tracer
52      !!
53      !! ** Method  :
54      !!              Compute the passive tracers trends
55      !!              Update the passive tracers
56      !!-------------------------------------------------------------------
57
58      USE dom_oce, ONLY: narea
59
60      INTEGER, INTENT( in ) ::  kt      ! ocean time-step index
61      INTEGER               ::  jk, jn  ! dummy loop indices
62      REAL(wp)              ::  ztrai
63      CHARACTER (len=25)    ::  charout 
64      !!-------------------------------------------------------------------
65      !
66      IF( nn_timing == 1 )   CALL timing_start('trc_stp')
67      !
68      IF( kt == nittrc000 .AND. lk_trdmxl_trc )  CALL trd_mxl_trc_init    ! trends: Mixed-layer
69      !
70      IF( lk_vvl ) THEN                                                   ! update ocean volume due to ssh temporal evolution
71         DO jk = 1, jpk
72            cvol(:,:,jk) = e1e2t(:,:) * fse3t(:,:,jk) * tmask(:,:,jk)
73         END DO
74         IF( lk_degrad )  cvol(:,:,:) = cvol(:,:,:) * facvol(:,:,:)       ! degrad option: reduction by facvol
75         areatot         = glob_sum( cvol(:,:,:) )
76      ENDIF
77      !
78      IF( l_trcdm2dc )   CALL trc_mean_qsr( kt )
79      !   
80      IF( nn_dttrc /= 1 )   CALL trc_sub_stp( kt )  ! averaging physical variables for sub-stepping
81      !   
82      IF( MOD( kt , nn_dttrc ) == 0 ) THEN      ! only every nn_dttrc time step
83         !
84         IF(ln_ctl) THEN
85            WRITE(charout,FMT="('kt =', I4,'  d/m/y =',I2,I2,I4)") kt, nday, nmonth, nyear
86            CALL prt_ctl_trc_info(charout)
87         ENDIF
88         !
89         tra(:,:,:,:) = 0.e0
90         !
91# if defined key_debug_medusa
92         IF(lwp) WRITE(numout,*) ' MEDUSA trc_stp begins at kt =', kt
93         CALL flush(numout)
94# endif
95                                   CALL trc_rst_opn  ( kt )       ! Open tracer restart file
96# if defined key_debug_medusa
97                                   CALL trc_rst_stat 
98                                   CALL trc_rst_tra_stat
99# endif
100         IF( lrst_trc )            CALL trc_rst_cal  ( kt, 'WRITE' )   ! calendar
101         IF( lk_iomput ) THEN  ;   CALL trc_wri      ( kt )       ! output of passive tracers with iom I/O manager
102         ELSE                  ;   CALL trc_dia      ( kt )       ! output of passive tracers with old I/O manager
103         ENDIF
104                                   CALL trc_sms      ( kt )       ! tracers: sinks and sources
105# if defined key_debug_medusa
106         IF(lwp) WRITE(numout,*) ' MEDUSA trc_stp SMS complete at kt =', kt
107         CALL trc_rst_stat
108         CALL trc_rst_tra_stat
109         CALL flush(numout)
110# endif
111                                   CALL trc_trp      ( kt )       ! transport of passive tracers
112# if defined key_debug_medusa
113         IF(lwp) WRITE(numout,*) ' MEDUSA trc_stp transport complete at kt =', kt
114         CALL trc_rst_stat
115         CALL trc_rst_tra_stat
116         CALL flush(numout)
117# endif
118         IF( kt == nittrc000 ) THEN
119            CALL iom_close( numrtr )       ! close input tracer restart file
120            IF(lwm) CALL FLUSH( numont )   ! flush namelist output
121         ENDIF
122         IF( lrst_trc )            CALL trc_rst_wri  ( kt )       ! write tracer restart file
123         IF( lk_trdmxl_trc  )      CALL trd_mxl_trc  ( kt )       ! trends: Mixed-layer
124         !
125         IF( nn_dttrc /= 1   )     CALL trc_sub_reset( kt )       ! resetting physical variables when sub-stepping
126# if defined key_debug_medusa
127         IF(lwp) WRITE(numout,*) ' MEDUSA trc_stp ends at kt =', kt
128         CALL flush(numout)
129# endif
130         !
131      ENDIF
132      !
133      IF (ln_ctl) THEN 
134         ! The following code is very expensive since it involves multiple
135         ! reproducible global sums over all tracer fields and is potentially 
136         ! called on every timestep. The results it produces are purely for
137         ! informational purposes and do not affect model evolution.
138         ! Hence we restrict its use by protecting it with the ln_ctl RTL
139         ! which should normally only be used under debugging conditions
140         ! and not in operational runs. We also need to restrict output 
141         ! to the master PE since there's no point duplicating the same results
142         ! on all processors.   
143         ztrai = 0._wp                                                   !  content of all tracers
144         DO jn = 1, jptra
145            ztrai = ztrai + glob_sum( trn(:,:,:,jn) * cvol(:,:,:)   )
146         END DO
147         IF( numstr /= -1 ) WRITE(numstr,9300) kt,  ztrai / areatot
1489300     FORMAT(i10,D23.16)
149      ENDIF
150      !
151      IF( nn_timing == 1 )   CALL timing_stop('trc_stp')
152      !
153   END SUBROUTINE trc_stp
154
155   SUBROUTINE trc_mean_qsr( kt )
156      !!----------------------------------------------------------------------
157      !!             ***  ROUTINE trc_mean_qsr  ***
158      !!
159      !! ** Purpose :  Compute daily mean qsr for biogeochemical model in case
160      !!               of diurnal cycle
161      !!
162      !! ** Method  : store in TOP the qsr every hour ( or every time-step if the latter
163      !!              is greater than 1 hour ) and then, compute the  mean with
164      !!              a moving average over 24 hours.
165      !!              In coupled mode, the sampling is done at every coupling frequency
166      !!----------------------------------------------------------------------
167      INTEGER, INTENT(in) ::   kt
168      INTEGER  :: jn
169      REAL(wp) :: zsecfst
170      CHARACTER(len=1)               ::   cl1                      ! 1 character
171      CHARACTER(len=2)               ::   cl2                      ! 2 characters
172
173      IF( kt == nittrc000 ) THEN
174         IF( ln_cpl )  THEN 
175            rdt_sampl = 86400. / ncpl_qsr_freq
176            nb_rec_per_day = ncpl_qsr_freq
177         ELSE 
178            rdt_sampl = MAX( 3600., rdt * nn_dttrc )
179            nb_rec_per_day = INT( 86400 / rdt_sampl )
180         ENDIF
181         !
182         IF( lwp ) THEN
183            WRITE(numout,*) 
184            WRITE(numout,*) ' Sampling frequency dt = ', rdt_sampl, 's','   Number of sampling per day  nrec = ', nb_rec_per_day
185            WRITE(numout,*) 
186         ENDIF
187         !
188         ALLOCATE( qsr_arr(jpi,jpj,nb_rec_per_day ) )
189         !
190         !                                            !* Restart: read in restart file
191         IF( ln_rsttr .AND. iom_varid( numrtr, 'qsr_mean' , ldstop = .FALSE. ) > 0 .AND. &
192                            iom_varid( numrtr, 'qsr_arr_1', ldstop = .FALSE. ) > 0 .AND. &
193                            iom_varid( numrtr, 'zsecfst'  , ldstop = .FALSE. ) > 0 ) THEN
194            IF(lwp) WRITE(numout,*) 'trc_qsr_mean:   qsr_mean read in the restart file'
195            CALL iom_get( numrtr, jpdom_autoglo, 'qsr_mean', qsr_mean )   !  A mean of qsr
196            CALL iom_get( numrtr, 'zsecfst', zsecfst )   !  A mean of qsr
197            isecfst = INT( zsecfst )
198            DO jn = 1, nb_rec_per_day 
199             IF( jn <= 9 )  THEN
200               WRITE(cl1,'(i1)') jn
201               CALL iom_get( numrtr, jpdom_autoglo, 'qsr_arr_'//cl1, qsr_arr(:,:,jn) )   !  A mean of qsr
202             ELSE
203               WRITE(cl2,'(i2.2)') jn
204               CALL iom_get( numrtr, jpdom_autoglo, 'qsr_arr_'//cl2, qsr_arr(:,:,jn) )   !  A mean of qsr
205             ENDIF
206           ENDDO
207         ELSE                                         !* no restart: set from nit000 values
208            IF(lwp) WRITE(numout,*) 'trc_qsr_mean:   qsr_mean set to nit000 values'
209            isecfst  = nsec_year + nsec1jan000   !   number of seconds between Jan. 1st 00h of nit000 year and the middle of time step
210            !
211            qsr_mean(:,:) = qsr(:,:)
212            DO jn = 1, nb_rec_per_day
213               qsr_arr(:,:,jn) = qsr_mean(:,:)
214            ENDDO
215         ENDIF
216         !
217      ENDIF
218      !
219      iseclast = nsec_year + nsec1jan000
220      !
221      llnew   = ( iseclast - isecfst )  > INT( rdt_sampl )   !   new shortwave to store
222      IF( llnew ) THEN
223          IF( lwp ) WRITE(numout,*) ' New shortwave to sample for TOP at time kt = ', kt, &
224             &                      ' time = ', (iseclast+rdt*nn_dttrc/2.)/3600.,'hours '
225          isecfst = iseclast
226          DO jn = 1, nb_rec_per_day - 1
227             qsr_arr(:,:,jn) = qsr_arr(:,:,jn+1)
228          ENDDO
229          qsr_arr (:,:,nb_rec_per_day) = qsr(:,:)
230          qsr_mean(:,:                ) = SUM( qsr_arr(:,:,:), 3 ) / nb_rec_per_day
231      ENDIF
232      !
233      IF( lrst_trc ) THEN    !* Write the mean of qsr in restart file
234         IF(lwp) WRITE(numout,*)
235         IF(lwp) WRITE(numout,*) 'trc_mean_qsr : write qsr_mean in restart file  kt =', kt
236         IF(lwp) WRITE(numout,*) '~~~~~~~'
237          DO jn = 1, nb_rec_per_day 
238             IF( jn <= 9 )  THEN
239               WRITE(cl1,'(i1)') jn
240               CALL iom_rstput( kt, nitrst, numrtw, 'qsr_arr_'//cl1, qsr_arr(:,:,jn) )
241             ELSE
242               WRITE(cl2,'(i2.2)') jn
243               CALL iom_rstput( kt, nitrst, numrtw, 'qsr_arr_'//cl2, qsr_arr(:,:,jn) )
244             ENDIF
245         ENDDO
246         CALL iom_rstput( kt, nitrst, numrtw, 'qsr_mean', qsr_mean(:,:) )
247         zsecfst = REAL( isecfst, wp )
248         CALL iom_rstput( kt, nitrst, numrtw, 'zsecfst', zsecfst )
249      ENDIF
250      !
251   END SUBROUTINE trc_mean_qsr
252
253#else
254   !!----------------------------------------------------------------------
255   !!   Default key                                     NO passive tracers
256   !!----------------------------------------------------------------------
257CONTAINS
258   SUBROUTINE trc_stp( kt )        ! Empty routine
259      WRITE(*,*) 'trc_stp: You should not have seen this print! error?', kt
260   END SUBROUTINE trc_stp
261#endif
262
263   !!======================================================================
264END MODULE trcstp
Note: See TracBrowser for help on using the repository browser.