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

source: branches/2011/dev_NEMO_MERGE_2011/NEMOGCM/NEMO/TOP_SRC/trcini.F90 @ 3124

Last change on this file since 3124 was 3124, checked in by cetlod, 12 years ago

dev_NEMO_MERGE_2011/NEMOGCM:minor modifications on the use of nittrc000 + style corrections
  • Property svn:keywords set to Id
File size: 9.6 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_lobster  ! LOBSTER  initialisation
24   USE trcini_pisces   ! PISCES   initialisation
25   USE trcini_c14b     ! C14 bomb initialisation
26   USE trcini_my_trc   ! MY_TRC   initialisation
27   USE trcdta          ! initialisation form files
28   USE daymod          ! calendar manager
29   USE zpshde          ! partial step: hor. derivative   (zps_hde routine)
30   USE prtctl_trc      ! Print control passive tracers (prt_ctl_trc_init routine)
31   USE trcsub       ! variables to substep passive tracers
32   
33   IMPLICIT NONE
34   PRIVATE
35   
36   PUBLIC   trc_init   ! called by opa
37
38    !! * Substitutions
39#  include "domzgr_substitute.h90"
40   !!----------------------------------------------------------------------
41   !! NEMO/TOP 4.0 , NEMO Consortium (2011)
42   !! $Id$
43   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
44   !!----------------------------------------------------------------------
45CONTAINS
46   
47   SUBROUTINE trc_init
48      !!---------------------------------------------------------------------
49      !!                     ***  ROUTINE trc_init  ***
50      !!
51      !! ** Purpose :   Initialization of the passive tracer fields
52      !!
53      !! ** Method  : - read namelist
54      !!              - control the consistancy
55      !!              - compute specific initialisations
56      !!              - set initial tracer fields (either read restart
57      !!                or read data or analytical formulation
58      !!---------------------------------------------------------------------
59      INTEGER ::   jk, jn, jl    ! dummy loop indices
60      INTEGER ::   ierr          ! local integer
61      CHARACTER (len=25) :: charout
62      REAL(wp), ALLOCATABLE, DIMENSION(:,:,:,:) ::  ztrcdta   ! 4D  workspace
63      !!---------------------------------------------------------------------
64
65      IF(lwp) WRITE(numout,*)
66      IF(lwp) WRITE(numout,*) 'trc_init : initial set up of the passive tracers'
67      IF(lwp) WRITE(numout,*) '~~~~~~~'
68
69      CALL top_alloc()              ! allocate TOP arrays
70
71      IF( ln_dm2dc .AND. ( lk_pisces .OR. lk_lobster ) )    &
72         &  CALL ctl_stop( ' The diurnal cycle is not compatible with PISCES or LOBSTER  ' )
73
74      IF( nn_cla == 1 )   &
75         &  CALL ctl_stop( ' Cross Land Advection not yet implemented with passive tracer ; nn_cla must be 0' )
76
77      CALL trc_nam                  ! read passive tracers namelists
78
79      IF( lk_lobster ) THEN   ;   CALL trc_ini_lobster      ! LOBSTER bio-model
80      ELSE                    ;   IF(lwp) WRITE(numout,*) '          LOBSTER not used'
81      ENDIF
82     
83      IF( lk_pisces  ) THEN   ;   CALL trc_ini_pisces       ! PISCES  bio-model
84      ELSE                    ;   IF(lwp) WRITE(numout,*) '          PISCES not used'
85      ENDIF
86     
87      IF( lk_cfc     ) THEN   ;   CALL trc_ini_cfc          ! CFC     tracers
88      ELSE                    ;   IF(lwp) WRITE(numout,*) '          CFC not used'
89      ENDIF
90
91      IF( lk_c14b    ) THEN   ;   CALL trc_ini_c14b         ! C14 bomb  tracer
92      ELSE                    ;   IF(lwp) WRITE(numout,*) '          C14 not used'
93      ENDIF
94     
95      IF( lk_my_trc  ) THEN   ;   CALL trc_ini_my_trc       ! MY_TRC  tracers
96      ELSE                    ;   IF(lwp) WRITE(numout,*) '          MY_TRC not used'
97      ENDIF
98
99      IF( lwp ) THEN
100         !
101         CALL ctl_opn( numstr, 'tracer.stat', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE., narea )
102         !
103      ENDIF
104
105      IF( ln_trcdta )             CALL trc_dta_init
106
107      IF( ln_rsttr ) THEN
108        !
109        IF( lk_offline )  neuler = 1   ! Set time-step indicator at nittrc000 (leap-frog)
110        CALL trc_rst_read              ! restart from a file
111        !
112      ELSE
113        IF( lk_offline )  THEN
114           neuler = 0                  ! Set time-step indicator at nittrc000 (euler)
115           CALL day_init               ! set calendar
116        ENDIF
117        IF( ln_trcdta .AND. nb_trcdta > 0 ) THEN  ! Initialisation of tracer from a file that may also be used for damping
118            ALLOCATE( ztrcdta(jpi,jpj,jpk,nb_trcdta), STAT=ierr )
119            IF( ierr > 0 ) THEN
120               CALL ctl_stop( 'trc_ini: unable to allocate ztrcdta array' )   ;   RETURN
121            ENDIF
122            !
123            CALL trc_dta( nittrc000, ztrcdta )   ! read tracer data at nittrc000
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                  trn(:,:,:,jn) = ztrcdta(:,:,:,jl) * tmask(:,:,:) 
129               ENDIF
130            ENDDO
131            DEALLOCATE( ztrcdta ) 
132        ENDIF
133        !
134        trb(:,:,:,:) = trn(:,:,:,:)
135        !
136      ENDIF
137 
138      tra(:,:,:,:) = 0._wp
139     
140      IF( ln_zps .AND. .NOT. lk_c1d )   &              ! Partial steps: before horizontal gradient of passive
141        &    CALL zps_hde( nittrc000, jptra, trn, gtru, gtrv )       ! tracers at the bottom ocean level
142      !                                                              ! masked grid volume
143      DO jk = 1, jpk
144         cvol(:,:,jk) = e1e2t(:,:) * fse3t(:,:,jk) * tmask(:,:,jk)
145      END DO
146      IF( lk_degrad ) cvol(:,:,:) = cvol(:,:,:) * facvol(:,:,:)      ! degrad option: reduction by facvol
147      !                                                              ! total volume of the ocean
148      areatot = glob_sum( cvol(:,:,:) )
149
150      !
151      IF( nn_dttrc /= 1 )        CALL trc_sub_ini      ! Initialize variables for substepping passive tracers
152      !
153
154      trai(:) = 0._wp                                                   ! initial content of all tracers
155      DO jn = 1, jptra
156         trai(jn) = trai(jn) + glob_sum( trn(:,:,:,jn) * cvol(:,:,:)   )
157      END DO
158
159      IF(lwp) THEN               ! control print
160         WRITE(numout,*)
161         WRITE(numout,*)
162         WRITE(numout,*) '          *** Total number of passive tracer jptra = ', jptra
163         WRITE(numout,*) '          *** Total volume of ocean                = ', areatot
164         WRITE(numout,*) '          *** Total inital content of all tracers '
165         WRITE(numout,*)
166         DO jn = 1, jptra
167            WRITE(numout,9000) jn, TRIM( ctrcnm(jn) ), trai(jn)
168         ENDDO
169         WRITE(numout,*)
170      ENDIF
171      WRITE(numout,*)
172      IF(ln_ctl) THEN            ! print mean trends (used for debugging)
173         CALL prt_ctl_trc_init
174         WRITE(charout, FMT="('ini ')")
175         CALL prt_ctl_trc_info( charout )
176         CALL prt_ctl_trc( tab4d=trn, mask=tmask, clinfo=ctrcnm )
177      ENDIF
1789000  FORMAT(' tracer nb : ',i2,'      name :',a10,'      initial content :',e18.10)
179      !
180   END SUBROUTINE trc_init
181
182
183   SUBROUTINE top_alloc
184      !!----------------------------------------------------------------------
185      !!                     ***  ROUTINE top_alloc  ***
186      !!
187      !! ** Purpose :   Allocate all the dynamic arrays of the OPA modules
188      !!----------------------------------------------------------------------
189      USE trcadv        , ONLY:   trc_adv_alloc          ! 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 trdmod_trc_oce, ONLY:   trd_mod_trc_oce_alloc
194#if defined key_trdmld_trc 
195      USE trdmld_trc    , ONLY:   trd_mld_trc_alloc
196#endif
197      !
198      INTEGER :: ierr
199      !!----------------------------------------------------------------------
200      !
201      ierr =        trc_adv_alloc()          ! Start of TOP-related alloc routines...
202      ierr = ierr + trc_alloc    ()
203      ierr = ierr + trc_nxt_alloc()
204      ierr = ierr + trc_zdf_alloc()
205      ierr = ierr + trd_mod_trc_oce_alloc()
206#if defined key_trdmld_trc 
207      ierr = ierr + trd_mld_trc_alloc()
208#endif
209      !
210      IF( lk_mpp    )   CALL mpp_sum( ierr )
211      IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'top_alloc : unable to allocate standard ocean arrays' )
212      !
213   END SUBROUTINE top_alloc
214
215#else
216   !!----------------------------------------------------------------------
217   !!  Empty module :                                     No passive tracer
218   !!----------------------------------------------------------------------
219CONTAINS
220   SUBROUTINE trc_init                      ! Dummy routine   
221   END SUBROUTINE trc_init
222#endif
223
224   !!======================================================================
225END MODULE trcini
Note: See TracBrowser for help on using the repository browser.