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 branches/2015/dev_r5003_MERCATOR6_CRS/NEMOGCM/NEMO/TOP_SRC – NEMO

source: branches/2015/dev_r5003_MERCATOR6_CRS/NEMOGCM/NEMO/TOP_SRC/trcstp.F90 @ 7256

Last change on this file since 7256 was 7256, checked in by cbricaud, 7 years ago

phaze NEMO routines in CRS branch with nemo_v3_6_STABLE branch at rev 7213 (09-09-2016) (merge -r 5519:7213 )

  • Property svn:keywords set to Id
File size: 9.9 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 trc
14   USE trctrp           ! passive tracers transport
15   USE trcsms           ! passive tracers sources and sinks
16   USE prtctl_trc       ! Print control for debbuging
17   USE trcdia
18   USE trcwri , ONLY : trc_wri
19   USE trcrst
20   USE trdtrc_oce
21   USE trdmxl_trc
22   USE iom, ONLY : lk_iomput , iom_close, iom_varid, jpdom_autoglo, iom_get, iom_rstput
23   USE in_out_manager
24   USE trcsub
25   USE dom_oce, ONLY : nday, nmonth, nyear, nsec1jan000, nsec_year
26   !USE sbc_oce
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   REAL(wp) :: rsecfst, rseclast
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      INTEGER, INTENT( in ) ::  kt      ! ocean time-step index
59      INTEGER               ::  jk, jn  ! dummy loop indices
60      REAL(wp)              ::  ztrai
61      CHARACTER (len=25)    ::  charout 
62      !!-------------------------------------------------------------------
63      !
64      IF( nn_timing == 1 )   CALL timing_start('trc_stp')
65      !
66      IF( kt == nittrc000 .AND. lk_trdmxl_trc )  CALL trd_mxl_trc_init    ! trends: Mixed-layer
67      !
68      IF( lk_vvl ) THEN                                                   ! update ocean volume due to ssh temporal evolution
69         DO jk = 1, jpk
70            cvol(:,:,jk) = e1e2t(:,:) * fse3t(:,:,jk) * tmask(:,:,jk)
71         END DO
72         !cbr IF( lk_degrad )  cvol(:,:,:) = cvol(:,:,:) * facvol(:,:,:)       ! degrad option: reduction by facvol
73         areatot         = glob_sum( cvol(:,:,:) )
74      ENDIF
75      !
76      IF( l_trcdm2dc )   CALL trc_mean_qsr( kt )
77      !   
78!cbr      IF( nn_dttrc /= 1 )   CALL trc_sub_stp( kt )  ! averaging physical variables for sub-stepping
79      !   
80      IF( MOD( kt , nn_dttrc ) == 0 ) THEN      ! only every nn_dttrc time step
81         !
82         IF(ln_ctl) THEN
83            WRITE(charout,FMT="('kt =', I4,'  d/m/y =',I2,I2,I4)") kt, nday, nmonth, nyear
84            CALL prt_ctl_trc_info(charout)
85         ENDIF
86         !
87         tra(:,:,:,:) = 0.e0
88         !
89                                   CALL trc_rst_opn  ( kt )       ! Open tracer restart file
90         IF( lrst_trc )            CALL trc_rst_cal  ( kt, 'WRITE' )   ! calendar
91         IF( lk_iomput ) THEN  ;   CALL trc_wri      ( kt )       ! output of passive tracers with iom I/O manager
92         ELSE                  ;   CALL trc_dia      ( kt )       ! output of passive tracers with old I/O manager
93         ENDIF
94                                   CALL trc_sms      ( kt )       ! tracers: sinks and sources
95                                   CALL trc_trp      ( kt )       ! transport of passive tracers
96
97         IF( kt == nittrc000 ) THEN
98            CALL iom_close( numrtr )       ! close input tracer restart file
99            IF(lwm) CALL FLUSH( numont )   ! flush namelist output
100         ENDIF
101         IF( lrst_trc )            CALL trc_rst_wri  ( kt )       ! write tracer restart file
102         IF( lk_trdmxl_trc  )      CALL trd_mxl_trc  ( kt )       ! trends: Mixed-layer
103         !
104!cbr         IF( nn_dttrc /= 1   )     CALL trc_sub_reset( kt )       ! resetting physical variables when sub-stepping
105         !
106      ENDIF
107      !
108
109      ztrai = 0._wp                                                   !  content of all tracers
110      DO jn = 1, jptra
111         ztrai = ztrai + glob_sum( trn(:,:,:,jn) * cvol(:,:,:)   )
112      END DO
113      IF( lwp ) WRITE(numstr,9300) kt,  ztrai / areatot
1149300  FORMAT(i10,D23.16)
115      !
116      IF( nn_timing == 1 )   CALL timing_stop('trc_stp')
117      !
118   END SUBROUTINE trc_stp
119
120   SUBROUTINE trc_mean_qsr( kt )
121      !!----------------------------------------------------------------------
122      !!             ***  ROUTINE trc_mean_qsr  ***
123      !!
124      !! ** Purpose :  Compute daily mean qsr for biogeochemical model in case
125      !!               of diurnal cycle
126      !!
127      !! ** Method  : store in TOP the qsr every hour ( or every time-step if the latter
128      !!              is greater than 1 hour ) and then, compute the  mean with
129      !!              a moving average over 24 hours.
130      !!              In coupled mode, the sampling is done at every coupling frequency
131      !!----------------------------------------------------------------------
132      INTEGER, INTENT(in) ::   kt
133      INTEGER  :: jn
134      REAL(wp) :: zkt
135      CHARACTER(len=1)               ::   cl1                      ! 1 character
136      CHARACTER(len=2)               ::   cl2                      ! 2 characters
137
138      IF( kt == nit000 ) THEN
139         IF( ln_cpl )  THEN 
140            rdt_sampl = rday / ncpl_qsr_freq
141            nb_rec_per_day = ncpl_qsr_freq
142         ELSE 
143            rdt_sampl = MAX( 3600., rdttrc(1) )
144            nb_rec_per_day = INT( rday / rdt_sampl )
145         ENDIF
146         !
147         IF( lwp ) THEN
148            WRITE(numout,*) 
149            WRITE(numout,*) ' Sampling frequency dt = ', rdt_sampl, 's','   Number of sampling per day  nrec = ', nb_rec_per_day
150            WRITE(numout,*) 
151         ENDIF
152         !
153         ALLOCATE( qsr_arr(jpi,jpj,nb_rec_per_day ) )
154         !
155         !                                            !* Restart: read in restart file
156         IF( ln_rsttr .AND. iom_varid( numrtr, 'qsr_mean' , ldstop = .FALSE. ) > 0 .AND. &
157                            iom_varid( numrtr, 'qsr_arr_1', ldstop = .FALSE. ) > 0 .AND. &
158                            iom_varid( numrtr, 'ktdcy'    , ldstop = .FALSE. ) > 0 ) THEN
159            CALL iom_get( numrtr, 'ktdcy', zkt )   !  A mean of qsr
160            rsecfst = INT( zkt ) * rdttrc(1)
161            IF(lwp) WRITE(numout,*) 'trc_qsr_mean:   qsr_mean read in the restart file at time-step rsecfst =', rsecfst, ' s '
162            CALL iom_get( numrtr, jpdom_autoglo, 'qsr_mean', qsr_mean )   !  A mean of qsr
163            DO jn = 1, nb_rec_per_day 
164             IF( jn <= 9 )  THEN
165               WRITE(cl1,'(i1)') jn
166               CALL iom_get( numrtr, jpdom_autoglo, 'qsr_arr_'//cl1, qsr_arr(:,:,jn) )   !  A mean of qsr
167             ELSE
168               WRITE(cl2,'(i2.2)') jn
169               CALL iom_get( numrtr, jpdom_autoglo, 'qsr_arr_'//cl2, qsr_arr(:,:,jn) )   !  A mean of qsr
170             ENDIF
171           ENDDO
172         ELSE                                         !* no restart: set from nit000 values
173            IF(lwp) WRITE(numout,*) 'trc_qsr_mean:   qsr_mean set to nit000 values'
174            rsecfst  = kt * rdttrc(1)
175            !
176            qsr_mean(:,:) = qsr(:,:)
177            DO jn = 1, nb_rec_per_day
178               qsr_arr(:,:,jn) = qsr_mean(:,:)
179            ENDDO
180         ENDIF
181         !
182      ENDIF
183      !
184      rseclast = kt * rdttrc(1)
185      !
186      llnew   = ( rseclast - rsecfst ) .ge.  rdt_sampl    !   new shortwave to store
187      IF( llnew ) THEN
188          IF( lwp ) WRITE(numout,*) ' New shortwave to sample for TOP at time kt = ', kt, &
189             &                      ' time = ', rseclast/3600.,'hours '
190          rsecfst = rseclast
191          DO jn = 1, nb_rec_per_day - 1
192             qsr_arr(:,:,jn) = qsr_arr(:,:,jn+1)
193          ENDDO
194          qsr_arr (:,:,nb_rec_per_day) = qsr(:,:)
195          qsr_mean(:,:                ) = SUM( qsr_arr(:,:,:), 3 ) / nb_rec_per_day
196      ENDIF
197      !
198      IF( lrst_trc ) THEN    !* Write the mean of qsr in restart file
199         IF(lwp) WRITE(numout,*)
200         IF(lwp) WRITE(numout,*) 'trc_mean_qsr : write qsr_mean in restart file  kt =', kt
201         IF(lwp) WRITE(numout,*) '~~~~~~~'
202         zkt = REAL( kt, wp )
203         CALL iom_rstput( kt, nitrst, numrtw, 'ktdcy', zkt )
204          DO jn = 1, nb_rec_per_day 
205             IF( jn <= 9 )  THEN
206               WRITE(cl1,'(i1)') jn
207               CALL iom_rstput( kt, nitrst, numrtw, 'qsr_arr_'//cl1, qsr_arr(:,:,jn) )
208             ELSE
209               WRITE(cl2,'(i2.2)') jn
210               CALL iom_rstput( kt, nitrst, numrtw, 'qsr_arr_'//cl2, qsr_arr(:,:,jn) )
211             ENDIF
212         ENDDO
213         CALL iom_rstput( kt, nitrst, numrtw, 'qsr_mean', qsr_mean(:,:) )
214      ENDIF
215      !
216   END SUBROUTINE trc_mean_qsr
217
218#else
219   !!----------------------------------------------------------------------
220   !!   Default key                                     NO passive tracers
221   !!----------------------------------------------------------------------
222CONTAINS
223   SUBROUTINE trc_stp( kt )        ! Empty routine
224      WRITE(*,*) 'trc_stp: You should not have seen this print! error?', kt
225   END SUBROUTINE trc_stp
226#endif
227
228   !!======================================================================
229END MODULE trcstp
Note: See TracBrowser for help on using the repository browser.