1 | MODULE trc |
---|
2 | !!====================================================================== |
---|
3 | !! *** MODULE trc *** |
---|
4 | !! Passive tracers : module for tracers defined |
---|
5 | !!====================================================================== |
---|
6 | !! History : |
---|
7 | !! 8.2 ! 96-01 (M. Levy) Original code |
---|
8 | !! ! 99-07 (M. Levy) for LOBSTER1 or NPZD model |
---|
9 | !! ! 00-04 (O. Aumont, M.A. Foujols) HAMOCC3 and P3ZD |
---|
10 | !! 9.0 ! 04-03 (C. Ethe) Free form and module |
---|
11 | !!---------------------------------------------------------------------- |
---|
12 | !! TOP 1.0, LOCEAN-IPSL (2005) |
---|
13 | !! $Header$ |
---|
14 | !! This software is governed by the CeCILL licence see modipsl/doc/NEMO_CeCILL.txt |
---|
15 | !!---------------------------------------------------------------------- |
---|
16 | #if defined key_passivetrc |
---|
17 | !!---------------------------------------------------------------------- |
---|
18 | !! 'key_passivetrc' : Passive tracer |
---|
19 | !!--------------------------------------------------------------------- |
---|
20 | !! * Modules used |
---|
21 | USE par_oce |
---|
22 | USE par_trc |
---|
23 | IMPLICIT NONE |
---|
24 | |
---|
25 | PUBLIC |
---|
26 | |
---|
27 | |
---|
28 | !! passive tracers names and units (read in namelist) |
---|
29 | !! -------------------------------------------------- |
---|
30 | CHARACTER(len=12), PUBLIC, DIMENSION(jptra) :: & |
---|
31 | ctrcnm , & !!: tracer name |
---|
32 | ctrcun !!: tracer unit |
---|
33 | |
---|
34 | CHARACTER(len=80), PUBLIC, DIMENSION(jptra) :: & |
---|
35 | ctrcnl !!: tracer long name |
---|
36 | |
---|
37 | |
---|
38 | !! parameters for the control of passive tracers |
---|
39 | !! -------------------------------------------------- |
---|
40 | INTEGER, PUBLIC :: & |
---|
41 | numnat !!: the number of the passive tracer NAMELIST |
---|
42 | |
---|
43 | LOGICAL, PUBLIC, DIMENSION(jptra) :: & |
---|
44 | lutini !!: initialisation from FILE or not (NAMELIST) |
---|
45 | |
---|
46 | INTEGER , PUBLIC, DIMENSION(jptra) :: & |
---|
47 | nutini !!: FORTRAN LOGICAL UNIT for initialisation file |
---|
48 | |
---|
49 | !! passive tracers fields (before,now,after) |
---|
50 | !! -------------------------------------------------- |
---|
51 | REAL(wp), PUBLIC, SAVE :: & |
---|
52 | trai , & !!: initial total tracer |
---|
53 | areatot !!: total volume |
---|
54 | |
---|
55 | REAL(wp), PUBLIC, DIMENSION (jpi,jpj,jpk,jptra) :: & |
---|
56 | trn , & !!: traceur concentration for actual time step |
---|
57 | tra , & !!: traceur concentration for next time step |
---|
58 | trb !!: traceur concentration for before time step |
---|
59 | |
---|
60 | |
---|
61 | !! numerical parameter (NAMELIST) |
---|
62 | !! -------------------------------------------------- |
---|
63 | REAL(wp), PUBLIC :: & |
---|
64 | rsc , & !!: tuning coefficient for anti-diffusion |
---|
65 | rtrn !!: value for truncation |
---|
66 | |
---|
67 | !! namelist parameters |
---|
68 | !! -------------------------------------------------- |
---|
69 | INTEGER , PUBLIC :: & |
---|
70 | ncortrc , & !!: number of corrective phases |
---|
71 | ndttrc , & !!: frequency of step on passive tracers |
---|
72 | nittrc000 !!: first time step of passive tracers model |
---|
73 | |
---|
74 | LOGICAL, PUBLIC :: & |
---|
75 | crosster !!: logical if true computes crossterms |
---|
76 | |
---|
77 | |
---|
78 | !! isopycnal scheme for passive tracers |
---|
79 | !! -------------------------------------------------- |
---|
80 | REAL(wp), PUBLIC :: & |
---|
81 | ahtrb0 , & !!: background diffusivity coefficient for passive tracer (m2/s) |
---|
82 | trcrat , & !!: ratio between passive and active tracer coeff for diffusion |
---|
83 | ahtrc0 , & !!: horizontal eddy diffusivity for passive tracers (m2/s) |
---|
84 | aeivtr0 !!: eddy induced velocity coefficient (m2/s) |
---|
85 | |
---|
86 | |
---|
87 | !! passive tracers restart (input and output) |
---|
88 | !! -------------------------------------------------- |
---|
89 | LOGICAL, PUBLIC :: & |
---|
90 | lrsttr !!: boolean term for restart i/o for passive tracers (namelist) |
---|
91 | |
---|
92 | INTEGER , PUBLIC :: & |
---|
93 | nutwrs , & !!: output FILE for passive tracers restart |
---|
94 | nutrst , & !!: logical unit for restart FILE for passive tracers |
---|
95 | nrsttr !!: control of the time step ( 0 or 1 ) for pass. tr. |
---|
96 | |
---|
97 | |
---|
98 | !! interpolated gradient |
---|
99 | !!-------------------------------------------------- |
---|
100 | REAL (wp), PUBLIC, DIMENSION (jpi,jpj,jptra) :: & |
---|
101 | gtru , & !!: horizontal gradient at u-points at bottom ocean level |
---|
102 | gtrv !!: horizontal gradient at v-points at bottom ocean level |
---|
103 | |
---|
104 | |
---|
105 | #if defined key_trcldf_eiv && defined key_diaeiv |
---|
106 | !! The three component of the eddy induced velocity |
---|
107 | !! -------------------------------------------------- |
---|
108 | REAL(wp), PUBLIC, DIMENSION (jpi,jpj,jpk) :: & |
---|
109 | u_trc_eiv, & !!: u-eiv (m/s) |
---|
110 | v_trc_eiv, & !!: v-eiv (m/s) |
---|
111 | w_trc_eiv !!: w-eiv (m/s) |
---|
112 | #endif |
---|
113 | |
---|
114 | |
---|
115 | !! information for outputs |
---|
116 | !! -------------------------------------------------- |
---|
117 | INTEGER , PUBLIC :: & |
---|
118 | nwritetrc !!: time step frequency for concentration outputs (namelist) |
---|
119 | |
---|
120 | #if defined key_trc_diaadd |
---|
121 | !! additional 2D/3D outputs namelist |
---|
122 | !! -------------------------------------------------- |
---|
123 | CHARACTER(len=8), PUBLIC, DIMENSION (jpdia2d) :: & |
---|
124 | ctrc2d , & !!: 2d output field name |
---|
125 | ctrc2u !!: 2d output field unit |
---|
126 | |
---|
127 | CHARACTER(len=8), PUBLIC, DIMENSION (jpdia3d) :: & |
---|
128 | ctrc3d , & !!: 3d output field name |
---|
129 | ctrc3u !!: 3d output field unit |
---|
130 | |
---|
131 | CHARACTER(len=80), PUBLIC, DIMENSION (jpdia2d) :: & |
---|
132 | ctrc2l !!: 2d output field long name |
---|
133 | |
---|
134 | CHARACTER(len=80), PUBLIC, DIMENSION (jpdia3d) :: & |
---|
135 | ctrc3l !!: 3d output field long name |
---|
136 | |
---|
137 | REAL(wp), PUBLIC, DIMENSION (jpi,jpj,jpdia2d) :: & |
---|
138 | trc2d !!: additional 2d outputs |
---|
139 | |
---|
140 | REAL(wp), PUBLIC, DIMENSION (jpi,jpj,jpk,jpdia3d) :: & |
---|
141 | trc3d !!: additional 3d outputs |
---|
142 | |
---|
143 | |
---|
144 | !! netcdf files and index common |
---|
145 | !! -------------------------------------------------- |
---|
146 | INTEGER , PUBLIC :: & |
---|
147 | nwriteadd !!: frequency of additional arrays outputs(namelist) |
---|
148 | #endif |
---|
149 | |
---|
150 | #if defined key_trc_diatrd |
---|
151 | |
---|
152 | !! non conservative trends (biological, ...) |
---|
153 | !! -------------------------------------------------- |
---|
154 | LOGICAL, PUBLIC, DIMENSION (jptra) :: & |
---|
155 | luttrd !!: large trends diagnostic to write or not (namelist) |
---|
156 | |
---|
157 | !! dynamical trends |
---|
158 | !! trtrd() : trends of the tracer equations |
---|
159 | !! 1 : X advection |
---|
160 | !! 2 : Y advection |
---|
161 | !! 3 : Z advection |
---|
162 | !! 4 : X diffusion |
---|
163 | !! 5 : Y diffusion |
---|
164 | !! 6 : Z diffusion |
---|
165 | !! 7 : X gent velocity |
---|
166 | !! 8 : Y gent velocity |
---|
167 | !! 9 : Z gent velocity |
---|
168 | !! -------------------------------------------------- |
---|
169 | |
---|
170 | |
---|
171 | REAL(wp), PUBLIC, DIMENSION(:,:,:,:,:), ALLOCATABLE, SAVE :: & |
---|
172 | trtrd !!: trends of the tracer equations |
---|
173 | |
---|
174 | INTEGER, PUBLIC, DIMENSION(jptra), SAVE :: ikeep ! indice of tracer for which dyn trends are stored |
---|
175 | INTEGER, PUBLIC, SAVE :: nkeep ! number of tracers for which dyn trends are stored |
---|
176 | ! (used to allocate trtrd buffer) |
---|
177 | |
---|
178 | !! netcdf files and index common |
---|
179 | !! -------------------------------------------------- |
---|
180 | INTEGER , PUBLIC :: & |
---|
181 | nwritetrd !!: frequency of additional arrays outputs(namelist) |
---|
182 | |
---|
183 | #endif |
---|
184 | |
---|
185 | !! passive tracers data read and at given time_step |
---|
186 | !! -------------------------------------------------- |
---|
187 | #if defined key_dtatrc |
---|
188 | |
---|
189 | INTEGER , PUBLIC, DIMENSION(jptra) :: & |
---|
190 | numtr !!: logical unit for passive tracers data |
---|
191 | |
---|
192 | #endif |
---|
193 | |
---|
194 | !! 1D configuration |
---|
195 | !! -------------------------------------------------- |
---|
196 | #if defined key_cfg_1d |
---|
197 | LOGICAL, PARAMETER :: lk_trccfg_1d = .TRUE. !: 1D pass. tracer configuration flag |
---|
198 | #else |
---|
199 | LOGICAL, PARAMETER :: lk_trccfg_1d = .FALSE. !: 1D pass. tracer configuration flag |
---|
200 | #endif |
---|
201 | |
---|
202 | |
---|
203 | #else |
---|
204 | !!====================================================================== |
---|
205 | !! Empty module : No passive tracer |
---|
206 | !!====================================================================== |
---|
207 | #endif |
---|
208 | |
---|
209 | END MODULE trc |
---|