| 1 | MODULE oce_trc |
|---|
| 2 | !!====================================================================== |
|---|
| 3 | !! *** MODULE oce_trc *** |
|---|
| 4 | !! TOP : variables shared between ocean and passive tracers |
|---|
| 5 | !!====================================================================== |
|---|
| 6 | !! History : 1.0 ! 2004-03 (C. Ethe) original code |
|---|
| 7 | !! 2.0 ! 2007-12 (C. Ethe, G. Madec) rewritting |
|---|
| 8 | !!---------------------------------------------------------------------- |
|---|
| 9 | !! NEMO/TOP 2.0, LOCEAN-IPSL (2007) |
|---|
| 10 | !! $Id$ |
|---|
| 11 | !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt) |
|---|
| 12 | !!---------------------------------------------------------------------- |
|---|
| 13 | #if defined key_top |
|---|
| 14 | !!---------------------------------------------------------------------- |
|---|
| 15 | !! 'key_top' TOP models |
|---|
| 16 | !!---------------------------------------------------------------------- |
|---|
| 17 | |
|---|
| 18 | !* Domain size * |
|---|
| 19 | USE par_oce , ONLY : cp_cfg => cp_cfg !: name of the configuration |
|---|
| 20 | USE par_oce , ONLY : jp_cfg => jp_cfg !: resolution of the configuration |
|---|
| 21 | USE par_oce , ONLY : jpiglo => jpiglo !: first dimension of global domain --> i |
|---|
| 22 | USE par_oce , ONLY : jpjglo => jpjglo !: second dimension of global domain --> j |
|---|
| 23 | USE par_oce , ONLY : jpi => jpi !: first dimension of grid --> i |
|---|
| 24 | USE par_oce , ONLY : jpj => jpj !: second dimension of grid --> j |
|---|
| 25 | USE par_oce , ONLY : jpk => jpk !: number of levels |
|---|
| 26 | USE par_oce , ONLY : jpim1 => jpim1 !: jpi - 1 |
|---|
| 27 | USE par_oce , ONLY : jpjm1 => jpjm1 !: jpj - 1 |
|---|
| 28 | USE par_oce , ONLY : jpkm1 => jpkm1 !: jpk - 1 |
|---|
| 29 | USE par_oce , ONLY : jpij => jpij !: jpi x jpj |
|---|
| 30 | USE par_oce , ONLY : jpidta => jpidta !: first horizontal dimension > or = jpi |
|---|
| 31 | USE par_oce , ONLY : jpjdta => jpjdta !: second horizontal dimension > or = jpj |
|---|
| 32 | USE par_oce , ONLY : jpkdta => jpkdta !: number of levels > or = jpk |
|---|
| 33 | USE par_oce , ONLY : lk_esopa => lk_esopa !: flag to activate the all option |
|---|
| 34 | USE par_oce , ONLY : jp_tem => jp_tem !: indice for temperature |
|---|
| 35 | USE par_oce , ONLY : jp_sal => jp_sal !: indice for salinity |
|---|
| 36 | |
|---|
| 37 | !* IO manager * |
|---|
| 38 | USE in_out_manager ! use all the variables |
|---|
| 39 | !* physical constants * |
|---|
| 40 | USE phycst ! use all the variables |
|---|
| 41 | |
|---|
| 42 | !* model domain * |
|---|
| 43 | USE dom_oce , ONLY : lzoom => lzoom !: zoom flag |
|---|
| 44 | USE dom_oce , ONLY : lzoom_e => lzoom_e !: East zoom type flag |
|---|
| 45 | USE dom_oce , ONLY : lzoom_w => lzoom_w !: West zoom type flag |
|---|
| 46 | USE dom_oce , ONLY : lzoom_s => lzoom_s !: South zoom type flag |
|---|
| 47 | USE dom_oce , ONLY : lzoom_n => lzoom_n !: North zoom type flag |
|---|
| 48 | USE dom_oce , ONLY : lzoom_arct => lzoom_arct !: ORCA arctic zoom flag |
|---|
| 49 | USE dom_oce , ONLY : lzoom_anta => lzoom_anta !: ORCA antarctic zoom flag |
|---|
| 50 | USE dom_oce , ONLY : nperio => nperio !: type of lateral boundary condition |
|---|
| 51 | USE dom_oce , ONLY : nimpp => nimpp !: i index for mpp-subdomain left bottom |
|---|
| 52 | USE dom_oce , ONLY : njmpp => njmpp !: j index for mpp-subdomain left bottom |
|---|
| 53 | USE dom_oce , ONLY : nproc => nproc !: number for local processor |
|---|
| 54 | USE dom_oce , ONLY : narea => narea !: number for local area |
|---|
| 55 | USE dom_oce , ONLY : mig => mig !: local ==> global domain i-indice |
|---|
| 56 | USE dom_oce , ONLY : mjg => mjg !: local ==> global domain i-indice |
|---|
| 57 | USE dom_oce , ONLY : mi0 => mi0 !: global ==> local domain i-indice |
|---|
| 58 | USE dom_oce , ONLY : mi1 => mi1 !: (mi0=1 and mi1=0 if the global indice is not in the local one) |
|---|
| 59 | USE dom_oce , ONLY : mj0 => mj0 !: global ==> local domain j-indice |
|---|
| 60 | USE dom_oce , ONLY : mj1 => mj1 !: (mj0=1 and mj1=0 if the global indice is not in the local one) |
|---|
| 61 | USE dom_oce , ONLY : nidom => nidom |
|---|
| 62 | USE dom_oce , ONLY : nimppt => nimppt !:i-indexes for each processor |
|---|
| 63 | USE dom_oce , ONLY : njmppt => njmppt !:j-indexes for each processor |
|---|
| 64 | USE dom_oce , ONLY : ibonit => ibonit !:i-processor neighbour existence |
|---|
| 65 | USE dom_oce , ONLY : ibonjt => ibonjt !:j- processor neighbour existence |
|---|
| 66 | USE dom_oce , ONLY : nlci => nlci !:i- & j-dimensions of the local subdomain |
|---|
| 67 | USE dom_oce , ONLY : nlcj => nlcj !: |
|---|
| 68 | USE dom_oce , ONLY : nldi => nldi !:first and last indoor i- and j-indexes |
|---|
| 69 | USE dom_oce , ONLY : nlei => nlei !: |
|---|
| 70 | USE dom_oce , ONLY : nldj => nldj !: |
|---|
| 71 | USE dom_oce , ONLY : nlej => nlej !: |
|---|
| 72 | USE dom_oce , ONLY : nlcit => nlcit !:dimensions of every i-subdomain |
|---|
| 73 | USE dom_oce , ONLY : nlcjt => nlcjt !:dimensions of every j-subdomain |
|---|
| 74 | USE dom_oce , ONLY : nldit => nldit !:first indoor index for each i-domain |
|---|
| 75 | USE dom_oce , ONLY : nleit => nleit !:last indoor index for each i-domain |
|---|
| 76 | USE dom_oce , ONLY : nldjt => nldjt !:first indoor index for each j-domain |
|---|
| 77 | USE dom_oce , ONLY : nlejt => nlejt !:last indoor index for each j-domain |
|---|
| 78 | |
|---|
| 79 | !* horizontal mesh * |
|---|
| 80 | USE dom_oce , ONLY : glamt => glamt !: longitude of t-point (degre) |
|---|
| 81 | USE dom_oce , ONLY : glamu => glamu !: longitude of t-point (degre) |
|---|
| 82 | USE dom_oce , ONLY : glamv => glamv !: longitude of t-point (degre) |
|---|
| 83 | USE dom_oce , ONLY : glamf => glamf !: longitude of t-point (degre) |
|---|
| 84 | USE dom_oce , ONLY : gphit => gphit !: latitude of t-point (degre) |
|---|
| 85 | USE dom_oce , ONLY : gphiu => gphiu !: latitude of t-point (degre) |
|---|
| 86 | USE dom_oce , ONLY : gphiv => gphiv !: latitude of t-point (degre) |
|---|
| 87 | USE dom_oce , ONLY : gphif => gphif !: latitude of t-point (degre) |
|---|
| 88 | USE dom_oce , ONLY : e1t => e1t !: horizontal scale factors at t-point (m) |
|---|
| 89 | USE dom_oce , ONLY : e2t => e2t !: horizontal scale factors at t-point (m) |
|---|
| 90 | USE dom_oce , ONLY : e1u => e1u !: horizontal scale factors at u-point (m) |
|---|
| 91 | USE dom_oce , ONLY : e2u => e2u !: horizontal scale factors at u-point (m) |
|---|
| 92 | USE dom_oce , ONLY : e1v => e1v !: horizontal scale factors at v-point (m) |
|---|
| 93 | USE dom_oce , ONLY : e2v => e2v !: horizontal scale factors at v-point (m) |
|---|
| 94 | |
|---|
| 95 | !* vertical mesh * |
|---|
| 96 | USE dom_oce , ONLY : gdept_0 => gdept_0 !: reference depth of t-points (m) |
|---|
| 97 | USE dom_oce , ONLY : e3t_0 => e3t_0 !: reference depth of t-points (m) |
|---|
| 98 | USE dom_oce , ONLY : e3w_0 => e3w_0 !: reference depth of w-points (m) |
|---|
| 99 | USE dom_oce , ONLY : gdepw_0 => gdepw_0 !: reference depth of w-points (m) |
|---|
| 100 | # if ! defined key_zco |
|---|
| 101 | USE dom_oce , ONLY : gdep3w => gdep3w !: ??? |
|---|
| 102 | USE dom_oce , ONLY : gdept => gdept !: depth of t-points (m) |
|---|
| 103 | USE dom_oce , ONLY : gdepw => gdepw !: depth of t-points (m) |
|---|
| 104 | USE dom_oce , ONLY : e3t => e3t !: vertical scale factors at t- |
|---|
| 105 | USE dom_oce , ONLY : e3u => e3u !: vertical scale factors at u- |
|---|
| 106 | USE dom_oce , ONLY : e3v => e3v !: vertical scale factors v- |
|---|
| 107 | USE dom_oce , ONLY : e3w => e3w !: w-points (m) |
|---|
| 108 | USE dom_oce , ONLY : e3f => e3f !: f-points (m) |
|---|
| 109 | USE dom_oce , ONLY : e3uw => e3uw !: uw-points (m) |
|---|
| 110 | USE dom_oce , ONLY : e3vw => e3vw !: vw-points (m) |
|---|
| 111 | # endif |
|---|
| 112 | USE dom_oce , ONLY : ln_zps => ln_zps !: partial steps flag |
|---|
| 113 | USE dom_oce , ONLY : ln_sco => ln_sco !: s-coordinate flag |
|---|
| 114 | USE dom_oce , ONLY : ln_zco => ln_zco !: z-coordinate flag |
|---|
| 115 | USE dom_oce , ONLY : lk_zco => lk_zco !: z-coordinate flag (1D or 3D arrays) |
|---|
| 116 | USE dom_oce , ONLY : hbatt => hbatt !: ocean depth at the vertical of t-point (m) |
|---|
| 117 | USE dom_oce , ONLY : hbatu => hbatu !: ocean depth at the vertical of u-point (m) |
|---|
| 118 | USE dom_oce , ONLY : hbatv => hbatv !: ocean depth at the vertical of w-point (m) |
|---|
| 119 | USE dom_oce , ONLY : gsigt => gsigt !: model level depth coefficient at T-levels |
|---|
| 120 | USE dom_oce , ONLY : gsigw => gsigw !: model level depth coefficient at W-levels |
|---|
| 121 | USE dom_oce , ONLY : gsi3w => gsi3w !: model level depth coef at w-levels (defined as the sum of e3w) |
|---|
| 122 | USE dom_oce , ONLY : esigt => esigt !: vertical scale factor coef. at t-levels |
|---|
| 123 | USE dom_oce , ONLY : esigw => esigw !: vertical scale factor coef. at w-levels |
|---|
| 124 | USE dom_oce , ONLY : lk_vvl => lk_vvl !: variable grid flag |
|---|
| 125 | |
|---|
| 126 | !* masks, bathymetry * |
|---|
| 127 | USE dom_oce , ONLY : mbathy => mbathy !: number of ocean level (=0, & 1, ... , jpk-1) |
|---|
| 128 | USE dom_oce , ONLY : tmask_i => tmask_i !: Interior mask at t-points |
|---|
| 129 | USE dom_oce , ONLY : tmask => tmask !: land/ocean mask at t-points |
|---|
| 130 | USE dom_oce , ONLY : umask => umask !: land/ocean mask at u-points |
|---|
| 131 | USE dom_oce , ONLY : vmask => vmask !: land/ocean mask at v-points |
|---|
| 132 | USE dom_oce , ONLY : fmask => fmask !: land/ocean mask at f-points |
|---|
| 133 | |
|---|
| 134 | !* time domain * |
|---|
| 135 | USE dom_oce , ONLY : neuler => neuler !: restart euler forward option (0=Euler) |
|---|
| 136 | USE dom_oce , ONLY : rdt => rdt !: time step for the dynamics |
|---|
| 137 | USE dom_oce , ONLY : atfp => atfp !: asselin time filter parameter |
|---|
| 138 | USE dom_oce , ONLY : atfp1 => atfp1 !: asselin time filter coeff. (atfp1= 1-2*atfp) |
|---|
| 139 | USE dom_oce , ONLY : rdttra => rdttra !: vertical profile of tracer time step |
|---|
| 140 | ! !: it is the accumulated duration of previous runs |
|---|
| 141 | ! !: that may have been run with different time steps. |
|---|
| 142 | !* calendar variables * |
|---|
| 143 | USE dom_oce , ONLY : nyear => nyear !: current year |
|---|
| 144 | USE dom_oce , ONLY : nmonth => nmonth !: current month |
|---|
| 145 | USE dom_oce , ONLY : nday => nday !: current day of the month |
|---|
| 146 | USE dom_oce , ONLY : ndastp => ndastp !: time step date in yyyymmdd format |
|---|
| 147 | USE dom_oce , ONLY : nday_year => nday_year !: current day counted from jan 1st of the current year |
|---|
| 148 | USE dom_oce , ONLY : nsec_year => nsec_year !: current time step counted in second since 00h jan 1st of the current year |
|---|
| 149 | USE dom_oce , ONLY : nsec_month => nsec_month !: current time step counted in second since 00h 1st day of the current month |
|---|
| 150 | USE dom_oce , ONLY : nsec_day => nsec_day !: current time step counted in second since 00h of the current day |
|---|
| 151 | USE dom_oce , ONLY : fjulday => fjulday !: julian day |
|---|
| 152 | USE dom_oce , ONLY : adatrj => adatrj !: number of elapsed days since the begining of the whole simulation |
|---|
| 153 | !: (cumulative duration of previous runs |
|---|
| 154 | !: that may have used different time-step size) |
|---|
| 155 | USE dom_oce , ONLY : nyear_len => nyear_len !: length in days of the previous/current year |
|---|
| 156 | USE dom_oce , ONLY : nmonth_len => nmonth_len !: length in days of the months of the current year |
|---|
| 157 | |
|---|
| 158 | |
|---|
| 159 | !* ocean fields: here now and after fields * |
|---|
| 160 | USE oce , ONLY : ua => ua !: i-horizontal velocity (m s-1) |
|---|
| 161 | USE oce , ONLY : va => va !: j-horizontal velocity (m s-1) |
|---|
| 162 | USE oce , ONLY : un => un !: i-horizontal velocity (m s-1) |
|---|
| 163 | USE oce , ONLY : vn => vn !: j-horizontal velocity (m s-1) |
|---|
| 164 | USE oce , ONLY : wn => wn !: vertical velocity (m s-1) |
|---|
| 165 | USE oce , ONLY : tn => tn !: pot. temperature (celsius) |
|---|
| 166 | USE oce , ONLY : sn => sn !: salinity (psu) |
|---|
| 167 | USE oce , ONLY : tsn => tsn !: 4D array contaning ( tn, sn ) |
|---|
| 168 | USE oce , ONLY : tsb => tsb !: 4D array contaning ( tb, sb ) |
|---|
| 169 | USE oce , ONLY : tsa => tsa !: 4D array contaning ( ta, sa ) |
|---|
| 170 | USE oce , ONLY : rhop => rhop !: potential volumic mass (kg m-3) |
|---|
| 171 | USE oce , ONLY : rhd => rhd !: in situ density anomalie rhd=(rho-rau0)/rau0 (no units) |
|---|
| 172 | USE oce , ONLY : hdivn => hdivn !: horizontal divergence (1/s) |
|---|
| 173 | USE oce , ONLY : l_traldf_rot => l_traldf_rot !: rotated laplacian operator for lateral diffusion |
|---|
| 174 | #if defined key_offline |
|---|
| 175 | USE oce , ONLY : gtsu => gtsu !: t-, s- and rd horizontal gradient at u- and |
|---|
| 176 | USE oce , ONLY : gtsv => gtsv !: |
|---|
| 177 | USE oce , ONLY : gru => gru !: |
|---|
| 178 | USE oce , ONLY : grv => grv !: |
|---|
| 179 | # if defined key_degrad |
|---|
| 180 | USE dommsk , ONLY : facvol => facvol !: volume factor for degradation |
|---|
| 181 | # endif |
|---|
| 182 | |
|---|
| 183 | #endif |
|---|
| 184 | USE lib_mpp , ONLY : lk_mpp => lk_mpp !: Mpp flag |
|---|
| 185 | |
|---|
| 186 | USE dom_oce , ONLY : n_cla => n_cla !: flag (0/1) for cross land advection |
|---|
| 187 | |
|---|
| 188 | !* surface fluxes * |
|---|
| 189 | USE sbc_oce , ONLY : utau => utau !: i-surface stress component |
|---|
| 190 | USE sbc_oce , ONLY : vtau => vtau !: j-surface stress component |
|---|
| 191 | USE sbc_oce , ONLY : wndm => wndm !: 10m wind speed |
|---|
| 192 | USE sbc_oce , ONLY : qsr => qsr !: penetrative solar radiation (w m-2) |
|---|
| 193 | USE sbc_oce , ONLY : emp => emp !: freshwater budget: volume flux [Kg/m2/s] |
|---|
| 194 | USE sbc_oce , ONLY : emps => emps !: freshwater budget: concentration/dillution [Kg/m2/s] |
|---|
| 195 | USE sbc_oce , ONLY : rnf => rnf !: river runoff [Kg/m2/s] |
|---|
| 196 | USE sbc_oce , ONLY : fr_i => fr_i !: ice fraction (between 0 to 1) |
|---|
| 197 | USE traqsr , ONLY : rn_abs => rn_abs !: fraction absorbed in the very near surface |
|---|
| 198 | USE traqsr , ONLY : rn_si0 => rn_si0 !: very near surface depth of extinction |
|---|
| 199 | USE traqsr , ONLY : rn_si2 => rn_si2 !: deepest depth of extinction (blue & 0.01 mg.m-3) (RGB) |
|---|
| 200 | USE traqsr , ONLY : ln_qsr_bio => ln_qsr_bio !: flag to use or not the biological fluxes for light |
|---|
| 201 | USE sbcrnf , ONLY : rnfmsk => rnfmsk !: mixed adv scheme in runoffs vicinity (hori.) |
|---|
| 202 | USE sbcrnf , ONLY : rnfmsk_z => rnfmsk_z !: mixed adv scheme in runoffs vicinity (vert.) |
|---|
| 203 | |
|---|
| 204 | USE trc_oce |
|---|
| 205 | |
|---|
| 206 | !* lateral diffusivity (tracers) * |
|---|
| 207 | USE ldftra_oce , ONLY : aht0 => aht0 !: horizontal eddy diffusivity for tracers (m2/s) |
|---|
| 208 | USE ldftra_oce , ONLY : ahtb0 => ahtb0 !: background eddy diffusivity for isopycnal diff. (m2/s) |
|---|
| 209 | USE ldftra_oce , ONLY : ahtu => ahtu !: lateral diffusivity coef. at u-points |
|---|
| 210 | USE ldftra_oce , ONLY : ahtv => ahtv !: lateral diffusivity coef. at v-points |
|---|
| 211 | USE ldftra_oce , ONLY : ahtw => ahtw !: lateral diffusivity coef. at w-points |
|---|
| 212 | USE ldftra_oce , ONLY : ahtt => ahtt !: lateral diffusivity coef. at t-points |
|---|
| 213 | USE ldftra_oce , ONLY : aeiv0 => aeiv0 !: eddy induced velocity coefficient (m2/s) |
|---|
| 214 | USE ldftra_oce , ONLY : aeiu => aeiu !: eddy induced velocity coef. at u-points (m2/s) |
|---|
| 215 | USE ldftra_oce , ONLY : aeiv => aeiv !: eddy induced velocity coef. at v-points (m2/s) |
|---|
| 216 | USE ldftra_oce , ONLY : aeiw => aeiw !: eddy induced velocity coef. at w-points (m2/s) |
|---|
| 217 | |
|---|
| 218 | !* vertical diffusion * |
|---|
| 219 | USE zdf_oce , ONLY : avt => avt !: vert. diffusivity coef. at w-point for temp |
|---|
| 220 | # if defined key_zdfddm |
|---|
| 221 | USE zdfddm , ONLY : avs => avs !: salinity vertical diffusivity coeff. at w-point |
|---|
| 222 | # endif |
|---|
| 223 | |
|---|
| 224 | !* mixing & mixed layer depth * |
|---|
| 225 | USE zdfmxl , ONLY : nmln => nmln !: number of level in the mixed layer |
|---|
| 226 | USE zdfmxl , ONLY : hmld => hmld !: mixing layer depth (turbocline) |
|---|
| 227 | USE zdfmxl , ONLY : hmlp => hmlp !: mixed layer depth (rho=rho0+zdcrit) (m) |
|---|
| 228 | USE zdfmxl , ONLY : hmlpt => hmlpt !: mixed layer depth at t-points (m) |
|---|
| 229 | |
|---|
| 230 | !* direction of lateral diffusion * |
|---|
| 231 | USE ldfslp , ONLY : lk_ldfslp => lk_ldfslp !: slopes flag |
|---|
| 232 | # if defined key_ldfslp |
|---|
| 233 | USE ldfslp , ONLY : uslp => uslp !: i-direction slope at u-, w-points |
|---|
| 234 | USE ldfslp , ONLY : vslp => vslp !: j-direction slope at v-, w-points |
|---|
| 235 | USE ldfslp , ONLY : wslpi => wslpi !: i-direction slope at u-, w-points |
|---|
| 236 | USE ldfslp , ONLY : wslpj => wslpj !: j-direction slope at v-, w-points |
|---|
| 237 | # endif |
|---|
| 238 | |
|---|
| 239 | #else |
|---|
| 240 | !!---------------------------------------------------------------------- |
|---|
| 241 | !! Empty module : No passive tracer |
|---|
| 242 | !!---------------------------------------------------------------------- |
|---|
| 243 | #endif |
|---|
| 244 | |
|---|
| 245 | !!====================================================================== |
|---|
| 246 | END MODULE oce_trc |
|---|
