source: branches/NERC/dev_r5518_GO6_conserv_check_up/NEMOGCM/NEMO/TOP_SRC/trcstp.F90 @ 9260

Last change on this file since 9260 was 9163, checked in by frrh, 3 years ago

Add code from Julien Palmieri's Met Office GMED ticket 338.
This incorporates code from branches/NERC/dev_r5518_GO6_package_trdtrc
revisions 8454:9020 inclusive.

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