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 NEMO/branches/2019/dev_r11708_aumont_PISCES_QUOTA/src/TOP – NEMO

source: NEMO/branches/2019/dev_r11708_aumont_PISCES_QUOTA/src/TOP/trcnam.F90 @ 14306

Last change on this file since 14306 was 14306, checked in by aumont, 3 years ago

small bug fixes and improvements in the diagenetic module
  • Property svn:keywords set to Id
File size: 14.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 trd_oce     !       
23   USE trdtrc_oce  !
24   USE iom         ! I/O manager
25#if defined key_mpp_mpi
26   USE lib_mpp, ONLY: ncom_dttrc
27#endif
28
29   IMPLICIT NONE
30   PRIVATE
31
32   PUBLIC   trc_nam_run  ! called in trcini
33   PUBLIC   trc_nam      ! called in trcini
34
35   TYPE(PTRACER), DIMENSION(jpmaxtrc), PUBLIC  :: sn_tracer  !: type of tracer for saving if not key_iomput
36
37   !!----------------------------------------------------------------------
38   !! NEMO/TOP 4.0 , NEMO Consortium (2018)
39   !! $Id$
40   !! Software governed by the CeCILL license (see ./LICENSE)
41   !!----------------------------------------------------------------------
42CONTAINS
43
44   SUBROUTINE trc_nam
45      !!---------------------------------------------------------------------
46      !!                     ***  ROUTINE trc_nam  ***
47      !!
48      !! ** Purpose :   READ and PRINT options for the passive tracer run (namelist)
49      !!
50      !! ** Method  : - read passive tracer namelist
51      !!              - read namelist of each defined SMS model
52      !!                ( (PISCES, CFC, MY_TRC )
53      !!---------------------------------------------------------------------
54      INTEGER  ::   jn   ! dummy loop indice
55      !!---------------------------------------------------------------------
56      !
57      IF( .NOT.l_offline )   CALL trc_nam_run     ! Parameters of the run                                 
58      !               
59      CALL trc_nam_trc                            ! passive tracer informations
60      !                                       
61      IF( ln_rsttr                     )   ln_trcdta = .FALSE.   ! restart : no need of clim data
62      !
63      IF( ln_trcdmp .OR. ln_trcdmp_clo )   ln_trcdta = .TRUE.    ! damping : need to have clim data
64#if defined key_sed_off
65      ln_trcdta = .TRUE.
66#endif
67      !
68      !
69      IF(lwp) THEN                   ! control print
70         IF( ln_rsttr ) THEN
71            WRITE(numout,*)
72            WRITE(numout,*) '   ==>>>   Read a restart file for passive tracer : ', TRIM( cn_trcrst_in )
73         ENDIF
74         IF( ln_trcdta .AND. .NOT.ln_rsttr ) THEN
75            WRITE(numout,*)
76            WRITE(numout,*) '   ==>>>   Some of the passive tracers are initialised from climatologies '
77         ENDIF
78         IF( .NOT.ln_trcdta ) THEN
79            WRITE(numout,*)
80            WRITE(numout,*) '   ==>>>   All the passive tracers are initialised with constant values '
81         ENDIF
82      ENDIF
83      !
84      rdttrc = rdt * FLOAT( nn_dttrc )          ! passive tracer time-step     
85      !
86      IF(lwp) THEN                              ! control print
87        WRITE(numout,*) 
88        WRITE(numout,*) '   ==>>>   Passive Tracer  time step    rdttrc = nn_dttrc*rdt = ', rdttrc
89      ENDIF
90      !
91      IF( l_trdtrc )        CALL trc_nam_trd    ! Passive tracer trends
92      !
93   END SUBROUTINE trc_nam
94
95
96   SUBROUTINE trc_nam_run
97      !!---------------------------------------------------------------------
98      !!                     ***  ROUTINE trc_nam  ***
99      !!
100      !! ** Purpose :   read options for the passive tracer run (namelist)
101      !!
102      !!---------------------------------------------------------------------
103      INTEGER  ::   ios   ! Local integer
104      !!
105      NAMELIST/namtrc_run/ nn_dttrc, ln_rsttr, nn_rsttr, ln_top_euler, &
106        &                  cn_trcrst_indir, cn_trcrst_outdir, cn_trcrst_in, cn_trcrst_out
107      !!---------------------------------------------------------------------
108      !
109      IF(lwp) WRITE(numout,*)
110      IF(lwp) WRITE(numout,*) 'trc_nam_run : read the passive tracer namelists'
111      IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
112      !
113      CALL ctl_opn( numnat_ref, 'namelist_top_ref'   , 'OLD'    , 'FORMATTED', 'SEQUENTIAL', -1, numout, .FALSE. )
114      CALL ctl_opn( numnat_cfg, 'namelist_top_cfg'   , 'OLD'    , 'FORMATTED', 'SEQUENTIAL', -1, numout, .FALSE. )
115      IF(lwm) CALL ctl_opn( numont, 'output.namelist.top', 'UNKNOWN', 'FORMATTED', 'SEQUENTIAL', -1, numout, .FALSE., 1 )
116      !
117      REWIND( numnat_ref )              ! Namelist namtrc in reference namelist : Passive tracer variables
118      READ  ( numnat_ref, namtrc_run, IOSTAT = ios, ERR = 901)
119901   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namtrc in reference namelist' )
120      REWIND( numnat_cfg )              ! Namelist namtrc in configuration namelist : Passive tracer variables
121      READ  ( numnat_cfg, namtrc_run, IOSTAT = ios, ERR = 902 )
122902   IF( ios >  0 )   CALL ctl_nam ( ios , 'namtrc in configuration namelist' )
123      IF(lwm) WRITE( numont, namtrc_run )
124
125      nittrc000 = nit000 + nn_dttrc - 1      ! first time step of tracer model
126
127      IF(lwp) THEN                   ! control print
128         WRITE(numout,*) '   Namelist : namtrc_run'
129         WRITE(numout,*) '      time step freq. for passive tracer           nn_dttrc      = ', nn_dttrc
130         WRITE(numout,*) '      restart  for passive tracer                  ln_rsttr      = ', ln_rsttr
131         WRITE(numout,*) '      control of time step for passive tracer      nn_rsttr      = ', nn_rsttr
132         WRITE(numout,*) '      first time step for pass. trac.              nittrc000     = ', nittrc000
133         WRITE(numout,*) '      Use euler integration for TRC (y/n)          ln_top_euler  = ', ln_top_euler
134      ENDIF
135      !
136#if defined key_mpp_mpi
137      ncom_dttrc = nn_dttrc    ! make nn_fsbc available for lib_mpp
138#endif
139      !
140   END SUBROUTINE trc_nam_run
141
142
143   SUBROUTINE trc_nam_trc
144      !!---------------------------------------------------------------------
145      !!                     ***  ROUTINE trc_nam  ***
146      !!
147      !! ** Purpose :   read options for the passive tracer run (namelist)
148      !!
149      !!---------------------------------------------------------------------
150      INTEGER ::   ios, ierr, icfc       ! Local integer
151      !!
152      NAMELIST/namtrc/jp_bgc, ln_pisces, ln_my_trc, ln_age, ln_cfc11, ln_cfc12, ln_sf6, ln_c14, &
153         &            sn_tracer, ln_trcdta, ln_trcdmp, ln_trcdmp_clo, jp_dia3d, jp_dia2d
154      !!---------------------------------------------------------------------
155      ! Dummy settings to fill tracers data structure
156      !                  !   name   !   title   !   unit   !   init  !   sbc   !   cbc   !   obc  !
157      sn_tracer = PTRACER( 'NONAME' , 'NOTITLE' , 'NOUNIT' , .false. , .false. , .false. , .false.)
158      !
159      IF(lwp) WRITE(numout,*)
160      IF(lwp) WRITE(numout,*) 'trc_nam_trc : read the passive tracer namelists'
161      IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
162
163      REWIND( numnat_ref )              ! Namelist namtrc in reference namelist : Passive tracer variables
164      READ  ( numnat_ref, namtrc, IOSTAT = ios, ERR = 901)
165901   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namtrc in reference namelist' )
166      REWIND( numnat_cfg )              ! Namelist namtrc in configuration namelist : Passive tracer variables
167      READ  ( numnat_cfg, namtrc, IOSTAT = ios, ERR = 902 )
168902   IF( ios >  0 )   CALL ctl_nam ( ios , 'namtrc in configuration namelist' )
169      IF(lwm) WRITE( numont, namtrc )
170
171      ! Control settings
172      IF( ln_pisces .AND. ln_my_trc )   CALL ctl_stop( 'Choose only ONE BGC model - PISCES or MY_TRC' )
173      IF( .NOT. ln_pisces .AND. .NOT. ln_my_trc )   jp_bgc = 0
174      ll_cfc = ln_cfc11 .OR. ln_cfc12 .OR. ln_sf6
175      !
176      jptra       =  0
177      jp_pisces   =  0    ;   jp_pcs0  =  0    ;   jp_pcs1  = 0
178      jp_my_trc   =  0    ;   jp_myt0  =  0    ;   jp_myt1  = 0
179      jp_cfc      =  0    ;   jp_cfc0  =  0    ;   jp_cfc1  = 0
180      jp_age      =  0    ;   jp_c14   =  0
181      !
182      IF( ln_pisces )  THEN
183         jp_pisces = jp_bgc
184         jp_pcs0   = 1
185         jp_pcs1   = jp_pisces
186      ENDIF
187      IF( ln_my_trc )  THEN
188          jp_my_trc = jp_bgc
189          jp_myt0   = 1
190          jp_myt1   = jp_my_trc
191      ENDIF
192      !
193      jptra  = jp_bgc
194      !
195      IF( ln_age )    THEN
196         jptra     = jptra + 1
197         jp_age    = jptra
198      ENDIF
199      IF( ln_cfc11 )  jp_cfc = jp_cfc + 1
200      IF( ln_cfc12 )  jp_cfc = jp_cfc + 1
201      IF( ln_sf6   )  jp_cfc = jp_cfc + 1
202      IF( ll_cfc )    THEN
203          jptra     = jptra + jp_cfc
204          jp_cfc0   = jptra - jp_cfc + 1
205          jp_cfc1   = jptra
206      ENDIF
207      IF( ln_c14 )    THEN
208           jptra     = jptra + 1
209           jp_c14    = jptra
210      ENDIF
211      !
212      IF( jptra == 0 )   CALL ctl_stop( 'All TOP tracers disabled: change namtrc setting or check if key_top is active' )
213      !
214      IF(lwp) THEN                   ! control print
215         WRITE(numout,*) '   Namelist : namtrc'
216         WRITE(numout,*) '      Total number of passive tracers              jptra         = ', jptra
217         WRITE(numout,*) '      Total number of BGC tracers                  jp_bgc        = ', jp_bgc
218         WRITE(numout,*) '      Simulating PISCES model                      ln_pisces     = ', ln_pisces
219         WRITE(numout,*) '      Simulating MY_TRC  model                     ln_my_trc     = ', ln_my_trc
220         WRITE(numout,*) '      Simulating water mass age                    ln_age        = ', ln_age
221         WRITE(numout,*) '      Simulating CFC11 passive tracer              ln_cfc11      = ', ln_cfc11
222         WRITE(numout,*) '      Simulating CFC12 passive tracer              ln_cfc12      = ', ln_cfc12
223         WRITE(numout,*) '      Simulating SF6 passive tracer                ln_sf6        = ', ln_sf6
224         WRITE(numout,*) '      Total number of CFCs tracers                 jp_cfc        = ', jp_cfc
225         WRITE(numout,*) '      Simulating C14   passive tracer              ln_c14        = ', ln_c14
226         WRITE(numout,*) '      Read inputs data from file (y/n)             ln_trcdta     = ', ln_trcdta
227         WRITE(numout,*) '      Damping of passive tracer (y/n)              ln_trcdmp     = ', ln_trcdmp
228         WRITE(numout,*) '      Restoring of tracer on closed seas           ln_trcdmp_clo = ', ln_trcdmp_clo
229      ENDIF
230      !
231      IF( ll_cfc .OR. ln_c14 ) THEN
232        !                             ! Open namelist files
233        CALL ctl_opn( numtrc_ref, 'namelist_trc_ref'   ,     'OLD', 'FORMATTED', 'SEQUENTIAL', -1, numout, .FALSE. )
234        CALL ctl_opn( numtrc_cfg, 'namelist_trc_cfg'   ,     'OLD', 'FORMATTED', 'SEQUENTIAL', -1, numout, .FALSE. )
235        IF(lwm) CALL ctl_opn( numonr, 'output.namelist.trc', 'UNKNOWN', 'FORMATTED', 'SEQUENTIAL', -1, numout, .FALSE. )
236        !
237      ENDIF
238      !
239   END SUBROUTINE trc_nam_trc
240
241
242   SUBROUTINE trc_nam_trd
243      !!---------------------------------------------------------------------
244      !!                     ***  ROUTINE trc_nam_dia  ***
245      !!
246      !! ** Purpose :   read options for the passive tracer diagnostics
247      !!
248      !! ** Method  : - read passive tracer namelist
249      !!              - read namelist of each defined SMS model
250      !!                ( (PISCES, CFC, MY_TRC )
251      !!---------------------------------------------------------------------
252#if defined key_trdmxl_trc  || defined key_trdtrc
253      INTEGER  ::   jn, ios, ierr                 ! Local integer
254      !!
255      NAMELIST/namtrc_trd/ nn_trd_trc, nn_ctls_trc, rn_ucf_trc, &
256         &                ln_trdmxl_trc_restart, ln_trdmxl_trc_instant, &
257         &                cn_trdrst_trc_in, cn_trdrst_trc_out, ln_trdtrc
258      !!---------------------------------------------------------------------
259      !
260      IF(lwp) WRITE(numout,*)
261      IF(lwp) WRITE(numout,*) 'trc_nam_trd : read the passive tracer diagnostics options'
262      IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
263      !
264      ALLOCATE( ln_trdtrc(jptra) ) 
265      ln_trdtrc(:) = .false.
266      !
267      REWIND( numnat_ref )              ! Namelist namtrc_trd in reference namelist : Passive tracer trends
268      READ  ( numnat_ref, namtrc_trd, IOSTAT = ios, ERR = 905)
269905   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namtrc_trd in reference namelist' )
270      REWIND( numnat_cfg )              ! Namelist namtrc_trd in configuration namelist : Passive tracer trends
271      READ  ( numnat_cfg, namtrc_trd, IOSTAT = ios, ERR = 906 )
272906   IF( ios >  0 )   CALL ctl_nam ( ios , 'namtrc_trd in configuration namelist' )
273     IF(lwm) WRITE( numont, namtrc_trd )
274
275      IF(lwp) THEN
276         WRITE(numout,*) '   Namelist : namtrc_trd                    '
277         WRITE(numout,*) '      frequency of trends diagnostics   nn_trd_trc             = ', nn_trd_trc
278         WRITE(numout,*) '      control surface type              nn_ctls_trc            = ', nn_ctls_trc
279         WRITE(numout,*) '      restart for ML diagnostics        ln_trdmxl_trc_restart  = ', ln_trdmxl_trc_restart
280         WRITE(numout,*) '      instantantaneous or mean trends   ln_trdmxl_trc_instant  = ', ln_trdmxl_trc_instant
281         WRITE(numout,*) '      unit conversion factor            rn_ucf_trc             = ', rn_ucf_trc
282         DO jn = 1, jptra
283            IF( ln_trdtrc(jn) ) WRITE(numout,*) '      compute ML trends for tracer number :', jn
284         END DO
285      ENDIF
286#endif
287      !
288   END SUBROUTINE trc_nam_trd
289
290#else
291   !!----------------------------------------------------------------------
292   !!  Dummy module :                                     No passive tracer
293   !!----------------------------------------------------------------------
294CONTAINS
295   SUBROUTINE trc_nam                      ! Empty routine   
296   END SUBROUTINE trc_nam
297   SUBROUTINE trc_nam_run                      ! Empty routine   
298   END SUBROUTINE trc_nam_run
299#endif
300
301   !!======================================================================
302END MODULE trcnam
Note: See TracBrowser for help on using the repository browser.