| 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 | |
|---|
| 91 | USE dom_oce , ONLY : & |
|---|
| 92 | nimppt => nimppt , & !:i-indexes for each processor |
|---|
| 93 | njmppt => njmppt , & !:j-indexes for each processor |
|---|
| 94 | ibonit => ibonit , & !:i-processor neighbour existence |
|---|
| 95 | ibonjt => ibonjt , & !:j- processor neighbour existence |
|---|
| 96 | nlcit => nlcit , & !:dimensions of every i-subdomain |
|---|
| 97 | nlcjt => nlcjt , & !:dimensions of every j-subdomain |
|---|
| 98 | nldit => nldit , & !:first indoor index for each i-domain |
|---|
| 99 | nleit => nleit , & !:last indoor index for each i-domain |
|---|
| 100 | nldjt => nldjt , & !:first indoor index for each j-domain |
|---|
| 101 | nlejt => nlejt !:last indoor index for each j-domain |
|---|
| 102 | |
|---|
| 103 | |
|---|
| 104 | !! horizontal curvilinear coordinate and scale factors |
|---|
| 105 | USE dom_oce , ONLY : & |
|---|
| 106 | glamt => glamt , & !: longitude of t-point (degre) |
|---|
| 107 | glamu => glamu , & !: longitude of t-point (degre) |
|---|
| 108 | glamv => glamv , & !: longitude of t-point (degre) |
|---|
| 109 | glamf => glamf , & !: longitude of t-point (degre) |
|---|
| 110 | gphit => gphit , & !: latitude of t-point (degre) |
|---|
| 111 | gphiu => gphiu , & !: latitude of t-point (degre) |
|---|
| 112 | gphiv => gphiv , & !: latitude of t-point (degre) |
|---|
| 113 | gphif => gphif , & !: latitude of t-point (degre) |
|---|
| 114 | e1t => e1t , & !: horizontal scale factors at t-point (m) |
|---|
| 115 | e2t => e2t , & !: horizontal scale factors at t-point (m) |
|---|
| 116 | e1u => e1u , & !: horizontal scale factors at u-point (m) |
|---|
| 117 | e2u => e2u , & !: horizontal scale factors at u-point (m) |
|---|
| 118 | e1v => e1v , & !: horizontal scale factors at v-point (m) |
|---|
| 119 | e2v => e2v !: horizontal scale factors at v-point (m) |
|---|
| 120 | |
|---|
| 121 | !! vertical coordinate and scale factors |
|---|
| 122 | USE dom_oce , ONLY : & |
|---|
| 123 | gdept => gdept , & !: reference depth of t-points (m) |
|---|
| 124 | e3t => e3t , & !: reference depth of t-points (m) |
|---|
| 125 | e3w => e3w , & !: reference depth of w-points (m) |
|---|
| 126 | gdepw => gdepw !: reference depth of w-points (m) |
|---|
| 127 | |
|---|
| 128 | USE dom_oce , ONLY : & |
|---|
| 129 | lk_zps => lk_zps , & !: partial steps flag |
|---|
| 130 | lk_sco => lk_sco , & !: s-coordinate flag |
|---|
| 131 | lk_zco => lk_zco !: z-coordinate flag |
|---|
| 132 | |
|---|
| 133 | USE lib_mpp , ONLY : & |
|---|
| 134 | lk_mpp => lk_mpp !: Mpp flag |
|---|
| 135 | |
|---|
| 136 | USE dynspg_fsc , ONLY : & |
|---|
| 137 | lk_dynspg_fsc => lk_dynspg_fsc !: free surface constant volume flag |
|---|
| 138 | |
|---|
| 139 | USE dynspg_fsc_atsk , ONLY : & |
|---|
| 140 | lk_dynspg_fsc_tsk => lk_dynspg_fsc_tsk !: free surface constant volume flag |
|---|
| 141 | |
|---|
| 142 | #if defined key_partial_steps |
|---|
| 143 | !! Partial steps ('key_partial_steps') |
|---|
| 144 | !! ----------------------------------- |
|---|
| 145 | USE dom_oce , ONLY : & |
|---|
| 146 | gdep3w => gdep3w , & !: ??? |
|---|
| 147 | gdept_ps => gdept_ps, & !: depth of t-points (m) |
|---|
| 148 | gdepw_ps => gdepw_ps, & !: depth of t-points (m) |
|---|
| 149 | e3t_ps => e3t_ps , & !: vertical scale factors at t- |
|---|
| 150 | e3u_ps => e3u_ps , & !: vertical scale factors at u- |
|---|
| 151 | e3v_ps => e3v_ps , & !: vertical scale factors v- |
|---|
| 152 | e3w_ps => e3w_ps , & !: w-points (m) |
|---|
| 153 | e3f_ps => e3f_ps , & !: f-points (m) |
|---|
| 154 | e3uw_ps => e3uw_ps , & !: uw-points (m) |
|---|
| 155 | e3vw_ps => e3vw_ps !: vw-points (m) |
|---|
| 156 | |
|---|
| 157 | USE oce , ONLY : & |
|---|
| 158 | gtu => gtu , & !: t- horizontal gradient at u- |
|---|
| 159 | gtv => gtv !: and v-points at bottom ocean level |
|---|
| 160 | #endif |
|---|
| 161 | |
|---|
| 162 | #if defined key_s_coord |
|---|
| 163 | USE dom_oce , ONLY : & |
|---|
| 164 | hbatt => hbatt , & !: ocean depth at the vertical of t-point (m) |
|---|
| 165 | hbatu => hbatu , & !: ocean depth at the vertical of u-point (m) |
|---|
| 166 | hbatv => hbatv , & !: ocean depth at the vertical of w-point (m) |
|---|
| 167 | gsigt => gsigt , & !: model level depth coefficient at t-, & w-levelsvertical scale factors at u- |
|---|
| 168 | gsigw => gsigw , & !: model level depth coefficient at t-, & w-levelsvertical scale factors v- |
|---|
| 169 | gsi3w => gsi3w , & !: model level depth coef at w-levels (defined as the sum of e3w) |
|---|
| 170 | esigt => esigt , & !: vertical scale factor coef. at t-levels |
|---|
| 171 | esigw => esigw !: vertical scale factor coef. at w-levels |
|---|
| 172 | #endif |
|---|
| 173 | |
|---|
| 174 | !! masks, bathymetry |
|---|
| 175 | USE dom_oce , ONLY : & |
|---|
| 176 | mbathy => mbathy, & !: number of ocean level (=0, & 1, ... , jpk-1) |
|---|
| 177 | tmask_i => tmask_i, & !: Interior mask at t-points |
|---|
| 178 | tmask => tmask , & !: land/ocean mask at t-points |
|---|
| 179 | umask => umask , & !: land/ocean mask at u-points |
|---|
| 180 | vmask => vmask , & !: land/ocean mask at v-points |
|---|
| 181 | fmask => fmask !: land/ocean mask at f-points |
|---|
| 182 | |
|---|
| 183 | USE dom_oce , ONLY : & |
|---|
| 184 | n_cla => n_cla !: flag (0/1) for cross land advection |
|---|
| 185 | |
|---|
| 186 | !! time domain |
|---|
| 187 | USE dom_oce , ONLY : & |
|---|
| 188 | neuler => neuler, & !: restart euler forward option (0=Euler) |
|---|
| 189 | rdt => rdt , & !: time step for the dynamics |
|---|
| 190 | atfp => atfp , & !: asselin time filter parameter |
|---|
| 191 | atfp1 => atfp1 , & !: asselin time filter coeff. (atfp1= 1-2*atfp) |
|---|
| 192 | rdttra => rdttra !: vertical profile of tracer time step |
|---|
| 193 | |
|---|
| 194 | USE daymod , ONLY : & |
|---|
| 195 | ndastp => ndastp, & !: time step date in year/month/day aammjj |
|---|
| 196 | nday_year => nday_year, & !: curent day counted from jan 1st of the current year |
|---|
| 197 | nyear => nyear, & !: Current year |
|---|
| 198 | nmonth => nmonth, & !: Current month |
|---|
| 199 | nday => nday !: Current day |
|---|
| 200 | |
|---|
| 201 | !! physical constants |
|---|
| 202 | USE phycst , ONLY : & |
|---|
| 203 | ra => ra , & !: earth radius |
|---|
| 204 | rpi => rpi , & !: pi |
|---|
| 205 | rday => rday , & !: day |
|---|
| 206 | rauw => rauw , & !: density of pure water kg/m3 |
|---|
| 207 | ro0cpr => ro0cpr, & !: = 1. / ( rau0 * rcp ) |
|---|
| 208 | rad => rad , & !: conversion coeff. from degre into radian |
|---|
| 209 | raass => raass , & !: number of seconds in one year |
|---|
| 210 | rmoss => rmoss , & !: number of seconds in one month |
|---|
| 211 | rjjss => rjjss !: number of seconds in one day |
|---|
| 212 | |
|---|
| 213 | !! present fields (now) |
|---|
| 214 | USE oce , ONLY : & |
|---|
| 215 | ua => ua , & !: i-horizontal velocity (m s-1) |
|---|
| 216 | va => va , & !: j-horizontal velocity (m s-1) |
|---|
| 217 | un => un , & !: i-horizontal velocity (m s-1) |
|---|
| 218 | vn => vn , & !: j-horizontal velocity (m s-1) |
|---|
| 219 | wn => wn , & !: vertical velocity (m s-1) |
|---|
| 220 | tn => tn , & !: pot. temperature (celsius) |
|---|
| 221 | sn => sn , & !: salinity (psu) |
|---|
| 222 | rhop => rhop , & !: potential volumic mass (kg m-3) |
|---|
| 223 | rhd => rhd !: in situ density anomalie rhd=(rho-rau0)/rau0 (no units) |
|---|
| 224 | |
|---|
| 225 | #if defined key_trc_diatrd |
|---|
| 226 | USE oce , ONLY : & |
|---|
| 227 | hdivn => hdivn !: horizontal divergence (1/s) |
|---|
| 228 | #endif |
|---|
| 229 | |
|---|
| 230 | #if defined key_flx_bulk_monthly || defined key_flx_bulk_daily |
|---|
| 231 | !! wind speed |
|---|
| 232 | USE blk_oce , ONLY : & |
|---|
| 233 | vatm => vatm !: wind speed at sea surface (m s-1) |
|---|
| 234 | #endif |
|---|
| 235 | |
|---|
| 236 | !! wind speed |
|---|
| 237 | USE taumod , ONLY : & |
|---|
| 238 | taux => taux , & !: i-surface stress component |
|---|
| 239 | tauy => tauy !: j-surface stress component |
|---|
| 240 | |
|---|
| 241 | #if defined key_trabbl_dif || defined key_trabbl_adv |
|---|
| 242 | USE trabbl , ONLY : & |
|---|
| 243 | atrbbl => atrbbl !: lateral coeff. for bottom boundary layer scheme (m2/s) |
|---|
| 244 | # if defined key_off_tra |
|---|
| 245 | USE trabbl, ONLY : & |
|---|
| 246 | bblx => bblx, & |
|---|
| 247 | bbly => bbly |
|---|
| 248 | # endif |
|---|
| 249 | #endif |
|---|
| 250 | |
|---|
| 251 | !! lateral diffusivity (tracers) |
|---|
| 252 | USE ldftra_oce , ONLY : & |
|---|
| 253 | aht0 => aht0 , & !: horizontal eddy diffusivity for tracers (m2/s) |
|---|
| 254 | ahtb0 => ahtb0 , & !: background eddy diffusivity for isopycnal diff. (m2/s) |
|---|
| 255 | ahtu => ahtu , & !: lateral diffusivity coef. at u-points |
|---|
| 256 | ahtv => ahtv , & !: lateral diffusivity coef. at v-points |
|---|
| 257 | ahtw => ahtw , & !: lateral diffusivity coef. at w-points |
|---|
| 258 | ahtt => ahtt , & !: lateral diffusivity coef. at t-points |
|---|
| 259 | aeiv0 => aeiv0 , & !: eddy induced velocity coefficient (m2/s) |
|---|
| 260 | aeiu => aeiu , & !: eddy induced velocity coef. at u-points (m2/s) |
|---|
| 261 | aeiv => aeiv , & !: eddy induced velocity coef. at v-points (m2/s) |
|---|
| 262 | aeiw => aeiw !: eddy induced velocity coef. at w-points (m2/s) |
|---|
| 263 | |
|---|
| 264 | !! vertical diffusion |
|---|
| 265 | USE zdf_oce , ONLY : & |
|---|
| 266 | avt => avt , & !: vert. diffusivity coef. at w-point for temp |
|---|
| 267 | avt0 => avt0 , & !: vertical eddy diffusivity for tracers (m2/s) |
|---|
| 268 | #if ! defined key_off_tra |
|---|
| 269 | l_trazdf_exp => l_trazdf_exp , & !: explicit vertical diffusion scheme flag |
|---|
| 270 | #endif |
|---|
| 271 | ln_zdfnpc => ln_zdfnpc !: convection: non-penetrative convection flag |
|---|
| 272 | |
|---|
| 273 | |
|---|
| 274 | #if defined key_zdfddm |
|---|
| 275 | USE zdfddm , ONLY : & |
|---|
| 276 | avs => avs !: salinity vertical diffusivity coeff. at w-point |
|---|
| 277 | #endif |
|---|
| 278 | |
|---|
| 279 | !! penetrative solar radiation |
|---|
| 280 | USE traqsr , ONLY : & |
|---|
| 281 | xsi1 => xsi1 !: first depth of extinction |
|---|
| 282 | |
|---|
| 283 | !! surface fluxes |
|---|
| 284 | USE ocesbc , ONLY : & |
|---|
| 285 | qt => qt , & !: total surface heat flux (w m-2) |
|---|
| 286 | qsr => qsr , & !: penetrative solar radiation (w m-2) |
|---|
| 287 | emp => emp , & !: evaporation minus precipitation (kg m-2 s-2) |
|---|
| 288 | emps => emps !: evaporation minus precipitation (kg m-2 s-2) |
|---|
| 289 | |
|---|
| 290 | !! freezing area |
|---|
| 291 | USE ocfzpt , ONLY : & |
|---|
| 292 | freeze => freeze, & !: ice mask (0 or 1) |
|---|
| 293 | fzptn => fzptn !: now freezing temperature at ocean surface |
|---|
| 294 | |
|---|
| 295 | |
|---|
| 296 | !! mixing layer depth (turbocline) |
|---|
| 297 | USE zdfmxl , ONLY : & |
|---|
| 298 | hmld => hmld , & !: mixing layer depth (turbocline) |
|---|
| 299 | hmlp => hmlp , & !: mixed layer depth (rho=rho0+zdcrit) (m) |
|---|
| 300 | hmlpt => hmlpt !: mixed layer depth at t-points (m) |
|---|
| 301 | |
|---|
| 302 | USE ldfslp , ONLY : & |
|---|
| 303 | lk_ldfslp => lk_ldfslp !: slopes flag |
|---|
| 304 | #if defined key_ldfslp |
|---|
| 305 | !! direction of lateral diffusion (momentum tracers) |
|---|
| 306 | USE ldfslp , ONLY : & |
|---|
| 307 | uslp => uslp , & !: i-direction slope at u-, w-points |
|---|
| 308 | vslp => vslp , & !: j-direction slope at v-, w-points |
|---|
| 309 | wslpi => wslpi , & !: i-direction slope at u-, w-points |
|---|
| 310 | wslpj => wslpj !: j-direction slope at v-, w-points |
|---|
| 311 | #endif |
|---|
| 312 | |
|---|
| 313 | !! ocean forcings runoff |
|---|
| 314 | USE flxrnf , ONLY : & |
|---|
| 315 | upsrnfh => upsrnfh , & !: mixed adv scheme in runoffs vicinity (hori.) |
|---|
| 316 | upsrnfz => upsrnfz , & !: mixed adv scheme in runoffs vicinity (vert.) |
|---|
| 317 | upsadv => upsadv !: mixed adv scheme in straits vicinity (hori.) |
|---|
| 318 | |
|---|
| 319 | END MODULE oce_trc |
|---|
