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