MODULE trcstp !!====================================================================== !! *** MODULE trcstp *** !! Time-stepping : time loop of opa for passive tracer !!====================================================================== !! History : 1.0 ! 2004-03 (C. Ethe) Original !! 4.1 ! 2019-08 (A. Coward, D. Storkey) rewrite in preparation for new timestepping scheme !!---------------------------------------------------------------------- #if defined key_top !!---------------------------------------------------------------------- !! trc_stp : passive tracer system time-stepping !!---------------------------------------------------------------------- USE oce_trc ! ocean dynamics and active tracers variables USE sbc_oce USE trc USE trctrp ! passive tracers transport USE trcsms ! passive tracers sources and sinks USE trcwri USE trcrst USE trdtrc_oce USE trdmxl_trc USE sms_pisces, ONLY : ln_check_mass ! USE prtctl_trc ! Print control for debbuging USE iom ! USE in_out_manager ! IMPLICIT NONE PRIVATE PUBLIC trc_stp ! called by step LOGICAL :: llnew ! ??? REAL(wp) :: rdt_sampl ! ??? INTEGER :: nb_rec_per_day, ktdcy ! ??? REAL(wp) :: rsecfst, rseclast ! ??? REAL(wp), DIMENSION(:,:,:), SAVE, ALLOCATABLE :: qsr_arr ! save qsr during TOP time-step !!---------------------------------------------------------------------- !! NEMO/TOP 4.0 , NEMO Consortium (2018) !! $Id$ !! Software governed by the CeCILL license (see ./LICENSE) !!---------------------------------------------------------------------- CONTAINS SUBROUTINE trc_stp( kt, Kbb, Kmm, Krhs, Kaa ) !!------------------------------------------------------------------- !! *** ROUTINE trc_stp *** !! !! ** Purpose : Time loop of opa for passive tracer !! !! ** Method : Compute the passive tracers trends !! Update the passive tracers !!------------------------------------------------------------------- INTEGER, INTENT( in ) :: kt ! ocean time-step index INTEGER, INTENT( in ) :: Kbb, Kmm, Krhs, Kaa ! time level indices ! INTEGER :: jk, jn ! dummy loop indices REAL(wp):: ztrai ! local scalar LOGICAL :: ll_trcstat ! local logical CHARACTER (len=25) :: charout ! !!------------------------------------------------------------------- ! IF( ln_timing ) CALL timing_start('trc_stp') ! IF( ( neuler == 0 .AND. kt == nittrc000 ) .OR. ln_top_euler ) THEN ! at nittrc000 r2dttrc = rdttrc ! = rdttrc (use or restarting with Euler time stepping) ELSEIF( kt <= nittrc000 + 1 ) THEN ! at nittrc000 or nittrc000+1 r2dttrc = 2. * rdttrc ! = 2 rdttrc (leapfrog) ENDIF ! ll_trcstat = ( sn_cfctl%l_trcstat ) .AND. & & ( ( MOD( kt, sn_cfctl%ptimincr ) == 0 ) .OR. ( kt == nitend ) ) IF( kt == nittrc000 .AND. lk_trdmxl_trc ) CALL trd_mxl_trc_init ! trends: Mixed-layer ! IF( .NOT.ln_linssh ) THEN ! update ocean volume due to ssh temporal evolution DO jk = 1, jpk cvol(:,:,jk) = e1e2t(:,:) * e3t(:,:,jk,Kmm) * tmask(:,:,jk) END DO IF ( ll_trcstat .OR. kt == nitrst .OR. ( ln_check_mass .AND. kt == nitend ) & & .OR. iom_use( "pno3tot" ) .OR. iom_use( "ppo4tot" ) .OR. iom_use( "psiltot" ) & & .OR. iom_use( "palktot" ) .OR. iom_use( "pfertot" ) ) & & areatot = glob_sum( 'trcstp', cvol(:,:,:) ) ENDIF ! IF( l_trcdm2dc ) CALL trc_mean_qsr( kt ) ! ! IF(sn_cfctl%l_prttrc) THEN WRITE(charout,FMT="('kt =', I4,' d/m/y =',I2,I2,I4)") kt, nday, nmonth, nyear CALL prt_ctl_trc_info(charout) ENDIF ! tr(:,:,:,:,Krhs) = 0._wp ! CALL trc_rst_opn ( kt ) ! Open tracer restart file IF( lrst_trc ) CALL trc_rst_cal ( kt, 'WRITE' ) ! calendar CALL trc_wri ( kt, Kmm ) ! output of passive tracers with iom I/O manager CALL trc_sms ( kt, Kbb, Kmm, Krhs ) ! tracers: sinks and sources CALL trc_trp ( kt, Kbb, Kmm, Krhs, Kaa ) ! transport of passive tracers ! ! Note passive tracers have been time-filtered in trc_trp but the time level ! indices will not be swapped until after tra_atf/dyn_atf/ssh_atf in stp. Subsequent calls here ! anticipate this update which will be: Nrhs= Nbb ; Nbb = Nnn ; Nnn = Naa ; Naa = Nrhs ! and use the filtered levels explicitly. ! IF( kt == nittrc000 ) THEN CALL iom_close( numrtr ) ! close input tracer restart file IF(lwm) CALL FLUSH( numont ) ! flush namelist output ENDIF IF( lrst_trc ) CALL trc_rst_wri ( kt, Kmm, Kaa, Kbb ) ! write tracer restart file IF( lk_trdmxl_trc ) CALL trd_mxl_trc ( kt, Kaa ) ! trends: Mixed-layer ! IF( ln_top_euler ) THEN ! For Euler timestepping for TOP we need to copy the "after" to the "now" fields ! here then after the (leapfrog) swapping of the time-level indices in OCE/step.F90 we have ! "before" fields = "now" fields. tr(:,:,:,:,Kmm) = tr(:,:,:,:,Kaa) ENDIF ! IF (ll_trcstat) THEN ztrai = 0._wp ! content of all tracers DO jn = 1, jptra ztrai = ztrai + glob_sum( 'trcstp', tr(:,:,:,jn,Kaa) * cvol(:,:,:) ) END DO IF( lwm ) WRITE(numstr,9300) kt, ztrai / areatot ENDIF 9300 FORMAT(i10,D23.16) ! IF( ln_timing ) CALL timing_stop('trc_stp') ! END SUBROUTINE trc_stp SUBROUTINE trc_mean_qsr( kt ) !!---------------------------------------------------------------------- !! *** ROUTINE trc_mean_qsr *** !! !! ** Purpose : Compute daily mean qsr for biogeochemical model in case !! of diurnal cycle !! !! ** Method : store in TOP the qsr every hour ( or every time-step if the latter !! is greater than 1 hour ) and then, compute the mean with !! a moving average over 24 hours. !! In coupled mode, the sampling is done at every coupling frequency !!---------------------------------------------------------------------- INTEGER, INTENT( in ) :: kt ! ocean time-step index ! INTEGER :: jn ! dummy loop indices REAL(wp) :: zkt, zrec ! local scalars CHARACTER(len=1) :: cl1 ! 1 character CHARACTER(len=2) :: cl2 ! 2 characters !!---------------------------------------------------------------------- ! IF( ln_timing ) CALL timing_start('trc_mean_qsr') ! IF( kt == nittrc000 ) THEN IF( ln_cpl ) THEN rdt_sampl = rday / ncpl_qsr_freq nb_rec_per_day = ncpl_qsr_freq ELSE rdt_sampl = MAX( 3600., rdttrc ) nb_rec_per_day = INT( rday / rdt_sampl ) ENDIF ! IF(lwp) THEN WRITE(numout,*) WRITE(numout,*) ' Sampling frequency dt = ', rdt_sampl, 's',' Number of sampling per day nrec = ', nb_rec_per_day WRITE(numout,*) ENDIF ! ALLOCATE( qsr_arr(jpi,jpj,nb_rec_per_day ) ) ! ! !* Restart: read in restart file IF( ln_rsttr .AND. nn_rsttr /= 0 .AND. iom_varid( numrtr, 'qsr_mean' , ldstop = .FALSE. ) > 0 & & .AND. iom_varid( numrtr, 'qsr_arr_1', ldstop = .FALSE. ) > 0 & & .AND. iom_varid( numrtr, 'ktdcy' , ldstop = .FALSE. ) > 0 & & .AND. iom_varid( numrtr, 'nrdcy' , ldstop = .FALSE. ) > 0 ) THEN CALL iom_get( numrtr, 'ktdcy', zkt ) rsecfst = INT( zkt ) * rdttrc IF(lwp) WRITE(numout,*) 'trc_qsr_mean: qsr_mean read in the restart file at time-step rsecfst =', rsecfst, ' s ' CALL iom_get( numrtr, jpdom_autoglo, 'qsr_mean', qsr_mean ) ! A mean of qsr CALL iom_get( numrtr, 'nrdcy', zrec ) ! Number of record per days IF( INT( zrec ) == nb_rec_per_day ) THEN DO jn = 1, nb_rec_per_day IF( jn <= 9 ) THEN WRITE(cl1,'(i1)') jn CALL iom_get( numrtr, jpdom_autoglo, 'qsr_arr_'//cl1, qsr_arr(:,:,jn) ) ! A mean of qsr ELSE WRITE(cl2,'(i2.2)') jn CALL iom_get( numrtr, jpdom_autoglo, 'qsr_arr_'//cl2, qsr_arr(:,:,jn) ) ! A mean of qsr ENDIF END DO ELSE DO jn = 1, nb_rec_per_day qsr_arr(:,:,jn) = qsr_mean(:,:) ENDDO ENDIF ELSE !* no restart: set from nit000 values IF(lwp) WRITE(numout,*) 'trc_qsr_mean: qsr_mean set to nit000 values' rsecfst = kt * rdttrc ! qsr_mean(:,:) = qsr(:,:) DO jn = 1, nb_rec_per_day qsr_arr(:,:,jn) = qsr_mean(:,:) END DO ENDIF ! ENDIF ! rseclast = kt * rdttrc ! llnew = ( rseclast - rsecfst ) .ge. rdt_sampl ! new shortwave to store IF( llnew ) THEN ktdcy = kt IF( lwp .AND. kt < nittrc000 + 100 ) WRITE(numout,*) ' New shortwave to sample for TOP at time kt = ', ktdcy, & & ' time = ', rseclast/3600.,'hours ' rsecfst = rseclast DO jn = 1, nb_rec_per_day - 1 qsr_arr(:,:,jn) = qsr_arr(:,:,jn+1) ENDDO qsr_arr (:,:,nb_rec_per_day) = qsr(:,:) qsr_mean(:,: ) = SUM( qsr_arr(:,:,:), 3 ) / nb_rec_per_day ENDIF ! IF( lrst_trc ) THEN !* Write the mean of qsr in restart file IF(lwp) WRITE(numout,*) IF(lwp) WRITE(numout,*) 'trc_mean_qsr : write qsr_mean in restart file kt =', kt IF(lwp) WRITE(numout,*) '~~~~~~~' zkt = REAL( ktdcy, wp ) zrec = REAL( nb_rec_per_day, wp ) CALL iom_rstput( kt, nitrst, numrtw, 'ktdcy', zkt ) CALL iom_rstput( kt, nitrst, numrtw, 'nrdcy', zrec ) DO jn = 1, nb_rec_per_day IF( jn <= 9 ) THEN WRITE(cl1,'(i1)') jn CALL iom_rstput( kt, nitrst, numrtw, 'qsr_arr_'//cl1, qsr_arr(:,:,jn) ) ELSE WRITE(cl2,'(i2.2)') jn CALL iom_rstput( kt, nitrst, numrtw, 'qsr_arr_'//cl2, qsr_arr(:,:,jn) ) ENDIF END DO CALL iom_rstput( kt, nitrst, numrtw, 'qsr_mean', qsr_mean(:,:) ) ENDIF ! IF( ln_timing ) CALL timing_stop('trc_mean_qsr') ! END SUBROUTINE trc_mean_qsr #else !!---------------------------------------------------------------------- !! Default key NO passive tracers !!---------------------------------------------------------------------- CONTAINS SUBROUTINE trc_stp( kt ) ! Empty routine WRITE(*,*) 'trc_stp: You should not have seen this print! error?', kt END SUBROUTINE trc_stp #endif !!====================================================================== END MODULE trcstp