| 1 | MODULE dom_oce |
|---|
| 2 | !!====================================================================== |
|---|
| 3 | !! *** MODULE dom_oce *** |
|---|
| 4 | !! ** Purpose : Define in memory all the ocean space domain variables |
|---|
| 5 | !!====================================================================== |
|---|
| 6 | !! History : 1.0 ! 2005-10 (A. Beckmann, G. Madec) reactivate s-coordinate |
|---|
| 7 | !! 3.3 ! 2010-11 (G. Madec) add mbk. arrays associated to the deepest ocean level |
|---|
| 8 | !! 3.4 ! 2011-01 (A. R. Porter, STFC Daresbury) dynamical allocation |
|---|
| 9 | !! 3.5 ! 2012 (S. Mocavero, I. Epicoco) Add arrays associated |
|---|
| 10 | !! to the optimization of BDY communications |
|---|
| 11 | !! 3.7 ! 2015-11 (G. Madec) introduce surface and scale factor ratio |
|---|
| 12 | !! - ! 2015-11 (G. Madec, A. Coward) time varying zgr by default |
|---|
| 13 | !! 4.1 ! 2019-08 (A. Coward, D. Storkey) rename prognostic variables in preparation for new time scheme. |
|---|
| 14 | !! 4.x ! 2020-02 (G. Madec, S. Techene) introduce ssh to h0 ratio |
|---|
| 15 | !!---------------------------------------------------------------------- |
|---|
| 16 | |
|---|
| 17 | !!---------------------------------------------------------------------- |
|---|
| 18 | !! Agrif_Root : dummy function used when lk_agrif=F |
|---|
| 19 | !! Agrif_Fixed : dummy function used when lk_agrif=F |
|---|
| 20 | !! Agrif_CFixed : dummy function used when lk_agrif=F |
|---|
| 21 | !! dom_oce_alloc : dynamical allocation of dom_oce arrays |
|---|
| 22 | !!---------------------------------------------------------------------- |
|---|
| 23 | USE par_oce ! ocean parameters |
|---|
| 24 | |
|---|
| 25 | IMPLICIT NONE |
|---|
| 26 | PUBLIC ! allows the acces to par_oce when dom_oce is used (exception to coding rules) |
|---|
| 27 | |
|---|
| 28 | PUBLIC dom_oce_alloc ! Called from nemogcm.F90 |
|---|
| 29 | |
|---|
| 30 | !!---------------------------------------------------------------------- |
|---|
| 31 | !! time & space domain namelist |
|---|
| 32 | !! ---------------------------- |
|---|
| 33 | ! !!* Namelist namdom : time & space domain * |
|---|
| 34 | LOGICAL , PUBLIC :: ln_linssh !: =T linear free surface ==>> model level are fixed in time |
|---|
| 35 | LOGICAL , PUBLIC :: ln_meshmask !: =T create a mesh-mask file (mesh_mask.nc) |
|---|
| 36 | REAL(wp), PUBLIC :: rn_Dt !: time step for the dynamics and tracer |
|---|
| 37 | REAL(wp), PUBLIC :: rn_atfp !: asselin time filter parameter |
|---|
| 38 | LOGICAL , PUBLIC :: ln_1st_euler !: =T start with forward time step or not (=F) |
|---|
| 39 | LOGICAL , PUBLIC :: ln_crs !: Apply grid coarsening to dynamical model output or online passive tracers |
|---|
| 40 | |
|---|
| 41 | !! Free surface parameters |
|---|
| 42 | !! ======================= |
|---|
| 43 | LOGICAL , PUBLIC :: ln_dynspg_exp !: Explicit free surface flag |
|---|
| 44 | LOGICAL , PUBLIC :: ln_dynspg_ts !: Split-Explicit free surface flag |
|---|
| 45 | |
|---|
| 46 | !! Time splitting parameters |
|---|
| 47 | !! ========================= |
|---|
| 48 | LOGICAL, PUBLIC :: ln_bt_fw !: Forward integration of barotropic sub-stepping |
|---|
| 49 | LOGICAL, PUBLIC :: ln_bt_av !: Time averaging of barotropic variables |
|---|
| 50 | LOGICAL, PUBLIC :: ln_bt_auto !: Set number of barotropic iterations automatically |
|---|
| 51 | INTEGER, PUBLIC :: nn_bt_flt !: Filter choice |
|---|
| 52 | INTEGER, PUBLIC :: nn_e !: Number of barotropic iterations during one baroclinic step (rn_Dt) |
|---|
| 53 | REAL(wp), PUBLIC :: rn_bt_cmax !: Maximum allowed courant number (used if ln_bt_auto=T) |
|---|
| 54 | REAL(wp), PUBLIC :: rn_bt_alpha !: Time stepping diffusion parameter |
|---|
| 55 | |
|---|
| 56 | |
|---|
| 57 | ! !!! associated variables |
|---|
| 58 | LOGICAL , PUBLIC :: l_1st_euler !: Euler 1st time-step flag (=T if ln_restart=F or ln_1st_euler=T) |
|---|
| 59 | REAL(wp), PUBLIC :: rDt, r1_Dt !: Current model timestep and reciprocal |
|---|
| 60 | !: rDt = 2 * rn_Dt if leapfrog and l_1st_euler = F |
|---|
| 61 | !: = rn_Dt if leapfrog and l_1st_euler = T |
|---|
| 62 | !: = rn_Dt if RK3 |
|---|
| 63 | |
|---|
| 64 | !!---------------------------------------------------------------------- |
|---|
| 65 | !! space domain parameters |
|---|
| 66 | !!---------------------------------------------------------------------- |
|---|
| 67 | INTEGER, PUBLIC :: jperio !: Global domain lateral boundary type (between 0 and 7) |
|---|
| 68 | ! ! = 0 closed ; = 1 cyclic East-West |
|---|
| 69 | ! ! = 2 cyclic North-South ; = 3 North fold T-point pivot |
|---|
| 70 | ! ! = 4 cyclic East-West AND North fold T-point pivot |
|---|
| 71 | ! ! = 5 North fold F-point pivot |
|---|
| 72 | ! ! = 6 cyclic East-West AND North fold F-point pivot |
|---|
| 73 | ! ! = 7 bi-cyclic East-West AND North-South |
|---|
| 74 | LOGICAL, PUBLIC :: l_Iperio, l_Jperio ! should we explicitely take care I/J periodicity |
|---|
| 75 | LOGICAL, PUBLIC :: l_NFoldT, l_NFoldF |
|---|
| 76 | |
|---|
| 77 | ! Tiling namelist |
|---|
| 78 | LOGICAL, PUBLIC :: ln_tile |
|---|
| 79 | INTEGER :: nn_ltile_i, nn_ltile_j |
|---|
| 80 | |
|---|
| 81 | ! Domain tiling (all tiles) |
|---|
| 82 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: ntsi_a !: start of internal part of tile domain |
|---|
| 83 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: ntsj_a ! |
|---|
| 84 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: ntei_a !: end of internal part of tile domain |
|---|
| 85 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: ntej_a ! |
|---|
| 86 | |
|---|
| 87 | ! !: domain MPP decomposition parameters |
|---|
| 88 | INTEGER , PUBLIC :: nimpp, njmpp !: i- & j-indexes for mpp-subdomain left bottom |
|---|
| 89 | INTEGER , PUBLIC :: narea !: number for local area (starting at 1) = MPI rank + 1 |
|---|
| 90 | INTEGER, PUBLIC :: nidom !: IOIPSL things... |
|---|
| 91 | |
|---|
| 92 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: mig !: local ==> global domain, including halos (jpiglo), i-index |
|---|
| 93 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: mjg !: local ==> global domain, including halos (jpjglo), j-index |
|---|
| 94 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: mig0 !: local ==> global domain, excluding halos (Ni0glo), i-index |
|---|
| 95 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: mjg0 !: local ==> global domain, excluding halos (Nj0glo), j-index |
|---|
| 96 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: mi0, mi1 !: global, including halos (jpiglo) ==> local domain i-index |
|---|
| 97 | ! !: (mi0=1 and mi1=0 if global index not in local domain) |
|---|
| 98 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: mj0, mj1 !: global, including halos (jpjglo) ==> local domain j-index |
|---|
| 99 | ! !: (mj0=1 and mj1=0 if global index not in local domain) |
|---|
| 100 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: nfimpp, nfproc, nfjpi |
|---|
| 101 | |
|---|
| 102 | !!---------------------------------------------------------------------- |
|---|
| 103 | !! horizontal curvilinear coordinate and scale factors |
|---|
| 104 | !! --------------------------------------------------------------------- |
|---|
| 105 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE , DIMENSION(:,:) :: glamt , glamu, glamv , glamf !: longitude at t, u, v, f-points [degree] |
|---|
| 106 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE , DIMENSION(:,:) :: gphit , gphiu, gphiv , gphif !: latitude at t, u, v, f-points [degree] |
|---|
| 107 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, TARGET, DIMENSION(:,:) :: e1t , e2t , r1_e1t, r1_e2t !: t-point horizontal scale factors [m] |
|---|
| 108 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, TARGET, DIMENSION(:,:) :: e1u , e2u , r1_e1u, r1_e2u !: horizontal scale factors at u-point [m] |
|---|
| 109 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, TARGET, DIMENSION(:,:) :: e1v , e2v , r1_e1v, r1_e2v !: horizontal scale factors at v-point [m] |
|---|
| 110 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, TARGET, DIMENSION(:,:) :: e1f , e2f , r1_e1f, r1_e2f !: horizontal scale factors at f-point [m] |
|---|
| 111 | ! |
|---|
| 112 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE , DIMENSION(:,:) :: e1e2t , r1_e1e2t !: associated metrics at t-point |
|---|
| 113 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE , DIMENSION(:,:) :: e1e2u , r1_e1e2u , e2_e1u !: associated metrics at u-point |
|---|
| 114 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE , DIMENSION(:,:) :: e1e2v , r1_e1e2v , e1_e2v !: associated metrics at v-point |
|---|
| 115 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE , DIMENSION(:,:) :: e1e2f , r1_e1e2f !: associated metrics at f-point |
|---|
| 116 | ! |
|---|
| 117 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: ff_f , ff_t !: Coriolis factor at f- & t-points [1/s] |
|---|
| 118 | |
|---|
| 119 | !!---------------------------------------------------------------------- |
|---|
| 120 | !! vertical coordinate and scale factors |
|---|
| 121 | !! --------------------------------------------------------------------- |
|---|
| 122 | #if defined key_qco |
|---|
| 123 | LOGICAL, PUBLIC, PARAMETER :: lk_qco = .TRUE. !: qco key flag |
|---|
| 124 | #else |
|---|
| 125 | LOGICAL, PUBLIC, PARAMETER :: lk_qco = .FALSE. !: qco key flag |
|---|
| 126 | #endif |
|---|
| 127 | #if defined key_linssh |
|---|
| 128 | LOGICAL, PUBLIC, PARAMETER :: lk_linssh = .TRUE. !: linssh key flag |
|---|
| 129 | #else |
|---|
| 130 | LOGICAL, PUBLIC, PARAMETER :: lk_linssh = .FALSE. !: linssh key flag |
|---|
| 131 | #endif |
|---|
| 132 | LOGICAL, PUBLIC :: ln_zco !: z-coordinate - full step |
|---|
| 133 | LOGICAL, PUBLIC :: ln_zps !: z-coordinate - partial step |
|---|
| 134 | LOGICAL, PUBLIC :: ln_sco !: s-coordinate or hybrid z-s coordinate |
|---|
| 135 | LOGICAL, PUBLIC :: ln_isfcav !: presence of ISF |
|---|
| 136 | ! ! reference scale factors |
|---|
| 137 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: e3t_0 !: t- vert. scale factor [m] |
|---|
| 138 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: e3u_0 !: u- vert. scale factor [m] |
|---|
| 139 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: e3v_0 !: v- vert. scale factor [m] |
|---|
| 140 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: e3f_0 !: f- vert. scale factor [m] |
|---|
| 141 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: e3w_0 !: w- vert. scale factor [m] |
|---|
| 142 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: e3uw_0 !: uw-vert. scale factor [m] |
|---|
| 143 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: e3vw_0 !: vw-vert. scale factor [m] |
|---|
| 144 | |
|---|
| 145 | ! ! time-dependent scale factors (domvvl) |
|---|
| 146 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) :: e3t, e3u, e3v, e3w, e3uw, e3vw !: vert. scale factor [m] |
|---|
| 147 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: e3f !: F-point vert. scale factor [m] |
|---|
| 148 | |
|---|
| 149 | ! ! time-dependent ratio ssh / h_0 (domqco) |
|---|
| 150 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: r3t, r3u, r3v !: time-dependent ratio at t-, u- and v-point [-] |
|---|
| 151 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: r3f !: mid-time-level ratio at f-point [-] |
|---|
| 152 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: r3t_f, r3u_f, r3v_f !: now time-filtered ratio at t-, u- and v-point [-] |
|---|
| 153 | |
|---|
| 154 | ! ! reference depths of cells |
|---|
| 155 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: gdept_0 !: t- depth [m] |
|---|
| 156 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: gdepw_0 !: w- depth [m] |
|---|
| 157 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: gde3w_0 !: w- depth (sum of e3w) [m] |
|---|
| 158 | |
|---|
| 159 | ! ! time-dependent depths of cells (domvvl) |
|---|
| 160 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) :: gdept, gdepw |
|---|
| 161 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: gde3w |
|---|
| 162 | |
|---|
| 163 | ! ! reference heights of ocean water column and its inverse |
|---|
| 164 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: ht_0, r1_ht_0 !: t-depth [m] and [1/m] |
|---|
| 165 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: hu_0, r1_hu_0 !: u-depth [m] and [1/m] |
|---|
| 166 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: hv_0, r1_hv_0 !: v-depth [m] and [1/m] |
|---|
| 167 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: hf_0, r1_hf_0 !: f-depth [m] and [1/m] |
|---|
| 168 | |
|---|
| 169 | ! ! time-dependent heights of ocean water column (domvvl) |
|---|
| 170 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: ht !: t-points [m] |
|---|
| 171 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: hu, r1_hu !: u-depth [m] and [1/m] |
|---|
| 172 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: hv, r1_hv !: v-depth [m] and [1/m] |
|---|
| 173 | |
|---|
| 174 | INTEGER, PUBLIC :: nla10 !: deepest W level Above ~10m (nlb10 - 1) |
|---|
| 175 | INTEGER, PUBLIC :: nlb10 !: shallowest W level Bellow ~10m (nla10 + 1) |
|---|
| 176 | |
|---|
| 177 | !! 1D reference vertical coordinate |
|---|
| 178 | !! =-----------------====------ |
|---|
| 179 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: gdept_1d, gdepw_1d !: reference depth of t- and w-points (m) |
|---|
| 180 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: e3t_1d , e3w_1d !: reference vertical scale factors at T- and W-pts (m) |
|---|
| 181 | |
|---|
| 182 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: risfdep, bathy |
|---|
| 183 | |
|---|
| 184 | !!---------------------------------------------------------------------- |
|---|
| 185 | !! masks, top and bottom ocean point position |
|---|
| 186 | !! --------------------------------------------------------------------- |
|---|
| 187 | !!gm Proposition of new name for top/bottom vertical indices |
|---|
| 188 | ! INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: mtk_t, mtk_u, mtk_v !: top first wet T-, U-, and V-level (ISF) |
|---|
| 189 | ! INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: mbk_t, mbk_u, mbk_v !: bottom last wet T-, U-, and V-level |
|---|
| 190 | !!gm |
|---|
| 191 | INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: mbkt, mbku, mbkv !: bottom last wet T-, U- and V-level |
|---|
| 192 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: tmask_i !: interior domain T-point mask |
|---|
| 193 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: tmask_h !: internal domain T-point mask (Figure 8.5 NEMO book) |
|---|
| 194 | |
|---|
| 195 | INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: mikt, miku, mikv, mikf !: top first wet T-, U-, V-, F-level (ISF) |
|---|
| 196 | |
|---|
| 197 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: ssmask, ssumask, ssvmask, ssfmask !: surface mask at T-,U-, V- and F-pts |
|---|
| 198 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:), TARGET :: tmask, umask, vmask, wmask, fmask !: land/ocean mask at T-, U-, V-, W- and F-pts |
|---|
| 199 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:), TARGET :: wumask, wvmask !: land/ocean mask at WU- and WV-pts |
|---|
| 200 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:), TARGET :: fe3mask !: land/ocean mask at F-pts (qco only) |
|---|
| 201 | |
|---|
| 202 | !!---------------------------------------------------------------------- |
|---|
| 203 | !! calendar variables |
|---|
| 204 | !! --------------------------------------------------------------------- |
|---|
| 205 | INTEGER , PUBLIC :: nyear !: current year |
|---|
| 206 | INTEGER , PUBLIC :: nmonth !: current month |
|---|
| 207 | INTEGER , PUBLIC :: nday !: current day of the month |
|---|
| 208 | INTEGER , PUBLIC :: nhour !: current hour |
|---|
| 209 | INTEGER , PUBLIC :: nminute !: current minute |
|---|
| 210 | INTEGER , PUBLIC :: ndastp !: time step date in yyyymmdd format |
|---|
| 211 | INTEGER , PUBLIC :: nday_year !: current day counted from jan 1st of the current year |
|---|
| 212 | INTEGER , PUBLIC :: nsec_year !: seconds between 00h jan 1st of the current year and half of the current time step |
|---|
| 213 | INTEGER , PUBLIC :: nsec_month !: seconds between 00h 1st day of the current month and half of the current time step |
|---|
| 214 | INTEGER , PUBLIC :: nsec_monday !: seconds between 00h of the last Monday and half of the current time step |
|---|
| 215 | INTEGER , PUBLIC :: nsec_day !: seconds between 00h of the current day and half of the current time step |
|---|
| 216 | REAL(wp), PUBLIC :: fjulday !: current julian day |
|---|
| 217 | REAL(wp), PUBLIC :: fjulstartyear !: first day of the current year in julian days |
|---|
| 218 | REAL(wp), PUBLIC :: adatrj !: number of elapsed days since the begining of the whole simulation |
|---|
| 219 | ! !: (cumulative duration of previous runs that may have used different time-step size) |
|---|
| 220 | INTEGER , PUBLIC, DIMENSION( 0: 2) :: nyear_len !: length in days of the previous/current/next year |
|---|
| 221 | INTEGER , PUBLIC, DIMENSION(-11:25) :: nmonth_len !: length in days of the months of the current year |
|---|
| 222 | INTEGER , PUBLIC, DIMENSION(-11:25) :: nmonth_beg !: second since Jan 1st 0h of the current year and the half of the months |
|---|
| 223 | INTEGER , PUBLIC :: nsec1jan000 !: second since Jan 1st 0h of nit000 year and Jan 1st 0h the current year |
|---|
| 224 | INTEGER , PUBLIC :: nsec000_1jan000 !: second since Jan 1st 0h of nit000 year and nit000 |
|---|
| 225 | INTEGER , PUBLIC :: nsecend_1jan000 !: second since Jan 1st 0h of nit000 year and nitend |
|---|
| 226 | |
|---|
| 227 | !!---------------------------------------------------------------------- |
|---|
| 228 | !! variable defined here to avoid circular dependencies... |
|---|
| 229 | !! --------------------------------------------------------------------- |
|---|
| 230 | INTEGER, PUBLIC :: nbasin ! number of basin to be considered in diaprt (glo, atl, pac, ind, ipc) |
|---|
| 231 | |
|---|
| 232 | !!---------------------------------------------------------------------- |
|---|
| 233 | !! agrif domain |
|---|
| 234 | !!---------------------------------------------------------------------- |
|---|
| 235 | #if defined key_agrif |
|---|
| 236 | LOGICAL, PUBLIC, PARAMETER :: lk_agrif = .TRUE. !: agrif flag |
|---|
| 237 | LOGICAL, PUBLIC :: lk_south, lk_north, lk_west, lk_east !: Child grid boundaries (interpolation or not) |
|---|
| 238 | #else |
|---|
| 239 | LOGICAL, PUBLIC, PARAMETER :: lk_agrif = .FALSE. !: agrif flag |
|---|
| 240 | #endif |
|---|
| 241 | |
|---|
| 242 | !!---------------------------------------------------------------------- |
|---|
| 243 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
|---|
| 244 | !! $Id$ |
|---|
| 245 | !! Software governed by the CeCILL license (see ./LICENSE) |
|---|
| 246 | !!---------------------------------------------------------------------- |
|---|
| 247 | CONTAINS |
|---|
| 248 | |
|---|
| 249 | #if ! defined key_agrif |
|---|
| 250 | !!---------------------------------------------------------------------- |
|---|
| 251 | !! NOT 'key_agrif' dummy function No AGRIF zoom |
|---|
| 252 | !!---------------------------------------------------------------------- |
|---|
| 253 | LOGICAL FUNCTION Agrif_Root() |
|---|
| 254 | Agrif_Root = .TRUE. |
|---|
| 255 | END FUNCTION Agrif_Root |
|---|
| 256 | |
|---|
| 257 | INTEGER FUNCTION Agrif_Fixed() |
|---|
| 258 | Agrif_Fixed = 0 |
|---|
| 259 | END FUNCTION Agrif_Fixed |
|---|
| 260 | |
|---|
| 261 | CHARACTER(len=3) FUNCTION Agrif_CFixed() |
|---|
| 262 | Agrif_CFixed = '0' |
|---|
| 263 | END FUNCTION Agrif_CFixed |
|---|
| 264 | #endif |
|---|
| 265 | |
|---|
| 266 | INTEGER FUNCTION dom_oce_alloc() |
|---|
| 267 | !!---------------------------------------------------------------------- |
|---|
| 268 | INTEGER :: ii |
|---|
| 269 | INTEGER, DIMENSION(30) :: ierr |
|---|
| 270 | !!---------------------------------------------------------------------- |
|---|
| 271 | ii = 0 ; ierr(:) = 0 |
|---|
| 272 | ! |
|---|
| 273 | ii = ii+1 |
|---|
| 274 | ALLOCATE( mig(jpi), mjg(jpj), mig0(jpi), mjg0(jpj), STAT=ierr(ii) ) |
|---|
| 275 | ! |
|---|
| 276 | ii = ii+1 |
|---|
| 277 | ALLOCATE( mi0(jpiglo), mi1(jpiglo), mj0(jpjglo), mj1(jpjglo), STAT=ierr(ii) ) |
|---|
| 278 | ! |
|---|
| 279 | ii = ii+1 |
|---|
| 280 | ALLOCATE( glamt(jpi,jpj) , glamu(jpi,jpj) , glamv(jpi,jpj) , glamf(jpi,jpj) , & |
|---|
| 281 | & gphit(jpi,jpj) , gphiu(jpi,jpj) , gphiv(jpi,jpj) , gphif(jpi,jpj) , & |
|---|
| 282 | & e1t (jpi,jpj) , e2t (jpi,jpj) , r1_e1t(jpi,jpj) , r1_e2t(jpi,jpj) , & |
|---|
| 283 | & e1u (jpi,jpj) , e2u (jpi,jpj) , r1_e1u(jpi,jpj) , r1_e2u(jpi,jpj) , & |
|---|
| 284 | & e1v (jpi,jpj) , e2v (jpi,jpj) , r1_e1v(jpi,jpj) , r1_e2v(jpi,jpj) , & |
|---|
| 285 | & e1f (jpi,jpj) , e2f (jpi,jpj) , r1_e1f(jpi,jpj) , r1_e2f(jpi,jpj) , & |
|---|
| 286 | & e1e2t(jpi,jpj) , r1_e1e2t(jpi,jpj) , & |
|---|
| 287 | & e1e2u(jpi,jpj) , r1_e1e2u(jpi,jpj) , e2_e1u(jpi,jpj) , & |
|---|
| 288 | & e1e2v(jpi,jpj) , r1_e1e2v(jpi,jpj) , e1_e2v(jpi,jpj) , & |
|---|
| 289 | & e1e2f(jpi,jpj) , r1_e1e2f(jpi,jpj) , & |
|---|
| 290 | & ff_f (jpi,jpj) , ff_t (jpi,jpj) , STAT=ierr(ii) ) |
|---|
| 291 | ! |
|---|
| 292 | ii = ii+1 |
|---|
| 293 | ALLOCATE( gdept_0 (jpi,jpj,jpk) , gdepw_0 (jpi,jpj,jpk) , gde3w_0(jpi,jpj,jpk) , & |
|---|
| 294 | & gdept_1d( jpk) , gdepw_1d( jpk) , STAT=ierr(ii) ) |
|---|
| 295 | ! |
|---|
| 296 | ii = ii+1 |
|---|
| 297 | ALLOCATE( e3t_0 (jpi,jpj,jpk) , e3u_0 (jpi,jpj,jpk) , e3v_0 (jpi,jpj,jpk) , e3f_0(jpi,jpj,jpk) , & |
|---|
| 298 | & e3w_0 (jpi,jpj,jpk) , e3uw_0(jpi,jpj,jpk) , e3vw_0(jpi,jpj,jpk) , & |
|---|
| 299 | & e3t_1d( jpk) , e3w_1d( jpk) , STAT=ierr(ii) ) |
|---|
| 300 | ! |
|---|
| 301 | ii = ii+1 |
|---|
| 302 | ALLOCATE( ht_0(jpi,jpj) , hu_0(jpi,jpj) , hv_0(jpi,jpj) , hf_0(jpi,jpj) , & |
|---|
| 303 | & r1_ht_0(jpi,jpj) , r1_hu_0(jpi,jpj) , r1_hv_0(jpi,jpj), r1_hf_0(jpi,jpj) , STAT=ierr(ii) ) |
|---|
| 304 | ! |
|---|
| 305 | #if defined key_qco |
|---|
| 306 | ! qco : ssh to h ratio and specific fmask |
|---|
| 307 | ii = ii+1 |
|---|
| 308 | ALLOCATE( r3t (jpi,jpj,jpt) , r3u (jpi,jpj,jpt) , r3v (jpi,jpj,jpt) , r3f (jpi,jpj) , & |
|---|
| 309 | & r3t_f(jpi,jpj) , r3u_f(jpi,jpj) , r3v_f(jpi,jpj) , STAT=ierr(ii) ) |
|---|
| 310 | ! |
|---|
| 311 | ii = ii+1 |
|---|
| 312 | ALLOCATE( fe3mask(jpi,jpj,jpk) , STAT=ierr(ii) ) |
|---|
| 313 | ! |
|---|
| 314 | #elif defined key_linssh |
|---|
| 315 | ! linear ssh no time varying coordinate arrays |
|---|
| 316 | #else |
|---|
| 317 | ! vvl : time varation for all vertical coordinate variables |
|---|
| 318 | ii = ii+1 |
|---|
| 319 | ALLOCATE( gdept (jpi,jpj,jpk,jpt) , gdepw (jpi,jpj,jpk,jpt) , gde3w (jpi,jpj,jpk) , STAT=ierr(ii) ) |
|---|
| 320 | ! |
|---|
| 321 | ii = ii+1 |
|---|
| 322 | ALLOCATE( e3t(jpi,jpj,jpk,jpt) , e3u (jpi,jpj,jpk,jpt) , e3v (jpi,jpj,jpk,jpt) , e3f(jpi,jpj,jpk) , & |
|---|
| 323 | & e3w(jpi,jpj,jpk,jpt) , e3uw(jpi,jpj,jpk,jpt) , e3vw(jpi,jpj,jpk,jpt) , STAT=ierr(ii) ) |
|---|
| 324 | ! |
|---|
| 325 | ii = ii+1 |
|---|
| 326 | ALLOCATE( ht (jpi,jpj) , hu (jpi,jpj,jpt), hv (jpi,jpj,jpt) , & |
|---|
| 327 | & r1_hu (jpi,jpj,jpt), r1_hv (jpi,jpj,jpt) , STAT=ierr(ii) ) |
|---|
| 328 | #endif |
|---|
| 329 | ! |
|---|
| 330 | ii = ii+1 |
|---|
| 331 | ALLOCATE( risfdep(jpi,jpj) , bathy(jpi,jpj) , STAT=ierr(ii) ) |
|---|
| 332 | ! |
|---|
| 333 | ii = ii+1 |
|---|
| 334 | ALLOCATE( tmask_i(jpi,jpj) , tmask_h(jpi,jpj) , & |
|---|
| 335 | & ssmask (jpi,jpj) , ssumask(jpi,jpj) , ssvmask(jpi,jpj) , ssfmask(jpi,jpj) , & |
|---|
| 336 | & mbkt (jpi,jpj) , mbku (jpi,jpj) , mbkv (jpi,jpj) , STAT=ierr(ii) ) |
|---|
| 337 | ! |
|---|
| 338 | ii = ii+1 |
|---|
| 339 | ALLOCATE( mikt(jpi,jpj), miku(jpi,jpj), mikv(jpi,jpj), mikf(jpi,jpj), STAT=ierr(ii) ) |
|---|
| 340 | ! |
|---|
| 341 | ii = ii+1 |
|---|
| 342 | ALLOCATE( tmask(jpi,jpj,jpk) , umask(jpi,jpj,jpk) , & |
|---|
| 343 | & vmask(jpi,jpj,jpk) , fmask(jpi,jpj,jpk) , STAT=ierr(ii) ) |
|---|
| 344 | ! |
|---|
| 345 | ii = ii+1 |
|---|
| 346 | ALLOCATE( wmask(jpi,jpj,jpk) , wumask(jpi,jpj,jpk), wvmask(jpi,jpj,jpk) , STAT=ierr(ii) ) |
|---|
| 347 | ! |
|---|
| 348 | dom_oce_alloc = MAXVAL(ierr) |
|---|
| 349 | ! |
|---|
| 350 | END FUNCTION dom_oce_alloc |
|---|
| 351 | |
|---|
| 352 | !!====================================================================== |
|---|
| 353 | END MODULE dom_oce |
|---|
