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

source: trunk/NEMOGCM/NEMO/TOP_SRC/trcnam.F90 @ 5341

Last change on this file since 5341 was 5341, checked in by davestorkey, 9 years ago

Merge of 2014/dev_r4650_UKMO11_restart_functionality branch into the trunk
as part of 3.6_stable build. See ticket #1347.
  • Property svn:keywords set to Id
File size: 16.0 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 trd_oce       
28   USE trdtrc_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                  ! dummy loop indice
59      !                                        !   Parameters of the run
60      IF( .NOT. lk_offline ) CALL trc_nam_run
61     
62      !                                        !  passive tracer informations
63      CALL trc_nam_trc
64     
65      !                                        !   Parameters of additional diagnostics
66      CALL trc_nam_dia
67
68      !                                        !   namelist of transport
69      CALL trc_nam_trp
70
71
72      IF( ln_rsttr )                      ln_trcdta = .FALSE.   ! restart : no need of clim data
73      !
74      IF( ln_trcdmp .OR. ln_trcdmp_clo )  ln_trcdta = .TRUE.   ! damping : need to have clim data
75      !
76      IF( .NOT.ln_trcdta ) THEN
77         ln_trc_ini(:) = .FALSE.
78      ENDIF
79
80     IF(lwp) THEN                   ! control print
81         WRITE(numout,*)
82         WRITE(numout,*) ' Namelist : namtrc'
83         WRITE(numout,*) '   Read inputs data from file (y/n)             ln_trcdta     = ', ln_trcdta
84         WRITE(numout,*) '   Damping of passive tracer (y/n)              ln_trcdmp     = ', ln_trcdmp
85         WRITE(numout,*) '   Restoring of tracer on closed seas           ln_trcdmp_clo = ', ln_trcdmp_clo
86         WRITE(numout,*) ' '
87         DO jn = 1, jptra
88            WRITE(numout,*) '  tracer nb : ', jn, '    short name : ', ctrcnm(jn)
89         END DO
90         WRITE(numout,*) ' '
91      ENDIF
92
93      IF(lwp) THEN                   ! control print
94         IF( ln_rsttr ) THEN
95            WRITE(numout,*)
96            WRITE(numout,*) '  Read a restart file for passive tracer : ', TRIM( cn_trcrst_in )
97            WRITE(numout,*)
98         ENDIF
99         IF( ln_trcdta .AND. .NOT.ln_rsttr ) THEN
100            WRITE(numout,*)
101            WRITE(numout,*) '  Some of the passive tracers are initialised from climatologies '
102            WRITE(numout,*)
103         ENDIF
104         IF( .NOT.ln_trcdta ) THEN
105            WRITE(numout,*)
106            WRITE(numout,*) '  All the passive tracers are initialised with constant values '
107            WRITE(numout,*)
108         ENDIF
109      ENDIF
110
111     
112      rdttrc(:) = rdttra(:) * FLOAT( nn_dttrc )   ! vertical profile of passive tracer time-step
113 
114      IF(lwp) THEN                   ! control print
115        WRITE(numout,*) 
116        WRITE(numout,*) '    Passive Tracer  time step    rdttrc  = ', rdttrc(1)
117        WRITE(numout,*) 
118      ENDIF
119
120
121#if defined key_trdmxl_trc || defined key_trdtrc
122
123         REWIND( numnat_ref )              ! Namelist namtrc_trd in reference namelist : Passive tracer trends
124         READ  ( numnat_ref, namtrc_trd, IOSTAT = ios, ERR = 905)
125905      IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_trd in reference namelist', lwp )
126
127         REWIND( numnat_cfg )              ! Namelist namtrc_trd in configuration namelist : Passive tracer trends
128         READ  ( numnat_cfg, namtrc_trd, IOSTAT = ios, ERR = 906 )
129906      IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_trd in configuration namelist', lwp )
130         IF(lwm) WRITE ( numont, namtrc_trd )
131
132         IF(lwp) THEN
133            WRITE(numout,*)
134            WRITE(numout,*) ' trd_mxl_trc_init : read namelist namtrc_trd                    '
135            WRITE(numout,*) ' ~~~~~~~~~~~~~~~~                                               '
136            WRITE(numout,*) '   * frequency of trends diagnostics   nn_trd_trc             = ', nn_trd_trc
137            WRITE(numout,*) '   * control surface type              nn_ctls_trc            = ', nn_ctls_trc
138            WRITE(numout,*) '   * restart for ML diagnostics        ln_trdmxl_trc_restart  = ', ln_trdmxl_trc_restart
139            WRITE(numout,*) '   * flag to diagnose trends of                                 '
140            WRITE(numout,*) '     instantantaneous or mean ML T/S   ln_trdmxl_trc_instant  = ', ln_trdmxl_trc_instant
141            WRITE(numout,*) '   * unit conversion factor            rn_ucf_trc             = ', rn_ucf_trc
142            DO jn = 1, jptra
143               IF( ln_trdtrc(jn) ) WRITE(numout,*) '    compute ML trends for tracer number :', jn
144            END DO
145         ENDIF
146#endif
147
148
149      ! namelist of SMS
150      ! ---------------     
151      IF( lk_pisces  ) THEN   ;   CALL trc_nam_pisces      ! PISCES  bio-model
152      ELSE                    ;   IF(lwp) WRITE(numout,*) '          PISCES not used'
153      ENDIF
154
155      IF( lk_cfc     ) THEN   ;   CALL trc_nam_cfc         ! CFC     tracers
156      ELSE                    ;   IF(lwp) WRITE(numout,*) '          CFC not used'
157      ENDIF
158
159      IF( lk_c14b     ) THEN   ;   CALL trc_nam_c14b         ! C14 bomb     tracers
160      ELSE                    ;   IF(lwp) WRITE(numout,*) '          C14 not used'
161      ENDIF
162
163      IF( lk_my_trc  ) THEN   ;   CALL trc_nam_my_trc      ! MY_TRC  tracers
164      ELSE                    ;   IF(lwp) WRITE(numout,*) '          MY_TRC not used'
165      ENDIF
166      !
167   END SUBROUTINE trc_nam
168
169   SUBROUTINE trc_nam_run
170      !!---------------------------------------------------------------------
171      !!                     ***  ROUTINE trc_nam  ***
172      !!
173      !! ** Purpose :   read options for the passive tracer run (namelist)
174      !!
175      !!---------------------------------------------------------------------
176      NAMELIST/namtrc_run/ nn_dttrc, nn_writetrc, ln_rsttr, nn_rsttr, ln_top_euler, &
177        &                  cn_trcrst_indir, cn_trcrst_outdir, cn_trcrst_in, cn_trcrst_out
178
179
180      INTEGER  ::   ios                 ! Local integer output status for namelist read
181
182      !!---------------------------------------------------------------------
183
184
185      IF(lwp) WRITE(numout,*) 'trc_nam : read the passive tracer namelists'
186      IF(lwp) WRITE(numout,*) '~~~~~~~'
187
188      CALL ctl_opn( numnat_ref, 'namelist_top_ref'   , 'OLD'    , 'FORMATTED', 'SEQUENTIAL', -1, numout, .FALSE. )
189      CALL ctl_opn( numnat_cfg, 'namelist_top_cfg'   , 'OLD'    , 'FORMATTED', 'SEQUENTIAL', -1, numout, .FALSE. )
190      IF(lwm) CALL ctl_opn( numont, 'output.namelist.top', 'UNKNOWN', 'FORMATTED', 'SEQUENTIAL', -1, numout, .FALSE., 1 )
191
192      REWIND( numnat_ref )              ! Namelist namtrc in reference namelist : Passive tracer variables
193      READ  ( numnat_ref, namtrc_run, IOSTAT = ios, ERR = 901)
194901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc in reference namelist', lwp )
195
196      REWIND( numnat_cfg )              ! Namelist namtrc in configuration namelist : Passive tracer variables
197      READ  ( numnat_cfg, namtrc_run, IOSTAT = ios, ERR = 902 )
198902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc in configuration namelist', lwp )
199      IF(lwm) WRITE ( numont, namtrc_run )
200
201      !  computes the first time step of tracer model
202      nittrc000 = nit000 + nn_dttrc - 1
203
204      IF(lwp) THEN                   ! control print
205         WRITE(numout,*)
206         WRITE(numout,*) ' Namelist : namtrc_run'
207         WRITE(numout,*) '   time step freq. for passive tracer           nn_dttrc      = ', nn_dttrc
208         WRITE(numout,*) '   restart  for passive tracer                  ln_rsttr      = ', ln_rsttr
209         WRITE(numout,*) '   control of time step for passive tracer      nn_rsttr      = ', nn_rsttr
210         WRITE(numout,*) '   first time step for pass. trac.              nittrc000     = ', nittrc000
211         WRITE(numout,*) '   frequency of outputs for passive tracers     nn_writetrc   = ', nn_writetrc 
212         WRITE(numout,*) '   Use euler integration for TRC (y/n)          ln_top_euler  = ', ln_top_euler
213         WRITE(numout,*) ' '
214      ENDIF
215      !
216    END SUBROUTINE trc_nam_run
217
218
219   SUBROUTINE trc_nam_trc
220      !!---------------------------------------------------------------------
221      !!                     ***  ROUTINE trc_nam  ***
222      !!
223      !! ** Purpose :   read options for the passive tracer run (namelist)
224      !!
225      !!---------------------------------------------------------------------
226      TYPE(PTRACER), DIMENSION(jptra) :: sn_tracer  ! type of tracer for saving if not key_iomput
227      !!
228      NAMELIST/namtrc/ sn_tracer, ln_trcdta,ln_trcdmp, ln_trcdmp_clo
229 
230      INTEGER  ::   ios                 ! Local integer output status for namelist read
231      INTEGER  ::   jn                  ! dummy loop indice
232      !!---------------------------------------------------------------------
233      IF(lwp) WRITE(numout,*)
234      IF(lwp) WRITE(numout,*) 'trc_nam : read the passive tracer namelists'
235      IF(lwp) WRITE(numout,*) '~~~~~~~'
236
237
238      REWIND( numnat_ref )              ! Namelist namtrc in reference namelist : Passive tracer variables
239      READ  ( numnat_ref, namtrc, IOSTAT = ios, ERR = 901)
240901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc in reference namelist', lwp )
241
242      REWIND( numnat_cfg )              ! Namelist namtrc in configuration namelist : Passive tracer variables
243      READ  ( numnat_cfg, namtrc, IOSTAT = ios, ERR = 902 )
244902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc in configuration namelist', lwp )
245      IF(lwm) WRITE ( numont, namtrc )
246
247      DO jn = 1, jptra
248         ctrcnm    (jn) = TRIM( sn_tracer(jn)%clsname )
249         ctrcln    (jn) = TRIM( sn_tracer(jn)%cllname )
250         ctrcun    (jn) = TRIM( sn_tracer(jn)%clunit  )
251         ln_trc_ini(jn) =       sn_tracer(jn)%llinit
252         ln_trc_wri(jn) =       sn_tracer(jn)%llsave
253      END DO
254     
255    END SUBROUTINE trc_nam_trc
256
257
258   SUBROUTINE trc_nam_dia
259      !!---------------------------------------------------------------------
260      !!                     ***  ROUTINE trc_nam_dia  ***
261      !!
262      !! ** Purpose :   read options for the passive tracer diagnostics
263      !!
264      !! ** Method  : - read passive tracer namelist
265      !!              - read namelist of each defined SMS model
266      !!                ( (PISCES, CFC, MY_TRC )
267      !!---------------------------------------------------------------------
268      INTEGER ::  ierr
269#if defined key_trdmxl_trc  || defined key_trdtrc
270      NAMELIST/namtrc_trd/ nn_trd_trc, nn_ctls_trc, rn_ucf_trc, &
271         &                ln_trdmxl_trc_restart, ln_trdmxl_trc_instant, &
272         &                cn_trdrst_trc_in, cn_trdrst_trc_out, ln_trdtrc
273#endif
274      NAMELIST/namtrc_dia/ ln_diatrc, ln_diabio, nn_writedia, nn_writebio
275
276      INTEGER  ::   ios                 ! Local integer output status for namelist read
277      !!---------------------------------------------------------------------
278
279      IF(lwp) WRITE(numout,*) 
280      IF(lwp) WRITE(numout,*) 'trc_nam_dia : read the passive tracer diagnostics options'
281      IF(lwp) WRITE(numout,*) '~~~~~~~'
282
283      IF(lwp) WRITE(numout,*)
284      IF(lwp) WRITE(numout,*) 'trc_nam_dia : read the passive tracer diagnostics options'
285      IF(lwp) WRITE(numout,*) '~~~~~~~'
286
287      REWIND( numnat_ref )              ! Namelist namtrc_dia in reference namelist : Passive tracer diagnostics
288      READ  ( numnat_ref, namtrc_dia, IOSTAT = ios, ERR = 903)
289903   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_dia in reference namelist', lwp )
290
291      REWIND( numnat_cfg )              ! Namelist namtrc_dia in configuration namelist : Passive tracer diagnostics
292      READ  ( numnat_cfg, namtrc_dia, IOSTAT = ios, ERR = 904 )
293904   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_dia in configuration namelist', lwp )
294      IF(lwm) WRITE ( numont, namtrc_dia )
295
296      IF(lwp) THEN
297         WRITE(numout,*)
298         WRITE(numout,*)
299         WRITE(numout,*) ' Namelist : namtrc_dia'
300         WRITE(numout,*) '    save additionnal diagnostics arrays         ln_diatrc   = ', ln_diatrc
301         WRITE(numout,*) '    save additionnal biology diagnostics arrays ln_diabio   = ', ln_diabio
302         WRITE(numout,*) '    frequency of outputs for additional arrays  nn_writedia = ', nn_writedia
303         WRITE(numout,*) '    frequency of outputs for biological trends  nn_writebio = ', nn_writebio
304         WRITE(numout,*) ' '
305      ENDIF
306
307      IF( ln_diatrc .AND. .NOT. lk_iomput ) THEN
308         ALLOCATE( trc2d(jpi,jpj,jpdia2d), trc3d(jpi,jpj,jpk,jpdia3d),  &
309           &       ctrc2d(jpdia2d), ctrc2l(jpdia2d), ctrc2u(jpdia2d) ,  & 
310           &       ctrc3d(jpdia3d), ctrc3l(jpdia3d), ctrc3u(jpdia3d) ,  STAT = ierr ) 
311         IF( ierr > 0 )   CALL ctl_stop( 'STOP', 'trcnam: unable to allocate add. diag. array' )
312         !
313         trc2d(:,:,:  ) = 0._wp  ;   ctrc2d(:) = ' '   ;   ctrc2l(:) = ' '    ;    ctrc2u(:) = ' ' 
314         trc3d(:,:,:,:) = 0._wp  ;   ctrc3d(:) = ' '   ;   ctrc3l(:) = ' '    ;    ctrc3u(:) = ' ' 
315         !
316      ENDIF
317
318      IF( ( ln_diabio .AND. .NOT. lk_iomput ) .OR. l_trdtrc ) THEN
319         ALLOCATE( trbio (jpi,jpj,jpk,jpdiabio) , &
320           &       ctrbio(jpdiabio), ctrbil(jpdiabio), ctrbiu(jpdiabio), STAT = ierr ) 
321         IF( ierr > 0 )   CALL ctl_stop( 'STOP', 'trcnam: unable to allocate bio. diag. array' )
322         !
323         trbio(:,:,:,:) = 0._wp  ;   ctrbio(:) = ' '   ;   ctrbil(:) = ' '    ;    ctrbiu(:) = ' ' 
324         !
325      ENDIF
326      !
327   END SUBROUTINE trc_nam_dia
328
329#else
330   !!----------------------------------------------------------------------
331   !!  Dummy module :                                     No passive tracer
332   !!----------------------------------------------------------------------
333CONTAINS
334   SUBROUTINE trc_nam                      ! Empty routine   
335   END SUBROUTINE trc_nam
336   SUBROUTINE trc_nam_run                      ! Empty routine   
337   END SUBROUTINE trc_nam_run
338#endif
339
340   !!----------------------------------------------------------------------
341   !! NEMO/TOP 3.3 , NEMO Consortium (2010)
342   !! $Id$
343   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
344   !!======================================================================
345END MODULE  trcnam
Note: See TracBrowser for help on using the repository browser.