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.
trcini.F90 in branches/UKMO/dev_r5518_MEDUSA_optim_RH/NEMOGCM/NEMO/TOP_SRC – NEMO

source: branches/UKMO/dev_r5518_MEDUSA_optim_RH/NEMOGCM/NEMO/TOP_SRC/trcini.F90 @ 7693

Last change on this file since 7693 was 7693, checked in by frrh, 7 years ago

Merge in branches/NERC/dev_r5518_NOC_MEDUSA_Stable from revision range
r 5711:7611 (i.e. the entire branch)

File size: 13.4 KB
RevLine 
[268]1MODULE trcini
[945]2   !!======================================================================
3   !!                         ***  MODULE trcini  ***
4   !! TOP :   Manage the passive tracer initialization
5   !!======================================================================
[2715]6   !! History :   -   ! 1991-03 (O. Marti)  original code
7   !!            1.0  ! 2005-03 (O. Aumont, A. El Moussaoui) F90
8   !!            2.0  ! 2005-10 (C. Ethe, G. Madec) revised architecture
9   !!            4.0  ! 2011-01 (A. R. Porter, STFC Daresbury) dynamical allocation
[7693]10   !!             -   ! 2014-06 (A. Yool, J. Palmieri) adding MEDUSA-2
[274]11   !!----------------------------------------------------------------------
[1011]12#if defined key_top
13   !!----------------------------------------------------------------------
14   !!   'key_top'                                                TOP models
15   !!----------------------------------------------------------------------
[2715]16   !!   trc_init  :   Initialization for passive tracer
17   !!   top_alloc :   allocate the TOP arrays
[1011]18   !!----------------------------------------------------------------------
[3294]19   USE oce_trc         ! shared variables between ocean and passive tracers
20   USE trc             ! passive tracers common variables
21   USE trcrst          ! passive tracers restart
[2528]22   USE trcnam          ! Namelist read
[1254]23   USE trcini_cfc      ! CFC      initialisation
24   USE trcini_pisces   ! PISCES   initialisation
25   USE trcini_c14b     ! C14 bomb initialisation
26   USE trcini_my_trc   ! MY_TRC   initialisation
[7693]27   USE trcini_medusa   ! MEDUSA   initialisation
28   USE trcini_idtra    ! idealize tracer initialisation
29   USE trcini_age      ! AGE      initialisation
[4230]30   USE trcdta          ! initialisation from files
[3294]31   USE daymod          ! calendar manager
[2528]32   USE zpshde          ! partial step: hor. derivative   (zps_hde routine)
[1011]33   USE prtctl_trc      ! Print control passive tracers (prt_ctl_trc_init routine)
[4306]34   USE trcsub          ! variables to substep passive tracers
35   USE lib_mpp         ! distribued memory computing library
36   USE sbc_oce
[5385]37   USE trcice          ! tracers in sea ice
[4306]38 
[335]39   IMPLICIT NONE
40   PRIVATE
[1011]41   
[2528]42   PUBLIC   trc_init   ! called by opa
[268]43
[1011]44    !! * Substitutions
45#  include "domzgr_substitute.h90"
[2715]46   !!----------------------------------------------------------------------
47   !! NEMO/TOP 4.0 , NEMO Consortium (2011)
[7692]48   !! $Id$
[2715]49   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
50   !!----------------------------------------------------------------------
[335]51CONTAINS
[1011]52   
[2528]53   SUBROUTINE trc_init
[1011]54      !!---------------------------------------------------------------------
[2528]55      !!                     ***  ROUTINE trc_init  ***
[335]56      !!
[1011]57      !! ** Purpose :   Initialization of the passive tracer fields
58      !!
59      !! ** Method  : - read namelist
60      !!              - control the consistancy
61      !!              - compute specific initialisations
62      !!              - set initial tracer fields (either read restart
63      !!                or read data or analytical formulation
64      !!---------------------------------------------------------------------
[3294]65      INTEGER ::   jk, jn, jl    ! dummy loop indices
[1011]66      CHARACTER (len=25) :: charout
[4230]67      REAL(wp), POINTER, DIMENSION(:,:,:) ::  ztrcdta   ! 4D  workspace
[1011]68      !!---------------------------------------------------------------------
[3294]69      !
70      IF( nn_timing == 1 )   CALL timing_start('trc_init')
71      !
[945]72      IF(lwp) WRITE(numout,*)
[2528]73      IF(lwp) WRITE(numout,*) 'trc_init : initial set up of the passive tracers'
[945]74      IF(lwp) WRITE(numout,*) '~~~~~~~'
[1011]75
[2715]76      CALL top_alloc()              ! allocate TOP arrays
77
[5407]78      l_trcdm2dc = ln_dm2dc .OR. ( ln_cpl .AND. ncpl_qsr_freq /= 1 )
[5385]79      l_trcdm2dc = l_trcdm2dc  .AND. .NOT. lk_offline
80      IF( l_trcdm2dc .AND. lwp ) &
81         &   CALL ctl_warn(' Coupling with passive tracers and used of diurnal cycle. &
82         & Computation of a daily mean shortwave for some biogeochemical models) ')
[7693]83          !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
84          !!!!! CHECK For MEDUSA
85          !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
[3294]86      IF( nn_cla == 1 )   &
87         &  CALL ctl_stop( ' Cross Land Advection not yet implemented with passive tracer ; nn_cla must be 0' )
[1011]88
[4152]89      CALL trc_nam      ! read passive tracers namelists
[3294]90      !
91      IF(lwp) WRITE(numout,*)
[4152]92      !
93      IF( ln_rsttr .AND. .NOT. lk_offline ) CALL trc_rst_cal( nit000, 'READ' )   ! calendar
94      !
[3294]95      IF(lwp) WRITE(numout,*)
96                                                              ! masked grid volume
97      !                                                              ! masked grid volume
98      DO jk = 1, jpk
99         cvol(:,:,jk) = e1e2t(:,:) * fse3t(:,:,jk) * tmask(:,:,jk)
100      END DO
101      IF( lk_degrad ) cvol(:,:,:) = cvol(:,:,:) * facvol(:,:,:)      ! degrad option: reduction by facvol
102      !                                                              ! total volume of the ocean
103      areatot = glob_sum( cvol(:,:,:) )
[1011]104
[3294]105      IF( lk_pisces  )       CALL trc_ini_pisces       ! PISCES  bio-model
[7693]106      IF( lk_medusa  )       CALL trc_ini_medusa       ! MEDUSA  tracers
107      IF( lk_idtra   )       CALL trc_ini_idtra        ! Idealize tracers
[3294]108      IF( lk_cfc     )       CALL trc_ini_cfc          ! CFC     tracers
109      IF( lk_c14b    )       CALL trc_ini_c14b         ! C14 bomb  tracer
[7693]110      IF( lk_age     )       CALL trc_ini_age          ! AGE       tracer
[3294]111      IF( lk_my_trc  )       CALL trc_ini_my_trc       ! MY_TRC  tracers
[2528]112
[5385]113      CALL trc_ice_ini                                 ! Tracers in sea ice
114
[7693]115# if defined key_debug_medusa
116         IF (lwp) write (numout,*) '------------------------------'
117         IF (lwp) write (numout,*) 'Jpalm - debug'
118         IF (lwp) write (numout,*) ' in trc_init'
119         IF (lwp) write (numout,*) ' sms init OK'
120         IF (lwp) write (numout,*) ' next: open tracer.stat'
121         IF (lwp) write (numout,*) ' '
122         CALL flush(numout)
123# endif
124
[3294]125      IF( lwp ) THEN
126         !
[4152]127         CALL ctl_opn( numstr, 'tracer.stat', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, numout, lwp , narea )
[3294]128         !
[945]129      ENDIF
[1254]130
[7693]131# if defined key_debug_medusa
132         IF (lwp) write (numout,*) '------------------------------'
133         IF (lwp) write (numout,*) 'Jpalm - debug'
134         IF (lwp) write (numout,*) ' in trc_init'
135         IF (lwp) write (numout,*) 'open tracer.stat -- OK'
136         IF (lwp) write (numout,*) ' '
137         CALL flush(numout)
138# endif
[1011]139
[3294]140
[7693]141      IF( ln_trcdta ) THEN
142#if defined key_medusa
143         IF(lwp) WRITE(numout,*) 'AXY: calling trc_dta_init'
144         IF(lwp) CALL flush(numout)
145#endif
146         CALL trc_dta_init(jptra)
147      ENDIF
148
[2528]149      IF( ln_rsttr ) THEN
150        !
[7693]151#if defined key_medusa
152        IF(lwp) WRITE(numout,*) 'AXY: calling trc_rst_read'
153        IF(lwp) CALL flush(numout)
154#endif
[2528]155        CALL trc_rst_read              ! restart from a file
156        !
[1011]157      ELSE
[3294]158        !
159        IF( ln_trcdta .AND. nb_trcdta > 0 ) THEN  ! Initialisation of tracer from a file that may also be used for damping
160            !
[4230]161            CALL wrk_alloc( jpi, jpj, jpk, ztrcdta )    ! Memory allocation
[3294]162            !
163            DO jn = 1, jptra
164               IF( ln_trc_ini(jn) ) THEN      ! update passive tracers arrays with input data read from file
165                  jl = n_trc_index(jn) 
[4230]166                  CALL trc_dta( nit000, sf_trcdta(jl),rf_trfac(jl) )   ! read tracer data at nit000
167                  ztrcdta(:,:,:) = sf_trcdta(jl)%fnow(:,:,:)
168                  trn(:,:,:,jn) = ztrcdta(:,:,:) * tmask(:,:,:) 
169                  IF( .NOT.ln_trcdmp .AND. .NOT.ln_trcdmp_clo ) THEN      !== deallocate data structure   ==!
170                     !                                                    (data used only for initialisation)
171                     IF(lwp) WRITE(numout,*) 'trc_dta: deallocate data arrays as they are only used to initialize the run'
172                                                  DEALLOCATE( sf_trcdta(jl)%fnow )     !  arrays in the structure
173                     IF( sf_trcdta(jl)%ln_tint )  DEALLOCATE( sf_trcdta(jl)%fdta )
174                     !
175                  ENDIF
[3294]176               ENDIF
177            ENDDO
[4230]178            CALL wrk_dealloc( jpi, jpj, jpk, ztrcdta )
[2528]179        ENDIF
[3294]180        !
[7693]181# if defined key_debug_medusa
182         IF (lwp) write (numout,*) '------------------------------'
183         IF (lwp) write (numout,*) 'Jpalm - debug'
184         IF (lwp) write (numout,*) ' in trc_init'
185         IF (lwp) write (numout,*) ' before trb = trn'
186         IF (lwp) write (numout,*) ' '
187         CALL flush(numout)
188# endif
189        !
[2528]190        trb(:,:,:,:) = trn(:,:,:,:)
191        !
[7693]192# if defined key_debug_medusa
193         IF (lwp) write (numout,*) '------------------------------'
194         IF (lwp) write (numout,*) 'Jpalm - debug'
195         IF (lwp) write (numout,*) ' in trc_init'
196         IF (lwp) write (numout,*) ' trb = trn -- OK'
197         IF (lwp) write (numout,*) ' '
198         CALL flush(numout)
199# endif
200        !
[1011]201      ENDIF
[2528]202 
[2715]203      tra(:,:,:,:) = 0._wp
[5120]204      IF( ln_zps .AND. .NOT. lk_c1d .AND. .NOT. ln_isfcav )   &              ! Partial steps: before horizontal gradient of passive
205        &    CALL zps_hde    ( nit000, jptra, trn, gtru, gtrv  )  ! Partial steps: before horizontal gradient
206      IF( ln_zps .AND. .NOT. lk_c1d .AND.       ln_isfcav )   &
207        &    CALL zps_hde_isf( nit000, jptra, trn, pgtu=gtru, pgtv=gtrv, pgtui=gtrui, pgtvi=gtrvi )       ! tracers at the bottom ocean level
[3294]208      !
[7693]209# if defined key_debug_medusa
210         IF (lwp) write (numout,*) '------------------------------'
211         IF (lwp) write (numout,*) 'Jpalm - debug'
212         IF (lwp) write (numout,*) ' in trc_init'
213         IF (lwp) write (numout,*) ' partial step -- OK'
214         IF (lwp) write (numout,*) ' '
215         CALL flush(numout)
216# endif
217      !
[3294]218      IF( nn_dttrc /= 1 )        CALL trc_sub_ini      ! Initialize variables for substepping passive tracers
219      !
[7693]220# if defined key_debug_medusa
221         IF (lwp) write (numout,*) '------------------------------'
222         IF (lwp) write (numout,*) 'Jpalm - debug'
223         IF (lwp) write (numout,*) ' in trc_init'
224         IF (lwp) write (numout,*) ' before initiate tracer contents'
225         IF (lwp) write (numout,*) ' '
226         CALL flush(numout)
227# endif
228      !
[3294]229      trai(:) = 0._wp                                                   ! initial content of all tracers
[1011]230      DO jn = 1, jptra
[3294]231         trai(jn) = trai(jn) + glob_sum( trn(:,:,:,jn) * cvol(:,:,:)   )
232      END DO
[1011]233
[2715]234      IF(lwp) THEN               ! control print
235         WRITE(numout,*)
236         WRITE(numout,*)
237         WRITE(numout,*) '          *** Total number of passive tracer jptra = ', jptra
238         WRITE(numout,*) '          *** Total volume of ocean                = ', areatot
[3294]239         WRITE(numout,*) '          *** Total inital content of all tracers '
[2715]240         WRITE(numout,*)
[7693]241# if defined key_debug_medusa
242         CALL flush(numout)
243# endif
244         !
245# if defined key_debug_medusa
246         WRITE(numout,*) ' litle check :  ', ctrcnm(1)
247         CALL flush(numout)
248# endif
[3294]249         DO jn = 1, jptra
250            WRITE(numout,9000) jn, TRIM( ctrcnm(jn) ), trai(jn)
251         ENDDO
252         WRITE(numout,*)
[2715]253      ENDIF
[3294]254      IF(lwp) WRITE(numout,*)
[2715]255      IF(ln_ctl) THEN            ! print mean trends (used for debugging)
256         CALL prt_ctl_trc_init
[1011]257         WRITE(charout, FMT="('ini ')")
258         CALL prt_ctl_trc_info( charout )
259         CALL prt_ctl_trc( tab4d=trn, mask=tmask, clinfo=ctrcnm )
260      ENDIF
[7693]261
262      IF(lwp) WRITE(numout,*)
263      IF(lwp) WRITE(numout,*) 'trc_init : passive tracer set up completed'
264      IF(lwp) WRITE(numout,*) '~~~~~~~'
265      IF(lwp) CALL flush(numout)
266# if defined key_debug_medusa
267         CALL trc_rst_stat
268         CALL flush(numout)
269# endif
270
[3294]2719000  FORMAT(' tracer nb : ',i2,'      name :',a10,'      initial content :',e18.10)
[2715]272      !
[3294]273      IF( nn_timing == 1 )   CALL timing_stop('trc_init')
274      !
[2528]275   END SUBROUTINE trc_init
[268]276
[2715]277
278   SUBROUTINE top_alloc
279      !!----------------------------------------------------------------------
280      !!                     ***  ROUTINE top_alloc  ***
281      !!
282      !! ** Purpose :   Allocate all the dynamic arrays of the OPA modules
283      !!----------------------------------------------------------------------
284      USE trcadv        , ONLY:   trc_adv_alloc          ! TOP-related alloc routines...
285      USE trc           , ONLY:   trc_alloc
286      USE trcnxt        , ONLY:   trc_nxt_alloc
287      USE trczdf        , ONLY:   trc_zdf_alloc
[4990]288      USE trdtrc_oce    , ONLY:   trd_trc_oce_alloc
289#if defined key_trdmxl_trc 
290      USE trdmxl_trc    , ONLY:   trd_mxl_trc_alloc
[2715]291#endif
292      !
293      INTEGER :: ierr
294      !!----------------------------------------------------------------------
295      !
296      ierr =        trc_adv_alloc()          ! Start of TOP-related alloc routines...
297      ierr = ierr + trc_alloc    ()
298      ierr = ierr + trc_nxt_alloc()
299      ierr = ierr + trc_zdf_alloc()
[4990]300      ierr = ierr + trd_trc_oce_alloc()
301#if defined key_trdmxl_trc 
302      ierr = ierr + trd_mxl_trc_alloc()
[2715]303#endif
304      !
305      IF( lk_mpp    )   CALL mpp_sum( ierr )
306      IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'top_alloc : unable to allocate standard ocean arrays' )
307      !
308   END SUBROUTINE top_alloc
309
[1011]310#else
311   !!----------------------------------------------------------------------
312   !!  Empty module :                                     No passive tracer
313   !!----------------------------------------------------------------------
314CONTAINS
[2528]315   SUBROUTINE trc_init                      ! Dummy routine   
316   END SUBROUTINE trc_init
[1011]317#endif
318
[335]319   !!======================================================================
[268]320END MODULE trcini
Note: See TracBrowser for help on using the repository browser.