New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
trcstp.F90 in NEMO/branches/2019/dev_r10721_KERNEL-02_Storkey_Coward_IMMERSE_first_steps/src/TOP – NEMO

source: NEMO/branches/2019/dev_r10721_KERNEL-02_Storkey_Coward_IMMERSE_first_steps/src/TOP/trcstp.F90 @ 10893

Last change on this file since 10893 was 10880, checked in by davestorkey, 5 years ago

branches/2019/dev_r10721_KERNEL-02_Storkey_Coward_IMMERSE_first_steps:

  1. Move time indices from dom_oce.F90 to step.F90.
  2. Implement time dimension for passive tracers with independent set of time indices in trcstp.F90.
  3. Update all the traadv and trcadv modules.
  • Property svn:keywords set to Id
File size: 12.1 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 trcwri
18   USE trcrst
19   USE trcsub         !
20   USE trdtrc_oce
21   USE trdmxl_trc
22   USE sms_pisces,  ONLY : ln_check_mass
23   !
24   USE prtctl_trc     ! Print control for debbuging
25   USE iom            !
26   USE in_out_manager !
27
28   IMPLICIT NONE
29   PRIVATE
30
31   PUBLIC   trc_stp    ! called by step
32   PUBLIC   update_pointers_trc ! called in initialisation
33
34   !!----------------------------------------------------------------------
35   !! time level indices
36   !!----------------------------------------------------------------------
37   INTEGER, PUBLIC :: Nbb, Nnn, Naa, Nrhs               !! used by trc_init
38
39   LOGICAL  ::   llnew                   ! ???
40   REAL(wp) ::   rdt_sampl               ! ???
41   INTEGER  ::   nb_rec_per_day, ktdcy   ! ???
42   REAL(wp) ::   rsecfst, rseclast       ! ???
43   REAL(wp), DIMENSION(:,:,:), SAVE, ALLOCATABLE ::   qsr_arr   ! save qsr during TOP time-step
44
45   !!----------------------------------------------------------------------
46   !! NEMO/TOP 4.0 , NEMO Consortium (2018)
47   !! $Id$
48   !! Software governed by the CeCILL license (see ./LICENSE)
49   !!----------------------------------------------------------------------
50CONTAINS
51
52   SUBROUTINE trc_stp( kt )
53      !!-------------------------------------------------------------------
54      !!                     ***  ROUTINE trc_stp  ***
55      !!                     
56      !! ** Purpose :   Time loop of opa for passive tracer
57      !!
58      !! ** Method  :   Compute the passive tracers trends
59      !!                Update the passive tracers
60      !!-------------------------------------------------------------------
61      INTEGER, INTENT( in ) ::   kt   ! ocean time-step index
62      !
63      INTEGER ::   jk, jn   ! dummy loop indices
64      REAL(wp)::   ztrai    ! local scalar
65      LOGICAL ::   ll_trcstat ! local logical
66      CHARACTER (len=25) ::   charout   !
67      !!-------------------------------------------------------------------
68      !
69      IF( ln_timing )   CALL timing_start('trc_stp')
70      !
71      IF( ( neuler == 0 .AND. kt == nittrc000 ) .OR. ln_top_euler ) THEN     ! at nittrc000
72         r2dttrc =  rdttrc           ! = rdttrc (use or restarting with Euler time stepping)
73      ELSEIF( kt <= nittrc000 + nn_dttrc ) THEN          ! at nittrc000 or nittrc000+1
74         r2dttrc = 2. * rdttrc       ! = 2 rdttrc (leapfrog)
75      ENDIF
76      !
77      ll_trcstat  = ( ln_ctl .OR. sn_cfctl%l_trcstat ) .AND. &
78     &              ( ( MOD( kt, sn_cfctl%ptimincr ) == 0 ) .OR. ( kt == nitend ) )
79      IF( kt == nittrc000 .AND. lk_trdmxl_trc )  CALL trd_mxl_trc_init    ! trends: Mixed-layer
80      !
81      IF( .NOT.ln_linssh ) THEN                                           ! update ocean volume due to ssh temporal evolution
82         DO jk = 1, jpk
83            cvol(:,:,jk) = e1e2t(:,:) * e3t_n(:,:,jk) * tmask(:,:,jk)
84         END DO
85         IF ( ln_ctl .OR. kt == nitrst .OR. ( ln_check_mass .AND. kt == nitend )              &
86            & .OR. iom_use( "pno3tot" ) .OR. iom_use( "ppo4tot" ) .OR. iom_use( "psiltot" )   &
87            & .OR. iom_use( "palktot" ) .OR. iom_use( "pfertot" ) )                           &
88            &     areatot = glob_sum( 'trcstp', cvol(:,:,:) )
89      ENDIF
90      !
91      IF( l_trcdm2dc )   CALL trc_mean_qsr( kt )
92      !   
93      IF( nn_dttrc /= 1 )   CALL trc_sub_stp( kt )  ! averaging physical variables for sub-stepping
94      !   
95      IF( MOD( kt , nn_dttrc ) == 0 ) THEN      ! only every nn_dttrc time step
96         !
97         IF(ln_ctl) THEN
98            WRITE(charout,FMT="('kt =', I4,'  d/m/y =',I2,I2,I4)") kt, nday, nmonth, nyear
99            CALL prt_ctl_trc_info(charout)
100         ENDIF
101         !
102         tra(:,:,:,:) = 0.e0
103         !
104                                   CALL trc_rst_opn  ( kt )       ! Open tracer restart file
105         IF( lrst_trc )            CALL trc_rst_cal  ( kt, 'WRITE' )   ! calendar
106                                   CALL trc_wri      ( kt )       ! output of passive tracers with iom I/O manager
107                                   CALL trc_sms      ( kt )       ! tracers: sinks and sources
108                                   CALL trc_trp      ( kt, Nbb, Nnn, Nrhs, Naa )       ! transport of passive tracers
109         IF( kt == nittrc000 ) THEN
110            CALL iom_close( numrtr )       ! close input tracer restart file
111            IF(lwm) CALL FLUSH( numont )   ! flush namelist output
112         ENDIF
113         IF( lrst_trc )            CALL trc_rst_wri  ( kt )       ! write tracer restart file
114         IF( lk_trdmxl_trc  )      CALL trd_mxl_trc  ( kt )       ! trends: Mixed-layer
115         !
116         IF( nn_dttrc /= 1   )     CALL trc_sub_reset( kt )       ! resetting physical variables when sub-stepping
117         !
118      ENDIF
119      !
120      IF (ll_trcstat) THEN
121         ztrai = 0._wp                                                   !  content of all tracers
122         DO jn = 1, jptra
123            ztrai = ztrai + glob_sum( 'trcstp', trn(:,:,:,jn) * cvol(:,:,:)   )
124         END DO
125         IF( lwm ) WRITE(numstr,9300) kt,  ztrai / areatot
126      ENDIF
1279300  FORMAT(i10,D23.16)
128      !
129      IF( ln_timing )   CALL timing_stop('trc_stp')
130      !
131   END SUBROUTINE trc_stp
132
133   SUBROUTINE update_pointers_trc
134      !!----------------------------------------------------------------------
135      !!                     ***  ROUTINE update_pointers_trc  ***
136      !!
137      !! ** Purpose :   Associate temporary pointer arrays.
138      !!                For IMMERSE development phase only - to be deleted
139      !!
140      !! ** Method  :
141      !!----------------------------------------------------------------------
142
143      trb => tr(:,:,:,:,Nbb); trn => tr(:,:,:,:,Nnn); tra => tr(:,:,:,:,Naa)
144
145   END SUBROUTINE update_pointers_trc
146
147   SUBROUTINE trc_mean_qsr( kt )
148      !!----------------------------------------------------------------------
149      !!             ***  ROUTINE trc_mean_qsr  ***
150      !!
151      !! ** Purpose :  Compute daily mean qsr for biogeochemical model in case
152      !!               of diurnal cycle
153      !!
154      !! ** Method  : store in TOP the qsr every hour ( or every time-step if the latter
155      !!              is greater than 1 hour ) and then, compute the  mean with
156      !!              a moving average over 24 hours.
157      !!              In coupled mode, the sampling is done at every coupling frequency
158      !!----------------------------------------------------------------------
159      INTEGER, INTENT( in ) ::   kt   ! ocean time-step index
160      !
161      INTEGER  ::   jn   ! dummy loop indices
162      REAL(wp) ::   zkt, zrec     ! local scalars
163      CHARACTER(len=1) ::   cl1   ! 1 character
164      CHARACTER(len=2) ::   cl2   ! 2 characters
165      !!----------------------------------------------------------------------
166      !
167      IF( ln_timing )   CALL timing_start('trc_mean_qsr')
168      !
169      IF( kt == nittrc000 ) THEN
170         IF( ln_cpl )  THEN 
171            rdt_sampl = rday / ncpl_qsr_freq
172            nb_rec_per_day = ncpl_qsr_freq
173         ELSE 
174            rdt_sampl = MAX( 3600., rdttrc )
175            nb_rec_per_day = INT( rday / rdt_sampl )
176         ENDIF
177         !
178         IF(lwp) THEN
179            WRITE(numout,*) 
180            WRITE(numout,*) ' Sampling frequency dt = ', rdt_sampl, 's','   Number of sampling per day  nrec = ', nb_rec_per_day
181            WRITE(numout,*) 
182         ENDIF
183         !
184         ALLOCATE( qsr_arr(jpi,jpj,nb_rec_per_day ) )
185         !
186         !                                            !* Restart: read in restart file
187         IF( ln_rsttr .AND. nn_rsttr /= 0 .AND. iom_varid( numrtr, 'qsr_mean' , ldstop = .FALSE. ) > 0  &
188           &                              .AND. iom_varid( numrtr, 'qsr_arr_1', ldstop = .FALSE. ) > 0  &
189           &                              .AND. iom_varid( numrtr, 'ktdcy'    , ldstop = .FALSE. ) > 0  &
190           &                              .AND. iom_varid( numrtr, 'nrdcy'    , ldstop = .FALSE. ) > 0  ) THEN
191
192            CALL iom_get( numrtr, 'ktdcy', zkt ) 
193            rsecfst = INT( zkt ) * rdttrc
194            IF(lwp) WRITE(numout,*) 'trc_qsr_mean:   qsr_mean read in the restart file at time-step rsecfst =', rsecfst, ' s '
195            CALL iom_get( numrtr, jpdom_autoglo, 'qsr_mean', qsr_mean )   !  A mean of qsr
196            CALL iom_get( numrtr, 'nrdcy', zrec )   !  Number of record per days
197            IF( INT( zrec ) == nb_rec_per_day ) THEN
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              END DO
207            ELSE
208               DO jn = 1, nb_rec_per_day
209                  qsr_arr(:,:,jn) = qsr_mean(:,:)
210               ENDDO
211            ENDIF
212         ELSE                                         !* no restart: set from nit000 values
213            IF(lwp) WRITE(numout,*) 'trc_qsr_mean:   qsr_mean set to nit000 values'
214            rsecfst  = kt * rdttrc
215            !
216            qsr_mean(:,:) = qsr(:,:)
217            DO jn = 1, nb_rec_per_day
218               qsr_arr(:,:,jn) = qsr_mean(:,:)
219            END DO
220         ENDIF
221         !
222      ENDIF
223      !
224      rseclast = kt * rdttrc
225      !
226      llnew   = ( rseclast - rsecfst ) .ge.  rdt_sampl    !   new shortwave to store
227      IF( llnew ) THEN
228          ktdcy = kt
229          IF( lwp .AND. kt < nittrc000 + 100 ) WRITE(numout,*) ' New shortwave to sample for TOP at time kt = ', ktdcy, &
230             &                      ' time = ', rseclast/3600.,'hours '
231          rsecfst = rseclast
232          DO jn = 1, nb_rec_per_day - 1
233             qsr_arr(:,:,jn) = qsr_arr(:,:,jn+1)
234          ENDDO
235          qsr_arr (:,:,nb_rec_per_day) = qsr(:,:)
236          qsr_mean(:,:                ) = SUM( qsr_arr(:,:,:), 3 ) / nb_rec_per_day
237      ENDIF
238      !
239      IF( lrst_trc ) THEN    !* Write the mean of qsr in restart file
240         IF(lwp) WRITE(numout,*)
241         IF(lwp) WRITE(numout,*) 'trc_mean_qsr : write qsr_mean in restart file  kt =', kt
242         IF(lwp) WRITE(numout,*) '~~~~~~~'
243         zkt  = REAL( ktdcy, wp )
244         zrec = REAL( nb_rec_per_day, wp )
245         CALL iom_rstput( kt, nitrst, numrtw, 'ktdcy', zkt  )
246         CALL iom_rstput( kt, nitrst, numrtw, 'nrdcy', zrec )
247          DO jn = 1, nb_rec_per_day 
248             IF( jn <= 9 )  THEN
249               WRITE(cl1,'(i1)') jn
250               CALL iom_rstput( kt, nitrst, numrtw, 'qsr_arr_'//cl1, qsr_arr(:,:,jn) )
251             ELSE
252               WRITE(cl2,'(i2.2)') jn
253               CALL iom_rstput( kt, nitrst, numrtw, 'qsr_arr_'//cl2, qsr_arr(:,:,jn) )
254             ENDIF
255         END DO
256         CALL iom_rstput( kt, nitrst, numrtw, 'qsr_mean', qsr_mean(:,:) )
257      ENDIF
258      !
259      IF( ln_timing )   CALL timing_stop('trc_mean_qsr')
260      !
261   END SUBROUTINE trc_mean_qsr
262
263#else
264   !!----------------------------------------------------------------------
265   !!   Default key                                     NO passive tracers
266   !!----------------------------------------------------------------------
267CONTAINS
268   SUBROUTINE trc_stp( kt )        ! Empty routine
269      WRITE(*,*) 'trc_stp: You should not have seen this print! error?', kt
270   END SUBROUTINE trc_stp
271#endif
272
273   !!======================================================================
274END MODULE trcstp
Note: See TracBrowser for help on using the repository browser.