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_trp.F90 in branches/2013/dev_r3891_METO1_MERCATOR6_OBC_BDY_merge/NEMOGCM/NEMO/TOP_SRC/TRP – NEMO

source: branches/2013/dev_r3891_METO1_MERCATOR6_OBC_BDY_merge/NEMOGCM/NEMO/TOP_SRC/TRP/trcnam_trp.F90 @ 3898

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

trunk: fix on passive tracer damping, see ticket #1083
  • Property svn:keywords set to Id
File size: 10.1 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 oce_trc              ! shared ocean passive tracers variables
16   USE trc                 ! passive tracers variables
17   USE in_out_manager      ! ocean dynamics and active tracers variables
18
19   IMPLICIT NONE
20   PRIVATE
21
22   PUBLIC   trc_nam_trp    ! routine called by step module
23 
24   !                                                 !!: ** Advection (nam_trcadv) **
25   LOGICAL , PUBLIC ::   ln_trcadv_cen2   = .FALSE.   ! 2nd order centered scheme flag
26   LOGICAL , PUBLIC ::   ln_trcadv_tvd    = .TRUE.    ! TVD scheme flag
27   LOGICAL , PUBLIC ::   ln_trcadv_muscl  = .FALSE.   ! MUSCL scheme flag
28   LOGICAL , PUBLIC ::   ln_trcadv_muscl2 = .FALSE.   ! MUSCL2 scheme flag
29   LOGICAL , PUBLIC ::   ln_trcadv_ubs    = .FALSE.   ! UBS scheme flag
30   LOGICAL , PUBLIC ::   ln_trcadv_qck    = .FALSE.   ! QUICKEST scheme flag
31   LOGICAL , PUBLIC ::   ln_trcadv_msc_ups= .FALSE.   ! use upstream scheme within muscl
32
33
34   !                                                 !!: ** lateral mixing namelist (nam_trcldf) **
35   LOGICAL , PUBLIC ::   ln_trcldf_diff  = .FALSE.    !: flag of perform or not the lateral diff.
36   LOGICAL , PUBLIC ::   ln_trcldf_lap   = .TRUE.     !: laplacian operator
37   LOGICAL , PUBLIC ::   ln_trcldf_bilap = .FALSE.    !: bilaplacian operator
38   LOGICAL , PUBLIC ::   ln_trcldf_level = .FALSE.    !: iso-level direction
39   LOGICAL , PUBLIC ::   ln_trcldf_hor   = .FALSE.    !: horizontal (geopotential) direction
40   LOGICAL , PUBLIC ::   ln_trcldf_iso   = .TRUE.     !: 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       = .TRUE.     !: flag to artificially correct negative concentrations
46
47   !                                                 !!: ** Vertical diffusion (nam_trczdf) **
48   LOGICAL , PUBLIC ::   ln_trczdf_exp = .FALSE.      !: explicit vertical diffusion scheme flag
49   INTEGER , PUBLIC ::   nn_trczdf_exp = 3             !: number of sub-time step (explicit time stepping)
50
51   !                                                 !!: ** newtonian damping namelist (nam_trcdmp) **
52   INTEGER , PUBLIC ::   nn_hdmp_tr      =   -1       ! = 0/-1/'latitude' for damping over passive tracer
53   INTEGER , PUBLIC ::   nn_zdmp_tr      =    0       ! = 0/1/2 flag for damping in the mixed layer
54   REAL(wp), PUBLIC ::   rn_surf_tr      =   50.      ! surface time scale for internal damping        [days]
55   REAL(wp), PUBLIC ::   rn_bot_tr       =  360.      ! bottom time scale for internal damping         [days]
56   REAL(wp), PUBLIC ::   rn_dep_tr       =  800.      ! depth of transition between rn_surf and rn_bot [meters]
57   INTEGER , PUBLIC ::   nn_file_tr      =    2       ! = 1 create a damping.coeff NetCDF file
58
59   !!----------------------------------------------------------------------
60   !! NEMO/TOP 3.3 , NEMO Consortium (2010)
61   !! $Id$
62   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
63   !!----------------------------------------------------------------------
64
65CONTAINS
66
67   SUBROUTINE trc_nam_trp
68      !!----------------------------------------------------------------------
69      !!                  ***  ROUTINE trc_nam_trp  ***
70      !!               
71      !! ** Purpose :   Read Namelist for tracer transport option
72      !!----------------------------------------------------------------------
73      NAMELIST/namtrc_adv/ ln_trcadv_cen2 , ln_trcadv_tvd   ,    &
74         &                 ln_trcadv_muscl, ln_trcadv_muscl2,    &
75         &                 ln_trcadv_ubs  , ln_trcadv_qck, ln_trcadv_msc_ups
76
77      NAMELIST/namtrc_ldf/ ln_trcldf_diff , ln_trcldf_lap  ,     &
78         &                 ln_trcldf_bilap, ln_trcldf_level,     &
79         &                 ln_trcldf_hor  , ln_trcldf_iso  , rn_ahtrc_0, rn_ahtrb_0
80      NAMELIST/namtrc_zdf/ ln_trczdf_exp  , nn_trczdf_exp
81      NAMELIST/namtrc_rad/ ln_trcrad
82      NAMELIST/namtrc_dmp/ nn_hdmp_tr, nn_zdmp_tr, rn_surf_tr, &
83        &                  rn_bot_tr , rn_dep_tr , nn_file_tr
84      !!----------------------------------------------------------------------
85
86      IF(lwp) WRITE(numout,*)
87      IF(lwp) WRITE(numout,*) ' trc_nam_trp: read namelist for tracer transport'
88      IF(lwp) WRITE(numout,*) ' ~~~~~~~~~~~'
89
90      REWIND ( numnat )               ! Read Namelist namtrc_adv : tracer advection scheme
91      READ   ( numnat, namtrc_adv )
92
93      IF(lwp) THEN                    ! Namelist print
94         WRITE(numout,*)
95         WRITE(numout,*) 'trc_adv_ctl : choice/control of the tracer advection scheme'
96         WRITE(numout,*) '~~~~~~~~~~~'
97         WRITE(numout,*) '   Namelist namtrc_adv : chose a advection scheme for tracers'
98         WRITE(numout,*) '      2nd order advection scheme     ln_trcadv_cen2   = ', ln_trcadv_cen2
99         WRITE(numout,*) '      TVD advection scheme           ln_trcadv_tvd    = ', ln_trcadv_tvd
100         WRITE(numout,*) '      MUSCL  advection scheme        ln_trcadv_muscl  = ', ln_trcadv_muscl
101         WRITE(numout,*) '      MUSCL2 advection scheme        ln_trcadv_muscl2 = ', ln_trcadv_muscl2
102         WRITE(numout,*) '      UBS    advection scheme        ln_trcadv_ubs    = ', ln_trcadv_ubs
103         WRITE(numout,*) '      QUICKEST advection scheme      ln_trcadv_qck    = ', ln_trcadv_qck
104      ENDIF
105      !
106      REWIND( numnat )                ! Namelist namtrc_ldf
107      READ  ( numnat, namtrc_ldf )
108
109      IF(lwp) THEN                    ! Namelist print
110         WRITE(numout,*)
111         WRITE(numout,*) 'trc:ldf_ctl : lateral tracer diffusive operator'
112         WRITE(numout,*) '~~~~~~~~~~~'
113         WRITE(numout,*) '   Namelist namtrc_ldf : set lateral mixing parameters (type, direction, coefficients)'
114         WRITE(numout,*) '      perform lateral diffusion or not                   ln_trcldf_diff  = ', ln_trcldf_diff
115         WRITE(numout,*) '      laplacian operator                                 ln_trcldf_lap   = ', ln_trcldf_lap
116         WRITE(numout,*) '      bilaplacian operator                               ln_trcldf_bilap = ', ln_trcldf_bilap
117         WRITE(numout,*) '      iso-level                                          ln_trcldf_level = ', ln_trcldf_level
118         WRITE(numout,*) '      horizontal (geopotential)                          ln_trcldf_hor   = ', ln_trcldf_hor
119         WRITE(numout,*) '      iso-neutral                                        ln_trcldf_iso   = ', ln_trcldf_iso
120         WRITE(numout,*) '      diffusivity coefficient                                 rn_ahtrc_0 = ', rn_ahtrc_0
121         WRITE(numout,*) '      background hor. diffusivity                             rn_ahtrb_0 = ', rn_ahtrb_0
122      ENDIF
123
124      !                                ! Vertical mixing
125      REWIND( numnat )                 !   ! Read namtopzdf namelist
126      READ  ( numnat, namtrc_zdf )
127
128      IF(lwp) THEN                     !   ! Control print
129         WRITE(numout,*)
130         WRITE(numout,*) '   Namelist namtrc_zdf : set vertical diffusion parameters'
131         WRITE(numout,*) '      time splitting / backward scheme ln_trczdf_exp = ', ln_trczdf_exp
132         WRITE(numout,*) '      number of time step              nn_trczdf_exp = ', nn_trczdf_exp
133      ENDIF
134
135      !
136      REWIND( numnat )                 !   Read Namelist namtoprad
137      READ  ( numnat, namtrc_rad )
138
139      IF(lwp) THEN                     !   ! Control print
140         WRITE(numout,*)
141         WRITE(numout,*) '   Namelist namtrc_rad : treatment of negative concentrations'
142         WRITE(numout,*) '      correct artificially negative concen. or not ln_trcrad = ', ln_trcrad
143      ENDIF
144
145
146      REWIND ( numnat )                  ! Read Namelist namtra_dmp : temperature and salinity damping term
147      READ   ( numnat, namtrc_dmp )
148      IF( lzoom )   nn_zdmp_tr = 0           ! restoring to climatology at closed north or south boundaries
149
150      IF(lwp) THEN                       ! Namelist print
151         WRITE(numout,*)
152         WRITE(numout,*) 'trc_dmp : Passive tracers newtonian damping'
153         WRITE(numout,*) '~~~~~~~'
154         WRITE(numout,*) '   Namelist namtrc_dmp : set damping parameter'
155         WRITE(numout,*) '      tracer damping option          nn_hdmp_tr = ', nn_hdmp_tr
156         WRITE(numout,*) '      mixed layer damping option     nn_zdmp_tr = ', nn_zdmp_tr, '(zoom: forced to 0)'
157         WRITE(numout,*) '      surface time scale (days)      rn_surf_tr = ', rn_surf_tr
158         WRITE(numout,*) '      bottom time scale (days)       rn_bot_tr  = ', rn_bot_tr
159         WRITE(numout,*) '      depth of transition (meters)   rn_dep_tr  = ', rn_dep_tr
160         WRITE(numout,*) '      create a damping.coeff file    nn_file_tr = ', nn_file_tr
161      ENDIF
162      !
163   END SUBROUTINE trc_nam_trp
164   
165#else
166   !!----------------------------------------------------------------------
167   !!   Dummy module :                                         No TOP model
168   !!----------------------------------------------------------------------
169CONTAINS
170   SUBROUTINE trc_nam_trp              ! Empty routine
171   END SUBROUTINE trc_nam_trp
172#endif
173
174  !!======================================================================
175END MODULE trcnam_trp
Note: See TracBrowser for help on using the repository browser.