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/AMM15_v3_6_STABLE_package_collate/NEMOGCM/NEMO/TOP_SRC – NEMO

source: branches/UKMO/AMM15_v3_6_STABLE_package_collate/NEMOGCM/NEMO/TOP_SRC/trcini.F90 @ 12432

Last change on this file since 12432 was 12432, checked in by jcastill, 2 years ago

Merge changes in AMM15_v3_6_STABLE_package_collate_utils326, see Met Office utils ticket 326

File size: 11.2 KB
Line 
1MODULE trcini
2   !!======================================================================
3   !!                         ***  MODULE trcini  ***
4   !! TOP :   Manage the passive tracer initialization
5   !!======================================================================
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
10   !!----------------------------------------------------------------------
11#if defined key_top
12   !!----------------------------------------------------------------------
13   !!   'key_top'                                                TOP models
14   !!----------------------------------------------------------------------
15   !!   trc_init  :   Initialization for passive tracer
16   !!   top_alloc :   allocate the TOP arrays
17   !!----------------------------------------------------------------------
18   USE oce_trc         ! shared variables between ocean and passive tracers
19   USE trc             ! passive tracers common variables
20   USE trcrst          ! passive tracers restart
21   USE trcnam          ! Namelist read
22   USE trcini_cfc      ! CFC      initialisation
23   USE trcini_pisces   ! PISCES   initialisation
24   USE trcini_c14b     ! C14 bomb initialisation
25   USE trcini_my_trc   ! MY_TRC   initialisation
26   ! +++>>> FABM
27   USE trcsms_fabm     ! FABM initialisation
28   USE trcini_fabm     ! FABM initialisation
29   ! FABM <<<FABM
30   USE trcdta          ! initialisation from files
31   USE daymod          ! calendar manager
32   USE zpshde          ! partial step: hor. derivative   (zps_hde routine)
33   USE prtctl_trc      ! Print control passive tracers (prt_ctl_trc_init routine)
34   USE trcsub          ! variables to substep passive tracers
35   USE lib_mpp         ! distribued memory computing library
36   USE sbc_oce
37   USE trcice          ! tracers in sea ice
38   USE trcbc,   only : trc_bc_init ! generalized Boundary Conditions
39 
40   IMPLICIT NONE
41   PRIVATE
42   
43   PUBLIC   trc_init   ! called by opa
44
45    !! * Substitutions
46#  include "domzgr_substitute.h90"
47   !!----------------------------------------------------------------------
48   !! NEMO/TOP 4.0 , NEMO Consortium (2011)
49   !! $Id$
50   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
51   !!----------------------------------------------------------------------
52CONTAINS
53   
54   SUBROUTINE trc_init
55      !!---------------------------------------------------------------------
56      !!                     ***  ROUTINE trc_init  ***
57      !!
58      !! ** Purpose :   Initialization of the passive tracer fields
59      !!
60      !! ** Method  : - read namelist
61      !!              - control the consistancy
62      !!              - compute specific initialisations
63      !!              - set initial tracer fields (either read restart
64      !!                or read data or analytical formulation
65      !!---------------------------------------------------------------------
66      INTEGER ::   jk, jn, jl    ! dummy loop indices
67      CHARACTER (len=25) :: charout
68      REAL(wp), POINTER, DIMENSION(:,:,:) ::  ztrcdta   ! 4D  workspace
69      !!---------------------------------------------------------------------
70      !
71      IF( nn_timing == 1 )   CALL timing_start('trc_init')
72      !
73      IF(lwp) WRITE(numout,*)
74      IF(lwp) WRITE(numout,*) 'trc_init : initial set up of the passive tracers'
75      IF(lwp) WRITE(numout,*) '~~~~~~~'
76      ! +++>>> FABM
77      ! Allow FABM to update numbers of biogeochemical tracers, diagnostics (jptra etc.)
78      IF( lk_fabm ) CALL nemo_fabm_init
79      ! FABM <<<+++
80
81      CALL top_alloc()              ! allocate TOP arrays
82
83      l_trcdm2dc = ln_dm2dc  .AND. .NOT. lk_offline
84      IF( l_trcdm2dc .AND. lwp ) &
85         &   CALL ctl_warn(' Coupling with passive tracers and used of diurnal cycle. &
86         & Computation of a daily mean shortwave for some biogeochemical models) ')
87
88      IF( nn_cla == 1 )   &
89         &  CALL ctl_stop( ' Cross Land Advection not yet implemented with passive tracer ; nn_cla must be 0' )
90
91      CALL trc_nam      ! read passive tracers namelists
92      !
93      IF(lwp) WRITE(numout,*)
94      !
95      IF( ln_rsttr .AND. .NOT. lk_offline ) CALL trc_rst_cal( nit000, 'READ' )   ! calendar
96      !
97      IF(lwp) WRITE(numout,*)
98                                                              ! masked grid volume
99      !                                                              ! masked grid volume
100      DO jk = 1, jpk
101         cvol(:,:,jk) = e1e2t(:,:) * fse3t(:,:,jk) * tmask(:,:,jk)
102      END DO
103      IF( lk_degrad ) cvol(:,:,:) = cvol(:,:,:) * facvol(:,:,:)      ! degrad option: reduction by facvol
104      !                                                              ! total volume of the ocean
105      areatot = glob_sum( cvol(:,:,:) )
106
107      IF( lk_pisces  )       CALL trc_ini_pisces       ! PISCES  bio-model
108      IF( lk_cfc     )       CALL trc_ini_cfc          ! CFC     tracers
109      IF( lk_c14b    )       CALL trc_ini_c14b         ! C14 bomb  tracer
110      IF( lk_my_trc  )       CALL trc_ini_my_trc       ! MY_TRC  tracers
111      ! +++>>> FABM
112      IF( lk_fabm    )       CALL trc_ini_fabm         ! FABM    tracers
113      ! FABM <<<+++
114
115      CALL trc_ice_ini                                 ! Tracers in sea ice
116
117      IF( lwp ) THEN
118         !
119         CALL ctl_opn( numstr, 'tracer.stat', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, numout, lwp , narea )
120         !
121      ENDIF
122
123      ! Initialisation of tracers Initial Conditions
124      IF( ln_trcdta )      CALL trc_dta_init(jptra)
125
126
127      IF( ln_rsttr ) THEN
128        !
129        CALL trc_rst_read              ! restart from a file
130        !
131      ELSE
132        !
133        IF( ln_trcdta .AND. nb_trcdta > 0 ) THEN  ! Initialisation of tracer from a file that may also be used for damping
134            !
135            CALL wrk_alloc( jpi, jpj, jpk, ztrcdta )    ! Memory allocation
136            !
137            DO jn = 1, jptra
138               IF( ln_trc_ini(jn) ) THEN      ! update passive tracers arrays with input data read from file
139                  jl = n_trc_index(jn) 
140                  CALL trc_dta( nit000, sf_trcdta(jl),rf_trfac(jl) )   ! read tracer data at nit000
141                  ztrcdta(:,:,:) = sf_trcdta(jl)%fnow(:,:,:)
142                  trn(:,:,:,jn) = ztrcdta(:,:,:) * tmask(:,:,:) 
143                  IF( .NOT.ln_trcdmp .AND. .NOT.ln_trcdmp_clo ) THEN      !== deallocate data structure   ==!
144                     !                                                    (data used only for initialisation)
145                     IF(lwp) WRITE(numout,*) 'trc_dta: deallocate data arrays as they are only used to initialize the run'
146                                                  DEALLOCATE( sf_trcdta(jl)%fnow )     !  arrays in the structure
147                     IF( sf_trcdta(jl)%ln_tint )  DEALLOCATE( sf_trcdta(jl)%fdta )
148                     !
149                  ENDIF
150               ENDIF
151            ENDDO
152            CALL wrk_dealloc( jpi, jpj, jpk, ztrcdta )
153        ENDIF
154        !
155        trb(:,:,:,:) = trn(:,:,:,:)
156        !
157      ENDIF
158      ! --->>> FABM
159! Initialisation of tracers Boundary Conditions  - here so that you can use initial condition as boundary
160      !IF( lk_my_trc )     CALL trc_bc_init(jptra)
161      ! FABM <<<---
162      ! FABM +++>>>
163! Initialisation of FABM diagnostics and tracer boundary conditions (so that you can use initial condition as boundary)
164      IF( lk_fabm )     THEN
165          wndm=0._wp !uninitiased field at this point
166          qsr=0._wp !uninitiased field at this point
167          CALL compute_fabm ! only needed to set-up diagnostics
168          CALL trc_bc_init(jptra)
169      ENDIF
170      ! FABM <<<+++
171 
172      tra(:,:,:,:) = 0._wp
173      IF( ln_zps .AND. .NOT. lk_c1d .AND. .NOT. ln_isfcav )   &              ! Partial steps: before horizontal gradient of passive
174        &    CALL zps_hde    ( nit000, jptra, trn, gtru, gtrv  )  ! Partial steps: before horizontal gradient
175      IF( ln_zps .AND. .NOT. lk_c1d .AND.       ln_isfcav )   &
176        &    CALL zps_hde_isf( nit000, jptra, trn, pgtu=gtru, pgtv=gtrv, pgtui=gtrui, pgtvi=gtrvi )       ! tracers at the bottom ocean level
177
178
179      !
180      IF( nn_dttrc /= 1 )        CALL trc_sub_ini      ! Initialize variables for substepping passive tracers
181      !
182
183      trai(:) = 0._wp                                                   ! initial content of all tracers
184      DO jn = 1, jptra
185         trai(jn) = trai(jn) + glob_sum( trn(:,:,:,jn) * cvol(:,:,:)   )
186      END DO
187
188      IF(lwp) THEN               ! control print
189         WRITE(numout,*)
190         WRITE(numout,*)
191         WRITE(numout,*) '          *** Total number of passive tracer jptra = ', jptra
192         WRITE(numout,*) '          *** Total volume of ocean                = ', areatot
193         WRITE(numout,*) '          *** Total inital content of all tracers '
194         WRITE(numout,*)
195         DO jn = 1, jptra
196            WRITE(numout,9000) jn, TRIM( ctrcnm(jn) ), trai(jn)
197         ENDDO
198         WRITE(numout,*)
199      ENDIF
200      IF(lwp) WRITE(numout,*)
201      IF(ln_ctl) THEN            ! print mean trends (used for debugging)
202         CALL prt_ctl_trc_init
203         WRITE(charout, FMT="('ini ')")
204         CALL prt_ctl_trc_info( charout )
205         CALL prt_ctl_trc( tab4d=trn, mask=tmask, clinfo=ctrcnm )
206      ENDIF
2079000  FORMAT(' tracer nb : ',i2,'      name :',a10,'      initial content :',e18.10)
208      !
209      IF( nn_timing == 1 )   CALL timing_stop('trc_init')
210      !
211   END SUBROUTINE trc_init
212
213
214   SUBROUTINE top_alloc
215      !!----------------------------------------------------------------------
216      !!                     ***  ROUTINE top_alloc  ***
217      !!
218      !! ** Purpose :   Allocate all the dynamic arrays of the OPA modules
219      !!----------------------------------------------------------------------
220      USE trcadv        , ONLY:   trc_adv_alloc          ! TOP-related alloc routines...
221      USE trc           , ONLY:   trc_alloc
222      USE trcnxt        , ONLY:   trc_nxt_alloc
223      USE trczdf        , ONLY:   trc_zdf_alloc
224      USE trdtrc_oce    , ONLY:   trd_trc_oce_alloc
225#if defined key_trdmxl_trc 
226      USE trdmxl_trc    , ONLY:   trd_mxl_trc_alloc
227#endif
228      !
229      INTEGER :: ierr
230      !!----------------------------------------------------------------------
231      !
232      ierr =        trc_adv_alloc()          ! Start of TOP-related alloc routines...
233      ierr = ierr + trc_alloc    ()
234      ierr = ierr + trc_nxt_alloc()
235      ierr = ierr + trc_zdf_alloc()
236      ierr = ierr + trd_trc_oce_alloc()
237#if defined key_trdmxl_trc 
238      ierr = ierr + trd_mxl_trc_alloc()
239#endif
240      !
241      IF( lk_mpp    )   CALL mpp_sum( ierr )
242      IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'top_alloc : unable to allocate standard ocean arrays' )
243      !
244   END SUBROUTINE top_alloc
245
246#else
247   !!----------------------------------------------------------------------
248   !!  Empty module :                                     No passive tracer
249   !!----------------------------------------------------------------------
250CONTAINS
251   SUBROUTINE trc_init                      ! Dummy routine   
252   END SUBROUTINE trc_init
253#endif
254
255   !!======================================================================
256END MODULE trcini
Note: See TracBrowser for help on using the repository browser.