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

source: branches/2011/dev_r2802_TOP_substepping/NEMOGCM/NEMO/TOP_SRC/trcnam.F90 @ 2830

Last change on this file since 2830 was 2830, checked in by kpedwards, 13 years ago

Updates to average physics variables for TOP substepping.

  • Property svn:keywords set to Id
File size: 9.0 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
21   USE trc
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_trc_oce
29
30   IMPLICIT NONE
31   PRIVATE
32
33   PUBLIC trc_nam      ! called in trcini
34
35   !! * Substitutions
36#  include "top_substitute.h90"
37   !!----------------------------------------------------------------------
38   !! NEMO/TOP 3.3 , NEMO Consortium (2010)
39   !! $Id$
40   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
41   !!----------------------------------------------------------------------
42
43CONTAINS
44
45   SUBROUTINE trc_nam
46      !!---------------------------------------------------------------------
47      !!                     ***  ROUTINE trc_nam  ***
48      !!
49      !! ** Purpose :   READ and PRINT options for the passive tracer run (namelist)
50      !!
51      !! ** Method  : - read passive tracer namelist
52      !!              - read namelist of each defined SMS model
53      !!                ( (LOBSTER, PISCES, CFC, MY_TRC )
54      !!---------------------------------------------------------------------
55      INTEGER ::  jn
56
57      ! Definition of a tracer as a structure
58      TYPE PTRACER
59         CHARACTER(len = 20)  :: clsname  !: short name
60         CHARACTER(len = 80 ) :: cllname  !: long name
61         CHARACTER(len = 20 ) :: clunit   !: unit
62         LOGICAL              :: llinit   !: read in a file or not
63         LOGICAL              :: llsave   !: save the tracer or not
64      END TYPE PTRACER
65
66      TYPE(PTRACER) , DIMENSION(jptra) :: sn_tracer
67
68      !!
69      NAMELIST/namtrc/    nn_dttrc, nn_writetrc, ln_rsttr, nn_rsttr, &
70                          cn_trcrst_in, cn_trcrst_out, sn_tracer
71#if defined key_trdmld_trc  || defined key_trdtrc
72      NAMELIST/namtrc_trd/ nn_trd_trc, nn_ctls_trc, rn_ucf_trc, &
73                         ln_trdmld_trc_restart, ln_trdmld_trc_instant, &
74                         cn_trdrst_trc_in, cn_trdrst_trc_out, ln_trdtrc
75#endif
76
77      !!---------------------------------------------------------------------
78
79      IF(lwp) WRITE(numout,*) 'trc_nam : read the passive tracer namelists'
80      IF(lwp) WRITE(numout,*) '~~~~~~~'
81
82      CALL ctl_opn( numnat, 'namelist_top', 'OLD', 'FORMATTED', 'SEQUENTIAL', 1, numout, .FALSE. )
83
84      ! Namelist nattrc (files)
85      ! ----------------------------------------------
86      nn_dttrc    = 1                 ! default values
87      nn_writetrc = 10     
88      ln_rsttr    = .FALSE.
89      nn_rsttr    =  0
90      cn_trcrst_in  = 'restart_trc'
91      cn_trcrst_out = 'restart_trc'
92      DO jn = 1, jptra
93         WRITE(ctrcnm(jn),'("TR_",I1)'           ) jn
94         WRITE(ctrcnl(jn),'("TRACER NUMBER ",I1)') jn
95         ctrcun(jn) = 'mmole/m3'
96         lutini(jn) = .FALSE. 
97         lutsav(jn) = .TRUE. 
98      END DO
99
100      REWIND( numnat )               ! read nattrc
101      READ  ( numnat, namtrc )
102
103      DO jn = 1, jptra
104         ctrcnm(jn) = TRIM( sn_tracer(jn)%clsname )
105         ctrcnl(jn) = TRIM( sn_tracer(jn)%cllname )
106         ctrcun(jn) = TRIM( sn_tracer(jn)%clunit  )
107         lutini(jn) =       sn_tracer(jn)%llinit 
108         lutsav(jn) =       sn_tracer(jn)%llsave
109      END DO
110
111      !!KPE  computes the first time step of tracer model
112      nittrc000 = nit000 + nn_dttrc - 1
113 
114
115      IF(lwp) THEN                   ! control print
116         WRITE(numout,*)
117         WRITE(numout,*) ' Namelist : namtrc'
118         WRITE(numout,*) '    time step freq. for pass. trac. nn_dttrc             = ', nn_dttrc
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,*) '    restart LOGICAL for passive tr. ln_rsttr             = ', ln_rsttr
122         WRITE(numout,*) '    control of time step for p. tr. nn_rsttr             = ', nn_rsttr
123         WRITE(numout,*) ' '
124         DO jn = 1, jptra
125            WRITE(numout,*) '   tracer nb             : ', jn 
126            WRITE(numout,*) '   short name            : ', ctrcnm(jn)
127            WRITE(numout,*) '   long name             : ', ctrcnl(jn)
128            WRITE(numout,*) '   unit                  : ', ctrcun(jn)
129            WRITE(numout,*) '   initial value in FILE : ', lutini(jn) 
130            WRITE(numout,*) ' '
131         END DO
132      ENDIF
133
134      rdttrc(:) = rdttra(:) * FLOAT( nn_dttrc )   ! vertical profile of passive tracer time-step
135 
136      IF(lwp) WRITE(numout,*) 
137      IF(lwp) WRITE(numout,*) '    Passive Tracer  time step    rdttrc  = ', rdttrc(1)
138      IF(lwp) WRITE(numout,*) 
139
140#if defined key_trdmld_trc || defined key_trdtrc
141      nn_trd_trc  = 20
142      nn_ctls_trc =  9
143      rn_ucf_trc   =  1.
144      ln_trdmld_trc_instant = .TRUE.
145      ln_trdmld_trc_restart =.FALSE.
146      cn_trdrst_trc_in  = "restart_mld_trc"
147      cn_trdrst_trc_out = "restart_mld_trc"
148      ln_trdtrc(:) = .FALSE.
149
150      REWIND( numnat )               !  namelist namtoptrd : passive tracer trends diagnostic
151      READ  ( numnat, namtrc_trd )
152
153     IF(lwp) THEN
154         WRITE(numout,*)
155         WRITE(numout,*) ' trd_mld_trc_init : read namelist namtrc_trd                    '
156         WRITE(numout,*) ' ~~~~~~~~~~~~~~~~                                               '
157         WRITE(numout,*) '   * frequency of trends diagnostics   nn_trd_trc             = ', nn_trd_trc
158         WRITE(numout,*) '   * control surface type              nn_ctls_trc            = ', nn_ctls_trc
159         WRITE(numout,*) '   * restart for ML diagnostics        ln_trdmld_trc_restart  = ', ln_trdmld_trc_restart
160         WRITE(numout,*) '   * flag to diagnose trends of                                 '
161         WRITE(numout,*) '     instantantaneous or mean ML T/S   ln_trdmld_trc_instant  = ', ln_trdmld_trc_instant
162         WRITE(numout,*) '   * unit conversion factor            rn_ucf_trc             = ', rn_ucf_trc
163         DO jn = 1, jptra
164            IF( ln_trdtrc(jn) ) WRITE(numout,*) '    compute ML trends for tracer number :', jn
165         END DO
166      ENDIF
167#endif
168
169      ! namelist of transport
170      ! ---------------------
171      CALL trc_nam_trp
172
173
174      ! namelist of SMS
175      ! ---------------     
176      IF( lk_lobster ) THEN   ;   CALL trc_nam_lobster      ! LOBSTER bio-model
177      ELSE                    ;   IF(lwp) WRITE(numout,*) '          LOBSTER not used'
178      ENDIF
179
180      IF( lk_pisces  ) THEN   ;   CALL trc_nam_pisces      ! PISCES  bio-model
181      ELSE                    ;   IF(lwp) WRITE(numout,*) '          PISCES not used'
182      ENDIF
183
184      IF( lk_cfc     ) THEN   ;   CALL trc_nam_cfc         ! CFC     tracers
185      ELSE                    ;   IF(lwp) WRITE(numout,*) '          CFC not used'
186      ENDIF
187
188      IF( lk_c14b     ) THEN   ;   CALL trc_nam_c14b         ! C14 bomb     tracers
189      ELSE                    ;   IF(lwp) WRITE(numout,*) '          C14 not used'
190      ENDIF
191
192      IF( lk_my_trc  ) THEN   ;   CALL trc_nam_my_trc      ! MY_TRC  tracers
193      ELSE                    ;   IF(lwp) WRITE(numout,*) '          MY_TRC not used'
194      ENDIF
195      !
196   END SUBROUTINE trc_nam
197
198#else
199   !!----------------------------------------------------------------------
200   !!  Dummy module :                                     No passive tracer
201   !!----------------------------------------------------------------------
202CONTAINS
203   SUBROUTINE trc_nam                      ! Empty routine   
204   END SUBROUTINE trc_nam
205#endif
206
207   !!----------------------------------------------------------------------
208   !! NEMO/TOP 3.3 , NEMO Consortium (2010)
209   !! $Id$
210   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
211   !!======================================================================
212END MODULE  trcnam
Note: See TracBrowser for help on using the repository browser.