source: NEMO/trunk/src/TOP/trcnam.F90 @ 10425

Last change on this file since 10425 was 10425, checked in by smasson, 22 months ago

trunk: merge back dev_r10164_HPC09_ESIWACE_PREP_MERGE@10424 into the trunk

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