source: NEMO/branches/2018/dev_r10164_HPC09_ESIWACE_PREP_MERGE/src/TOP/trcnam.F90 @ 10297

Last change on this file since 10297 was 10297, checked in by smasson, 2 years ago

dev_r10164_HPC09_ESIWACE_PREP_MERGE: action 2a: add report calls of mppmin/max/sum, see #2133

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