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

source: branches/2016/dev_r6519_HPC_4/NEMOGCM/NEMO/TOP_SRC/trcini.F90 @ 7037

Last change on this file since 7037 was 7037, checked in by mocavero, 7 years ago

ORCA2_LIM_PISCES hybrid version update

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