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/2012/dev_LOCEAN_UKMO_CMCC_INGV_2012/NEMOGCM/NEMO/TOP_SRC/TRP – NEMO

source: branches/2012/dev_LOCEAN_UKMO_CMCC_INGV_2012/NEMOGCM/NEMO/TOP_SRC/TRP/trcnam_trp.F90 @ 3666

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

commit the changes resulting for the merged branches, see ticket #1025

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