[3] | 1 | MODULE dom_oce |
---|
[1601] | 2 | !!====================================================================== |
---|
[3] | 3 | !! *** MODULE dom_oce *** |
---|
| 4 | !! |
---|
| 5 | !! ** Purpose : Define in memory all the ocean space domain variables |
---|
[1601] | 6 | !!====================================================================== |
---|
| 7 | !! History : 1.0 ! 2005-10 (A. Beckmann, G. Madec) reactivate s-coordinate |
---|
[3] | 8 | !!---------------------------------------------------------------------- |
---|
[1601] | 9 | !! NEMO/OPA 3.2 , LOCEAN-IPSL (2009) |
---|
[1152] | 10 | !! $Id$ |
---|
[1601] | 11 | !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt) |
---|
[3] | 12 | !!---------------------------------------------------------------------- |
---|
| 13 | USE par_oce ! ocean parameters |
---|
| 14 | |
---|
| 15 | IMPLICIT NONE |
---|
[32] | 16 | PUBLIC ! allows the acces to par_oce when dom_oce is used |
---|
| 17 | ! ! exception to coding rules... to be suppressed ??? |
---|
[3] | 18 | |
---|
| 19 | !!---------------------------------------------------------------------- |
---|
[1601] | 20 | !! time & space domain namelist |
---|
| 21 | !! ---------------------------- |
---|
| 22 | ! !!* Namelist namdom : time & space domain * |
---|
| 23 | INTEGER , PUBLIC :: nn_bathy = 0 !: = 0/1 ,compute/read the bathymetry file |
---|
| 24 | REAL(wp), PUBLIC :: rn_e3zps_min = 5.0_wp !: miminum thickness for partial steps (meters) |
---|
| 25 | REAL(wp), PUBLIC :: rn_e3zps_rat = 0.1_wp !: minimum thickness ration for partial steps |
---|
| 26 | INTEGER , PUBLIC :: nn_msh = 0 !: = 1 create a mesh-mask file |
---|
| 27 | INTEGER , PUBLIC :: nn_acc = 0 !: = 0/1 use of the acceleration of convergence technique |
---|
| 28 | REAL(wp), PUBLIC :: rn_atfp = 0.1_wp !: asselin time filter parameter |
---|
| 29 | REAL(wp), PUBLIC :: rn_rdt = 3600._wp !: time step for the dynamics (and tracer if nacc=0) |
---|
| 30 | REAL(wp), PUBLIC :: rn_rdtmin = 3600._wp !: minimum time step on tracers |
---|
| 31 | REAL(wp), PUBLIC :: rn_rdtmax = 3600._wp !: maximum time step on tracers |
---|
| 32 | REAL(wp), PUBLIC :: rn_rdth = 800._wp !: depth variation of tracer step |
---|
| 33 | INTEGER , PUBLIC :: nn_baro = 64 !: number of barotropic time steps (key_dynspg_ts) |
---|
| 34 | INTEGER , PUBLIC :: nn_closea = 0 !: =0 suppress closed sea/lake from the ORCA domain or not (=1) |
---|
[3] | 35 | |
---|
[1601] | 36 | ! ! old non-DOCTOR names still used in the model |
---|
| 37 | INTEGER , PUBLIC :: ntopo !: = 0/1 ,compute/read the bathymetry file |
---|
| 38 | REAL(wp), PUBLIC :: e3zps_min !: miminum thickness for partial steps (meters) |
---|
| 39 | REAL(wp), PUBLIC :: e3zps_rat !: minimum thickness ration for partial steps |
---|
| 40 | INTEGER , PUBLIC :: nmsh !: = 1 create a mesh-mask file |
---|
| 41 | INTEGER , PUBLIC :: nacc !: = 0/1 use of the acceleration of convergence technique |
---|
| 42 | REAL(wp), PUBLIC :: atfp !: asselin time filter parameter |
---|
| 43 | REAL(wp), PUBLIC :: rdt !: time step for the dynamics (and tracer if nacc=0) |
---|
| 44 | REAL(wp), PUBLIC :: rdtmin !: minimum time step on tracers |
---|
| 45 | REAL(wp), PUBLIC :: rdtmax !: maximum time step on tracers |
---|
| 46 | REAL(wp), PUBLIC :: rdth !: depth variation of tracer step |
---|
| 47 | INTEGER , PUBLIC :: nclosea !: =0 suppress closed sea/lake from the ORCA domain or not (=1) |
---|
[3] | 48 | |
---|
| 49 | |
---|
[1601] | 50 | ! !!! associated variables |
---|
| 51 | INTEGER , PUBLIC :: neuler = 0 !: restart euler forward option (0=Euler) |
---|
| 52 | REAL(wp), PUBLIC :: atfp1 !: asselin time filter coeff. (atfp1= 1-2*atfp) |
---|
| 53 | REAL(wp), PUBLIC, DIMENSION(jpk) :: rdttra !: vertical profile of tracer time step |
---|
[3] | 54 | |
---|
[1601] | 55 | ! !!* Namelist namcla : cross land advection |
---|
| 56 | INTEGER, PUBLIC :: nn_cla = 0 !: =1 cross land advection for exchanges through some straits (ORCA2) |
---|
[3] | 57 | |
---|
[1601] | 58 | ! ! old non-DOCTOR names still used in the model |
---|
| 59 | INTEGER, PUBLIC :: n_cla = 0 !: =1 cross land advection for exchanges through some straits (ORCA2) |
---|
| 60 | |
---|
[3] | 61 | !!---------------------------------------------------------------------- |
---|
[1601] | 62 | !! space domain parameters |
---|
[1715] | 63 | !!---------------------------------------------------------------------- |
---|
[1601] | 64 | LOGICAL, PUBLIC :: lzoom = .FALSE. !: zoom flag |
---|
| 65 | LOGICAL, PUBLIC :: lzoom_e = .FALSE. !: East zoom type flag |
---|
| 66 | LOGICAL, PUBLIC :: lzoom_w = .FALSE. !: West zoom type flag |
---|
| 67 | LOGICAL, PUBLIC :: lzoom_s = .FALSE. !: South zoom type flag |
---|
| 68 | LOGICAL, PUBLIC :: lzoom_n = .FALSE. !: North zoom type flag |
---|
| 69 | LOGICAL, PUBLIC :: lzoom_arct = .FALSE. !: ORCA arctic zoom flag |
---|
| 70 | LOGICAL, PUBLIC :: lzoom_anta = .FALSE. !: ORCA antarctic zoom flag |
---|
| 71 | |
---|
| 72 | ! !!! domain parameters linked to mpp |
---|
| 73 | INTEGER, PUBLIC :: nperio !: type of lateral boundary condition |
---|
| 74 | INTEGER, PUBLIC :: nimpp, njmpp !: i- & j-indexes for mpp-subdomain left bottom |
---|
| 75 | INTEGER, PUBLIC :: nreci, nrecj !: overlap region in i and j |
---|
| 76 | INTEGER, PUBLIC :: nproc !: number for local processor |
---|
| 77 | INTEGER, PUBLIC :: narea !: number for local area |
---|
| 78 | INTEGER, PUBLIC :: nbondi, nbondj !: mark of i- and j-direction local boundaries |
---|
| 79 | INTEGER, PUBLIC :: npolj !: north fold mark (0, 3 or 4) |
---|
| 80 | INTEGER, PUBLIC :: nlci, nldi, nlei !: i-dimensions of the local subdomain and its first and last indoor indices |
---|
| 81 | INTEGER, PUBLIC :: nlcj, nldj, nlej !: i-dimensions of the local subdomain and its first and last indoor indices |
---|
| 82 | INTEGER, PUBLIC :: noea, nowe !: index of the local neighboring processors in |
---|
| 83 | INTEGER, PUBLIC :: noso, nono !: east, west, south and north directions |
---|
| 84 | INTEGER, PUBLIC :: npne, npnw !: index of north east and north west processor |
---|
| 85 | INTEGER, PUBLIC :: npse, npsw !: index of south east and south west processor |
---|
| 86 | INTEGER, PUBLIC :: nbne, nbnw !: logical of north east & north west processor |
---|
| 87 | INTEGER, PUBLIC :: nbse, nbsw !: logical of south east & south west processor |
---|
| 88 | INTEGER, PUBLIC :: nidom !: ??? |
---|
| 89 | |
---|
| 90 | INTEGER, PUBLIC, DIMENSION(jpi) :: mig !: local ==> global domain i-index |
---|
| 91 | INTEGER, PUBLIC, DIMENSION(jpj) :: mjg !: local ==> global domain j-index |
---|
| 92 | INTEGER, PUBLIC, DIMENSION(jpidta) :: mi0, mi1 !: global ==> local domain i-index !!bug ==> other solution? |
---|
| 93 | ! ! (mi0=1 and mi1=0 if the global index is not in the local domain) |
---|
| 94 | INTEGER, PUBLIC, DIMENSION(jpjdta) :: mj0, mj1 !: global ==> local domain j-index !!bug ==> other solution? |
---|
| 95 | ! ! (mi0=1 and mi1=0 if the global index is not in the local domain) |
---|
| 96 | INTEGER, PUBLIC, DIMENSION(jpnij) :: nimppt, njmppt !: i-, j-indexes for each processor |
---|
| 97 | INTEGER, PUBLIC, DIMENSION(jpnij) :: ibonit, ibonjt !: i-, j- processor neighbour existence |
---|
| 98 | INTEGER, PUBLIC, DIMENSION(jpnij) :: nlcit , nlcjt !: dimensions of every subdomain |
---|
| 99 | INTEGER, PUBLIC, DIMENSION(jpnij) :: nldit , nldjt !: first, last indoor index for each i-domain |
---|
| 100 | INTEGER, PUBLIC, DIMENSION(jpnij) :: nleit , nlejt !: first, last indoor index for each j-domain |
---|
| 101 | |
---|
| 102 | !!---------------------------------------------------------------------- |
---|
[3] | 103 | !! horizontal curvilinear coordinate and scale factors |
---|
| 104 | !! --------------------------------------------------------------------- |
---|
[1601] | 105 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: glamt, glamu !: longitude of t-, u-, v- and f-points (degre) |
---|
| 106 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: glamv, glamf !: |
---|
| 107 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: gphit, gphiu !: latitude of t-, u-, v- and f-points (degre) |
---|
| 108 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: gphiv, gphif !: |
---|
| 109 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: e1t, e2t !: horizontal scale factors at t-point (m) |
---|
| 110 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: e1u, e2u !: horizontal scale factors at u-point (m) |
---|
| 111 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: e1v, e2v !: horizontal scale factors at v-point (m) |
---|
| 112 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: e1f, e2f !: horizontal scale factors at f-point (m) |
---|
| 113 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: ff !: coriolis factor (2.*omega*sin(yphi) ) (s-1) |
---|
[3] | 114 | |
---|
| 115 | !!---------------------------------------------------------------------- |
---|
| 116 | !! vertical coordinate and scale factors |
---|
[1715] | 117 | !! --------------------------------------------------------------------- |
---|
[1601] | 118 | ! !!* Namelist namzgr : vertical coordinate * |
---|
| 119 | LOGICAL, PUBLIC :: ln_zco = .TRUE. !: z-coordinate - full step |
---|
| 120 | LOGICAL, PUBLIC :: ln_zps = .FALSE. !: z-coordinate - partial step |
---|
| 121 | LOGICAL, PUBLIC :: ln_sco = .FALSE. !: s-coordinate or hybrid z-s coordinate |
---|
[454] | 122 | #if defined key_zco |
---|
| 123 | LOGICAL, PUBLIC, PARAMETER :: lk_zco = .TRUE. !: z-coordinate flag (1D arrays) |
---|
| 124 | #else |
---|
| 125 | LOGICAL, PUBLIC, PARAMETER :: lk_zco = .FALSE. !: z-coordinate flag (3D arrays) |
---|
[3] | 126 | |
---|
[454] | 127 | !! All coordinates |
---|
| 128 | !! --------------- |
---|
[1601] | 129 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) :: gdep3w !: depth of T-points (sum of e3w) (m) |
---|
| 130 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) :: gdept , gdepw !: analytical depth at T-W points (m) |
---|
| 131 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) :: e3v , e3f !: analytical vertical scale factors at V--F |
---|
| 132 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) :: e3t , e3u !: T--U points (m) |
---|
| 133 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) :: e3vw !: analytical vertical scale factors at VW-- |
---|
| 134 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) :: e3w , e3uw !: W--UW points (m) |
---|
[454] | 135 | #endif |
---|
[592] | 136 | #if defined key_vvl |
---|
| 137 | LOGICAL, PUBLIC, PARAMETER :: lk_vvl = .TRUE. !: variable grid flag |
---|
[1601] | 138 | |
---|
[592] | 139 | !! All coordinates |
---|
| 140 | !! --------------- |
---|
[1438] | 141 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) :: gdep3w_1 !: depth of T-points (sum of e3w) (m) |
---|
| 142 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) :: gdept_1, gdepw_1 !: analytical depth at T-W points (m) |
---|
| 143 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) :: e3v_1 , e3f_1 !: analytical vertical scale factors at V--F |
---|
| 144 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) :: e3t_1 , e3u_1 !: T--U points (m) |
---|
| 145 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) :: e3vw_1 !: analytical vertical scale factors at VW-- |
---|
| 146 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) :: e3w_1 , e3uw_1 !: W--UW points (m) |
---|
[592] | 147 | #else |
---|
| 148 | LOGICAL, PUBLIC, PARAMETER :: lk_vvl = .FALSE. !: fixed grid flag |
---|
| 149 | #endif |
---|
[1601] | 150 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: hur , hvr !: inverse of u and v-points ocean depth (1/m) |
---|
| 151 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: hu , hv !: depth at u- and v-points (meters) |
---|
| 152 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: hu_0 , hv_0 !: refernce depth at u- and v-points (meters) |
---|
[3] | 153 | |
---|
[1601] | 154 | INTEGER, PUBLIC :: nla10 !: deepest W level Above ~10m (nlb10 - 1) |
---|
| 155 | INTEGER, PUBLIC :: nlb10 !: shallowest W level Bellow ~10m (nla10 + 1) |
---|
[1577] | 156 | |
---|
[454] | 157 | !! z-coordinate with full steps (also used in the other cases as reference z-coordinate) |
---|
| 158 | !! =-----------------====------ |
---|
[1601] | 159 | REAL(wp), PUBLIC, DIMENSION(jpk) :: gdept_0, gdepw_0 !: reference depth of t- and w-points (m) |
---|
| 160 | REAL(wp), PUBLIC, DIMENSION(jpk) :: e3t_0 , e3w_0 !: reference vertical scale factors at T- and W-pts (m) |
---|
| 161 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: hdept , hdepw !: ocean bottom depth at T and W points |
---|
| 162 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: e3tp , e3wp !: ocean bottom level thickness at T and W points |
---|
[454] | 163 | |
---|
| 164 | !! s-coordinate and hybrid z-s-coordinate |
---|
| 165 | !! =----------------======--------------- |
---|
[1601] | 166 | REAL(wp), PUBLIC, DIMENSION(jpk) :: gsigt, gsigw !: model level depth coefficient at t-, w-levels (analytic) |
---|
| 167 | REAL(wp), PUBLIC, DIMENSION(jpk) :: gsi3w !: model level depth coefficient at w-level (sum of gsigw) |
---|
| 168 | REAL(wp), PUBLIC, DIMENSION(jpk) :: esigt, esigw !: vertical scale factor coef. at t-, w-levels |
---|
[3] | 169 | |
---|
[1601] | 170 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: hbatv , hbatf !: ocean depth at the vertical of V--F |
---|
| 171 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: hbatt , hbatu !: T--U points (m) |
---|
| 172 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: scosrf, scobot !: ocean surface and bottom topographies |
---|
| 173 | ! ! (if deviating from coordinate surfaces in HYBRID) |
---|
| 174 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: hifv , hiff !: interface depth between stretching at V--F |
---|
| 175 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: hift , hifu !: and quasi-uniform spacing T--U points (m) |
---|
[454] | 176 | |
---|
[3] | 177 | !!---------------------------------------------------------------------- |
---|
| 178 | !! masks, bathymetry |
---|
[1715] | 179 | !! --------------------------------------------------------------------- |
---|
[1601] | 180 | INTEGER , PUBLIC, DIMENSION(jpi,jpj) :: mbathy !: number of ocean level (=0, 1, ... , jpk-1) |
---|
| 181 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: bathy !: ocean depth (meters) |
---|
| 182 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: tmask_i !: interior domain T-point mask |
---|
| 183 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: bmask !: land/ocean mask of barotropic stream function |
---|
[3] | 184 | |
---|
[1601] | 185 | REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) :: tmask, umask, vmask, fmask !: land/ocean mask at T-, U-, V- and F-points |
---|
[3] | 186 | |
---|
[1601] | 187 | REAL(wp), PUBLIC, DIMENSION(jpiglo) :: tpol, fpol !: north fold mask (nperio= 3 or 4) |
---|
[3] | 188 | |
---|
| 189 | #if defined key_noslip_accurate |
---|
[1601] | 190 | INTEGER, PUBLIC, DIMENSION (4,jpk) :: npcoa !: ??? |
---|
| 191 | INTEGER, PUBLIC, DIMENSION(2*(jpi+jpj),4,jpk) :: nicoa, njcoa !: ??? |
---|
[3] | 192 | #endif |
---|
| 193 | |
---|
| 194 | !!---------------------------------------------------------------------- |
---|
[1715] | 195 | !! calendar variables |
---|
| 196 | !! --------------------------------------------------------------------- |
---|
| 197 | INTEGER , PUBLIC :: nyear !: current year |
---|
| 198 | INTEGER , PUBLIC :: nmonth !: current month |
---|
| 199 | INTEGER , PUBLIC :: nday !: current day of the month |
---|
| 200 | INTEGER , PUBLIC :: ndastp !: time step date in yyyymmdd format |
---|
| 201 | INTEGER , PUBLIC :: nday_year !: current day counted from jan 1st of the current year |
---|
[1730] | 202 | INTEGER , PUBLIC :: nsec_year !: current time step counted in second since 00h jan 1st of the current year |
---|
| 203 | INTEGER , PUBLIC :: nsec_month !: current time step counted in second since 00h 1st day of the current month |
---|
| 204 | INTEGER , PUBLIC :: nsec_day !: current time step counted in second since 00h of the current day |
---|
[1715] | 205 | REAL(wp), PUBLIC :: fjulday !: julian day |
---|
| 206 | REAL(wp), PUBLIC :: adatrj !: number of elapsed days since the begining of the whole simulation |
---|
| 207 | ! !: (cumulative duration of previous runs that may have used different time-step size) |
---|
[1730] | 208 | INTEGER , PUBLIC, DIMENSION(0: 1) :: nyear_len !: length in days of the previous/current year |
---|
| 209 | INTEGER , PUBLIC, DIMENSION(0:13) :: nmonth_len !: length in days of the months of the current year |
---|
| 210 | INTEGER , PUBLIC, DIMENSION(0:13) :: nmonth_half !: second since Jan 1st 0h of the current year and the half of the months |
---|
| 211 | INTEGER , PUBLIC, DIMENSION(0:13) :: nmonth_end !: second since Jan 1st 0h of the current year and the end of the months |
---|
| 212 | INTEGER , PUBLIC :: nsec1jan000 !: second since Jan 1st 0h of nit000 year and Jan 1st 0h the current year |
---|
[1715] | 213 | |
---|
| 214 | !!---------------------------------------------------------------------- |
---|
[1200] | 215 | !! agrif domain |
---|
| 216 | !!---------------------------------------------------------------------- |
---|
| 217 | #if defined key_agrif |
---|
| 218 | LOGICAL, PUBLIC, PARAMETER :: lk_agrif = .TRUE. !: agrif flag |
---|
| 219 | #else |
---|
| 220 | LOGICAL, PUBLIC, PARAMETER :: lk_agrif = .FALSE. !: agrif flag |
---|
[1953] | 221 | |
---|
| 222 | CONTAINS |
---|
| 223 | LOGICAL FUNCTION Agrif_Root() |
---|
| 224 | Agrif_Root = .TRUE. |
---|
| 225 | END FUNCTION Agrif_Root |
---|
| 226 | |
---|
| 227 | CHARACTER(len=3) FUNCTION Agrif_CFixed() |
---|
| 228 | Agrif_CFixed = '0' |
---|
| 229 | END FUNCTION Agrif_CFixed |
---|
[1200] | 230 | #endif |
---|
| 231 | |
---|
[1601] | 232 | !!====================================================================== |
---|
[3] | 233 | END MODULE dom_oce |
---|