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.
trcnam.F90 in branches/2013/dev_r3940_CNRS4_IOCRS/NEMOGCM/NEMO/TOP_SRC – NEMO

source: branches/2013/dev_r3940_CNRS4_IOCRS/NEMOGCM/NEMO/TOP_SRC/trcnam.F90 @ 4064

Last change on this file since 4064 was 4064, checked in by cetlod, 11 years ago

branch dev_r3940_CNRS4_IOCRS: some improvments+ minor bug corrections
  • Property svn:keywords set to Id
File size: 14.5 KB
Line 
1MODULE trcnam
2   !!======================================================================
3   !!                       ***  MODULE trcnam  ***
4   !! TOP :   Read and print options for the passive tracer run (namelist)
5   !!======================================================================
6   !! History :    -   !  1996-11  (M.A. Foujols, M. Levy)  original code
7   !!              -   !  1998-04  (M.A Foujols, L. Bopp) ahtrb0 for isopycnal mixing
8   !!              -   !  1999-10  (M.A. Foujols, M. Levy) separation of sms
9   !!              -   !  2000-07  (A. Estublier) add TVD and MUSCL : Tests on ndttrc
10   !!              -   !  2000-11  (M.A Foujols, E Kestenare) trcrat, ahtrc0 and aeivtr0
11   !!              -   !  2001-01 (E Kestenare) suppress ndttrc=1 for CEN2 and TVD schemes
12   !!             1.0  !  2005-03 (O. Aumont, A. El Moussaoui) F90
13   !!----------------------------------------------------------------------
14#if defined key_top
15   !!----------------------------------------------------------------------
16   !!   'key_top'                                                TOP models
17   !!----------------------------------------------------------------------
18   !!   trc_nam    :  Read and print options for the passive tracer run (namelist)
19   !!----------------------------------------------------------------------
20   USE oce_trc           ! shared variables between ocean and passive tracers
21   USE trc               ! passive tracers common variables
22   USE trcnam_trp        ! Transport namelist
23   USE trcnam_pisces     ! PISCES namelist
24   USE trcnam_cfc        ! CFC SMS namelist
25   USE trcnam_c14b       ! C14 SMS namelist
26   USE trcnam_my_trc     ! MY_TRC SMS namelist
27   USE trdmod_oce       
28   USE trdmod_trc_oce
29   USE iom               ! I/O manager
30
31   IMPLICIT NONE
32   PRIVATE
33
34   PUBLIC trc_nam_run  ! called in trcini
35   PUBLIC trc_nam      ! called in trcini
36
37   !! * Substitutions
38#  include "top_substitute.h90"
39   !!----------------------------------------------------------------------
40   !! NEMO/TOP 3.3 , NEMO Consortium (2010)
41   !! $Id$
42   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
43   !!----------------------------------------------------------------------
44
45CONTAINS
46
47
48   SUBROUTINE trc_nam
49      !!---------------------------------------------------------------------
50      !!                     ***  ROUTINE trc_nam  ***
51      !!
52      !! ** Purpose :   READ and PRINT options for the passive tracer run (namelist)
53      !!
54      !! ** Method  : - read passive tracer namelist
55      !!              - read namelist of each defined SMS model
56      !!                ( (PISCES, CFC, MY_TRC )
57      !!---------------------------------------------------------------------
58      INTEGER ::  jn
59
60      !                                        !   Parameters of the run
61      IF( .NOT. lk_offline ) CALL trc_nam_run
62     
63      !                                        !  passive tracer informations
64      CALL trc_nam_trc
65     
66      !                                        !   Parameters of additional diagnostics
67      CALL trc_nam_dia
68
69      !                                        !   namelist of transport
70      CALL trc_nam_trp
71
72
73      IF( ln_rsttr )                      ln_trcdta = .FALSE.   ! restart : no need of clim data
74      !
75      IF( ln_trcdmp .OR. ln_trcdmp_clo )  ln_trcdta = .TRUE.   ! damping : need to have clim data
76      !
77      IF( .NOT.ln_trcdta ) THEN
78         ln_trc_ini(:) = .FALSE.
79      ENDIF
80
81
82      IF(lwp) THEN                   ! control print
83         WRITE(numout,*)
84         WRITE(numout,*) ' Namelist : namtrc'
85         WRITE(numout,*) '   Read inputs data from file (y/n)             ln_trcdta     = ', ln_trcdta
86         WRITE(numout,*) '   Damping of passive tracer (y/n)              ln_trcdmp     = ', ln_trcdmp
87         WRITE(numout,*) '   Restoring of tracer on closed seas           ln_trcdmp_clo = ', ln_trcdmp_clo
88         WRITE(numout,*) ' '
89         DO jn = 1, jptra
90            WRITE(numout,*) '  tracer nb : ', jn, '    short name : ', ctrcnm(jn)
91         END DO
92         WRITE(numout,*) ' '
93      ENDIF
94
95      IF(lwp) THEN                   ! control print
96         IF( ln_rsttr ) THEN
97            WRITE(numout,*)
98            WRITE(numout,*) '  Read a restart file for passive tracer : ', TRIM( cn_trcrst_in )
99            WRITE(numout,*)
100         ENDIF
101         IF( ln_trcdta .AND. .NOT.ln_rsttr ) THEN
102            WRITE(numout,*)
103            WRITE(numout,*) '  Some of the passive tracers are initialised from climatologies '
104            WRITE(numout,*)
105         ENDIF
106         IF( .NOT.ln_trcdta ) THEN
107            WRITE(numout,*)
108            WRITE(numout,*) '  All the passive tracers are initialised with constant values '
109            WRITE(numout,*)
110         ENDIF
111      ENDIF
112
113     
114      rdttrc(:) = rdttra(:) * FLOAT( nn_dttrc )   ! vertical profile of passive tracer time-step
115 
116      IF(lwp) THEN                   ! control print
117        WRITE(numout,*) 
118        WRITE(numout,*) '    Passive Tracer  time step    rdttrc  = ', rdttrc(1)
119        WRITE(numout,*) 
120      ENDIF
121
122
123#if defined key_trdmld_trc || defined key_trdtrc
124         nn_trd_trc  = 20
125         nn_ctls_trc =  9
126         rn_ucf_trc   =  1.
127         ln_trdmld_trc_instant = .TRUE.
128         ln_trdmld_trc_restart =.FALSE.
129         cn_trdrst_trc_in  = "restart_mld_trc"
130         cn_trdrst_trc_out = "restart_mld_trc"
131         ln_trdtrc(:) = .FALSE.
132
133         REWIND( numnat )               !  namelist namtoptrd : passive tracer trends diagnostic
134         READ  ( numnat, namtrc_trd )
135
136         IF(lwp) THEN
137            WRITE(numout,*)
138            WRITE(numout,*) ' trd_mld_trc_init : read namelist namtrc_trd                    '
139            WRITE(numout,*) ' ~~~~~~~~~~~~~~~~                                               '
140            WRITE(numout,*) '   * frequency of trends diagnostics   nn_trd_trc             = ', nn_trd_trc
141            WRITE(numout,*) '   * control surface type              nn_ctls_trc            = ', nn_ctls_trc
142            WRITE(numout,*) '   * restart for ML diagnostics        ln_trdmld_trc_restart  = ', ln_trdmld_trc_restart
143            WRITE(numout,*) '   * flag to diagnose trends of                                 '
144            WRITE(numout,*) '     instantantaneous or mean ML T/S   ln_trdmld_trc_instant  = ', ln_trdmld_trc_instant
145            WRITE(numout,*) '   * unit conversion factor            rn_ucf_trc             = ', rn_ucf_trc
146            DO jn = 1, jptra
147               IF( ln_trdtrc(jn) ) WRITE(numout,*) '    compute ML trends for tracer number :', jn
148            END DO
149         ENDIF
150#endif
151
152
153      ! namelist of SMS
154      ! ---------------     
155      IF( lk_pisces  ) THEN   ;   CALL trc_nam_pisces      ! PISCES  bio-model
156      ELSE                    ;   IF(lwp) WRITE(numout,*) '          PISCES not used'
157      ENDIF
158
159      IF( lk_cfc     ) THEN   ;   CALL trc_nam_cfc         ! CFC     tracers
160      ELSE                    ;   IF(lwp) WRITE(numout,*) '          CFC not used'
161      ENDIF
162
163      IF( lk_c14b     ) THEN   ;   CALL trc_nam_c14b         ! C14 bomb     tracers
164      ELSE                    ;   IF(lwp) WRITE(numout,*) '          C14 not used'
165      ENDIF
166
167      IF( lk_my_trc  ) THEN   ;   CALL trc_nam_my_trc      ! MY_TRC  tracers
168      ELSE                    ;   IF(lwp) WRITE(numout,*) '          MY_TRC not used'
169      ENDIF
170      !
171   END SUBROUTINE trc_nam
172
173   SUBROUTINE trc_nam_run
174      !!---------------------------------------------------------------------
175      !!                     ***  ROUTINE trc_nam  ***
176      !!
177      !! ** Purpose :   read options for the passive tracer run (namelist)
178      !!
179      !!---------------------------------------------------------------------
180      NAMELIST/namtrc_run/ nn_dttrc, nn_writetrc, ln_rsttr, nn_rsttr, ln_top_euler, &
181        &                  cn_trcrst_in, cn_trcrst_out
182
183      !!---------------------------------------------------------------------
184
185      IF(lwp) WRITE(numout,*) 
186      IF(lwp) WRITE(numout,*) 'trc_nam_run : read the passive tracer namelists'
187      IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
188
189      CALL ctl_opn( numnat, 'namelist_top', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
190
191      ! Namelist nattrc (files)
192      ! ----------------------------------------------
193      nn_dttrc      = 1                 ! default values
194      nn_writetrc   = 10 
195      ln_top_euler  = .FALSE.
196      ln_rsttr      = .FALSE.
197      nn_rsttr      =  0
198      cn_trcrst_in  = 'restart_trc'
199      cn_trcrst_out = 'restart_trc'
200      !
201      REWIND( numnat )               ! read nattrc
202      READ  ( numnat, namtrc_run )
203
204      !  computes the first time step of tracer model
205      nittrc000 = nit000 + nn_dttrc - 1
206
207      IF(lwp) THEN                   ! control print
208         WRITE(numout,*)
209         WRITE(numout,*) ' Namelist : namtrc'
210         WRITE(numout,*) '   time step freq. for passive tracer           nn_dttrc      = ', nn_dttrc
211         WRITE(numout,*) '   restart  for passive tracer                  ln_rsttr      = ', ln_rsttr
212         WRITE(numout,*) '   control of time step for passive tracer      nn_rsttr      = ', nn_rsttr
213         WRITE(numout,*) '   first time step for pass. trac.              nittrc000     = ', nittrc000
214         WRITE(numout,*) '   frequency of outputs for passive tracers     nn_writetrc   = ', nn_writetrc 
215         WRITE(numout,*) ' '
216      ENDIF
217      !
218    END SUBROUTINE trc_nam_run
219
220
221   SUBROUTINE trc_nam_trc
222      !!---------------------------------------------------------------------
223      !!                     ***  ROUTINE trc_nam  ***
224      !!
225      !! ** Purpose :   read options for the passive tracer run (namelist)
226      !!
227      !!---------------------------------------------------------------------
228      INTEGER ::  jn
229      ! Definition of a tracer as a structure
230      TYPE(PTRACER), DIMENSION(jptra) :: sn_tracer  ! type of tracer for saving if not key_iomput
231      !!
232      NAMELIST/namtrc/ sn_tracer, ln_trcdta,ln_trcdmp, ln_trcdmp_clo
233
234      !!---------------------------------------------------------------------
235
236      IF(lwp) WRITE(numout,*) 
237      IF(lwp) WRITE(numout,*) 'trc_nam : read the passive tracer namelists'
238      IF(lwp) WRITE(numout,*) '~~~~~~~'
239
240      !
241      DO jn = 1, jptra
242         WRITE( sn_tracer(jn)%clsname,'("TR_",I1)'           ) jn
243         WRITE( sn_tracer(jn)%cllname,'("TRACER NUMBER ",I1)') jn
244         sn_tracer(jn)%clunit  = 'mmole/m3'
245         sn_tracer(jn)%llinit  = .FALSE.
246         sn_tracer(jn)%llsave  = .TRUE.
247      END DO
248      ln_trcdta     = .FALSE.
249      ln_trcdmp     = .FALSE.
250      ln_trcdmp_clo = .FALSE.
251
252      REWIND( numnat )               ! read nattrc
253      READ  ( numnat, namtrc )
254
255      DO jn = 1, jptra
256         ctrcnm    (jn) = TRIM( sn_tracer(jn)%clsname )
257         ctrcln    (jn) = TRIM( sn_tracer(jn)%cllname )
258         ctrcun    (jn) = TRIM( sn_tracer(jn)%clunit  )
259         ln_trc_ini(jn) =       sn_tracer(jn)%llinit
260         ln_trc_wri(jn) =       sn_tracer(jn)%llsave
261      END DO
262     
263    END SUBROUTINE trc_nam_trc
264
265
266   SUBROUTINE trc_nam_dia
267      !!---------------------------------------------------------------------
268      !!                     ***  ROUTINE trc_nam_dia  ***
269      !!
270      !! ** Purpose :   read options for the passive tracer diagnostics
271      !!
272      !! ** Method  : - read passive tracer namelist
273      !!              - read namelist of each defined SMS model
274      !!                ( (PISCES, CFC, MY_TRC )
275      !!---------------------------------------------------------------------
276      INTEGER ::  ierr
277#if defined key_trdmld_trc  || defined key_trdtrc
278      NAMELIST/namtrc_trd/ nn_trd_trc, nn_ctls_trc, rn_ucf_trc, &
279         &                ln_trdmld_trc_restart, ln_trdmld_trc_instant, &
280         &                cn_trdrst_trc_in, cn_trdrst_trc_out, ln_trdtrc
281#endif
282      NAMELIST/namtrc_dia/ ln_diatrc, ln_diabio, nn_writedia, nn_writebio
283
284      !!---------------------------------------------------------------------
285
286      IF(lwp) WRITE(numout,*) 
287      IF(lwp) WRITE(numout,*) 'trc_nam_dia : read the passive tracer diagnostics options'
288      IF(lwp) WRITE(numout,*) '~~~~~~~'
289
290      ln_diatrc = .FALSE.
291      ln_diabio = .FALSE.
292      nn_writedia = 10
293      nn_writebio = 10
294
295      REWIND( numnat )               !  namelist namtoptrd : passive tracer trends diagnostic
296      READ  ( numnat, namtrc_dia )
297
298      IF(lwp) THEN
299         WRITE(numout,*)
300         WRITE(numout,*)
301         WRITE(numout,*) ' Namelist : namtrc_dia'
302         WRITE(numout,*) '    save additionnal diagnostics arrays         ln_diatrc   = ', ln_diatrc
303         WRITE(numout,*) '    save additionnal biology diagnostics arrays ln_diabio   = ', ln_diabio
304         WRITE(numout,*) '    frequency of outputs for additional arrays  nn_writedia = ', nn_writedia
305         WRITE(numout,*) '    frequency of outputs for biological trends  nn_writebio = ', nn_writebio
306         WRITE(numout,*) ' '
307      ENDIF
308
309      IF( ln_diatrc .AND. .NOT. lk_iomput ) THEN
310         ALLOCATE( trc2d(jpi,jpj,jpdia2d), trc3d(jpi,jpj,jpk,jpdia3d),  &
311           &       ctrc2d(jpdia2d), ctrc2l(jpdia2d), ctrc2u(jpdia2d) ,  & 
312           &       ctrc3d(jpdia3d), ctrc3l(jpdia3d), ctrc3u(jpdia3d) ,  STAT = ierr ) 
313         IF( ierr > 0 )   CALL ctl_stop( 'STOP', 'trcnam: unable to allocate add. diag. array' )
314         !
315         trc2d(:,:,:  ) = 0._wp  ;   ctrc2d(:) = ' '   ;   ctrc2l(:) = ' '    ;    ctrc2u(:) = ' ' 
316         trc3d(:,:,:,:) = 0._wp  ;   ctrc3d(:) = ' '   ;   ctrc3l(:) = ' '    ;    ctrc3u(:) = ' ' 
317         !
318      ENDIF
319
320      IF( ( ln_diabio .AND. .NOT. lk_iomput ) .OR. l_trdtrc ) THEN
321         ALLOCATE( trbio (jpi,jpj,jpk,jpdiabio) , &
322           &       ctrbio(jpdiabio), ctrbil(jpdiabio), ctrbiu(jpdiabio), STAT = ierr ) 
323         IF( ierr > 0 )   CALL ctl_stop( 'STOP', 'trcnam: unable to allocate bio. diag. array' )
324         !
325         trbio(:,:,:,:) = 0._wp  ;   ctrbio(:) = ' '   ;   ctrbil(:) = ' '    ;    ctrbiu(:) = ' ' 
326         !
327      ENDIF
328      !
329   END SUBROUTINE trc_nam_dia
330
331#else
332   !!----------------------------------------------------------------------
333   !!  Dummy module :                                     No passive tracer
334   !!----------------------------------------------------------------------
335CONTAINS
336   SUBROUTINE trc_nam                      ! Empty routine   
337   END SUBROUTINE trc_nam
338   SUBROUTINE trc_nam_run                      ! Empty routine   
339   END SUBROUTINE trc_nam_run
340#endif
341
342   !!----------------------------------------------------------------------
343   !! NEMO/TOP 3.3 , NEMO Consortium (2010)
344   !! $Id$
345   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
346   !!======================================================================
347END MODULE  trcnam
Note: See TracBrowser for help on using the repository browser.