| 1 | MODULE dom_oce |
|---|
| 2 | !!====================================================================== |
|---|
| 3 | !! *** MODULE dom_oce *** |
|---|
| 4 | !! |
|---|
| 5 | !! ** Purpose : Define in memory all the ocean space domain variables |
|---|
| 6 | !!====================================================================== |
|---|
| 7 | !! History : 1.0 ! 2005-10 (A. Beckmann, G. Madec) reactivate s-coordinate |
|---|
| 8 | !! 3.3 ! 2010-11 (G. Madec) add mbk. arrays associated to the deepest ocean level |
|---|
| 9 | !! 3.4 ! 2011-01 (A. R. Porter, STFC Daresbury) dynamical allocation |
|---|
| 10 | !! 3.5 ! 2012 (S. Mocavero, I. Epicoco) Add arrays associated |
|---|
| 11 | !! to the optimization of BDY communications |
|---|
| 12 | !! 3.7 ! 2015-11 (G. Madec) introduce surface and scale factor ratio |
|---|
| 13 | !! - ! 2015-11 (G. Madec, A. Coward) time varying zgr by default |
|---|
| 14 | !!---------------------------------------------------------------------- |
|---|
| 15 | |
|---|
| 16 | !!---------------------------------------------------------------------- |
|---|
| 17 | !! Agrif_Root : dummy function used when lk_agrif=F |
|---|
| 18 | !! Agrif_CFixed : dummy function used when lk_agrif=F |
|---|
| 19 | !! dom_oce_alloc : dynamical allocation of dom_oce arrays |
|---|
| 20 | !!---------------------------------------------------------------------- |
|---|
| 21 | USE par_oce ! ocean parameters |
|---|
| 22 | |
|---|
| 23 | IMPLICIT NONE |
|---|
| 24 | PUBLIC ! allows the acces to par_oce when dom_oce is used (exception to coding rules) |
|---|
| 25 | |
|---|
| 26 | PUBLIC dom_oce_alloc ! Called from nemogcm.F90 |
|---|
| 27 | |
|---|
| 28 | !! time & space domain namelist |
|---|
| 29 | !! ---------------------------- |
|---|
| 30 | INTEGER , PUBLIC :: nmsh !: = 1 create a mesh-mask file |
|---|
| 31 | ! !!* Namelist namdom : time & space domain * |
|---|
| 32 | INTEGER , PUBLIC :: nn_bathy !: = 0/1/2 ,compute/read the bathymetry file |
|---|
| 33 | REAL(wp), PUBLIC :: rn_bathy !: depth of flat bottom (active if nn_bathy=0; if =0 depth=jpkm1) |
|---|
| 34 | REAL(wp), PUBLIC :: rn_hmin !: minimum ocean depth (>0) or minimum number of ocean levels (<0) |
|---|
| 35 | REAL(wp), PUBLIC :: rn_e3zps_min !: miminum thickness for partial steps (meters) |
|---|
| 36 | REAL(wp), PUBLIC :: rn_e3zps_rat !: minimum thickness ration for partial steps |
|---|
| 37 | INTEGER , PUBLIC :: nn_msh !: = 1 create a mesh-mask file |
|---|
| 38 | |
|---|
| 39 | INTEGER , PUBLIC :: ntopo !: = 0/1 ,compute/read the bathymetry file |
|---|
| 40 | INTEGER, PUBLIC :: nperio !: type of lateral boundary condition |
|---|
| 41 | REAL(wp), PUBLIC :: e3zps_min !: miminum thickness for partial steps (meters) |
|---|
| 42 | REAL(wp), PUBLIC :: e3zps_rat !: minimum thickness ration for partial steps |
|---|
| 43 | INTEGER , PUBLIC :: nn_closea !: =0 suppress closed sea/lake from the ORCA domain or not (=1) |
|---|
| 44 | |
|---|
| 45 | INTEGER, PUBLIC :: nn_interp |
|---|
| 46 | CHARACTER(LEN=200), PUBLIC :: cn_topo |
|---|
| 47 | CHARACTER(LEN=132), PUBLIC :: cn_bath |
|---|
| 48 | CHARACTER(LEN=132), PUBLIC :: cn_lon |
|---|
| 49 | CHARACTER(LEN=132), PUBLIC :: cn_lat |
|---|
| 50 | REAL(wp), PUBLIC :: rn_scale |
|---|
| 51 | |
|---|
| 52 | LOGICAL, PUBLIC :: lzoom = .FALSE. !: zoom flag |
|---|
| 53 | LOGICAL, PUBLIC :: lzoom_e = .FALSE. !: East zoom type flag |
|---|
| 54 | LOGICAL, PUBLIC :: lzoom_w = .FALSE. !: West zoom type flag |
|---|
| 55 | LOGICAL, PUBLIC :: lzoom_s = .FALSE. !: South zoom type flag |
|---|
| 56 | LOGICAL, PUBLIC :: lzoom_n = .FALSE. !: North zoom type flag |
|---|
| 57 | |
|---|
| 58 | LOGICAL, PUBLIC :: ln_domclo = .FALSE. |
|---|
| 59 | |
|---|
| 60 | INTEGER :: jphgr_msh !: type of horizontal mesh |
|---|
| 61 | ! ! = 0 curvilinear coordinate on the sphere read in coordinate.nc |
|---|
| 62 | ! ! = 1 geographical mesh on the sphere with regular grid-spacing |
|---|
| 63 | ! ! = 2 f-plane with regular grid-spacing |
|---|
| 64 | ! ! = 3 beta-plane with regular grid-spacing |
|---|
| 65 | ! ! = 4 Mercator grid with T/U point at the equator |
|---|
| 66 | |
|---|
| 67 | REAL(wp) :: ppglam0 !: longitude of first raw and column T-point (jphgr_msh = 1) |
|---|
| 68 | REAL(wp) :: ppgphi0 !: latitude of first raw and column T-point (jphgr_msh = 1) |
|---|
| 69 | ! ! used for Coriolis & Beta parameters (jphgr_msh = 2 or 3) |
|---|
| 70 | REAL(wp) :: ppe1_deg !: zonal grid-spacing (degrees) |
|---|
| 71 | REAL(wp) :: ppe2_deg !: meridional grid-spacing (degrees) |
|---|
| 72 | REAL(wp) :: ppe1_m !: zonal grid-spacing (degrees) |
|---|
| 73 | REAL(wp) :: ppe2_m !: meridional grid-spacing (degrees) |
|---|
| 74 | |
|---|
| 75 | !! Vertical grid parameter for domzgr |
|---|
| 76 | !! ================================== |
|---|
| 77 | REAL(wp) :: ppsur !: ORCA r4, r2 and r05 coefficients |
|---|
| 78 | REAL(wp) :: ppa0 !: (default coefficients) |
|---|
| 79 | REAL(wp) :: ppa1 !: |
|---|
| 80 | REAL(wp) :: ppkth !: |
|---|
| 81 | REAL(wp) :: ppacr !: |
|---|
| 82 | ! |
|---|
| 83 | ! If both ppa0 ppa1 and ppsur are specified to 0, then |
|---|
| 84 | ! they are computed from ppdzmin, pphmax , ppkth, ppacr in dom_zgr |
|---|
| 85 | REAL(wp) :: ppdzmin !: Minimum vertical spacing |
|---|
| 86 | REAL(wp) :: pphmax !: Maximum depth |
|---|
| 87 | ! |
|---|
| 88 | LOGICAL :: ldbletanh !: Use/do not use double tanf function for vertical coordinates |
|---|
| 89 | REAL(wp) :: ppa2 !: Double tanh function parameters |
|---|
| 90 | REAL(wp) :: ppkth2 !: |
|---|
| 91 | REAL(wp) :: ppacr2 !: |
|---|
| 92 | |
|---|
| 93 | !!---------------------------------------------------------------------- |
|---|
| 94 | !! time & space domain namelist |
|---|
| 95 | !! ---------------------------- |
|---|
| 96 | ! !!* Namelist namdom : time & space domain * |
|---|
| 97 | LOGICAL , PUBLIC :: ln_meshmask !: =T create a mesh-mask file (mesh_mask.nc) |
|---|
| 98 | REAL(wp), PUBLIC :: rn_isfhmin !: threshold to discriminate grounded ice to floating ice |
|---|
| 99 | REAL(wp), PUBLIC :: rn_rdt !: time step for the dynamics and tracer |
|---|
| 100 | REAL(wp), PUBLIC :: rn_atfp !: asselin time filter parameter |
|---|
| 101 | INTEGER , PUBLIC :: nn_euler !: =0 start with forward time step or not (=1) |
|---|
| 102 | LOGICAL , PUBLIC :: ln_iscpl !: coupling with ice sheet |
|---|
| 103 | LOGICAL , PUBLIC :: ln_crs !: Apply grid coarsening to dynamical model output or online passive tracers |
|---|
| 104 | |
|---|
| 105 | !! Free surface parameters |
|---|
| 106 | !! ======================= |
|---|
| 107 | LOGICAL , PUBLIC :: ln_dynspg_exp !: Explicit free surface flag |
|---|
| 108 | LOGICAL , PUBLIC :: ln_dynspg_ts !: Split-Explicit free surface flag |
|---|
| 109 | |
|---|
| 110 | !! Time splitting parameters |
|---|
| 111 | !! ========================= |
|---|
| 112 | LOGICAL, PUBLIC :: ln_bt_fw !: Forward integration of barotropic sub-stepping |
|---|
| 113 | LOGICAL, PUBLIC :: ln_bt_av !: Time averaging of barotropic variables |
|---|
| 114 | LOGICAL, PUBLIC :: ln_bt_auto !: Set number of barotropic iterations automatically |
|---|
| 115 | INTEGER, PUBLIC :: nn_bt_flt !: Filter choice |
|---|
| 116 | INTEGER, PUBLIC :: nn_baro !: Number of barotropic iterations during one baroclinic step (rdt) |
|---|
| 117 | REAL(wp), PUBLIC :: rn_bt_cmax !: Maximum allowed courant number (used if ln_bt_auto=T) |
|---|
| 118 | REAL(wp), PUBLIC :: rn_bt_alpha !: Time stepping diffusion parameter |
|---|
| 119 | |
|---|
| 120 | |
|---|
| 121 | ! !! old non-DOCTOR names still used in the model |
|---|
| 122 | REAL(wp), PUBLIC :: atfp !: asselin time filter parameter |
|---|
| 123 | REAL(wp), PUBLIC :: rdt !: time step for the dynamics and tracer |
|---|
| 124 | |
|---|
| 125 | ! !!! associated variables |
|---|
| 126 | INTEGER , PUBLIC :: neuler !: restart euler forward option (0=Euler) |
|---|
| 127 | REAL(wp), PUBLIC :: r2dt !: = 2*rdt except at nit000 (=rdt) if neuler=0 |
|---|
| 128 | |
|---|
| 129 | !!---------------------------------------------------------------------- |
|---|
| 130 | !! space domain parameters |
|---|
| 131 | !!---------------------------------------------------------------------- |
|---|
| 132 | INTEGER, PUBLIC :: jperio !: Global domain lateral boundary type (between 0 and 7) |
|---|
| 133 | ! ! = 0 closed ; = 1 cyclic East-West |
|---|
| 134 | ! ! = 2 cyclic North-South ; = 3 North fold T-point pivot |
|---|
| 135 | ! ! = 4 cyclic East-West AND North fold T-point pivot |
|---|
| 136 | ! ! = 5 North fold F-point pivot |
|---|
| 137 | ! ! = 6 cyclic East-West AND North fold F-point pivot |
|---|
| 138 | ! ! = 7 bi-cyclic East-West AND North-South |
|---|
| 139 | LOGICAL, PUBLIC :: l_Iperio, l_Jperio ! should we explicitely take care I/J periodicity |
|---|
| 140 | |
|---|
| 141 | ! ! domain MPP decomposition parameters |
|---|
| 142 | INTEGER , PUBLIC :: nimpp, njmpp !: i- & j-indexes for mpp-subdomain left bottom |
|---|
| 143 | INTEGER , PUBLIC :: nreci, nrecj !: overlap region in i and j |
|---|
| 144 | INTEGER , PUBLIC :: nproc !: number for local processor |
|---|
| 145 | INTEGER , PUBLIC :: narea !: number for local area |
|---|
| 146 | INTEGER , PUBLIC :: nbondi, nbondj !: mark of i- and j-direction local boundaries |
|---|
| 147 | |
|---|
| 148 | INTEGER, PUBLIC :: npolj !: north fold mark (0, 3 or 4) |
|---|
| 149 | INTEGER, PUBLIC :: nlci, nldi, nlei !: i-dimensions of the local subdomain and its first and last indoor indices |
|---|
| 150 | INTEGER, PUBLIC :: nlcj, nldj, nlej !: i-dimensions of the local subdomain and its first and last indoor indices |
|---|
| 151 | INTEGER, PUBLIC :: noea, nowe !: index of the local neighboring processors in |
|---|
| 152 | INTEGER, PUBLIC :: noso, nono !: east, west, south and north directions |
|---|
| 153 | INTEGER, PUBLIC :: nidom !: ??? |
|---|
| 154 | |
|---|
| 155 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: mig !: local ==> global domain i-index |
|---|
| 156 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: mjg !: local ==> global domain j-index |
|---|
| 157 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: mi0, mi1 !: global ==> local domain i-index (mi0=1 and mi1=0 if the global index |
|---|
| 158 | ! ! is not in the local domain) |
|---|
| 159 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: mj0, mj1 !: global ==> local domain j-index (mj0=1 and mj1=0 if the global index |
|---|
| 160 | ! ! is not in the local domain) |
|---|
| 161 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: nimppt, njmppt !: i-, j-indexes for each processor |
|---|
| 162 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: ibonit, ibonjt !: i-, j- processor neighbour existence |
|---|
| 163 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: nlcit , nlcjt !: dimensions of every subdomain |
|---|
| 164 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: nldit , nldjt !: first, last indoor index for each i-domain |
|---|
| 165 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: nleit , nlejt !: first, last indoor index for each j-domain |
|---|
| 166 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: nfiimpp, nfipproc, nfilcit |
|---|
| 167 | |
|---|
| 168 | !!---------------------------------------------------------------------- |
|---|
| 169 | !! horizontal curvilinear coordinate and scale factors |
|---|
| 170 | !! --------------------------------------------------------------------- |
|---|
| 171 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE , DIMENSION(:,:) :: glamt , glamu, glamv , glamf !: longitude at t, u, v, f-points [degree] |
|---|
| 172 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE , DIMENSION(:,:) :: gphit , gphiu, gphiv , gphif !: latitude at t, u, v, f-points [degree] |
|---|
| 173 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, TARGET, DIMENSION(:,:) :: e1t , e2t , r1_e1t, r1_e2t !: t-point horizontal scale factors [m] |
|---|
| 174 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, TARGET, DIMENSION(:,:) :: e1u , e2u , r1_e1u, r1_e2u !: horizontal scale factors at u-point [m] |
|---|
| 175 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, TARGET, DIMENSION(:,:) :: e1v , e2v , r1_e1v, r1_e2v !: horizontal scale factors at v-point [m] |
|---|
| 176 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, TARGET, DIMENSION(:,:) :: e1f , e2f , r1_e1f, r1_e2f !: horizontal scale factors at f-point [m] |
|---|
| 177 | ! |
|---|
| 178 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE , DIMENSION(:,:) :: e1e2t , r1_e1e2t !: associated metrics at t-point |
|---|
| 179 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE , DIMENSION(:,:) :: e1e2u , r1_e1e2u , e2_e1u !: associated metrics at u-point |
|---|
| 180 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE , DIMENSION(:,:) :: e1e2v , r1_e1e2v , e1_e2v !: associated metrics at v-point |
|---|
| 181 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE , DIMENSION(:,:) :: e1e2f , r1_e1e2f !: associated metrics at f-point |
|---|
| 182 | ! |
|---|
| 183 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE , DIMENSION(:,:) :: ff_f , ff_t !: Coriolis factor at f- & t-points [1/s] |
|---|
| 184 | |
|---|
| 185 | !! s-coordinate and hybrid z-s-coordinate |
|---|
| 186 | !! =----------------======--------------- |
|---|
| 187 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: gsigt, gsigw !: model level depth coefficient at t-, w-levels (analytic) |
|---|
| 188 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: gsi3w !: model level depth coefficient at w-level (sum of gsigw) |
|---|
| 189 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: esigt, esigw !: vertical scale factor coef. at t-, w-levels |
|---|
| 190 | |
|---|
| 191 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: hbatv , hbatf !: ocean depth at the vertical of v--f |
|---|
| 192 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: hbatt , hbatu !: t--u points (m) |
|---|
| 193 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: scosrf, scobot !: ocean surface and bottom topographies |
|---|
| 194 | ! ! (if deviating from coordinate surfaces in HYBRID) |
|---|
| 195 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: hifv , hiff !: interface depth between stretching at v--f |
|---|
| 196 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: hift , hifu !: and quasi-uniform spacing t--u points (m) |
|---|
| 197 | !!gm end |
|---|
| 198 | |
|---|
| 199 | !!---------------------------------------------------------------------- |
|---|
| 200 | !! vertical coordinate and scale factors |
|---|
| 201 | !! --------------------------------------------------------------------- |
|---|
| 202 | LOGICAL, PUBLIC :: ln_zco !: z-coordinate - full step |
|---|
| 203 | LOGICAL, PUBLIC :: ln_zps !: z-coordinate - partial step |
|---|
| 204 | LOGICAL, PUBLIC :: ln_sco !: s-coordinate or hybrid z-s coordinate |
|---|
| 205 | LOGICAL, PUBLIC :: ln_isfcav !: presence of ISF |
|---|
| 206 | ! |
|---|
| 207 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: e3t_0, e3u_0 , e3v_0 , e3f_0 !: t-,u-,v-,f-vert. scale factor [m] |
|---|
| 208 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: e3w_0, e3uw_0, e3vw_0 !: w-,uw-,vw-vert. scale factor [m] |
|---|
| 209 | ! |
|---|
| 210 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: gdept_0 !: t- depth [m] |
|---|
| 211 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: gdepw_0 !: w- depth [m] |
|---|
| 212 | ! |
|---|
| 213 | INTEGER, PUBLIC :: nla10 !: deepest W level Above ~10m (nlb10 - 1) |
|---|
| 214 | INTEGER, PUBLIC :: nlb10 !: shallowest W level Bellow ~10m (nla10 + 1) |
|---|
| 215 | ! |
|---|
| 216 | !! 1D reference vertical coordinate |
|---|
| 217 | !! =-----------------====------ |
|---|
| 218 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: gdept_1d, gdepw_1d !: reference depth of t- and w-points (m) |
|---|
| 219 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: e3t_1d , e3w_1d !: reference vertical scale factors at T- and W-pts (m) |
|---|
| 220 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: e3tp , e3wp !: ocean bottom level thickness at T and W points |
|---|
| 221 | |
|---|
| 222 | !!---------------------------------------------------------------------- |
|---|
| 223 | !! masks, top and bottom ocean point position |
|---|
| 224 | !! --------------------------------------------------------------------- |
|---|
| 225 | !!gm Proposition of new name for top/bottom vertical indices |
|---|
| 226 | ! INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: mtk_t, mtk_u, mtk_v !: top first wet T-, U-, V-, F-level (ISF) |
|---|
| 227 | ! INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: mbk_t, mbk_u, mbk_v !: bottom last wet T-, U- and V-level |
|---|
| 228 | !!gm |
|---|
| 229 | INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: mbathy !: number of ocean level (=0, 1, ... , jpk-1) |
|---|
| 230 | REAL(wp) , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: bathy !: number of ocean level (=0, 1, ... , jpk-1) |
|---|
| 231 | INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: mbkt, mbku, mbkv !: bottom last wet T-, U- and V-level |
|---|
| 232 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: tmask_i !: interior domain T-point mask |
|---|
| 233 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: tmask_h !: internal domain T-point mask (Figure 8.5 NEMO book) |
|---|
| 234 | |
|---|
| 235 | INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: misfdep !: top first ocean level (ISF) |
|---|
| 236 | INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: mikt, miku, mikv, mikf !: top first wet T-, U-, V-, F-level (ISF) |
|---|
| 237 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: risfdep !: Iceshelf draft (ISF) |
|---|
| 238 | |
|---|
| 239 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: ssmask, ssumask, ssvmask !: surface mask at T-,U-, V- and F-pts |
|---|
| 240 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:), TARGET :: tmask, umask, vmask, fmask !: land/ocean mask at T-, U-, V- and F-pts |
|---|
| 241 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:), TARGET :: wmask !: land/ocean mask at W- pts |
|---|
| 242 | |
|---|
| 243 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: msk_opnsea , msk_csundef !: open ocean mask, closed sea mask (all of them) |
|---|
| 244 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: msk_csglo , msk_csrnf , msk_csemp !: closed sea masks |
|---|
| 245 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: msk_csgrpglo, msk_csgrprnf, msk_csgrpemp !: closed sea masks |
|---|
| 246 | |
|---|
| 247 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: tpol, fpol !: north fold mask (jperio= 3 or 4) |
|---|
| 248 | |
|---|
| 249 | !!---------------------------------------------------------------------- |
|---|
| 250 | !! calendar variables |
|---|
| 251 | !! --------------------------------------------------------------------- |
|---|
| 252 | INTEGER , PUBLIC :: nyear !: current year |
|---|
| 253 | INTEGER , PUBLIC :: nmonth !: current month |
|---|
| 254 | INTEGER , PUBLIC :: nday !: current day of the month |
|---|
| 255 | INTEGER , PUBLIC :: nhour !: current hour |
|---|
| 256 | INTEGER , PUBLIC :: nminute !: current minute |
|---|
| 257 | INTEGER , PUBLIC :: ndastp !: time step date in yyyymmdd format |
|---|
| 258 | INTEGER , PUBLIC :: nday_year !: current day counted from jan 1st of the current year |
|---|
| 259 | INTEGER , PUBLIC :: nsec_year !: current time step counted in second since 00h jan 1st of the current year |
|---|
| 260 | INTEGER , PUBLIC :: nsec_month !: current time step counted in second since 00h 1st day of the current month |
|---|
| 261 | INTEGER , PUBLIC :: nsec_week !: current time step counted in second since 00h of last monday |
|---|
| 262 | INTEGER , PUBLIC :: nsec_day !: current time step counted in second since 00h of the current day |
|---|
| 263 | REAL(wp), PUBLIC :: fjulday !: current julian day |
|---|
| 264 | REAL(wp), PUBLIC :: fjulstartyear !: first day of the current year in julian days |
|---|
| 265 | REAL(wp), PUBLIC :: adatrj !: number of elapsed days since the begining of the whole simulation |
|---|
| 266 | ! !: (cumulative duration of previous runs that may have used different time-step size) |
|---|
| 267 | INTEGER , PUBLIC, DIMENSION(0: 2) :: nyear_len !: length in days of the previous/current/next year |
|---|
| 268 | INTEGER , PUBLIC, DIMENSION(0:13) :: nmonth_len !: length in days of the months of the current year |
|---|
| 269 | INTEGER , PUBLIC, DIMENSION(0:13) :: nmonth_half !: second since Jan 1st 0h of the current year and the half of the months |
|---|
| 270 | INTEGER , PUBLIC, DIMENSION(0:13) :: nmonth_end !: second since Jan 1st 0h of the current year and the end of the months |
|---|
| 271 | INTEGER , PUBLIC :: nsec1jan000 !: second since Jan 1st 0h of nit000 year and Jan 1st 0h the current year |
|---|
| 272 | |
|---|
| 273 | !!---------------------------------------------------------------------- |
|---|
| 274 | !! agrif domain |
|---|
| 275 | !!---------------------------------------------------------------------- |
|---|
| 276 | #if defined key_agrif |
|---|
| 277 | LOGICAL, PUBLIC, PARAMETER :: lk_agrif = .TRUE. !: agrif flag |
|---|
| 278 | LOGICAL, PUBLIC :: lk_south, lk_north, lk_west, lk_east !: Child grid boundaries (interpolation or not) |
|---|
| 279 | #else |
|---|
| 280 | LOGICAL, PUBLIC, PARAMETER :: lk_agrif = .FALSE. !: agrif flag |
|---|
| 281 | #endif |
|---|
| 282 | |
|---|
| 283 | !!---------------------------------------------------------------------- |
|---|
| 284 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
|---|
| 285 | !! $Id: dom_oce.F90 10068 2018-08-28 14:09:04Z nicolasmartin $ |
|---|
| 286 | !! Software governed by the CeCILL license (see ./LICENSE) |
|---|
| 287 | !!---------------------------------------------------------------------- |
|---|
| 288 | CONTAINS |
|---|
| 289 | |
|---|
| 290 | #if ! defined key_agrif |
|---|
| 291 | !!---------------------------------------------------------------------- |
|---|
| 292 | !! NOT 'key_agrif' dummy function No AGRIF zoom |
|---|
| 293 | !!---------------------------------------------------------------------- |
|---|
| 294 | LOGICAL FUNCTION Agrif_Root() |
|---|
| 295 | Agrif_Root = .TRUE. |
|---|
| 296 | END FUNCTION Agrif_Root |
|---|
| 297 | |
|---|
| 298 | CHARACTER(len=3) FUNCTION Agrif_CFixed() |
|---|
| 299 | Agrif_CFixed = '0' |
|---|
| 300 | END FUNCTION Agrif_CFixed |
|---|
| 301 | #endif |
|---|
| 302 | |
|---|
| 303 | INTEGER FUNCTION dom_oce_alloc() |
|---|
| 304 | !!---------------------------------------------------------------------- |
|---|
| 305 | INTEGER, DIMENSION(11) :: ierr |
|---|
| 306 | !!---------------------------------------------------------------------- |
|---|
| 307 | ierr(:) = 0 |
|---|
| 308 | ! |
|---|
| 309 | ALLOCATE( mig(jpi), mjg(jpj), STAT=ierr(1) ) |
|---|
| 310 | ! |
|---|
| 311 | ALLOCATE( mi0(jpiglo) , mi1 (jpiglo), mj0(jpjglo) , mj1 (jpjglo) , & |
|---|
| 312 | & tpol(jpiglo) , fpol(jpiglo) , STAT=ierr(2) ) |
|---|
| 313 | ! |
|---|
| 314 | ALLOCATE( glamt(jpi,jpj) , glamu(jpi,jpj) , glamv(jpi,jpj) , glamf(jpi,jpj) , & |
|---|
| 315 | & gphit(jpi,jpj) , gphiu(jpi,jpj) , gphiv(jpi,jpj) , gphif(jpi,jpj) , & |
|---|
| 316 | & e1t (jpi,jpj) , e2t (jpi,jpj) , r1_e1t(jpi,jpj) , r1_e2t(jpi,jpj) , & |
|---|
| 317 | & e1u (jpi,jpj) , e2u (jpi,jpj) , r1_e1u(jpi,jpj) , r1_e2u(jpi,jpj) , & |
|---|
| 318 | & e1v (jpi,jpj) , e2v (jpi,jpj) , r1_e1v(jpi,jpj) , r1_e2v(jpi,jpj) , & |
|---|
| 319 | & e1f (jpi,jpj) , e2f (jpi,jpj) , r1_e1f(jpi,jpj) , r1_e2f(jpi,jpj) , & |
|---|
| 320 | & e1e2t(jpi,jpj) , r1_e1e2t(jpi,jpj) , & |
|---|
| 321 | & e1e2u(jpi,jpj) , r1_e1e2u(jpi,jpj) , e2_e1u(jpi,jpj) , & |
|---|
| 322 | & e1e2v(jpi,jpj) , r1_e1e2v(jpi,jpj) , e1_e2v(jpi,jpj) , & |
|---|
| 323 | & e1e2f(jpi,jpj) , r1_e1e2f(jpi,jpj) , & |
|---|
| 324 | & ff_f (jpi,jpj) , ff_t (jpi,jpj) , STAT=ierr(3) ) |
|---|
| 325 | ! |
|---|
| 326 | ! ALLOCATE( gdept_0(jpi,jpj,jpk) , gdepw_0(jpi,jpj,jpk) , gde3w_0(jpi,jpj,jpk) , & |
|---|
| 327 | ! & gdept_b(jpi,jpj,jpk) , gdepw_b(jpi,jpj,jpk) , & |
|---|
| 328 | ! & gdept_n(jpi,jpj,jpk) , gdepw_n(jpi,jpj,jpk) , gde3w_n(jpi,jpj,jpk) , STAT=ierr(4) ) |
|---|
| 329 | |
|---|
| 330 | ALLOCATE( gdept_0(jpi,jpj,jpk) , gdepw_0(jpi,jpj,jpk), STAT=ierr(4) ) |
|---|
| 331 | |
|---|
| 332 | ! |
|---|
| 333 | ! ALLOCATE( e3t_0(jpi,jpj,jpk) , e3u_0(jpi,jpj,jpk) , e3v_0(jpi,jpj,jpk) , e3f_0(jpi,jpj,jpk) , e3w_0(jpi,jpj,jpk) , & |
|---|
| 334 | ! & e3t_b(jpi,jpj,jpk) , e3u_b(jpi,jpj,jpk) , e3v_b(jpi,jpj,jpk) , e3w_b(jpi,jpj,jpk) , & |
|---|
| 335 | ! & e3t_n(jpi,jpj,jpk) , e3u_n(jpi,jpj,jpk) , e3v_n(jpi,jpj,jpk) , e3f_n(jpi,jpj,jpk) , e3w_n(jpi,jpj,jpk) , & |
|---|
| 336 | ! & e3t_a(jpi,jpj,jpk) , e3u_a(jpi,jpj,jpk) , e3v_a(jpi,jpj,jpk) , & |
|---|
| 337 | ! ! ! |
|---|
| 338 | ! & e3uw_0(jpi,jpj,jpk) , e3vw_0(jpi,jpj,jpk) , & |
|---|
| 339 | ! & e3uw_b(jpi,jpj,jpk) , e3vw_b(jpi,jpj,jpk) , & |
|---|
| 340 | ! & e3uw_n(jpi,jpj,jpk) , e3vw_n(jpi,jpj,jpk) , STAT=ierr(5) ) |
|---|
| 341 | |
|---|
| 342 | ! |
|---|
| 343 | ! ALLOCATE( ht_0(jpi,jpj) , hu_0(jpi,jpj) , hv_0(jpi,jpj) , & |
|---|
| 344 | ! & hu_b(jpi,jpj) , hv_b(jpi,jpj) , r1_hu_b(jpi,jpj) , r1_hv_b(jpi,jpj) , & |
|---|
| 345 | ! & ht_n(jpi,jpj) , hu_n(jpi,jpj) , hv_n(jpi,jpj) , r1_hu_n(jpi,jpj) , r1_hv_n(jpi,jpj) , & |
|---|
| 346 | ! & hu_a(jpi,jpj) , hv_a(jpi,jpj) , r1_hu_a(jpi,jpj) , r1_hv_a(jpi,jpj) , STAT=ierr(6) ) |
|---|
| 347 | ! |
|---|
| 348 | ALLOCATE( e3t_0 (jpi,jpj,jpk) , e3u_0 (jpi,jpj,jpk) , e3v_0(jpi,jpj,jpk) , e3f_0(jpi,jpj,jpk) , e3w_0(jpi,jpj,jpk) , & |
|---|
| 349 | & e3uw_0(jpi,jpj,jpk) , e3vw_0(jpi,jpj,jpk) , STAT=ierr(5) ) |
|---|
| 350 | ! |
|---|
| 351 | ALLOCATE( gdept_1d(jpk) , e3tp (jpi,jpj), e3wp(jpi,jpj) ,gdepw_1d(jpk) , e3t_1d(jpk) , e3w_1d(jpk) , STAT=ierr(6) ) |
|---|
| 352 | ! |
|---|
| 353 | ALLOCATE( bathy(jpi,jpj),mbathy(jpi,jpj), tmask_i(jpi,jpj) , tmask_h(jpi,jpj) , & |
|---|
| 354 | & ssmask (jpi,jpj) , ssumask(jpi,jpj) , ssvmask(jpi,jpj) , & |
|---|
| 355 | & mbkt (jpi,jpj) , mbku (jpi,jpj) , mbkv (jpi,jpj) , STAT=ierr(7) ) |
|---|
| 356 | ! |
|---|
| 357 | ALLOCATE( misfdep(jpi,jpj) , mikt(jpi,jpj) , miku(jpi,jpj) , & |
|---|
| 358 | & risfdep(jpi,jpj) , mikv(jpi,jpj) , mikf(jpi,jpj) , STAT=ierr(8) ) |
|---|
| 359 | ! |
|---|
| 360 | ALLOCATE( tmask(jpi,jpj,jpk) , umask(jpi,jpj,jpk) , & |
|---|
| 361 | & vmask(jpi,jpj,jpk) , fmask(jpi,jpj,jpk) , wmask(jpi,jpj,jpk) , STAT=ierr(9) ) |
|---|
| 362 | ! |
|---|
| 363 | ALLOCATE( hbatv (jpi,jpj) , hbatf (jpi,jpj) , & |
|---|
| 364 | & hbatt (jpi,jpj) , hbatu (jpi,jpj) , & |
|---|
| 365 | & scosrf(jpi,jpj) , scobot(jpi,jpj) , & |
|---|
| 366 | & hifv (jpi,jpj) , hiff (jpi,jpj) , & |
|---|
| 367 | & hift (jpi,jpj) , hifu (jpi,jpj) , STAT=ierr(10) ) |
|---|
| 368 | |
|---|
| 369 | ALLOCATE( msk_opnsea (jpi,jpj), msk_csundef (jpi,jpj), & |
|---|
| 370 | & msk_csglo (jpi,jpj), msk_csrnf (jpi,jpj), msk_csemp (jpi,jpj), & |
|---|
| 371 | & msk_csgrpglo(jpi,jpj), msk_csgrprnf(jpi,jpj), msk_csgrpemp(jpi,jpj), STAT=ierr(11) ) ! |
|---|
| 372 | dom_oce_alloc = MAXVAL(ierr) |
|---|
| 373 | ! |
|---|
| 374 | END FUNCTION dom_oce_alloc |
|---|
| 375 | |
|---|
| 376 | !!====================================================================== |
|---|
| 377 | END MODULE dom_oce |
|---|
