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 @ 4164

Last change on this file since 4164 was 4164, checked in by hadcv, 10 years ago

Ticket #1136: ctl_stop call to prevent hanging when nn_fsbc/nn_dttrc > 9 & key_iomput
  • Property svn:keywords set to Id
File size: 12.2 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 trdmod_oce       
28   USE trdmod_trc_oce
29   USE iom               ! I/O manager
30
31   IMPLICIT NONE
32   PRIVATE
33
34   PUBLIC trc_nam      ! called in trcini
35
36   !! * Substitutions
37#  include "top_substitute.h90"
38   !!----------------------------------------------------------------------
39   !! NEMO/TOP 3.3 , NEMO Consortium (2010)
40   !! $Id$
41   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
42   !!----------------------------------------------------------------------
43
44CONTAINS
45
46   SUBROUTINE trc_nam
47      !!---------------------------------------------------------------------
48      !!                     ***  ROUTINE trc_nam  ***
49      !!
50      !! ** Purpose :   READ and PRINT options for the passive tracer run (namelist)
51      !!
52      !! ** Method  : - read passive tracer namelist
53      !!              - read namelist of each defined SMS model
54      !!                ( (PISCES, CFC, MY_TRC )
55      !!---------------------------------------------------------------------
56      INTEGER ::  jn, ierr
57      ! Definition of a tracer as a structure
58      TYPE(PTRACER), DIMENSION(jptra) :: sn_tracer  ! type of tracer for saving if not key_iomput
59      !!
60      NAMELIST/namtrc/ nn_dttrc, nn_writetrc, ln_rsttr, nn_rsttr, &
61         &             cn_trcrst_in, cn_trcrst_out, sn_tracer, ln_trcdta, &
62         &             ln_trcdmp, ln_trcdmp_clo, ln_top_euler
63#if defined key_trdmld_trc  || defined key_trdtrc
64      NAMELIST/namtrc_trd/ nn_trd_trc, nn_ctls_trc, rn_ucf_trc, &
65         &                ln_trdmld_trc_restart, ln_trdmld_trc_instant, &
66         &                cn_trdrst_trc_in, cn_trdrst_trc_out, ln_trdtrc
67#endif
68      NAMELIST/namtrc_dia/ ln_diatrc, ln_diabio, nn_writedia, nn_writebio
69
70      !!---------------------------------------------------------------------
71
72      IF(lwp) WRITE(numout,*) 'trc_nam : read the passive tracer namelists'
73      IF(lwp) WRITE(numout,*) '~~~~~~~'
74
75      CALL ctl_opn( numnat, 'namelist_top', 'OLD', 'FORMATTED', 'SEQUENTIAL', 1, numout, .FALSE. )
76
77      ! Namelist nattrc (files)
78      ! ----------------------------------------------
79      nn_dttrc      = 1                 ! default values
80      nn_writetrc   = 10 
81      ln_top_euler  = .FALSE.
82      ln_rsttr      = .FALSE.
83      nn_rsttr      =  0
84      cn_trcrst_in  = 'restart_trc'
85      cn_trcrst_out = 'restart_trc'
86      !
87      DO jn = 1, jptra
88         WRITE( sn_tracer(jn)%clsname,'("TR_",I1)'           ) jn
89         WRITE( sn_tracer(jn)%cllname,'("TRACER NUMBER ",I1)') jn
90         sn_tracer(jn)%clunit  = 'mmole/m3'
91         sn_tracer(jn)%llinit  = .FALSE.
92         sn_tracer(jn)%llsave  = .TRUE.
93      END DO
94      ln_trcdta     = .FALSE.
95      ln_trcdmp     = .FALSE.
96      ln_trcdmp_clo = .FALSE.
97
98
99      REWIND( numnat )               ! read nattrc
100      READ  ( numnat, namtrc )
101
102      DO jn = 1, jptra
103         ctrcnm    (jn) = TRIM( sn_tracer(jn)%clsname )
104         ctrcln    (jn) = TRIM( sn_tracer(jn)%cllname )
105         ctrcun    (jn) = TRIM( sn_tracer(jn)%clunit  )
106         ln_trc_ini(jn) =       sn_tracer(jn)%llinit
107         ln_trc_wri(jn) =       sn_tracer(jn)%llsave
108      END DO
109
110      !!KPE  computes the first time step of tracer model
111      nittrc000 = nit000 + nn_dttrc - 1
112 
113
114      IF(lwp) THEN                   ! control print
115         WRITE(numout,*)
116         WRITE(numout,*) ' Namelist : namtrc'
117         WRITE(numout,*) '   time step freq. for passive tracer           nn_dttrc      = ', nn_dttrc
118         WRITE(numout,*) '   restart  for passive tracer                  ln_rsttr      = ', ln_rsttr
119         WRITE(numout,*) '   control of time step for passive tracer      nn_rsttr      = ', nn_rsttr
120         WRITE(numout,*) '   first time step for pass. trac.              nittrc000     = ', nittrc000
121         WRITE(numout,*) '   frequency of outputs for passive tracers     nn_writetrc   = ', nn_writetrc 
122         WRITE(numout,*) '   Read inputs data from file (y/n)             ln_trcdta     = ', ln_trcdta
123         WRITE(numout,*) '   Damping of passive tracer (y/n)              ln_trcdmp     = ', ln_trcdmp
124         WRITE(numout,*) '   Restoring of tracer on closed seas           ln_trcdmp_clo = ', ln_trcdmp_clo
125         WRITE(numout,*) '   Use euler integration for TRC (y/n)          ln_top_euler  = ', ln_top_euler
126         WRITE(numout,*) ' '
127         DO jn = 1, jptra
128            WRITE(numout,*) '  tracer nb : ', jn, '    short name : ', ctrcnm(jn)
129         END DO
130         WRITE(numout,*) ' '
131      ENDIF
132
133      rdttrc(:) = rdttra(:) * FLOAT( nn_dttrc )   ! vertical profile of passive tracer time-step
134 
135      IF(lwp) THEN                   ! control print
136        WRITE(numout,*) 
137        WRITE(numout,*) '    Passive Tracer  time step    rdttrc  = ', rdttrc(1)
138        WRITE(numout,*) 
139      ENDIF
140
141      IF( lk_iomput .AND. nn_dttrc > 9 )   & 
142         &   CALL ctl_stop( 'nn_dttrc > 9 cannot currently be used with key_iomput' )
143
144      ln_diatrc = .FALSE.
145      ln_diabio = .FALSE.
146      nn_writedia = 10
147      nn_writebio = 10
148
149      REWIND( numnat )               !  namelist namtoptrd : passive tracer trends diagnostic
150      READ  ( numnat, namtrc_dia )
151
152      IF(lwp) THEN
153         WRITE(numout,*)
154         WRITE(numout,*)
155         WRITE(numout,*) ' Namelist : namtrc_dia'
156         WRITE(numout,*) '    save additionnal diagnostics arrays         ln_diatrc   = ', ln_diatrc
157         WRITE(numout,*) '    save additionnal biology diagnostics arrays ln_diabio   = ', ln_diabio
158         WRITE(numout,*) '    frequency of outputs for additional arrays  nn_writedia = ', nn_writedia
159         WRITE(numout,*) '    frequency of outputs for biological trends  nn_writebio = ', nn_writebio
160         WRITE(numout,*) ' '
161      ENDIF
162
163      IF( ln_diatrc .AND. .NOT. lk_iomput ) THEN
164         ALLOCATE( trc2d(jpi,jpj,jpdia2d), trc3d(jpi,jpj,jpk,jpdia3d),  &
165           &       ctrc2d(jpdia2d), ctrc2l(jpdia2d), ctrc2u(jpdia2d) ,  & 
166           &       ctrc3d(jpdia3d), ctrc3l(jpdia3d), ctrc3u(jpdia3d) ,  STAT = ierr ) 
167         IF( ierr > 0 )   CALL ctl_stop( 'STOP', 'trcnam: unable to allocate add. diag. array' )
168         !
169         trc2d(:,:,:  ) = 0._wp  ;   ctrc2d(:) = ' '   ;   ctrc2l(:) = ' '    ;    ctrc2u(:) = ' ' 
170         trc3d(:,:,:,:) = 0._wp  ;   ctrc3d(:) = ' '   ;   ctrc3l(:) = ' '    ;    ctrc3u(:) = ' ' 
171         !
172      ENDIF
173
174      IF( ( ln_diabio .AND. .NOT. lk_iomput ) .OR. l_trdtrc ) THEN
175         ALLOCATE( trbio (jpi,jpj,jpk,jpdiabio) , &
176           &       ctrbio(jpdiabio), ctrbil(jpdiabio), ctrbiu(jpdiabio), STAT = ierr ) 
177         IF( ierr > 0 )   CALL ctl_stop( 'STOP', 'trcnam: unable to allocate bio. diag. array' )
178         !
179         trbio(:,:,:,:) = 0._wp  ;   ctrbio(:) = ' '   ;   ctrbil(:) = ' '    ;    ctrbiu(:) = ' ' 
180         !
181      ENDIF
182
183      ! namelist of transport
184      ! ---------------------
185      CALL trc_nam_trp
186
187
188      IF( ln_rsttr )                      ln_trcdta = .FALSE.   ! restart : no need of clim data
189      !
190      IF( ln_trcdmp .OR. ln_trcdmp_clo )  ln_trcdta = .TRUE.   ! damping : need to have clim data
191      !
192      IF( .NOT.ln_trcdta ) THEN
193         ln_trc_ini(:) = .FALSE.
194      ENDIF
195
196      IF(lwp) THEN                   ! control print
197         IF( ln_rsttr ) THEN
198            WRITE(numout,*)
199            WRITE(numout,*) '  Read a restart file for passive tracer : ', TRIM( cn_trcrst_in )
200            WRITE(numout,*)
201         ENDIF
202         IF( ln_trcdta .AND. .NOT.ln_rsttr ) THEN
203            WRITE(numout,*)
204            WRITE(numout,*) '  Some of the passive tracers are initialised from climatologies '
205            WRITE(numout,*)
206         ENDIF
207         IF( .NOT.ln_trcdta ) THEN
208            WRITE(numout,*)
209            WRITE(numout,*) '  All the passive tracers are initialised with constant values '
210            WRITE(numout,*)
211         ENDIF
212      ENDIF
213
214
215#if defined key_trdmld_trc || defined key_trdtrc
216         nn_trd_trc  = 20
217         nn_ctls_trc =  9
218         rn_ucf_trc   =  1.
219         ln_trdmld_trc_instant = .TRUE.
220         ln_trdmld_trc_restart =.FALSE.
221         cn_trdrst_trc_in  = "restart_mld_trc"
222         cn_trdrst_trc_out = "restart_mld_trc"
223         ln_trdtrc(:) = .FALSE.
224
225         REWIND( numnat )               !  namelist namtoptrd : passive tracer trends diagnostic
226         READ  ( numnat, namtrc_trd )
227
228         IF(lwp) THEN
229            WRITE(numout,*)
230            WRITE(numout,*) ' trd_mld_trc_init : read namelist namtrc_trd                    '
231            WRITE(numout,*) ' ~~~~~~~~~~~~~~~~                                               '
232            WRITE(numout,*) '   * frequency of trends diagnostics   nn_trd_trc             = ', nn_trd_trc
233            WRITE(numout,*) '   * control surface type              nn_ctls_trc            = ', nn_ctls_trc
234            WRITE(numout,*) '   * restart for ML diagnostics        ln_trdmld_trc_restart  = ', ln_trdmld_trc_restart
235            WRITE(numout,*) '   * flag to diagnose trends of                                 '
236            WRITE(numout,*) '     instantantaneous or mean ML T/S   ln_trdmld_trc_instant  = ', ln_trdmld_trc_instant
237            WRITE(numout,*) '   * unit conversion factor            rn_ucf_trc             = ', rn_ucf_trc
238            DO jn = 1, jptra
239               IF( ln_trdtrc(jn) ) WRITE(numout,*) '    compute ML trends for tracer number :', jn
240            END DO
241         ENDIF
242#endif
243
244
245      ! namelist of SMS
246      ! ---------------     
247      IF( lk_pisces  ) THEN   ;   CALL trc_nam_pisces      ! PISCES  bio-model
248      ELSE                    ;   IF(lwp) WRITE(numout,*) '          PISCES not used'
249      ENDIF
250
251      IF( lk_cfc     ) THEN   ;   CALL trc_nam_cfc         ! CFC     tracers
252      ELSE                    ;   IF(lwp) WRITE(numout,*) '          CFC not used'
253      ENDIF
254
255      IF( lk_c14b     ) THEN   ;   CALL trc_nam_c14b         ! C14 bomb     tracers
256      ELSE                    ;   IF(lwp) WRITE(numout,*) '          C14 not used'
257      ENDIF
258
259      IF( lk_my_trc  ) THEN   ;   CALL trc_nam_my_trc      ! MY_TRC  tracers
260      ELSE                    ;   IF(lwp) WRITE(numout,*) '          MY_TRC not used'
261      ENDIF
262      !
263   END SUBROUTINE trc_nam
264
265#else
266   !!----------------------------------------------------------------------
267   !!  Dummy module :                                     No passive tracer
268   !!----------------------------------------------------------------------
269CONTAINS
270   SUBROUTINE trc_nam                      ! Empty routine   
271   END SUBROUTINE trc_nam
272#endif
273
274   !!----------------------------------------------------------------------
275   !! NEMO/TOP 3.3 , NEMO Consortium (2010)
276   !! $Id$
277   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
278   !!======================================================================
279END MODULE  trcnam
Note: See TracBrowser for help on using the repository browser.