source: branches/2013/dev_LOCEAN_2013/NEMOGCM/NEMO/TOP_SRC/TRP/trcnam_trp.F90 @ 4147

Last change on this file since 4147 was 4147, checked in by cetlod, 8 years ago

merge in dev_LOCEAN_2013, the 1st development branch dev_r3853_CNRS9_Confsetting, from its starting point ( r3853 ) on the trunk: see ticket #1169

  • Property svn:keywords set to Id
File size: 12.4 KB
Line 
1MODULE trcnam_trp
2   !!======================================================================
3   !!                       ***  MODULE  trcnam_trp  ***
4   !! TOP :   namelist read options for transport
5   !!======================================================================
6   !! History :   1.0  !  2004-03  (C. Ethe)  Original code
7   !!             2.0  !  2007-12  (C. Ethe, G. Madec)  revised architecture
8   !!----------------------------------------------------------------------
9#if defined key_top
10   !!----------------------------------------------------------------------
11   !!   'key_top'                                                TOP models
12   !!----------------------------------------------------------------------
13   !!   trc_nam_trp  : read the passive tracer namelist for transport
14   !!----------------------------------------------------------------------
15   USE trc                 ! ocean passive tracers variables
16   USE in_out_manager      ! ocean dynamics and active tracers variables
17   USE lib_mpp           ! distributed memory computing library
18
19   IMPLICIT NONE
20   PRIVATE
21
22   PUBLIC   trc_nam_trp    ! routine called by step module
23 
24   !                                        !!: ** Advection (namtrc_adv) **
25   LOGICAL , PUBLIC ::   ln_trcadv_cen2      ! 2nd order centered scheme flag
26   LOGICAL , PUBLIC ::   ln_trcadv_tvd       ! TVD scheme flag
27   LOGICAL , PUBLIC ::   ln_trcadv_muscl     ! MUSCL scheme flag
28   LOGICAL , PUBLIC ::   ln_trcadv_muscl2    ! MUSCL2 scheme flag
29   LOGICAL , PUBLIC ::   ln_trcadv_ubs       ! UBS scheme flag
30   LOGICAL , PUBLIC ::   ln_trcadv_qck       ! QUICKEST scheme flag
31   LOGICAL , PUBLIC ::   ln_trcadv_msc_ups   ! use upstream scheme within muscl
32
33
34   !                                        !!: ** lateral mixing namelist (nam_trcldf) **
35   LOGICAL , PUBLIC ::   ln_trcldf_diff      !: flag of perform or not the lateral diff.
36   LOGICAL , PUBLIC ::   ln_trcldf_lap       !: laplacian operator
37   LOGICAL , PUBLIC ::   ln_trcldf_bilap     !: bilaplacian operator
38   LOGICAL , PUBLIC ::   ln_trcldf_level     !: iso-level direction
39   LOGICAL , PUBLIC ::   ln_trcldf_hor       !: horizontal (geopotential) direction
40   LOGICAL , PUBLIC ::   ln_trcldf_iso       !: iso-neutral direction
41   REAL(wp), PUBLIC ::   rn_ahtrc_0          !: diffusivity coefficient for passive tracer (m2/s)
42   REAL(wp), PUBLIC ::   rn_ahtrb_0          !: background diffusivity coefficient for passive tracer (m2/s)
43
44   !                                        !!: ** Treatment of Negative concentrations ( nam_trcrad )
45   LOGICAL , PUBLIC ::   ln_trcrad           !: flag to artificially correct negative concentrations
46
47   !                                        !!: ** Vertical diffusion (nam_trczdf) **
48   LOGICAL , PUBLIC ::   ln_trczdf_exp       !: explicit vertical diffusion scheme flag
49   INTEGER , PUBLIC ::   nn_trczdf_exp       !: number of sub-time step (explicit time stepping)
50
51
52#if defined key_trcdmp
53   !                                                 !!: ** newtonian damping namelist (nam_trcdmp) **
54   INTEGER , PUBLIC ::   nn_hdmp_tr      =   -1       ! = 0/-1/'latitude' for damping over passive tracer
55   INTEGER , PUBLIC ::   nn_zdmp_tr      =    0       ! = 0/1/2 flag for damping in the mixed layer
56   REAL(wp), PUBLIC ::   rn_surf_tr      =   50.      ! surface time scale for internal damping        [days]
57   REAL(wp), PUBLIC ::   rn_bot_tr       =  360.      ! bottom time scale for internal damping         [days]
58   REAL(wp), PUBLIC ::   rn_dep_tr       =  800.      ! depth of transition between rn_surf and rn_bot [meters]
59   INTEGER , PUBLIC ::   nn_file_tr      =    2       ! = 1 create a damping.coeff NetCDF file
60#endif
61
62   !!----------------------------------------------------------------------
63   !! NEMO/TOP 3.3 , NEMO Consortium (2010)
64   !! $Id$
65   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
66   !!----------------------------------------------------------------------
67
68CONTAINS
69
70   SUBROUTINE trc_nam_trp
71      !!----------------------------------------------------------------------
72      !!                  ***  ROUTINE trc_nam_trp  ***
73      !!               
74      !! ** Purpose :   Read Namelist for tracer transport option
75      !!----------------------------------------------------------------------
76      INTEGER ::  ios                 ! Local integer output status for namelist read
77      NAMELIST/namtrc_adv/ ln_trcadv_cen2 , ln_trcadv_tvd   ,    &
78         &                 ln_trcadv_muscl, ln_trcadv_muscl2,    &
79         &                 ln_trcadv_ubs  , ln_trcadv_qck, ln_trcadv_msc_ups
80
81      NAMELIST/namtrc_ldf/ ln_trcldf_diff , ln_trcldf_lap  ,     &
82         &                 ln_trcldf_bilap, ln_trcldf_level,     &
83         &                 ln_trcldf_hor  , ln_trcldf_iso  , rn_ahtrc_0, rn_ahtrb_0
84      NAMELIST/namtrc_zdf/ ln_trczdf_exp  , nn_trczdf_exp
85      NAMELIST/namtrc_rad/ ln_trcrad
86#if defined key_trcdmp
87      NAMELIST/namtrc_dmp/ ln_trcdmp, nn_hdmp_tr, nn_zdmp_tr, rn_surf_tr, &
88        &                  rn_bot_tr , rn_dep_tr , nn_file_tr
89#endif
90      !!----------------------------------------------------------------------
91
92      IF(lwp) WRITE(numout,*)
93      IF(lwp) WRITE(numout,*) ' trc_nam_trp: read namelist for tracer transport'
94      IF(lwp) WRITE(numout,*) ' ~~~~~~~~~~~'
95
96      REWIND( numnat_ref )              ! Namelist namtrc_adv in reference namelist : Tracer advection scheme
97      READ  ( numnat_ref, namtrc_adv, IOSTAT = ios, ERR = 901)
98901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_adv in reference namelist', lwp )
99
100      REWIND( numnat_cfg )              ! Namelist namtrc_adv in configuration namelist : Tracer advection scheme
101      READ  ( numnat_cfg, namtrc_adv, IOSTAT = ios, ERR = 902 )
102902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_adv in configuration namelist', lwp )
103      WRITE ( numont, namtrc_adv )
104
105      IF(lwp) THEN                    ! Namelist print
106         WRITE(numout,*)
107         WRITE(numout,*) 'trc_adv_ctl : choice/control of the tracer advection scheme'
108         WRITE(numout,*) '~~~~~~~~~~~'
109         WRITE(numout,*) '   Namelist namtrc_adv : chose a advection scheme for tracers'
110         WRITE(numout,*) '      2nd order advection scheme     ln_trcadv_cen2   = ', ln_trcadv_cen2
111         WRITE(numout,*) '      TVD advection scheme           ln_trcadv_tvd    = ', ln_trcadv_tvd
112         WRITE(numout,*) '      MUSCL  advection scheme        ln_trcadv_muscl  = ', ln_trcadv_muscl
113         WRITE(numout,*) '      MUSCL2 advection scheme        ln_trcadv_muscl2 = ', ln_trcadv_muscl2
114         WRITE(numout,*) '      UBS    advection scheme        ln_trcadv_ubs    = ', ln_trcadv_ubs
115         WRITE(numout,*) '      QUICKEST advection scheme      ln_trcadv_qck    = ', ln_trcadv_qck
116      ENDIF
117      !
118      REWIND( numnat_ref )              ! Namelist namtrc_ldf in reference namelist : Tracer lateral diffusive operator
119      READ  ( numnat_ref, namtrc_ldf, IOSTAT = ios, ERR = 903)
120903   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_ldf in reference namelist', lwp )
121
122      REWIND( numnat_cfg )              ! Namelist namtrc_ldf in configuration namelist : Tracer lateral diffusive operator
123      READ  ( numnat_cfg, namtrc_ldf, IOSTAT = ios, ERR = 904 )
124904   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_ldf in configuration namelist', lwp )
125      WRITE ( numont, namtrc_ldf )
126
127      IF(lwp) THEN                    ! Namelist print
128         WRITE(numout,*)
129         WRITE(numout,*) 'trc:ldf_ctl : lateral tracer diffusive operator'
130         WRITE(numout,*) '~~~~~~~~~~~'
131         WRITE(numout,*) '   Namelist namtrc_ldf : set lateral mixing parameters (type, direction, coefficients)'
132         WRITE(numout,*) '      perform lateral diffusion or not                   ln_trcldf_diff  = ', ln_trcldf_diff
133         WRITE(numout,*) '      laplacian operator                                 ln_trcldf_lap   = ', ln_trcldf_lap
134         WRITE(numout,*) '      bilaplacian operator                               ln_trcldf_bilap = ', ln_trcldf_bilap
135         WRITE(numout,*) '      iso-level                                          ln_trcldf_level = ', ln_trcldf_level
136         WRITE(numout,*) '      horizontal (geopotential)                          ln_trcldf_hor   = ', ln_trcldf_hor
137         WRITE(numout,*) '      iso-neutral                                        ln_trcldf_iso   = ', ln_trcldf_iso
138         WRITE(numout,*) '      diffusivity coefficient                                 rn_ahtrc_0 = ', rn_ahtrc_0
139         WRITE(numout,*) '      background hor. diffusivity                             rn_ahtrb_0 = ', rn_ahtrb_0
140      ENDIF
141
142      !                                ! Vertical mixing
143      REWIND( numnat_ref )              ! Namelist namtrc_zdf in reference namelist : Tracer vertical mixing
144      READ  ( numnat_ref, namtrc_zdf, IOSTAT = ios, ERR = 905)
145905   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_zdf in reference namelist', lwp )
146
147      REWIND( numnat_cfg )              ! Namelist namtrc_zdf in configuration namelist : Tracer vertical mixing
148      READ  ( numnat_cfg, namtrc_zdf, IOSTAT = ios, ERR = 906 )
149906   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_zdf in configuration namelist', lwp )
150      WRITE ( numont, namtrc_zdf )
151
152      IF(lwp) THEN                     !   ! Control print
153         WRITE(numout,*)
154         WRITE(numout,*) '   Namelist namtrc_zdf : set vertical diffusion parameters'
155         WRITE(numout,*) '      time splitting / backward scheme ln_trczdf_exp = ', ln_trczdf_exp
156         WRITE(numout,*) '      number of time step              nn_trczdf_exp = ', nn_trczdf_exp
157      ENDIF
158
159      !
160      REWIND( numnat_ref )              ! Namelist namtrc_rad in reference namelist : Tracer negative concentrations
161      READ  ( numnat_ref, namtrc_rad, IOSTAT = ios, ERR = 907)
162907   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_rad in reference namelist', lwp )
163
164      REWIND( numnat_cfg )              ! Namelist namtrc_rad in configuration namelist : Tracer negative concentrations
165      READ  ( numnat_cfg, namtrc_rad, IOSTAT = ios, ERR = 908 )
166908   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_rad in configuration namelist', lwp )
167      WRITE ( numont, namtrc_rad )
168
169      IF(lwp) THEN                     !   ! Control print
170         WRITE(numout,*)
171         WRITE(numout,*) '   Namelist namtrc_rad : treatment of negative concentrations'
172         WRITE(numout,*) '      correct artificially negative concen. or not ln_trcrad = ', ln_trcrad
173      ENDIF
174
175
176# if defined key_trcdmp
177      REWIND( numnat_ref )              ! Namelist namtrc_dmp in reference namelist : Passive tracers newtonian damping
178      READ  ( numnat_ref, namtrc_dmp, IOSTAT = ios, ERR = 909)
179909   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_dmp in reference namelist', lwp )
180
181      REWIND( numnat_cfg )              ! Namelist namtrc_dmp in configuration namelist : Passive tracers newtonian damping
182      READ  ( numnat_cfg, namtrc_dmp, IOSTAT = ios, ERR = 910)
183910   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_dmp in configuration namelist', lwp )
184      WRITE ( numont, namtrc_dmp )
185
186      IF( lzoom )   nn_zdmp_trc = 0           ! restoring to climatology at closed north or south boundaries
187
188      IF(lwp) THEN                       ! Namelist print
189         WRITE(numout,*)
190         WRITE(numout,*) 'trc_dmp : Passive tracers newtonian damping'
191         WRITE(numout,*) '~~~~~~~'
192         WRITE(numout,*) '   Namelist namtrc_dmp : set damping parameter'
193         WRITE(numout,*) '      add a damping term or not      ln_trcdmp = ', ln_trcdmp
194         WRITE(numout,*) '      tracer damping option          nn_hdmp_tr = ', nn_hdmp_tr
195         WRITE(numout,*) '      mixed layer damping option     nn_zdmp_tr = ', nn_zdmp_tr, '(zoom: forced to 0)'
196         WRITE(numout,*) '      surface time scale (days)      rn_surf_tr = ', rn_surf_tr
197         WRITE(numout,*) '      bottom time scale (days)       rn_bot_tr  = ', rn_bot_tr
198         WRITE(numout,*) '      depth of transition (meters)   rn_dep_tr  = ', rn_dep_tr
199         WRITE(numout,*) '      create a damping.coeff file    nn_file_tr = ', nn_file_tr
200      ENDIF
201#endif
202      !
203   END SUBROUTINE trc_nam_trp
204   
205#else
206   !!----------------------------------------------------------------------
207   !!   Dummy module :                                         No TOP model
208   !!----------------------------------------------------------------------
209CONTAINS
210   SUBROUTINE trc_nam_trp              ! Empty routine
211   END SUBROUTINE trc_nam_trp
212#endif
213
214  !!======================================================================
215END MODULE trcnam_trp
Note: See TracBrowser for help on using the repository browser.