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/2012/dev_MERGE_2012/NEMOGCM/NEMO/TOP_SRC – NEMO

source: branches/2012/dev_MERGE_2012/NEMOGCM/NEMO/TOP_SRC/trcnam.F90 @ 3680

Last change on this file since 3680 was 3680, checked in by rblod, 11 years ago

First commit of the final branch for 2012 (future nemo_3_5), see ticket #1028

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