MODULE trcini !!====================================================================== !! *** MODULE trcini *** !! TOP : Manage the passive tracer initialization !!====================================================================== !! History : - ! 1991-03 (O. Marti) original code !! 1.0 ! 2005-03 (O. Aumont, A. El Moussaoui) F90 !! 2.0 ! 2005-10 (C. Ethe, G. Madec) revised architecture !! 4.0 ! 2011-01 (A. R. Porter, STFC Daresbury) dynamical allocation !!---------------------------------------------------------------------- #if defined key_top !!---------------------------------------------------------------------- !! 'key_top' TOP models !!---------------------------------------------------------------------- !! trc_init : Initialization for passive tracer !! top_alloc : allocate the TOP arrays !!---------------------------------------------------------------------- USE oce_trc ! shared variables between ocean and passive tracers USE trc ! passive tracers common variables USE trcnam ! Namelist read USE daymod ! calendar manager USE prtctl_trc ! Print control passive tracers (prt_ctl_trc_init routine) USE trcrst USE lib_mpp ! distribued memory computing library USE trcice ! tracers in sea ice USE trcbc ! generalized Boundary Conditions IMPLICIT NONE PRIVATE PUBLIC trc_init ! called by opa !!---------------------------------------------------------------------- !! NEMO/TOP 4.0 , NEMO Consortium (2018) !! $Id$ !! Software governed by the CeCILL license (see ./LICENSE) !!---------------------------------------------------------------------- CONTAINS SUBROUTINE trc_init( Kbb, Kmm, Kaa ) !!--------------------------------------------------------------------- !! *** ROUTINE trc_init *** !! !! ** Purpose : Initialization of the passive tracer fields !! !! ** Method : - read namelist !! - control the consistancy !! - compute specific initialisations !! - set initial tracer fields (either read restart !! or read data or analytical formulation !!--------------------------------------------------------------------- INTEGER, INTENT(in) :: Kbb, Kmm, Kaa ! time level indices ! IF( ln_timing ) CALL timing_start('trc_init') ! IF(lwp) WRITE(numout,*) IF(lwp) WRITE(numout,*) 'trc_init : initial set up of the passive tracers' IF(lwp) WRITE(numout,*) '~~~~~~~~' ! CALL trc_nam ! read passive tracers namelists CALL top_alloc() ! allocate TOP arrays ! IF(.NOT.ln_trcdta ) ln_trc_ini(:) = .FALSE. ! IF(lwp) WRITE(numout,*) IF( ln_rsttr .AND. .NOT. l_offline ) CALL trc_rst_cal( nit000, 'READ' ) ! calendar IF(lwp) WRITE(numout,*) ! CALL trc_ini_sms( Kmm ) ! SMS CALL trc_ini_trp ! passive tracers transport CALL trc_ice_ini ! Tracers in sea ice ! IF( lwm .AND. sn_cfctl%l_trcstat ) THEN CALL ctl_opn( numstr, 'tracer.stat', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, numout, lwp , narea ) ENDIF ! CALL trc_ini_state( Kbb, Kmm, Kaa ) ! passive tracers initialisation : from a restart or from clim ! CALL trc_ini_inv( Kmm ) ! Inventories ! IF( ln_timing ) CALL timing_stop('trc_init') ! END SUBROUTINE trc_init SUBROUTINE trc_ini_inv( Kmm ) !!---------------------------------------------------------------------- !! *** ROUTINE trc_ini_stat *** !! ** Purpose : passive tracers inventories at initialsation phase !!---------------------------------------------------------------------- INTEGER, INTENT(in) :: Kmm ! time level index INTEGER :: jk, jn ! dummy loop indices CHARACTER (len=25) :: charout !!---------------------------------------------------------------------- ! IF(lwp) WRITE(numout,*) IF(lwp) WRITE(numout,*) 'trc_ini_inv : initial passive tracers inventories' IF(lwp) WRITE(numout,*) '~~~~~~~~~~~' ! ! ! masked grid volume DO jk = 1, jpk cvol(:,:,jk) = e1e2t(:,:) * e3t(:,:,jk,Kmm) * tmask(:,:,jk) END DO ! ! total volume of the ocean areatot = glob_sum( 'trcini', cvol(:,:,:) ) ! trai(:) = 0._wp ! initial content of all tracers DO jn = 1, jptra trai(jn) = trai(jn) + glob_sum( 'trcini', tr(:,:,:,jn,Kmm) * cvol(:,:,:) ) END DO IF(lwp) THEN ! control print WRITE(numout,*) WRITE(numout,*) ' ==>>> Total number of passive tracer jptra = ', jptra WRITE(numout,*) ' Total volume of ocean = ', areatot WRITE(numout,*) ' Total inital content of all tracers ' WRITE(numout,*) DO jn = 1, jptra WRITE(numout,9000) jn, TRIM( ctrcnm(jn) ), trai(jn) ENDDO WRITE(numout,*) ENDIF IF(lwp) WRITE(numout,*) IF(sn_cfctl%l_prttrc) THEN ! print mean trends (used for debugging) CALL prt_ctl_trc_init WRITE(charout, FMT="('ini ')") CALL prt_ctl_trc_info( charout ) CALL prt_ctl_trc( tab4d=tr(:,:,:,:,Kmm), mask=tmask, clinfo=ctrcnm ) ENDIF 9000 FORMAT(' tracer nb : ',i2,' name :',a10,' initial content :',e18.10) ! END SUBROUTINE trc_ini_inv SUBROUTINE trc_ini_sms( Kmm ) !!---------------------------------------------------------------------- !! *** ROUTINE trc_ini_sms *** !! ** Purpose : SMS initialisation !!---------------------------------------------------------------------- USE trcini_pisces ! PISCES initialisation USE trcini_cfc ! CFC initialisation USE trcini_c14 ! C14 initialisation USE trcini_age ! age initialisation USE trcini_my_trc ! MY_TRC initialisation ! INTEGER, INTENT(in) :: Kmm ! time level indices INTEGER :: jn !!---------------------------------------------------------------------- ! ! Pass sn_tracer fields to specialized arrays DO jn = 1, jp_bgc ctrcnm (jn) = TRIM( sn_tracer(jn)%clsname ) ctrcln (jn) = TRIM( sn_tracer(jn)%cllname ) ctrcun (jn) = TRIM( sn_tracer(jn)%clunit ) ln_trc_ini(jn) = sn_tracer(jn)%llinit ln_trc_sbc(jn) = sn_tracer(jn)%llsbc ln_trc_cbc(jn) = sn_tracer(jn)%llcbc ln_trc_obc(jn) = sn_tracer(jn)%llobc END DO ! IF( .NOT.ln_trcbc ) THEN DO jn = 1, jp_bgc ln_trc_sbc(jn) = .FALSE. ln_trc_cbc(jn) = .FALSE. ln_trc_obc(jn) = .FALSE. END DO ENDIF lltrcbc = ( COUNT(ln_trc_sbc) + COUNT(ln_trc_obc) + COUNT(ln_trc_cbc) ) > 0 ! IF( ln_pisces ) CALL trc_ini_pisces( Kmm ) ! PISCES model IF( ln_my_trc ) CALL trc_ini_my_trc( Kmm ) ! MY_TRC model IF( ll_cfc ) CALL trc_ini_cfc ( Kmm ) ! CFC's IF( ln_c14 ) CALL trc_ini_c14 ( Kmm ) ! C14 model IF( ln_age ) CALL trc_ini_age ( Kmm ) ! AGE ! IF(lwp) THEN ! control print WRITE(numout,*) WRITE(numout,*) 'trc_init_sms : Summary for selected passive tracers' WRITE(numout,*) '~~~~~~~~~~~~' WRITE(numout,*) ' ID NAME INI SBC CBC OBC' DO jn = 1, jptra WRITE(numout,9001) jn, TRIM(ctrcnm(jn)), ln_trc_ini(jn), ln_trc_sbc(jn),ln_trc_cbc(jn),ln_trc_obc(jn) END DO ENDIF IF( lwp .AND. ln_trcbc .AND. lltrcbc ) THEN WRITE(numout,*) WRITE(numout,*) ' Applying tracer boundary conditions ' ENDIF 9001 FORMAT(3x,i3,1x,a10,3x,l2,3x,l2,3x,l2,3x,l2) ! END SUBROUTINE trc_ini_sms SUBROUTINE trc_ini_trp !!---------------------------------------------------------------------- !! *** ROUTINE trc_ini_trp *** !! !! ** Purpose : Allocate all the dynamic arrays of the OPA modules !!---------------------------------------------------------------------- USE trcdmp , ONLY: trc_dmp_ini USE trcadv , ONLY: trc_adv_ini USE trcldf , ONLY: trc_ldf_ini USE trcrad , ONLY: trc_rad_ini USE trcsink, ONLY: trc_sink_ini ! INTEGER :: ierr !!---------------------------------------------------------------------- ! IF( ln_trcdmp ) CALL trc_dmp_ini ! damping CALL trc_adv_ini ! advection CALL trc_ldf_ini ! lateral diffusion ! ! vertical diffusion: always implicit time stepping scheme CALL trc_rad_ini ! positivity of passive tracers CALL trc_sink_ini ! Vertical sedimentation of particles ! END SUBROUTINE trc_ini_trp SUBROUTINE trc_ini_state( Kbb, Kmm, Kaa ) !!---------------------------------------------------------------------- !! *** ROUTINE trc_ini_state *** !! ** Purpose : Initialisation of passive tracer concentration !!---------------------------------------------------------------------- USE zpshde ! partial step: hor. derivative (zps_hde routine) USE trcrst ! passive tracers restart USE trcdta ! initialisation from files ! INTEGER, INTENT(in) :: Kbb, Kmm, Kaa ! time level index INTEGER :: jn, jl ! dummy loop indices !!---------------------------------------------------------------------- ! IF( ln_trcdta ) CALL trc_dta_ini( jptra ) ! set initial tracers values ! IF( ln_trcbc .AND. lltrcbc ) THEN CALL trc_bc_ini ( jptra, Kmm ) ! set tracers Boundary Conditions CALL trc_bc ( nit000, Kmm, tr, Kaa ) ! tracers: surface and lateral Boundary Conditions ENDIF ! ! IF( ln_rsttr ) THEN ! restart from a file ! CALL trc_rst_read( Kbb, Kmm ) ! ELSE ! Initialisation of tracer from a file that may also be used for damping !!gm BUG ? if damping and restart, what's happening ? IF( ln_trcdta .AND. nb_trcdta > 0 ) THEN ! update passive tracers arrays with input data read from file DO jn = 1, jptra IF( ln_trc_ini(jn) ) THEN jl = n_trc_index(jn) CALL trc_dta( nit000, Kmm, sf_trcdta(jl), rf_trfac(jl), tr(:,:,:,jn,Kmm) ) ! ! deallocate data structure if data are not used for damping IF( .NOT.ln_trcdmp .AND. .NOT.ln_trcdmp_clo ) THEN IF(lwp) WRITE(numout,*) 'trc_ini_state: deallocate data arrays as they are only used to initialize the run' DEALLOCATE( sf_trcdta(jl)%fnow ) IF( sf_trcdta(jl)%ln_tint ) DEALLOCATE( sf_trcdta(jl)%fdta ) ! ENDIF ENDIF END DO ! ENDIF ! tr(:,:,:,:,Kbb) = tr(:,:,:,:,Kmm) ! ENDIF ! tr(:,:,:,:,Kaa) = 0._wp ! ! Partial top/bottom cell: GRADh(tr(Kmm)) END SUBROUTINE trc_ini_state SUBROUTINE top_alloc !!---------------------------------------------------------------------- !! *** ROUTINE top_alloc *** !! !! ** Purpose : Allocate all the dynamic arrays of the OPA modules !!---------------------------------------------------------------------- USE trc , ONLY: trc_alloc USE trdtrc_oce , ONLY: trd_trc_oce_alloc #if defined key_trdmxl_trc USE trdmxl_trc , ONLY: trd_mxl_trc_alloc #endif ! INTEGER :: ierr ! local integer !!---------------------------------------------------------------------- ! ierr = trc_alloc() ierr = ierr + trd_trc_oce_alloc() #if defined key_trdmxl_trc ierr = ierr + trd_mxl_trc_alloc() #endif ! CALL mpp_sum( 'trcini', ierr ) IF( ierr /= 0 ) CALL ctl_stop( 'STOP', 'top_alloc : unable to allocate standard ocean arrays' ) ! END SUBROUTINE top_alloc #else !!---------------------------------------------------------------------- !! Empty module : No passive tracer !!---------------------------------------------------------------------- CONTAINS SUBROUTINE trc_init ! Dummy routine END SUBROUTINE trc_init #endif !!====================================================================== END MODULE trcini