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 branches/2011/dev_r2787_LOCEAN3_TRA_TRP/NEMOGCM/NEMO/TOP_SRC – NEMO

source: branches/2011/dev_r2787_LOCEAN3_TRA_TRP/NEMOGCM/NEMO/TOP_SRC/trcnam.F90 @ 2833

Last change on this file since 2833 was 2819, checked in by cetlod, 13 years ago

Improvment of branch dev_r2787_LOCEAN3_TRA_TRP
  • Property svn:keywords set to Id
File size: 11.3 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
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
95
96      REWIND( numnat )               ! read nattrc
97      READ  ( numnat, namtrc )
98
99      DO jn = 1, jptra
100         ctrcnm    (jn) = TRIM( sn_tracer(jn)%clsname )
101         ctrcln    (jn) = TRIM( sn_tracer(jn)%cllname )
102         ctrcun    (jn) = TRIM( sn_tracer(jn)%clunit  )
103         ln_trc_ini(jn) =       sn_tracer(jn)%llinit
104         ln_trc_wri(jn) =       sn_tracer(jn)%llsave
105      END DO
106
107
108      IF(lwp) THEN                   ! control print
109         WRITE(numout,*)
110         WRITE(numout,*) ' Namelist : namtrc'
111         WRITE(numout,*) '   time step freq. for passive tracer           nn_dttrc      = ', nn_dttrc
112         WRITE(numout,*) '   restart  for passive tracer                  ln_rsttr      = ', ln_rsttr
113         WRITE(numout,*) '   control of time step for passive tracer      nn_rsttr      = ', nn_rsttr
114         WRITE(numout,*) '   Read inputs data from file                   ln_trcdta     = ', ln_trcdta
115         WRITE(numout,*) ' '
116         DO jn = 1, jptra
117            WRITE(numout,*) '  tracer nb : ', jn, '    short name : ', ctrcnm(jn)
118         END DO
119         WRITE(numout,*) ' '
120      ENDIF
121
122      rdttrc(:) = rdttra(:) * FLOAT( nn_dttrc )   ! vertical profile of passive tracer time-step
123 
124      IF(lwp) THEN                   ! control print
125        WRITE(numout,*) 
126        WRITE(numout,*) '    Passive Tracer  time step    rdttrc  = ', rdttrc(1)
127        WRITE(numout,*) 
128      ENDIF
129
130      ln_diatrc = .FALSE.
131      ln_diabio = .FALSE.
132      nn_writedia = 10
133      nn_writebio = 10
134
135      REWIND( numnat )               !  namelist namtoptrd : passive tracer trends diagnostic
136      READ  ( numnat, namtrc_dia )
137
138      IF(lwp) THEN
139         WRITE(numout,*)
140         WRITE(numout,*)
141         WRITE(numout,*) ' Namelist : namtrc_dia'
142         WRITE(numout,*) '    save additionnal diagnostics arrays         ln_diatrc   = ', ln_diatrc
143         WRITE(numout,*) '    save additionnal biology diagnostics arrays ln_diabio   = ', ln_diabio
144         WRITE(numout,*) '    frequency of outputs for additional arrays  nn_writedia = ', nn_writedia
145         WRITE(numout,*) '    frequency of outputs for biological trends  nn_writebio = ', nn_writebio
146         WRITE(numout,*) ' '
147      ENDIF
148
149      IF( ln_diatrc .AND. .NOT. lk_iomput ) THEN
150         ALLOCATE( trc2d(jpi,jpj,jpdia2d), trc3d(jpi,jpj,jpk,jpdia3d),  &
151           &       ctrc2d(jpdia2d), ctrc2l(jpdia2d), ctrc2u(jpdia2d) ,  & 
152           &       ctrc3d(jpdia3d), ctrc3l(jpdia3d), ctrc3u(jpdia3d) ,  STAT = ierr ) 
153         IF( ierr > 0 )   CALL ctl_stop( 'STOP', 'trcnam: unable to allocate add. diag. array' )
154      ENDIF
155
156      IF( ( ln_diabio .AND. .NOT. lk_iomput ) .OR. l_trdtrc ) THEN
157         ALLOCATE( trbio (jpi,jpj,jpk,jpdiabio) , &
158           &       ctrbio(jpdiabio), ctrbil(jpdiabio), ctrbiu(jpdiabio), STAT = ierr ) 
159         IF( ierr > 0 )   CALL ctl_stop( 'STOP', 'trcnam: unable to allocate bio. diag. array' )
160      ENDIF
161
162      ! namelist of transport
163      ! ---------------------
164      CALL trc_nam_trp
165
166
167      IF( ln_trcdmp .AND. .NOT.ln_trcdta ) THEN
168         CALL ctl_warn( 'trc_nam: passive tracer damping requires data from files we set ln_trcdta to TRUE' )
169         ln_trcdta = .TRUE.
170      ENDIF
171      !
172      IF( ln_rsttr .AND. .NOT.ln_trcdmp .AND. ln_trcdta ) THEN
173          CALL ctl_warn( 'trc_nam: passive tracer restart and  data intialisation, ',   &
174             &           'we keep the restart values and set ln_trcdta to FALSE' )
175         ln_trcdta = .FALSE.
176      ENDIF
177      !
178      IF( .NOT.ln_trcdta ) THEN
179         ln_trc_ini(:) = .FALSE.
180      ENDIF
181
182      IF(lwp) THEN                   ! control print
183         IF( ln_rsttr ) THEN
184            WRITE(numout,*)
185            WRITE(numout,*) '    read a restart file for passive tracer : ', TRIM( cn_trcrst_in )
186            WRITE(numout,*)
187         ELSE
188            IF( .NOT.ln_trcdta ) THEN
189                WRITE(numout,*)
190                WRITE(numout,*) '  All the passive tracers are initialised with constant values '
191                WRITE(numout,*)
192            ENDIF
193         ENDIF
194      ENDIF
195
196
197#if defined key_trdmld_trc || defined key_trdtrc
198         nn_trd_trc  = 20
199         nn_ctls_trc =  9
200         rn_ucf_trc   =  1.
201         ln_trdmld_trc_instant = .TRUE.
202         ln_trdmld_trc_restart =.FALSE.
203         cn_trdrst_trc_in  = "restart_mld_trc"
204         cn_trdrst_trc_out = "restart_mld_trc"
205         ln_trdtrc(:) = .FALSE.
206
207         REWIND( numnat )               !  namelist namtoptrd : passive tracer trends diagnostic
208         READ  ( numnat, namtrc_trd )
209
210         IF(lwp) THEN
211            WRITE(numout,*)
212            WRITE(numout,*) ' trd_mld_trc_init : read namelist namtrc_trd                    '
213            WRITE(numout,*) ' ~~~~~~~~~~~~~~~~                                               '
214            WRITE(numout,*) '   * frequency of trends diagnostics   nn_trd_trc             = ', nn_trd_trc
215            WRITE(numout,*) '   * control surface type              nn_ctls_trc            = ', nn_ctls_trc
216            WRITE(numout,*) '   * restart for ML diagnostics        ln_trdmld_trc_restart  = ', ln_trdmld_trc_restart
217            WRITE(numout,*) '   * flag to diagnose trends of                                 '
218            WRITE(numout,*) '     instantantaneous or mean ML T/S   ln_trdmld_trc_instant  = ', ln_trdmld_trc_instant
219            WRITE(numout,*) '   * unit conversion factor            rn_ucf_trc             = ', rn_ucf_trc
220            DO jn = 1, jptra
221               IF( ln_trdtrc(jn) ) WRITE(numout,*) '    compute ML trends for tracer number :', jn
222            END DO
223         ENDIF
224#endif
225
226
227      ! namelist of SMS
228      ! ---------------     
229      IF( lk_lobster ) THEN   ;   CALL trc_nam_lobster      ! LOBSTER bio-model
230      ELSE                    ;   IF(lwp) WRITE(numout,*) '          LOBSTER not used'
231      ENDIF
232
233      IF( lk_pisces  ) THEN   ;   CALL trc_nam_pisces      ! PISCES  bio-model
234      ELSE                    ;   IF(lwp) WRITE(numout,*) '          PISCES not used'
235      ENDIF
236
237      IF( lk_cfc     ) THEN   ;   CALL trc_nam_cfc         ! CFC     tracers
238      ELSE                    ;   IF(lwp) WRITE(numout,*) '          CFC not used'
239      ENDIF
240
241      IF( lk_c14b     ) THEN   ;   CALL trc_nam_c14b         ! C14 bomb     tracers
242      ELSE                    ;   IF(lwp) WRITE(numout,*) '          C14 not used'
243      ENDIF
244
245      IF( lk_my_trc  ) THEN   ;   CALL trc_nam_my_trc      ! MY_TRC  tracers
246      ELSE                    ;   IF(lwp) WRITE(numout,*) '          MY_TRC not used'
247      ENDIF
248      !
249   END SUBROUTINE trc_nam
250
251#else
252   !!----------------------------------------------------------------------
253   !!  Dummy module :                                     No passive tracer
254   !!----------------------------------------------------------------------
255CONTAINS
256   SUBROUTINE trc_nam                      ! Empty routine   
257   END SUBROUTINE trc_nam
258#endif
259
260   !!----------------------------------------------------------------------
261   !! NEMO/TOP 3.3 , NEMO Consortium (2010)
262   !! $Id$
263   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
264   !!======================================================================
265END MODULE  trcnam
Note: See TracBrowser for help on using the repository browser.