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

source: branches/2012/dev_LOCEAN_2012/NEMOGCM/NEMO/TOP_SRC/trcnam.F90 @ 3584

Last change on this file since 3584 was 3584, checked in by cetlod, 11 years ago

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