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

Last change on this file since 3319 was 3319, checked in by cetlod, 12 years ago

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