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

source: branches/dev_r2586_dynamic_mem/NEMOGCM/NEMO/TOP_SRC/trcnam.F90 @ 2636

Last change on this file since 2636 was 2636, checked in by gm, 13 years ago

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