1 | MODULE oce_trc |
---|
2 | !!====================================================================== |
---|
3 | !! *** MODULE oce_trc *** |
---|
4 | !! Ocean passive tracer : share ocean-passive tracers variables |
---|
5 | !!====================================================================== |
---|
6 | !! History : |
---|
7 | !! 9.0 ! 04-03 (C. Ethe) F90: Free form and module |
---|
8 | !!---------------------------------------------------------------------- |
---|
9 | !! TOP 1.0, LOCEAN-IPSL (2005) |
---|
10 | !! $Header$ |
---|
11 | !! This software is governed by the CeCILL licence see modipsl/doc/NEMO_CeCILL.txt |
---|
12 | !!---------------------------------------------------------------------- |
---|
13 | !! * Modules used |
---|
14 | !! Domain characteristics |
---|
15 | USE par_oce , ONLY : & |
---|
16 | cp_cfg => cp_cfg, & !: name of the configuration |
---|
17 | jp_cfg => jp_cfg, & !: resolution of the configuration |
---|
18 | jpiglo => jpiglo, & !: first dimension of global domain --> i |
---|
19 | jpjglo => jpjglo, & !: second dimension of global domain --> j |
---|
20 | jpi => jpi , & !: first dimension of grid --> i |
---|
21 | jpj => jpj , & !: second dimension of grid --> j |
---|
22 | jpk => jpk , & !: number of levels |
---|
23 | jpim1 => jpim1 , & !: jpi - 1 |
---|
24 | jpjm1 => jpjm1 , & !: jpj - 1 |
---|
25 | jpkm1 => jpkm1 , & !: jpk - 1 |
---|
26 | jpij => jpij , & !: jpi x jpj |
---|
27 | jpidta => jpidta, & !: first horizontal dimension > or = jpi |
---|
28 | jpjdta => jpjdta, & !: second horizontal dimension > or = jpj |
---|
29 | jpkdta => jpkdta, & !: number of levels > or = jpk |
---|
30 | lk_esopa => lk_esopa !: flag to activate the all option |
---|
31 | |
---|
32 | |
---|
33 | !! namelist parameters |
---|
34 | USE in_out_manager , ONLY : & |
---|
35 | cexper => cexper, & !: experience name for vairmer format |
---|
36 | no => no , & !: job number |
---|
37 | nrstdt => nrstdt, & !: control of the time step (0, & 1 or 2) |
---|
38 | nit000 => nit000, & !: number of the first time step |
---|
39 | nitend => nitend, & !: number of the last time step |
---|
40 | nleapy => nleapy, & !: Leap year calendar (0/1) |
---|
41 | nwrite => nwrite, & !: frequency of OUTPUT file |
---|
42 | nstock => nstock, & !: frequency of restart file |
---|
43 | nprint => nprint, & !: level of print (0 no print) |
---|
44 | lwp => lwp , & !: boolean term for mpp output |
---|
45 | ln_ctl => ln_ctl, & !: = ln_ctl.AND.lwp (print control on the 1st proc) |
---|
46 | nictls => nictls, & !: Start i indice for the SUM control |
---|
47 | nictle => nictle, & !: End i indice for the SUM control |
---|
48 | njctls => njctls, & !: Start j indice for the SUM control |
---|
49 | njctle => njctle, & !: End j indice for the SUM control |
---|
50 | isplt => isplt , & !: number of processors following i |
---|
51 | jsplt => jsplt , & !: number of processors following j |
---|
52 | ijsplt => ijsplt, & !: nb of local domain = nb of processors |
---|
53 | numout => numout !: logical unit for output print |
---|
54 | |
---|
55 | |
---|
56 | !! run controm |
---|
57 | USE in_out_manager , ONLY : & |
---|
58 | nstop => nstop , & !: e r r o r flag (=number of reason for a |
---|
59 | ! ! prematurely stop the run) |
---|
60 | nwarn => nwarn , & !: w a r n i n g flag (=number of warning |
---|
61 | ! ! found during the run) |
---|
62 | cform_err => cform_err, & !: |
---|
63 | cform_war => cform_war !: |
---|
64 | |
---|
65 | USE dom_oce , ONLY : & |
---|
66 | lzoom => lzoom , & !: zoom flag |
---|
67 | lzoom_e => lzoom_e , & !: East zoom type flag |
---|
68 | lzoom_w => lzoom_w , & !: West zoom type flag |
---|
69 | lzoom_s => lzoom_s , & !: South zoom type flag |
---|
70 | lzoom_n => lzoom_n , & !: North zoom type flag |
---|
71 | lzoom_arct => lzoom_arct, & !: ORCA arctic zoom flag |
---|
72 | lzoom_anta => lzoom_anta !: ORCA antarctic zoom flag |
---|
73 | |
---|
74 | |
---|
75 | |
---|
76 | USE dom_oce , ONLY : & |
---|
77 | nperio => nperio, & !: type of lateral boundary condition |
---|
78 | nlci => nlci , & !: index i for the sub domain left bottom |
---|
79 | nlcj => nlcj , & !: index j for the sub domain left bottom |
---|
80 | nimpp => nimpp , & !: i index for mpp-subdomain left bottom |
---|
81 | njmpp => njmpp , & !: j index for mpp-subdomain left bottom |
---|
82 | nproc => nproc , & !: number for local processor |
---|
83 | narea => narea , & !: number for local area |
---|
84 | mig => mig , & !: local ==> global domain i-indice |
---|
85 | mjg => mjg , & !: local ==> global domain i-indice |
---|
86 | mi0 => mi0 , & !: global ==> local domain i-indice |
---|
87 | mi1 => mi1 , & !: (mi0=1 and mi1=0 if the global indice is not in the local domain) |
---|
88 | mj0 => mj0 , & !: global ==> local domain j-indice |
---|
89 | mj1 => mj1 , & !: (mj0=1 and mj1=0 if the global indice is not in the local domain) |
---|
90 | nidom => nidom |
---|
91 | |
---|
92 | USE dom_oce , ONLY : & |
---|
93 | nimppt => nimppt , & !:i-indexes for each processor |
---|
94 | njmppt => njmppt , & !:j-indexes for each processor |
---|
95 | ibonit => ibonit , & !:i-processor neighbour existence |
---|
96 | ibonjt => ibonjt , & !:j- processor neighbour existence |
---|
97 | nlcit => nlcit , & !:dimensions of every i-subdomain |
---|
98 | nlcjt => nlcjt , & !:dimensions of every j-subdomain |
---|
99 | nldit => nldit , & !:first indoor index for each i-domain |
---|
100 | nleit => nleit , & !:last indoor index for each i-domain |
---|
101 | nldjt => nldjt , & !:first indoor index for each j-domain |
---|
102 | nlejt => nlejt !:last indoor index for each j-domain |
---|
103 | |
---|
104 | |
---|
105 | !! horizontal curvilinear coordinate and scale factors |
---|
106 | USE dom_oce , ONLY : & |
---|
107 | glamt => glamt , & !: longitude of t-point (degre) |
---|
108 | glamu => glamu , & !: longitude of t-point (degre) |
---|
109 | glamv => glamv , & !: longitude of t-point (degre) |
---|
110 | glamf => glamf , & !: longitude of t-point (degre) |
---|
111 | gphit => gphit , & !: latitude of t-point (degre) |
---|
112 | gphiu => gphiu , & !: latitude of t-point (degre) |
---|
113 | gphiv => gphiv , & !: latitude of t-point (degre) |
---|
114 | gphif => gphif , & !: latitude of t-point (degre) |
---|
115 | e1t => e1t , & !: horizontal scale factors at t-point (m) |
---|
116 | e2t => e2t , & !: horizontal scale factors at t-point (m) |
---|
117 | e1u => e1u , & !: horizontal scale factors at u-point (m) |
---|
118 | e2u => e2u , & !: horizontal scale factors at u-point (m) |
---|
119 | e1v => e1v , & !: horizontal scale factors at v-point (m) |
---|
120 | e2v => e2v !: horizontal scale factors at v-point (m) |
---|
121 | |
---|
122 | !! vertical coordinate and scale factors |
---|
123 | USE dom_oce , ONLY : & |
---|
124 | gdept => gdept , & !: reference depth of t-points (m) |
---|
125 | e3t => e3t , & !: reference depth of t-points (m) |
---|
126 | e3w => e3w , & !: reference depth of w-points (m) |
---|
127 | gdepw => gdepw !: reference depth of w-points (m) |
---|
128 | |
---|
129 | USE dom_oce , ONLY : & |
---|
130 | lk_zps => lk_zps , & !: partial steps flag |
---|
131 | lk_sco => lk_sco , & !: s-coordinate flag |
---|
132 | lk_zco => lk_zco !: z-coordinate flag |
---|
133 | |
---|
134 | USE lib_mpp , ONLY : & |
---|
135 | lk_mpp => lk_mpp !: Mpp flag |
---|
136 | |
---|
137 | USE dynspg_fsc , ONLY : & |
---|
138 | lk_dynspg_fsc => lk_dynspg_fsc !: free surface constant volume flag |
---|
139 | |
---|
140 | USE dynspg_fsc_atsk , ONLY : & |
---|
141 | lk_dynspg_fsc_tsk => lk_dynspg_fsc_tsk !: free surface constant volume flag |
---|
142 | |
---|
143 | #if defined key_partial_steps |
---|
144 | !! Partial steps ('key_partial_steps') |
---|
145 | !! ----------------------------------- |
---|
146 | USE dom_oce , ONLY : & |
---|
147 | gdep3w => gdep3w , & !: ??? |
---|
148 | gdept_ps => gdept_ps, & !: depth of t-points (m) |
---|
149 | gdepw_ps => gdepw_ps, & !: depth of t-points (m) |
---|
150 | e3t_ps => e3t_ps , & !: vertical scale factors at t- |
---|
151 | e3u_ps => e3u_ps , & !: vertical scale factors at u- |
---|
152 | e3v_ps => e3v_ps , & !: vertical scale factors v- |
---|
153 | e3w_ps => e3w_ps , & !: w-points (m) |
---|
154 | e3f_ps => e3f_ps , & !: f-points (m) |
---|
155 | e3uw_ps => e3uw_ps , & !: uw-points (m) |
---|
156 | e3vw_ps => e3vw_ps !: vw-points (m) |
---|
157 | |
---|
158 | USE oce , ONLY : & |
---|
159 | gtu => gtu , & !: t- horizontal gradient at u- |
---|
160 | gtv => gtv !: and v-points at bottom ocean level |
---|
161 | #endif |
---|
162 | |
---|
163 | #if defined key_s_coord |
---|
164 | USE dom_oce , ONLY : & |
---|
165 | hbatt => hbatt , & !: ocean depth at the vertical of t-point (m) |
---|
166 | hbatu => hbatu , & !: ocean depth at the vertical of u-point (m) |
---|
167 | hbatv => hbatv , & !: ocean depth at the vertical of w-point (m) |
---|
168 | gsigt => gsigt , & !: model level depth coefficient at t-, & w-levelsvertical scale factors at u- |
---|
169 | gsigw => gsigw , & !: model level depth coefficient at t-, & w-levelsvertical scale factors v- |
---|
170 | gsi3w => gsi3w , & !: model level depth coef at w-levels (defined as the sum of e3w) |
---|
171 | esigt => esigt , & !: vertical scale factor coef. at t-levels |
---|
172 | esigw => esigw !: vertical scale factor coef. at w-levels |
---|
173 | #endif |
---|
174 | |
---|
175 | !! masks, bathymetry |
---|
176 | USE dom_oce , ONLY : & |
---|
177 | mbathy => mbathy, & !: number of ocean level (=0, & 1, ... , jpk-1) |
---|
178 | tmask_i => tmask_i, & !: Interior mask at t-points |
---|
179 | tmask => tmask , & !: land/ocean mask at t-points |
---|
180 | umask => umask , & !: land/ocean mask at u-points |
---|
181 | vmask => vmask , & !: land/ocean mask at v-points |
---|
182 | fmask => fmask !: land/ocean mask at f-points |
---|
183 | |
---|
184 | USE dom_oce , ONLY : & |
---|
185 | n_cla => n_cla !: flag (0/1) for cross land advection |
---|
186 | |
---|
187 | !! time domain |
---|
188 | USE dom_oce , ONLY : & |
---|
189 | neuler => neuler, & !: restart euler forward option (0=Euler) |
---|
190 | rdt => rdt , & !: time step for the dynamics |
---|
191 | atfp => atfp , & !: asselin time filter parameter |
---|
192 | atfp1 => atfp1 , & !: asselin time filter coeff. (atfp1= 1-2*atfp) |
---|
193 | rdttra => rdttra !: vertical profile of tracer time step |
---|
194 | |
---|
195 | USE daymod , ONLY : & |
---|
196 | ndastp => ndastp, & !: time step date in year/month/day aammjj |
---|
197 | nday_year => nday_year, & !: curent day counted from jan 1st of the current year |
---|
198 | nyear => nyear, & !: Current year |
---|
199 | nmonth => nmonth, & !: Current month |
---|
200 | nday => nday !: Current day |
---|
201 | |
---|
202 | !! physical constants |
---|
203 | USE phycst , ONLY : & |
---|
204 | ra => ra , & !: earth radius |
---|
205 | rpi => rpi , & !: pi |
---|
206 | rday => rday , & !: day |
---|
207 | rauw => rauw , & !: density of pure water kg/m3 |
---|
208 | ro0cpr => ro0cpr, & !: = 1. / ( rau0 * rcp ) |
---|
209 | rad => rad , & !: conversion coeff. from degre into radian |
---|
210 | raass => raass , & !: number of seconds in one year |
---|
211 | rmoss => rmoss , & !: number of seconds in one month |
---|
212 | rjjss => rjjss !: number of seconds in one day |
---|
213 | |
---|
214 | !! present fields (now) |
---|
215 | USE oce , ONLY : & |
---|
216 | ua => ua , & !: i-horizontal velocity (m s-1) |
---|
217 | va => va , & !: j-horizontal velocity (m s-1) |
---|
218 | un => un , & !: i-horizontal velocity (m s-1) |
---|
219 | vn => vn , & !: j-horizontal velocity (m s-1) |
---|
220 | wn => wn , & !: vertical velocity (m s-1) |
---|
221 | tn => tn , & !: pot. temperature (celsius) |
---|
222 | sn => sn , & !: salinity (psu) |
---|
223 | rhop => rhop , & !: potential volumic mass (kg m-3) |
---|
224 | rhd => rhd !: in situ density anomalie rhd=(rho-rau0)/rau0 (no units) |
---|
225 | |
---|
226 | #if defined key_trc_diatrd |
---|
227 | USE oce , ONLY : & |
---|
228 | hdivn => hdivn !: horizontal divergence (1/s) |
---|
229 | #endif |
---|
230 | |
---|
231 | #if defined key_flx_bulk_monthly || defined key_flx_bulk_daily |
---|
232 | !! wind speed |
---|
233 | USE blk_oce , ONLY : & |
---|
234 | vatm => vatm !: wind speed at sea surface (m s-1) |
---|
235 | #endif |
---|
236 | |
---|
237 | !! wind speed |
---|
238 | USE taumod , ONLY : & |
---|
239 | taux => taux , & !: i-surface stress component |
---|
240 | tauy => tauy !: j-surface stress component |
---|
241 | |
---|
242 | #if defined key_trabbl_dif || defined key_trabbl_adv |
---|
243 | USE trabbl , ONLY : & |
---|
244 | atrbbl => atrbbl !: lateral coeff. for bottom boundary layer scheme (m2/s) |
---|
245 | # if defined key_off_tra |
---|
246 | USE trabbl, ONLY : & |
---|
247 | bblx => bblx, & |
---|
248 | bbly => bbly |
---|
249 | # endif |
---|
250 | #endif |
---|
251 | |
---|
252 | !! lateral diffusivity (tracers) |
---|
253 | USE ldftra_oce , ONLY : & |
---|
254 | aht0 => aht0 , & !: horizontal eddy diffusivity for tracers (m2/s) |
---|
255 | ahtb0 => ahtb0 , & !: background eddy diffusivity for isopycnal diff. (m2/s) |
---|
256 | ahtu => ahtu , & !: lateral diffusivity coef. at u-points |
---|
257 | ahtv => ahtv , & !: lateral diffusivity coef. at v-points |
---|
258 | ahtw => ahtw , & !: lateral diffusivity coef. at w-points |
---|
259 | ahtt => ahtt , & !: lateral diffusivity coef. at t-points |
---|
260 | aeiv0 => aeiv0 , & !: eddy induced velocity coefficient (m2/s) |
---|
261 | aeiu => aeiu , & !: eddy induced velocity coef. at u-points (m2/s) |
---|
262 | aeiv => aeiv , & !: eddy induced velocity coef. at v-points (m2/s) |
---|
263 | aeiw => aeiw !: eddy induced velocity coef. at w-points (m2/s) |
---|
264 | |
---|
265 | !! vertical diffusion |
---|
266 | USE zdf_oce , ONLY : & |
---|
267 | avt => avt , & !: vert. diffusivity coef. at w-point for temp |
---|
268 | avt0 => avt0 , & !: vertical eddy diffusivity for tracers (m2/s) |
---|
269 | #if ! defined key_off_tra |
---|
270 | l_trazdf_exp => l_trazdf_exp , & !: explicit vertical diffusion scheme flag |
---|
271 | #endif |
---|
272 | ln_zdfnpc => ln_zdfnpc !: convection: non-penetrative convection flag |
---|
273 | |
---|
274 | |
---|
275 | #if defined key_zdfddm |
---|
276 | USE zdfddm , ONLY : & |
---|
277 | avs => avs !: salinity vertical diffusivity coeff. at w-point |
---|
278 | #endif |
---|
279 | |
---|
280 | !! penetrative solar radiation |
---|
281 | USE traqsr , ONLY : & |
---|
282 | xsi1 => xsi1 !: first depth of extinction |
---|
283 | |
---|
284 | !! surface fluxes |
---|
285 | USE ocesbc , ONLY : & |
---|
286 | qt => qt , & !: total surface heat flux (w m-2) |
---|
287 | qsr => qsr , & !: penetrative solar radiation (w m-2) |
---|
288 | emp => emp , & !: evaporation minus precipitation (kg m-2 s-2) |
---|
289 | emps => emps !: evaporation minus precipitation (kg m-2 s-2) |
---|
290 | |
---|
291 | !! freezing area |
---|
292 | USE ocfzpt , ONLY : & |
---|
293 | freeze => freeze, & !: ice mask (0 or 1) |
---|
294 | fzptn => fzptn !: now freezing temperature at ocean surface |
---|
295 | |
---|
296 | |
---|
297 | !! mixing layer depth (turbocline) |
---|
298 | USE zdfmxl , ONLY : & |
---|
299 | hmld => hmld , & !: mixing layer depth (turbocline) |
---|
300 | hmlp => hmlp , & !: mixed layer depth (rho=rho0+zdcrit) (m) |
---|
301 | hmlpt => hmlpt !: mixed layer depth at t-points (m) |
---|
302 | |
---|
303 | USE ldfslp , ONLY : & |
---|
304 | lk_ldfslp => lk_ldfslp !: slopes flag |
---|
305 | #if defined key_ldfslp |
---|
306 | !! direction of lateral diffusion (momentum tracers) |
---|
307 | USE ldfslp , ONLY : & |
---|
308 | uslp => uslp , & !: i-direction slope at u-, w-points |
---|
309 | vslp => vslp , & !: j-direction slope at v-, w-points |
---|
310 | wslpi => wslpi , & !: i-direction slope at u-, w-points |
---|
311 | wslpj => wslpj !: j-direction slope at v-, w-points |
---|
312 | #endif |
---|
313 | |
---|
314 | !! ocean forcings runoff |
---|
315 | USE flxrnf , ONLY : & |
---|
316 | upsrnfh => upsrnfh , & !: mixed adv scheme in runoffs vicinity (hori.) |
---|
317 | upsrnfz => upsrnfz , & !: mixed adv scheme in runoffs vicinity (vert.) |
---|
318 | upsadv => upsadv !: mixed adv scheme in straits vicinity (hori.) |
---|
319 | |
---|
320 | END MODULE oce_trc |
---|