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

source: branches/2017/nemo_v3_6_STABLE_trdtrc/NEMOGCM/NEMO/TOP_SRC/trcnam.F90 @ 8471

Last change on this file since 8471 was 8471, checked in by jpalmier, 7 years ago

JPALM -- #1933 -- add and correct passive tracer trends - needs improvements and testing
  • Property svn:keywords set to Id
File size: 18.7 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_age        ! AGE SMS namelist
27   USE trcnam_my_trc     ! MY_TRC SMS namelist
28   USE trd_oce       
29   USE trdtrc_oce
30   USE iom               ! I/O manager
31
32   IMPLICIT NONE
33   PRIVATE
34
35   PUBLIC trc_nam_run  ! called in trcini
36   PUBLIC trc_nam      ! called in trcini
37
38   !! * Substitutions
39#  include "top_substitute.h90"
40   !!----------------------------------------------------------------------
41   !! NEMO/TOP 3.3 , NEMO Consortium (2010)
42   !! $Id$
43   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
44   !!----------------------------------------------------------------------
45
46CONTAINS
47
48
49   SUBROUTINE trc_nam
50      !!---------------------------------------------------------------------
51      !!                     ***  ROUTINE trc_nam  ***
52      !!
53      !! ** Purpose :   READ and PRINT options for the passive tracer run (namelist)
54      !!
55      !! ** Method  : - read passive tracer namelist
56      !!              - read namelist of each defined SMS model
57      !!                ( (PISCES, CFC, MY_TRC, MEDUSA, IDTRA, Age )
58      !!---------------------------------------------------------------------
59      INTEGER ::  ierr
60#if defined key_trdmxl_trc  || defined key_trdtrc
61      NAMELIST/namtrc_trd/ nn_trd_trc, nn_ctls_trc, rn_ucf_trc, &
62         &                ln_trdmxl_trc_restart, ln_trdmxl_trc_instant, &
63         &                cn_trdrst_trc_in, cn_trdrst_trc_out, ln_trdtrc
64#endif
65
66      INTEGER  ::   jn, jk              ! dummy loop indice
67      INTEGER  ::   ios                 ! Local integer output status for namelist read
68      !!---------------------------------------------------------------------
69
70
71      !                                        !   Parameters of the run
72      IF( .NOT. lk_offline ) CALL trc_nam_run
73     
74      !                                        !  passive tracer informations
75                             CALL trc_nam_trc
76     
77      !                                        !   Parameters of additional diagnostics
78      IF( .NOT. lk_iomput)   CALL trc_nam_dia
79
80      !                                        !   namelist of transport
81                             CALL trc_nam_trp
82
83
84      IF( ln_rsttr )                      ln_trcdta = .FALSE.   ! restart : no need of clim data
85      !
86      IF( ln_trcdmp .OR. ln_trcdmp_clo )  ln_trcdta = .TRUE.   ! damping : need to have clim data
87      !
88      IF( .NOT.ln_trcdta ) THEN
89         ln_trc_ini(:) = .FALSE.
90      ENDIF
91
92      ! Call the ice module for tracers
93      ! -------------------------------
94      CALL trc_nam_ice
95
96      ! namelist of SMS
97      ! ---------------
98      IF( lk_pisces  ) THEN   ;   CALL trc_nam_pisces      ! PISCES  bio-model
99      ELSE                    ;   IF(lwp) WRITE(numout,*) '          PISCES not used'
100      ENDIF
101
102      IF( lk_my_trc  ) THEN  ;   CALL trc_nam_my_trc       ! MY_TRC  tracers
103      ELSE                   ;   IF(lwp) WRITE(numout,*)  '          MY_TRC not used'
104      ENDIF
105
106      IF( lk_cfc     ) THEN   ;   CALL trc_nam_cfc         ! CFC     tracers
107      ELSE                    ;   IF(lwp) WRITE(numout,*) '          CFC not used'
108      ENDIF
109
110      IF( lk_c14b    ) THEN  ;   CALL trc_nam_c14b         ! C14 bomb     tracers
111      ELSE                   ;   IF(lwp) WRITE(numout,*)  '          C14 not used'
112      ENDIF
113
114      IF( lk_age     ) THEN  ;   CALL trc_nam_age         ! AGE     tracer
115      ELSE                   ;   IF(lwp) WRITE(numout,*)  '          AGE not used'
116      ENDIF
117
118     IF(lwp) THEN                   ! control print
119         WRITE(numout,*)
120         WRITE(numout,*) ' Namelist : namtrc'
121         WRITE(numout,*) '   Read inputs data from file (y/n)             ln_trcdta     = ', ln_trcdta
122         WRITE(numout,*) '   Damping of passive tracer (y/n)              ln_trcdmp     = ', ln_trcdmp
123         WRITE(numout,*) '   Restoring of tracer on closed seas           ln_trcdmp_clo = ', ln_trcdmp_clo
124         WRITE(numout,*) ' '
125         DO jn = 1, jptra
126            WRITE(numout,*) '  tracer nb : ', jn, '    short name : ', ctrcnm(jn)
127         END DO
128         WRITE(numout,*) ' '
129      ENDIF
130
131      IF(lwp) THEN                   ! control print
132         IF( ln_rsttr ) THEN
133            WRITE(numout,*)
134            WRITE(numout,*) '  Read a restart file for passive tracer : ', TRIM( cn_trcrst_in )
135            WRITE(numout,*)
136         ENDIF
137         IF( ln_trcdta .AND. .NOT.ln_rsttr ) THEN
138            WRITE(numout,*)
139            WRITE(numout,*) '  Some of the passive tracers are initialised from climatologies '
140            WRITE(numout,*)
141         ENDIF
142         IF( .NOT.ln_trcdta ) THEN
143            WRITE(numout,*)
144            WRITE(numout,*) '  All the passive tracers are initialised with constant values '
145            WRITE(numout,*)
146         ENDIF
147      ENDIF
148
149     
150      rdttrc(:) = rdttra(:) * FLOAT( nn_dttrc )   ! vertical profile of passive tracer time-step
151 
152      IF(lwp) THEN                   ! control print
153        WRITE(numout,*) 
154        WRITE(numout,*) '    Passive Tracer  time step    rdttrc  = ', rdttrc(1)
155        WRITE(numout,*) 
156      ENDIF
157
158
159#if defined key_trdmxl_trc || defined key_trdtrc
160
161         REWIND( numnat_ref )              ! Namelist namtrc_trd in reference namelist : Passive tracer trends
162         READ  ( numnat_ref, namtrc_trd, IOSTAT = ios, ERR = 905)
163905      IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_trd in reference namelist', lwp )
164
165         REWIND( numnat_cfg )              ! Namelist namtrc_trd in configuration namelist : Passive tracer trends
166         READ  ( numnat_cfg, namtrc_trd, IOSTAT = ios, ERR = 906 )
167906      IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_trd in configuration namelist', lwp )
168         IF(lwm) WRITE ( numont, namtrc_trd )
169
170         IF(lwp) THEN
171            WRITE(numout,*)
172            WRITE(numout,*) ' trd_mxl_trc_init : read namelist namtrc_trd                    '
173            WRITE(numout,*) ' ~~~~~~~~~~~~~~~~                                               '
174            WRITE(numout,*) '   * frequency of trends diagnostics   nn_trd_trc             = ', nn_trd_trc
175            WRITE(numout,*) '   * control surface type              nn_ctls_trc            = ', nn_ctls_trc
176            WRITE(numout,*) '   * restart for ML diagnostics        ln_trdmxl_trc_restart  = ', ln_trdmxl_trc_restart
177            WRITE(numout,*) '   * flag to diagnose trends of                                 '
178            WRITE(numout,*) '     instantantaneous or mean ML T/S   ln_trdmxl_trc_instant  = ', ln_trdmxl_trc_instant
179            WRITE(numout,*) '   * unit conversion factor            rn_ucf_trc             = ', rn_ucf_trc
180            DO jn = 1, jptra
181               IF( ln_trdtrc(jn) ) WRITE(numout,*) '    compute ML trends for tracer number :', jn
182            END DO
183         ENDIF
184#endif
185      !
186   END SUBROUTINE trc_nam
187
188   SUBROUTINE trc_nam_run
189      !!---------------------------------------------------------------------
190      !!                     ***  ROUTINE trc_nam  ***
191      !!
192      !! ** Purpose :   read options for the passive tracer run (namelist)
193      !!
194      !!---------------------------------------------------------------------
195      NAMELIST/namtrc_run/ nn_dttrc, nn_writetrc, ln_rsttr, nn_rsttr, ln_top_euler, &
196        &                  cn_trcrst_indir, cn_trcrst_outdir, cn_trcrst_in, cn_trcrst_out
197
198
199      INTEGER  ::   ios                 ! Local integer output status for namelist read
200
201      !!---------------------------------------------------------------------
202
203
204      IF(lwp) WRITE(numout,*) 'trc_nam : read the passive tracer namelists'
205      IF(lwp) WRITE(numout,*) '~~~~~~~'
206
207      CALL ctl_opn( numnat_ref, 'namelist_top_ref'   , 'OLD'    , 'FORMATTED', 'SEQUENTIAL', -1, numout, .FALSE. )
208      CALL ctl_opn( numnat_cfg, 'namelist_top_cfg'   , 'OLD'    , 'FORMATTED', 'SEQUENTIAL', -1, numout, .FALSE. )
209      IF(lwm) CALL ctl_opn( numont, 'output.namelist.top', 'UNKNOWN', 'FORMATTED', 'SEQUENTIAL', -1, numout, .FALSE., 1 )
210
211      REWIND( numnat_ref )              ! Namelist namtrc in reference namelist : Passive tracer variables
212      READ  ( numnat_ref, namtrc_run, IOSTAT = ios, ERR = 901)
213901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc in reference namelist', lwp )
214
215      REWIND( numnat_cfg )              ! Namelist namtrc in configuration namelist : Passive tracer variables
216      READ  ( numnat_cfg, namtrc_run, IOSTAT = ios, ERR = 902 )
217902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc in configuration namelist', lwp )
218      IF(lwm) WRITE ( numont, namtrc_run )
219
220      !  computes the first time step of tracer model
221      nittrc000 = nit000 + nn_dttrc - 1
222
223      IF(lwp) THEN                   ! control print
224         WRITE(numout,*)
225         WRITE(numout,*) ' Namelist : namtrc_run'
226         WRITE(numout,*) '   time step freq. for passive tracer           nn_dttrc      = ', nn_dttrc
227         WRITE(numout,*) '   restart  for passive tracer                  ln_rsttr      = ', ln_rsttr
228         WRITE(numout,*) '   control of time step for passive tracer      nn_rsttr      = ', nn_rsttr
229         WRITE(numout,*) '   first time step for pass. trac.              nittrc000     = ', nittrc000
230         WRITE(numout,*) '   frequency of outputs for passive tracers     nn_writetrc   = ', nn_writetrc 
231         WRITE(numout,*) '   Use euler integration for TRC (y/n)          ln_top_euler  = ', ln_top_euler
232         WRITE(numout,*) ' '
233      ENDIF
234      !
235    END SUBROUTINE trc_nam_run
236
237   SUBROUTINE trc_nam_ice
238      !!---------------------------------------------------------------------
239      !!                     ***  ROUTINE trc_nam_ice ***
240      !!
241      !! ** Purpose :   Read the namelist for the ice effect on tracers
242      !!
243      !! ** Method  : -
244      !!
245      !!---------------------------------------------------------------------
246      ! --- Variable declarations --- !
247      INTEGER :: jn      ! dummy loop indices
248      INTEGER :: ios     ! Local integer output status for namelist read
249
250      ! --- Namelist declarations --- !
251      TYPE(TRC_I_NML), DIMENSION(jptra) :: sn_tri_tracer
252      NAMELIST/namtrc_ice/ nn_ice_tr, sn_tri_tracer
253
254      IF(lwp) THEN
255         WRITE(numout,*)
256         WRITE(numout,*) 'trc_nam_ice : Read the namelist for trc_ice'
257         WRITE(numout,*) '~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~'
258      ENDIF
259
260      IF( nn_timing == 1 )  CALL timing_start('trc_nam_ice')
261
262      !
263      REWIND( numnat_ref )              ! Namelist namtrc_ice in reference namelist : Passive tracer input data
264      READ  ( numnat_ref, namtrc_ice, IOSTAT = ios, ERR = 901)
265 901  IF( ios /= 0 ) CALL ctl_nam ( ios , ' namtrc_ice in reference namelist ', lwp )
266
267      REWIND( numnat_cfg )              ! Namelist namtrc_ice in configuration namelist : Pisces external sources of nutrients
268      READ  ( numnat_cfg, namtrc_ice, IOSTAT = ios, ERR = 902 )
269 902  IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_ice in configuration namelist', lwp )
270
271      IF( lwp ) THEN
272         WRITE(numout,*) ' '
273         WRITE(numout,*) ' Sea ice tracers option (nn_ice_tr) : ', nn_ice_tr
274         WRITE(numout,*) ' '
275      ENDIF
276
277      ! Assign namelist stuff
278      DO jn = 1, jptra
279         trc_ice_ratio(jn)  = sn_tri_tracer(jn)%trc_ratio
280         trc_ice_prescr(jn) = sn_tri_tracer(jn)%trc_prescr
281         cn_trc_o      (jn) = sn_tri_tracer(jn)%ctrc_o
282      END DO
283
284      IF( nn_timing == 1 )   CALL timing_stop('trc_nam_ice')
285      !
286   END SUBROUTINE trc_nam_ice
287
288   SUBROUTINE trc_nam_trc
289      !!---------------------------------------------------------------------
290      !!                     ***  ROUTINE trc_nam  ***
291      !!
292      !! ** Purpose :   read options for the passive tracer run (namelist)
293      !!
294      !!---------------------------------------------------------------------
295      TYPE(PTRACER), DIMENSION(jptra) :: sn_tracer  ! type of tracer for saving if not key_iomput
296      !!
297      NAMELIST/namtrc/ sn_tracer, ln_trcdta,ln_trcdmp, ln_trcdmp_clo
298 
299      INTEGER  ::   ios                 ! Local integer output status for namelist read
300      INTEGER  ::   jn                  ! dummy loop indice
301      !!---------------------------------------------------------------------
302      IF(lwp) WRITE(numout,*)
303      IF(lwp) WRITE(numout,*) 'trc_nam : read the passive tracer namelists'
304      IF(lwp) WRITE(numout,*) '~~~~~~~'
305
306
307      REWIND( numnat_ref )              ! Namelist namtrc in reference namelist : Passive tracer variables
308      READ  ( numnat_ref, namtrc, IOSTAT = ios, ERR = 901)
309901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc in reference namelist', lwp )
310
311      REWIND( numnat_cfg )              ! Namelist namtrc in configuration namelist : Passive tracer variables
312      READ  ( numnat_cfg, namtrc, IOSTAT = ios, ERR = 902 )
313902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc in configuration namelist', lwp )
314      IF(lwm) WRITE ( numont, namtrc )
315
316      DO jn = 1, jptra
317         ctrcnm    (jn) = TRIM( sn_tracer(jn)%clsname )
318         ctrcln    (jn) = TRIM( sn_tracer(jn)%cllname )
319         ctrcun    (jn) = TRIM( sn_tracer(jn)%clunit  )
320         ln_trc_ini(jn) =       sn_tracer(jn)%llinit
321         ln_trc_wri(jn) =       sn_tracer(jn)%llsave
322      END DO
323     
324    END SUBROUTINE trc_nam_trc
325
326
327   SUBROUTINE trc_nam_dia
328      !!---------------------------------------------------------------------
329      !!                     ***  ROUTINE trc_nam_dia  ***
330      !!
331      !! ** Purpose :   read options for the passive tracer diagnostics
332      !!
333      !! ** Method  : - read passive tracer namelist
334      !!              - read namelist of each defined SMS model
335      !!                ( (PISCES, CFC, MY_TRC )
336      !!---------------------------------------------------------------------
337      INTEGER ::  ierr
338#if defined key_trdmxl_trc  || defined key_trdtrc
339      NAMELIST/namtrc_trd/ nn_trd_trc, nn_ctls_trc, rn_ucf_trc, &
340         &                ln_trdmxl_trc_restart, ln_trdmxl_trc_instant, &
341         &                cn_trdrst_trc_in, cn_trdrst_trc_out, ln_trdtrc
342#endif
343      NAMELIST/namtrc_dia/ ln_diatrc, ln_diabio, nn_writedia, nn_writebio
344
345      INTEGER  ::   ios                 ! Local integer output status for namelist read
346      !!---------------------------------------------------------------------
347
348      IF(lwp) WRITE(numout,*) 
349      IF(lwp) WRITE(numout,*) 'trc_nam_dia : read the passive tracer diagnostics options'
350      IF(lwp) WRITE(numout,*) '~~~~~~~'
351
352      IF(lwp) WRITE(numout,*)
353      IF(lwp) WRITE(numout,*) 'trc_nam_dia : read the passive tracer diagnostics options'
354      IF(lwp) WRITE(numout,*) '~~~~~~~'
355
356      REWIND( numnat_ref )              ! Namelist namtrc_dia in reference namelist : Passive tracer diagnostics
357      READ  ( numnat_ref, namtrc_dia, IOSTAT = ios, ERR = 903)
358903   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_dia in reference namelist', lwp )
359
360      REWIND( numnat_cfg )              ! Namelist namtrc_dia in configuration namelist : Passive tracer diagnostics
361      READ  ( numnat_cfg, namtrc_dia, IOSTAT = ios, ERR = 904 )
362904   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_dia in configuration namelist', lwp )
363      IF(lwm) WRITE ( numont, namtrc_dia )
364
365      IF(lwp) THEN
366         WRITE(numout,*)
367         WRITE(numout,*)
368         WRITE(numout,*) ' Namelist : namtrc_dia'
369         WRITE(numout,*) '    save additionnal diagnostics arrays         ln_diatrc   = ', ln_diatrc
370         WRITE(numout,*) '    save additionnal biology diagnostics arrays ln_diabio   = ', ln_diabio
371         WRITE(numout,*) '    frequency of outputs for additional arrays  nn_writedia = ', nn_writedia
372         WRITE(numout,*) '    frequency of outputs for biological trends  nn_writebio = ', nn_writebio
373         WRITE(numout,*) ' '
374      ENDIF
375
376      IF( ln_diatrc ) THEN
377         ALLOCATE( trc2d(jpi,jpj,jpdia2d), trc3d(jpi,jpj,jpk,jpdia3d),  &
378           &       ctrc2d(jpdia2d), ctrc2l(jpdia2d), ctrc2u(jpdia2d) ,  & 
379           &       ctrc3d(jpdia3d), ctrc3l(jpdia3d), ctrc3u(jpdia3d) ,  STAT = ierr ) 
380         IF( ierr > 0 )   CALL ctl_stop( 'STOP', 'trcnam: unable to allocate add. diag. array' )
381         !
382         trc2d(:,:,:  ) = 0._wp  ;   ctrc2d(:) = ' '   ;   ctrc2l(:) = ' '    ;    ctrc2u(:) = ' ' 
383         trc3d(:,:,:,:) = 0._wp  ;   ctrc3d(:) = ' '   ;   ctrc3l(:) = ' '    ;    ctrc3u(:) = ' ' 
384         !
385      ENDIF
386
387      IF( ln_diabio .OR. l_trdtrc ) THEN
388         ALLOCATE( trbio (jpi,jpj,jpk,jpdiabio) , &
389           &       ctrbio(jpdiabio), ctrbil(jpdiabio), ctrbiu(jpdiabio), STAT = ierr ) 
390         IF( ierr > 0 )   CALL ctl_stop( 'STOP', 'trcnam: unable to allocate bio. diag. array' )
391         !
392         trbio(:,:,:,:) = 0._wp  ;   ctrbio(:) = ' '   ;   ctrbil(:) = ' '    ;    ctrbiu(:) = ' ' 
393         !
394      ENDIF
395      !
396   END SUBROUTINE trc_nam_dia
397
398#else
399   !!----------------------------------------------------------------------
400   !!  Dummy module :                                     No passive tracer
401   !!----------------------------------------------------------------------
402CONTAINS
403   SUBROUTINE trc_nam                      ! Empty routine   
404   END SUBROUTINE trc_nam
405   SUBROUTINE trc_nam_run                      ! Empty routine   
406   END SUBROUTINE trc_nam_run
407#endif
408
409   !!----------------------------------------------------------------------
410   !! NEMO/TOP 3.3 , NEMO Consortium (2010)
411   !! $Id$
412   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
413   !!======================================================================
414END MODULE trcnam
Note: See TracBrowser for help on using the repository browser.