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.
trclec.F90 in tags/nemo_v3_2/nemo_v3_2/NEMO/TOP_SRC – NEMO

source: tags/nemo_v3_2/nemo_v3_2/NEMO/TOP_SRC/trclec.F90 @ 1878

Last change on this file since 1878 was 1878, checked in by flavoni, 14 years ago

initial test for nemogcm
File size: 9.5 KB
Line 
1MODULE trclec
2   !!======================================================================
3   !!                       ***  MODULE trclec  ***
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_lec    :  Read and print options for the passive tracer run (namelist)
19   !!----------------------------------------------------------------------
20   USE oce_trc
21   USE trc
22   USE trp_trc
23   USE trctrp_lec
24   USE trclsm_lobster    ! LOBSTER namelist
25   USE trclsm_pisces     ! PISCES namelist
26   USE trclsm_cfc        ! CFC SMS namelist
27   USE trclsm_c14b       ! C14 SMS namelist
28   USE trclsm_my_trc     ! MY_TRC SMS namelist
29   USE in_out_manager    ! I/O manager
30   USE trdmld_trc_oce
31
32   IMPLICIT NONE
33   PRIVATE
34
35   PUBLIC trc_lec      ! called in ???
36
37   !! * Substitutions
38#  include "top_substitute.h90"
39   !!----------------------------------------------------------------------
40   !! NEMO/TOP 1.0 , LOCEAN-IPSL (2005)
41   !! $Id: trclec.F90 1581 2009-08-05 14:53:12Z smasson $
42   !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt)
43   !!----------------------------------------------------------------------
44
45CONTAINS
46
47   SUBROUTINE trc_lec
48      !!---------------------------------------------------------------------
49      !!                     ***  ROUTINE trc_lec  ***
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)  :: sname  !: short name
62         CHARACTER(len = 80 ) :: lname  !: long name
63         CHARACTER(len = 20 ) :: unit   !: unit
64         LOGICAL              :: lini   !: read in a file or not
65         LOGICAL              :: lsav   !: ouput the tracer or not
66      END TYPE PTRACER
67
68      TYPE(PTRACER) , DIMENSION(jptra) :: tracer
69
70      !!
71      NAMELIST/namtoptrc/ ndttrc, nwritetrc, ln_rsttr, nrsttr, &
72                          cn_trcrst_in, cn_trcrst_out, tracer
73#if defined key_trdmld_trc || defined key_trc_diatrd
74      NAMELIST/namtoptrd/ ntrd_trc, nctls_trc, ucf_trc, &
75                         ln_trdmld_trc_restart, ln_trdmld_trc_instant, &
76                         cn_trdrst_trc_in, cn_trdrst_trc_out, luttrd
77#endif
78
79      !!---------------------------------------------------------------------
80
81      IF(lwp) WRITE(numout,*) 'trc_lec : 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      ndttrc    = 1                 ! default values
89      nwritetrc = 10     
90      ln_rsttr    = .FALSE.
91      nrsttr    =  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, namtoptrc )
104
105      !!Chris  computes the first time step of tracer model
106      nittrc000 = nit000 + ndttrc - 1
107
108      DO jn = 1, jptra
109         ctrcnm(jn) = tracer(jn)%sname
110         ctrcnl(jn) = tracer(jn)%lname
111         ctrcun(jn) = tracer(jn)%unit
112         lutini(jn) = tracer(jn)%lini
113         lutsav(jn) = tracer(jn)%lsav
114      END DO
115
116
117      IF(lwp) THEN                   ! control print
118         WRITE(numout,*)
119         WRITE(numout,*) ' Namelist : namtoptrc'
120         WRITE(numout,*) '    time step freq. for pass. trac. ndttrc             = ', ndttrc
121         WRITE(numout,*) '    1st time step for pass. trac. nittrc000            = ', nittrc000
122         WRITE(numout,*) '    frequency of outputs for passive tracers nwritetrc = ', nwritetrc 
123         WRITE(numout,*) '    restart LOGICAL for passive tr. ln_rsttr           = ', ln_rsttr
124         WRITE(numout,*) '    control of time step for p. tr. nrsttr             = ', nrsttr
125         WRITE(numout,*) ' '
126         DO jn = 1, jptra
127            WRITE(numout,*) '   tracer nb             : ', jn 
128            WRITE(numout,*) '   short name            : ', TRIM(ctrcnm(jn))
129            WRITE(numout,*) '   long name             : ', TRIM(ctrcnl(jn))
130            WRITE(numout,*) '   unit                  : ', TRIM(ctrcun(jn))
131            WRITE(numout,*) '   initial value in FILE : ', lutini(jn) 
132            WRITE(numout,*) '   output of tracer      : ', lutsav(jn)
133            WRITE(numout,*) ' '
134         END DO
135      ENDIF
136
137#if defined key_trdmld_trc || defined key_trc_diatrd
138
139      ! Namelist natrtd (transport trends)
140      ! ----------------------------------------------
141      ntrd_trc  = 20
142      nctls_trc =  6
143      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      DO jn = 1, jptra
149         luttrd(jn) = .FALSE.
150      END DO
151
152      REWIND( numnat )               !  namelist namtoptrd : passive tracer trends diagnostic
153      READ  ( numnat, namtoptrd )
154
155#if defined key_trc_diatrd
156      nkeep    = 0
157      ikeep(:) = 0
158      DO jn = 1, jptra
159         IF( luttrd(jn) ) THEN
160             nkeep     = nkeep + 1
161             ikeep(jn) = nkeep
162         END IF
163      END DO
164      IF( nkeep > 0 ) THEN 
165        IF(.NOT. ALLOCATED( trtrd ) )   ALLOCATE( trtrd(jpi,jpj,jpk,nkeep,jpdiatrc) ) 
166        trtrd(:,:,:,:,:) = 0.e0
167      ENDIF
168
169      nwritetrd = ntrd_trc
170#endif
171
172     IF(lwp) THEN
173         WRITE(numout,*)
174         WRITE(numout,*) ' trd_mld_trc_init : read namelist namtoptrd                        '
175         WRITE(numout,*) ' ~~~~~~~~~~~~~~~~                                               '
176         WRITE(numout,*) '   * frequency of trends diagnostics   ntrd_trc               = ', ntrd_trc
177         WRITE(numout,*) '   * control surface type              nctls_trc              = ', nctls_trc
178         WRITE(numout,*) '   * restart for ML diagnostics        ln_trdmld_trc_restart  = ', ln_trdmld_trc_restart
179         WRITE(numout,*) '   * flag to diagnose trends of                                 '
180         WRITE(numout,*) '     instantantaneous or mean ML T/S   ln_trdmld_trc_instant  = ', ln_trdmld_trc_instant
181         WRITE(numout,*) '   * unit conversion factor            ucf_trc                = ', ucf_trc
182#if defined key_trdmld_trc
183         DO jn = 1, jptra
184            WRITE(numout,*) '    keep dynamical trends for tracer number :', jn, luttrd(jn)
185         END DO
186#else
187         DO jn = 1, jptra
188            WRITE(numout,*) '    keep dynamical trends for tracer number :', jn, luttrd(jn), ikeep(jn)
189         END DO
190
191         WRITE(numout,*)
192         WRITE(numout,*) '    total = ', nkeep, ' tracers dyn trends saved'
193         WRITE(numout,*) '    size of trtrd = ', jpi*jpj*jpk*nkeep*jpdiatrc
194#endif
195      ENDIF
196
197#endif
198
199
200      ! namelist of transport
201      ! ---------------------
202      CALL trc_trp_lec
203
204      ! namelist of SMS
205      ! ---------------     
206      IF( lk_lobster ) THEN   ;   CALL trc_lsm_lobster      ! LOBSTER bio-model
207      ELSE                    ;   IF(lwp) WRITE(numout,*) '          LOBSTER not used'
208      ENDIF
209
210      IF( lk_pisces  ) THEN   ;   CALL trc_lsm_pisces      ! PISCES  bio-model
211      ELSE                    ;   IF(lwp) WRITE(numout,*) '          PISCES not used'
212      ENDIF
213
214      IF( lk_cfc     ) THEN   ;   CALL trc_lsm_cfc         ! CFC     tracers
215      ELSE                    ;   IF(lwp) WRITE(numout,*) '          CFC not used'
216      ENDIF
217
218      IF( lk_c14b     ) THEN   ;   CALL trc_lsm_c14b         ! C14 bomb     tracers
219      ELSE                    ;   IF(lwp) WRITE(numout,*) '          C14 not used'
220      ENDIF
221
222      IF( lk_my_trc  ) THEN   ;   CALL trc_lsm_my_trc      ! MY_TRC  tracers
223      ELSE                    ;   IF(lwp) WRITE(numout,*) '          MY_TRC not used'
224      ENDIF
225      !
226   END SUBROUTINE trc_lec
227
228#else
229   !!----------------------------------------------------------------------
230   !!  Dummy module :                                     No passive tracer
231   !!----------------------------------------------------------------------
232CONTAINS
233   SUBROUTINE trc_lec                      ! Empty routine   
234   END SUBROUTINE trc_lec
235#endif
236
237   !!======================================================================
238END MODULE  trclec
Note: See TracBrowser for help on using the repository browser.