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

source: branches/2015/dev_r5171_CNRS_LIM3_seaicebgc/NEMOGCM/NEMO/TOP_SRC/trcini.F90 @ 5361

Last change on this file since 5361 was 5361, checked in by cetlod, 9 years ago

dev_r5171_CNRS_LIM3_seaicebgc : bugfix on trcsbc
  • Property svn:keywords set to Id
File size: 10.0 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   USE trcdta          ! initialisation from files
27   USE daymod          ! calendar manager
28   USE zpshde          ! partial step: hor. derivative   (zps_hde routine)
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 sbc_oce
33   USE trcice          ! tracers in sea ice
34 
35   IMPLICIT NONE
36   PRIVATE
37   
38   PUBLIC   trc_init   ! called by opa
39
40    !! * Substitutions
41#  include "domzgr_substitute.h90"
42   !!----------------------------------------------------------------------
43   !! NEMO/TOP 4.0 , NEMO Consortium (2011)
44   !! $Id$
45   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
46   !!----------------------------------------------------------------------
47CONTAINS
48   
49   SUBROUTINE trc_init
50      !!---------------------------------------------------------------------
51      !!                     ***  ROUTINE trc_init  ***
52      !!
53      !! ** Purpose :   Initialization of the passive tracer fields
54      !!
55      !! ** Method  : - read namelist
56      !!              - control the consistancy
57      !!              - compute specific initialisations
58      !!              - set initial tracer fields (either read restart
59      !!                or read data or analytical formulation
60      !!---------------------------------------------------------------------
61      INTEGER ::   jk, jn, jl    ! dummy loop indices
62      CHARACTER (len=25) :: charout
63      REAL(wp), POINTER, DIMENSION(:,:,:) ::  ztrcdta   ! 4D  workspace
64      !!---------------------------------------------------------------------
65      !
66      IF( nn_timing == 1 )   CALL timing_start('trc_init')
67      !
68      IF(lwp) WRITE(numout,*)
69      IF(lwp) WRITE(numout,*) 'trc_init : initial set up of the passive tracers'
70      IF(lwp) WRITE(numout,*) '~~~~~~~'
71
72      CALL top_alloc()              ! allocate TOP arrays
73
74#if defined key_offline
75      ltrcdm2dc = .FALSE.
76#endif
77
78      IF( ltrcdm2dc )CALL ctl_warn( ' Diurnal cycle on physics but not in PISCES or LOBSTER ' )
79
80      IF( nn_cla == 1 )   &
81         &  CALL ctl_stop( ' Cross Land Advection not yet implemented with passive tracer ; nn_cla must be 0' )
82
83      CALL trc_nam      ! read passive tracers namelists
84      !
85      IF(lwp) WRITE(numout,*)
86      !
87      IF( ln_rsttr .AND. .NOT. lk_offline ) CALL trc_rst_cal( nit000, 'READ' )   ! calendar
88      !
89      IF(lwp) WRITE(numout,*)
90                                                              ! masked grid volume
91      !                                                              ! masked grid volume
92      DO jk = 1, jpk
93         cvol(:,:,jk) = e1e2t(:,:) * fse3t(:,:,jk) * tmask(:,:,jk)
94      END DO
95      IF( lk_degrad ) cvol(:,:,:) = cvol(:,:,:) * facvol(:,:,:)      ! degrad option: reduction by facvol
96      !                                                              ! total volume of the ocean
97      areatot = glob_sum( cvol(:,:,:) )
98
99
100      IF( lk_pisces  )       CALL trc_ini_pisces       ! PISCES  bio-model
101      IF( lk_cfc     )       CALL trc_ini_cfc          ! CFC     tracers
102      IF( lk_c14b    )       CALL trc_ini_c14b         ! C14 bomb  tracer
103      IF( lk_my_trc  )       CALL trc_ini_my_trc       ! MY_TRC  tracers
104
105      CALL trc_ice_ini                                 ! Tracers in sea ice
106
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            CALL wrk_alloc( jpi, jpj, jpk, ztrcdta )    ! Memory allocation
126            !
127            DO jn = 1, jptra
128               IF( ln_trc_ini(jn) ) THEN      ! update passive tracers arrays with input data read from file
129                  jl = n_trc_index(jn) 
130                  CALL trc_dta( nit000, sf_trcdta(jl),rf_trfac(jl) )   ! read tracer data at nit000
131                  ztrcdta(:,:,:) = sf_trcdta(jl)%fnow(:,:,:)
132                  trn(:,:,:,jn) = ztrcdta(:,:,:) * tmask(:,:,:) 
133                  IF( .NOT.ln_trcdmp .AND. .NOT.ln_trcdmp_clo ) THEN      !== deallocate data structure   ==!
134                     !                                                    (data used only for initialisation)
135                     IF(lwp) WRITE(numout,*) 'trc_dta: deallocate data arrays as they are only used to initialize the run'
136                                                  DEALLOCATE( sf_trcdta(jl)%fnow )     !  arrays in the structure
137                     IF( sf_trcdta(jl)%ln_tint )  DEALLOCATE( sf_trcdta(jl)%fdta )
138                     !
139                  ENDIF
140               ENDIF
141            ENDDO
142            CALL wrk_dealloc( jpi, jpj, jpk, ztrcdta )
143        ENDIF
144        !
145        trb(:,:,:,:) = trn(:,:,:,:)
146        !
147      ENDIF
148 
149      tra(:,:,:,:) = 0._wp
150      IF( ln_zps .AND. .NOT. lk_c1d .AND. .NOT. ln_isfcav )   &              ! Partial steps: before horizontal gradient of passive
151        &    CALL zps_hde    ( nit000, jptra, trn, gtru, gtrv  )  ! Partial steps: before horizontal gradient
152      IF( ln_zps .AND. .NOT. lk_c1d .AND.       ln_isfcav )   &
153        &    CALL zps_hde_isf( nit000, jptra, trn, pgtu=gtru, pgtv=gtrv, pgtui=gtrui, pgtvi=gtrvi )       ! tracers at the bottom ocean level
154
155
156      !
157      IF( nn_dttrc /= 1 )        CALL trc_sub_ini      ! Initialize variables for substepping passive tracers
158      !
159
160      trai(:) = 0._wp                                                   ! initial content of all tracers
161      DO jn = 1, jptra
162         trai(jn) = trai(jn) + glob_sum( trn(:,:,:,jn) * cvol(:,:,:)   )
163      END DO
164
165      IF(lwp) THEN               ! control print
166         WRITE(numout,*)
167         WRITE(numout,*)
168         WRITE(numout,*) '          *** Total number of passive tracer jptra = ', jptra
169         WRITE(numout,*) '          *** Total volume of ocean                = ', areatot
170         WRITE(numout,*) '          *** Total inital content of all tracers '
171         WRITE(numout,*)
172         DO jn = 1, jptra
173            WRITE(numout,9000) jn, TRIM( ctrcnm(jn) ), trai(jn)
174         ENDDO
175         WRITE(numout,*)
176      ENDIF
177      IF(lwp) WRITE(numout,*)
178      IF(ln_ctl) THEN            ! print mean trends (used for debugging)
179         CALL prt_ctl_trc_init
180         WRITE(charout, FMT="('ini ')")
181         CALL prt_ctl_trc_info( charout )
182         CALL prt_ctl_trc( tab4d=trn, mask=tmask, clinfo=ctrcnm )
183      ENDIF
1849000  FORMAT(' tracer nb : ',i2,'      name :',a10,'      initial content :',e18.10)
185      !
186      IF( nn_timing == 1 )   CALL timing_stop('trc_init')
187      !
188   END SUBROUTINE trc_init
189
190
191   SUBROUTINE top_alloc
192      !!----------------------------------------------------------------------
193      !!                     ***  ROUTINE top_alloc  ***
194      !!
195      !! ** Purpose :   Allocate all the dynamic arrays of the OPA modules
196      !!----------------------------------------------------------------------
197      USE trcadv        , ONLY:   trc_adv_alloc          ! TOP-related alloc routines...
198      USE trc           , ONLY:   trc_alloc
199      USE trcnxt        , ONLY:   trc_nxt_alloc
200      USE trczdf        , ONLY:   trc_zdf_alloc
201      USE trdtrc_oce    , ONLY:   trd_trc_oce_alloc
202#if defined key_trdmxl_trc 
203      USE trdmxl_trc    , ONLY:   trd_mxl_trc_alloc
204#endif
205      !
206      INTEGER :: ierr
207      !!----------------------------------------------------------------------
208      !
209      ierr =        trc_adv_alloc()          ! Start of TOP-related alloc routines...
210      ierr = ierr + trc_alloc    ()
211      ierr = ierr + trc_nxt_alloc()
212      ierr = ierr + trc_zdf_alloc()
213      ierr = ierr + trd_trc_oce_alloc()
214#if defined key_trdmxl_trc 
215      ierr = ierr + trd_mxl_trc_alloc()
216#endif
217      !
218      IF( lk_mpp    )   CALL mpp_sum( ierr )
219      IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'top_alloc : unable to allocate standard ocean arrays' )
220      !
221   END SUBROUTINE top_alloc
222
223#else
224   !!----------------------------------------------------------------------
225   !!  Empty module :                                     No passive tracer
226   !!----------------------------------------------------------------------
227CONTAINS
228   SUBROUTINE trc_init                      ! Dummy routine   
229   END SUBROUTINE trc_init
230#endif
231
232   !!======================================================================
233END MODULE trcini
Note: See TracBrowser for help on using the repository browser.