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

source: branches/2015/dev_r5204_CNRS_PISCES_dcy/NEMOGCM/NEMO/TOP_SRC/trcini.F90 @ 5209

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

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