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 NEMO/branches/2018/dev_r5003_MERCATOR6_CRS/NEMOGCM/NEMO/TOP_SRC – NEMO

source: NEMO/branches/2018/dev_r5003_MERCATOR6_CRS/NEMOGCM/NEMO/TOP_SRC/trcini.F90 @ 10115

Last change on this file since 10115 was 10115, checked in by cbricaud, 6 years ago

phase 3.6 coarsening branch with nemo_3.6_rev9192
  • Property svn:keywords set to Id
File size: 9.8 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   ,ONLY: ln_rsttr
20   USE trcrst,ONLY: trc_rst_read,trc_rst_cal          ! 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_age      ! AGE      initialisation
26   USE trcini_my_trc   ! MY_TRC   initialisation
27   USE trcdta          ! initialisation from files
28   USE daymod          ! calendar manager
29   USE prtctl_trc      ! Print control passive tracers (prt_ctl_trc_init routine)
30   USE trcsub          ! variables to substep passive tracers
31   USE lib_mpp         ! distribued memory computing library
32   USE crs    , ONLY : ln_crs_top
33   USE dom_oce, ONLY : nn_cla, ln_isfcav
34   USE trcice          ! tracers in sea ice
35   USE sbc_oce
36 
37   IMPLICIT NONE
38   PRIVATE
39   
40   PUBLIC   trc_init   ! called by opa
41
42    !! * Substitutions
43#  include "domzgr_substitute.h90"
44   !!----------------------------------------------------------------------
45   !! NEMO/TOP 4.0 , NEMO Consortium (2011)
46   !! $Id$
47   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
48   !!----------------------------------------------------------------------
49CONTAINS
50   
51   SUBROUTINE trc_init
52      !!---------------------------------------------------------------------
53      !!                     ***  ROUTINE trc_init  ***
54      !!
55      !! ** Purpose :   Initialization of the passive tracer fields
56      !!
57      !! ** Method  : - read namelist
58      !!              - control the consistancy
59      !!              - compute specific initialisations
60      !!              - set initial tracer fields (either read restart
61      !!                or read data or analytical formulation
62      !!---------------------------------------------------------------------
63      INTEGER ::   jk, jn, jl    ! dummy loop indices
64      CHARACTER (len=25) :: charout
65      !!---------------------------------------------------------------------
66      !
67      IF( nn_timing == 1 )   CALL timing_start('trc_init')
68      !
69      IF(lwp) WRITE(numout,*)
70      IF(lwp) WRITE(numout,*) 'trc_init : initial set up of the passive tracers'
71      IF(lwp) WRITE(numout,*) '~~~~~~~'
72
73      CALL top_alloc()              ! allocate TOP arrays
74
75      l_trcdm2dc = ln_dm2dc .OR. ( ln_cpl .AND. ncpl_qsr_freq /= 1 )
76      l_trcdm2dc = l_trcdm2dc  .AND. .NOT. lk_offline
77      IF( l_trcdm2dc .AND. lwp ) &
78         &   CALL ctl_warn(' Coupling with passive tracers and used of diurnal cycle. &
79         & Computation of a daily mean shortwave for some biogeochemical models) ')
80
81      IF( nn_cla == 1 )   &
82         &  CALL ctl_stop( ' Cross Land Advection not yet implemented with passive tracer ; nn_cla must be 0' )
83
84      CALL trc_nam      ! read passive tracers namelists
85      !
86      IF(lwp) WRITE(numout,*)
87      !
88      IF( ln_rsttr .AND. .NOT. lk_offline ) CALL trc_rst_cal( nit000, 'READ' )   ! calendar
89      !
90      IF(lwp) WRITE(numout,*)
91                                                              ! masked grid volume
92      !                                                              ! masked grid volume
93      DO jk = 1, jpk
94         cvol(:,:,jk) = e1e2t(:,:) * fse3t(:,:,jk) * tmask(:,:,jk)
95      END DO
96      !cbr IF( lk_degrad ) cvol(:,:,:) = cvol(:,:,:) * facvol(:,:,:)      ! degrad option: reduction by facvol
97      !                                                              ! total volume of the ocean
98      areatot = glob_sum( cvol(:,:,:) )
99
100      IF( lk_pisces  )       CALL trc_ini_pisces       ! PISCES  bio-model
101      IF( lk_my_trc  )       CALL trc_ini_my_trc       ! MY_TRC    tracers
102      IF( lk_cfc     )       CALL trc_ini_cfc          ! CFC       tracers
103      IF( lk_c14b    )       CALL trc_ini_c14b         ! C14 bomb  tracer
104      IF( lk_age     )       CALL trc_ini_age          ! AGE       tracer
105
106      CALL trc_ice_ini                                 ! Tracers in sea ice
107
108      IF( lwp ) THEN
109         !
110         CALL ctl_opn( numstr, 'tracer.stat', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, numout, lwp , narea )
111         !
112      ENDIF
113
114      IF( ln_trcdta )      CALL trc_dta_init(jptra)
115
116
117      IF( ln_rsttr ) THEN
118        !
119        CALL trc_rst_read              ! restart from a file
120        !
121      ELSE
122        !
123        IF( ln_trcdta .AND. nb_trcdta > 0 ) THEN  ! Initialisation of tracer from a file that may also be used for damping
124            !
125            DO jn = 1, jptra
126               IF( ln_trc_ini(jn) ) THEN      ! update passive tracers arrays with input data read from file
127                  jl = n_trc_index(jn) 
128                  CALL trc_dta( nit000, sf_trcdta(jl), rf_trfac(jl) )   ! read tracer data at nit000
129                  trn(:,:,:,jn) = sf_trcdta(jl)%fnow(:,:,:) 
130                  IF( .NOT.ln_trcdmp .AND. .NOT.ln_trcdmp_clo ) THEN      !== deallocate data structure   ==!
131                     !                                                    (data used only for initialisation)
132                     IF(lwp) WRITE(numout,*) 'trc_dta: deallocate data arrays as they are only used to initialize the run'
133                                                  DEALLOCATE( sf_trcdta(jl)%fnow )     !  arrays in the structure
134                     IF( sf_trcdta(jl)%ln_tint )  DEALLOCATE( sf_trcdta(jl)%fdta )
135                     !
136                  ENDIF
137               ENDIF
138            ENDDO
139            !
140        ENDIF
141        !
142        trb(:,:,:,:) = trn(:,:,:,:)
143        !
144      ENDIF
145 
146      tra(:,:,:,:) = 0._wp
147      !
148      IF( nn_dttrc /= 1 )        CALL trc_sub_ini      ! Initialize variables for substepping passive tracers
149      !
150
151      trai(:) = 0._wp                                                   ! initial content of all tracers
152      DO jn = 1, jptra
153         trai(jn) = trai(jn) + glob_sum( trn(:,:,:,jn) * cvol(:,:,:)   )
154      END DO
155
156      IF(lwp) THEN               ! control print
157         WRITE(numout,*)
158         WRITE(numout,*)
159         WRITE(numout,*) '          *** Total number of passive tracer jptra = ', jptra
160         WRITE(numout,*) '          *** Total volume of ocean                = ', areatot
161         WRITE(numout,*) '          *** Total inital content of all tracers '
162         WRITE(numout,*)
163         DO jn = 1, jptra
164            WRITE(numout,9000) jn, TRIM( ctrcnm(jn) ), trai(jn)
165         ENDDO
166         WRITE(numout,*)
167      ENDIF
168      IF(lwp) WRITE(numout,*)
169      IF(ln_ctl) THEN            ! print mean trends (used for debugging)
170         CALL prt_ctl_trc_init
171         WRITE(charout, FMT="('ini ')")
172         CALL prt_ctl_trc_info( charout )
173         CALL prt_ctl_trc( tab4d=trn, mask=tmask, clinfo=ctrcnm )
174      ENDIF
1759000  FORMAT(' tracer nb : ',i2,'      name :',a10,'      initial content :',e18.10)
176      !
177      IF( nn_timing == 1 )   CALL timing_stop('trc_init')
178      !
179   END SUBROUTINE trc_init
180
181
182   SUBROUTINE top_alloc
183      !!----------------------------------------------------------------------
184      !!                     ***  ROUTINE top_alloc  ***
185      !!
186      !! ** Purpose :   Allocate all the dynamic arrays of the OPA modules
187      !!----------------------------------------------------------------------
188      USE trcadv        , ONLY:   trc_adv_alloc          ! TOP-related alloc routines...
189      USE trcadv_crs    , ONLY:   trc_adv_alloc_crs      ! TOP-related alloc routines..
190      USE trc           , ONLY:   trc_alloc
191      USE trcnxt        , ONLY:   trc_nxt_alloc
192      USE trczdf        , ONLY:   trc_zdf_alloc
193      USE trczdf_crs    , ONLY:   trc_zdf_alloc_crs
194      USE trdtrc_oce    , ONLY:   trd_trc_oce_alloc
195#if defined key_trdmxl_trc 
196      USE trdmxl_trc    , ONLY:   trd_mxl_trc_alloc
197#endif
198      !
199      INTEGER :: ierr
200      !!----------------------------------------------------------------------
201      !
202      ierr =        trc_adv_alloc()          ! Start of TOP-related alloc routines...
203      ierr = ierr + trc_adv_alloc_crs()
204      ierr = ierr + trc_alloc    ()
205      ierr = ierr + trc_nxt_alloc()
206      ierr = ierr + trc_zdf_alloc()
207      ierr = ierr + trc_zdf_alloc_crs()
208      ierr = ierr + trd_trc_oce_alloc()
209#if defined key_trdmxl_trc 
210      ierr = ierr + trd_mxl_trc_alloc()
211#endif
212      !
213      IF( lk_mpp    )   CALL mpp_sum( ierr )
214      IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'top_alloc : unable to allocate standard ocean arrays' )
215      !
216   END SUBROUTINE top_alloc
217
218#else
219   !!----------------------------------------------------------------------
220   !!  Empty module :                                     No passive tracer
221   !!----------------------------------------------------------------------
222CONTAINS
223   SUBROUTINE trc_init                      ! Dummy routine   
224   END SUBROUTINE trc_init
225#endif
226
227   !!======================================================================
228END MODULE trcini
Note: See TracBrowser for help on using the repository browser.