source: NEMO/trunk/src/TOP/trcini.F90 @ 10425

Last change on this file since 10425 was 10425, checked in by smasson, 20 months ago

trunk: merge back dev_r10164_HPC09_ESIWACE_PREP_MERGE@10424 into the trunk

  • Property svn:keywords set to Id
File size: 13.1 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 trcnam          ! Namelist read
21   USE daymod          ! calendar manager
22   USE prtctl_trc      ! Print control passive tracers (prt_ctl_trc_init routine)
23   USE trcsub          ! variables to substep passive tracers
24   USE trcrst
25   USE lib_mpp         ! distribued memory computing library
26   USE trcice          ! tracers in sea ice
27   USE trcbc,   only : trc_bc_ini ! generalized Boundary Conditions
28 
29   IMPLICIT NONE
30   PRIVATE
31   
32   PUBLIC   trc_init   ! called by opa
33
34   !!----------------------------------------------------------------------
35   !! NEMO/TOP 4.0 , NEMO Consortium (2018)
36   !! $Id$
37   !! Software governed by the CeCILL license (see ./LICENSE)
38   !!----------------------------------------------------------------------
39CONTAINS
40   
41   SUBROUTINE trc_init
42      !!---------------------------------------------------------------------
43      !!                     ***  ROUTINE trc_init  ***
44      !!
45      !! ** Purpose :   Initialization of the passive tracer fields
46      !!
47      !! ** Method  : - read namelist
48      !!              - control the consistancy
49      !!              - compute specific initialisations
50      !!              - set initial tracer fields (either read restart
51      !!                or read data or analytical formulation
52      !!---------------------------------------------------------------------
53      !
54      IF( ln_timing )   CALL timing_start('trc_init')
55      !
56      IF(lwp) WRITE(numout,*)
57      IF(lwp) WRITE(numout,*) 'trc_init : initial set up of the passive tracers'
58      IF(lwp) WRITE(numout,*) '~~~~~~~~'
59      !
60      CALL trc_ini_ctl   ! control
61      CALL trc_nam       ! read passive tracers namelists
62      CALL top_alloc()   ! allocate TOP arrays
63      !
64      IF(.NOT.ln_trcdta )   ln_trc_ini(:) = .FALSE.
65      !
66      IF(lwp) WRITE(numout,*)
67      IF( ln_rsttr .AND. .NOT. l_offline ) CALL trc_rst_cal( nit000, 'READ' )   ! calendar
68      IF(lwp) WRITE(numout,*)
69      !
70      CALL trc_ini_sms   ! SMS
71      CALL trc_ini_trp   ! passive tracers transport
72      CALL trc_ice_ini   ! Tracers in sea ice
73      !
74      IF(lwm) CALL ctl_opn( numstr, 'tracer.stat', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, numout, lwp , narea )
75      !
76      CALL trc_ini_state  !  passive tracers initialisation : from a restart or from clim
77      IF( nn_dttrc /= 1 ) &
78      CALL trc_sub_ini    ! Initialize variables for substepping passive tracers
79      !
80      CALL trc_ini_inv   ! Inventories
81      !
82      IF( ln_timing )   CALL timing_stop('trc_init')
83      !
84   END SUBROUTINE trc_init
85
86
87   SUBROUTINE trc_ini_ctl
88      !!----------------------------------------------------------------------
89      !!                     ***  ROUTINE trc_ini_ctl  ***
90      !! ** Purpose :        Control  + ocean volume
91      !!----------------------------------------------------------------------
92      INTEGER ::   jk    ! dummy loop indices
93      !
94      ! Define logical parameter ton control dirunal cycle in TOP
95      l_trcdm2dc = ln_dm2dc .OR. ( ln_cpl .AND. ncpl_qsr_freq /= 1 )
96      l_trcdm2dc = l_trcdm2dc  .AND. .NOT. l_offline
97      IF( l_trcdm2dc .AND. lwp )   CALL ctl_warn( 'Coupling with passive tracers and used of diurnal cycle.',   &
98         &                           'Computation of a daily mean shortwave for some biogeochemical models ' )
99      !
100   END SUBROUTINE trc_ini_ctl
101
102
103   SUBROUTINE trc_ini_inv
104      !!----------------------------------------------------------------------
105      !!                     ***  ROUTINE trc_ini_stat  ***
106      !! ** Purpose :      passive tracers inventories at initialsation phase
107      !!----------------------------------------------------------------------
108      INTEGER ::  jk, jn    ! dummy loop indices
109      CHARACTER (len=25) :: charout
110      !!----------------------------------------------------------------------
111      !
112      IF(lwp) WRITE(numout,*)
113      IF(lwp) WRITE(numout,*) 'trc_ini_inv : initial passive tracers inventories'
114      IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
115      !
116      !                          ! masked grid volume
117      DO jk = 1, jpk
118         cvol(:,:,jk) = e1e2t(:,:) * e3t_n(:,:,jk) * tmask(:,:,jk)
119      END DO
120      !                          ! total volume of the ocean
121      areatot = glob_sum( 'trcini', cvol(:,:,:) )
122      !
123      trai(:) = 0._wp            ! initial content of all tracers
124      DO jn = 1, jptra
125         trai(jn) = trai(jn) + glob_sum( 'trcini', trn(:,:,:,jn) * cvol(:,:,:)   )
126      END DO
127
128      IF(lwp) THEN               ! control print
129         WRITE(numout,*)
130         WRITE(numout,*) '   ==>>>   Total number of passive tracer jptra = ', jptra
131         WRITE(numout,*) '           Total volume of ocean                = ', areatot
132         WRITE(numout,*) '           Total inital content of all tracers '
133         WRITE(numout,*)
134         DO jn = 1, jptra
135            WRITE(numout,9000) jn, TRIM( ctrcnm(jn) ), trai(jn)
136         ENDDO
137         WRITE(numout,*)
138      ENDIF
139      IF(lwp) WRITE(numout,*)
140      IF(ln_ctl) THEN            ! print mean trends (used for debugging)
141         CALL prt_ctl_trc_init
142         WRITE(charout, FMT="('ini ')")
143         CALL prt_ctl_trc_info( charout )
144         CALL prt_ctl_trc( tab4d=trn, mask=tmask, clinfo=ctrcnm )
145      ENDIF
1469000  FORMAT('      tracer nb : ',i2,'      name :',a10,'      initial content :',e18.10)
147      !
148   END SUBROUTINE trc_ini_inv
149
150
151   SUBROUTINE trc_ini_sms
152      !!----------------------------------------------------------------------
153      !!                     ***  ROUTINE trc_ini_sms  ***
154      !! ** Purpose :   SMS initialisation
155      !!----------------------------------------------------------------------
156      USE trcini_pisces  ! PISCES   initialisation
157      USE trcini_cfc     ! CFC      initialisation
158      USE trcini_c14     ! C14  initialisation
159      USE trcini_age     ! age initialisation
160      USE trcini_my_trc  ! MY_TRC   initialisation
161      !
162      INTEGER :: jn
163      !!----------------------------------------------------------------------
164      !
165      ! Pass sn_tracer fields to specialized arrays
166      DO jn = 1, jp_bgc
167         ctrcnm    (jn) = TRIM( sn_tracer(jn)%clsname )
168         ctrcln    (jn) = TRIM( sn_tracer(jn)%cllname )
169         ctrcun    (jn) = TRIM( sn_tracer(jn)%clunit  )
170         ln_trc_ini(jn) =       sn_tracer(jn)%llinit
171         ln_trc_sbc(jn) =       sn_tracer(jn)%llsbc
172         ln_trc_cbc(jn) =       sn_tracer(jn)%llcbc
173         ln_trc_obc(jn) =       sn_tracer(jn)%llobc
174      END DO
175      !   
176      IF( ln_pisces      )   CALL trc_ini_pisces     !  PISCES model
177      IF( ln_my_trc      )   CALL trc_ini_my_trc     !  MY_TRC model
178      IF( ll_cfc         )   CALL trc_ini_cfc        !  CFC's
179      IF( ln_c14         )   CALL trc_ini_c14        !  C14 model
180      IF( ln_age         )   CALL trc_ini_age        !  AGE
181      IF( .NOT.ln_pisces ) ALLOCATE( profsed(2) )
182      !
183      IF(lwp) THEN                   ! control print
184         WRITE(numout,*)
185         WRITE(numout,*) 'trc_init_sms : Summary for selected passive tracers'
186         WRITE(numout,*) '~~~~~~~~~~~~'
187         WRITE(numout,*) '    ID     NAME     INI  SBC  CBC  OBC'
188         DO jn = 1, jptra
189            WRITE(numout,9001) jn, TRIM(ctrcnm(jn)), ln_trc_ini(jn), ln_trc_sbc(jn),ln_trc_cbc(jn),ln_trc_obc(jn)
190         END DO
191      ENDIF
1929001  FORMAT(3x,i3,1x,a10,3x,l2,3x,l2,3x,l2,3x,l2)
193      !
194   END SUBROUTINE trc_ini_sms
195
196
197   SUBROUTINE trc_ini_trp
198      !!----------------------------------------------------------------------
199      !!                     ***  ROUTINE trc_ini_trp  ***
200      !!
201      !! ** Purpose :   Allocate all the dynamic arrays of the OPA modules
202      !!----------------------------------------------------------------------
203      USE trcdmp , ONLY:  trc_dmp_ini
204      USE trcadv , ONLY:  trc_adv_ini
205      USE trcldf , ONLY:  trc_ldf_ini
206      USE trcrad , ONLY:  trc_rad_ini
207      USE trcsink, ONLY:  trc_sink_ini
208      !
209      INTEGER :: ierr
210      !!----------------------------------------------------------------------
211      !
212      IF( ln_trcdmp )  CALL  trc_dmp_ini          ! damping
213                       CALL  trc_adv_ini          ! advection
214                       CALL  trc_ldf_ini          ! lateral diffusion
215                       !                          ! vertical diffusion: always implicit time stepping scheme
216                       CALL  trc_rad_ini          ! positivity of passive tracers
217                       CALL  trc_sink_ini         ! Vertical sedimentation of particles
218      !
219   END SUBROUTINE trc_ini_trp
220
221
222   SUBROUTINE trc_ini_state
223      !!----------------------------------------------------------------------
224      !!                     ***  ROUTINE trc_ini_state ***
225      !! ** Purpose :          Initialisation of passive tracer concentration
226      !!----------------------------------------------------------------------
227      USE zpshde          ! partial step: hor. derivative   (zps_hde routine)
228      USE trcrst          ! passive tracers restart
229      USE trcdta          ! initialisation from files
230      !
231      INTEGER :: jn, jl   ! dummy loop indices
232      !!----------------------------------------------------------------------
233      !
234      IF( ln_trcdta )   CALL trc_dta_ini( jptra )      ! set initial tracers values
235      !
236      IF( ln_my_trc )   CALL trc_bc_ini ( jptra )      ! set tracers Boundary Conditions
237      !
238      !
239      IF( ln_rsttr ) THEN              ! restart from a file
240        !
241        CALL trc_rst_read
242        !
243      ELSE                             ! Initialisation of tracer from a file that may also be used for damping
244!!gm BUG ?   if damping and restart, what's happening ?
245        IF( ln_trcdta .AND. nb_trcdta > 0 ) THEN
246            ! update passive tracers arrays with input data read from file
247            DO jn = 1, jptra
248               IF( ln_trc_ini(jn) ) THEN
249                  jl = n_trc_index(jn) 
250                  CALL trc_dta( nit000, sf_trcdta(jl), rf_trfac(jl), trn(:,:,:,jn) )
251                  !
252                  ! deallocate data structure if data are not used for damping
253                  IF( .NOT.ln_trcdmp .AND. .NOT.ln_trcdmp_clo ) THEN
254                     IF(lwp) WRITE(numout,*) 'trc_ini_state: deallocate data arrays as they are only used to initialize the run'
255                                                  DEALLOCATE( sf_trcdta(jl)%fnow )
256                     IF( sf_trcdta(jl)%ln_tint )  DEALLOCATE( sf_trcdta(jl)%fdta )
257                     !
258                  ENDIF
259               ENDIF
260            END DO
261            !
262        ENDIF
263        !
264        trb(:,:,:,:) = trn(:,:,:,:)
265        !
266      ENDIF
267      !
268      tra(:,:,:,:) = 0._wp
269      !                                                         ! Partial top/bottom cell: GRADh(trn)
270   END SUBROUTINE trc_ini_state
271
272
273   SUBROUTINE top_alloc
274      !!----------------------------------------------------------------------
275      !!                     ***  ROUTINE top_alloc  ***
276      !!
277      !! ** Purpose :   Allocate all the dynamic arrays of the OPA modules
278      !!----------------------------------------------------------------------
279      USE trc           , ONLY:   trc_alloc
280      USE trdtrc_oce    , ONLY:   trd_trc_oce_alloc
281#if defined key_trdmxl_trc 
282      USE trdmxl_trc    , ONLY:   trd_mxl_trc_alloc
283#endif
284      !
285      INTEGER ::   ierr   ! local integer
286      !!----------------------------------------------------------------------
287      !
288      ierr =        trc_alloc()
289      ierr = ierr + trd_trc_oce_alloc()
290#if defined key_trdmxl_trc 
291      ierr = ierr + trd_mxl_trc_alloc()
292#endif
293      !
294      CALL mpp_sum( 'trcini', ierr )
295      IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'top_alloc : unable to allocate standard ocean arrays' )
296      !
297   END SUBROUTINE top_alloc
298
299#else
300   !!----------------------------------------------------------------------
301   !!  Empty module :                                     No passive tracer
302   !!----------------------------------------------------------------------
303CONTAINS
304   SUBROUTINE trc_init                      ! Dummy routine   
305   END SUBROUTINE trc_init
306#endif
307
308   !!======================================================================
309END MODULE trcini
Note: See TracBrowser for help on using the repository browser.