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 | |
---|
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 | |
---|
86 | ! !: domain MPP decomposition parameters |
---|
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 |
---|
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 |
---|
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 |
---|
95 | |
---|
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 |
---|
99 | INTEGER, PUBLIC :: nidom !: ??? |
---|
100 | |
---|
101 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: mig !: local ==> global domain, including halos (jpiglo), i-index |
---|
102 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: mjg !: local ==> global domain, including halos (jpjglo), j-index |
---|
103 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: mig0 !: local ==> global domain, excluding halos (Ni0glo), i-index |
---|
104 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: mjg0 !: local ==> global domain, excluding halos (Nj0glo), j-index |
---|
105 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: mig0_oldcmp !: local ==> global domain, excluding halos (Ni0glo), i-index |
---|
106 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: mjg0_oldcmp !: local ==> global domain, excluding halos (Nj0glo), j-index |
---|
107 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: mi0, mi1 !: global, including halos (jpiglo) ==> local domain i-index |
---|
108 | ! !: (mi0=1 and mi1=0 if global index not in local domain) |
---|
109 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: mj0, mj1 !: global, including halos (jpjglo) ==> local domain j-index |
---|
110 | ! !: (mj0=1 and mj1=0 if global index not in local domain) |
---|
111 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: nimppt, njmppt !: i-, j-indexes for each processor |
---|
112 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: ibonit, ibonjt !: i-, j- processor neighbour existence |
---|
113 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: jpiall, jpjall !: dimensions of all subdomain |
---|
114 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: nis0all, njs0all !: first, last indoor index for all i-subdomain |
---|
115 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: nie0all, nje0all !: first, last indoor index for all j-subdomain |
---|
116 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: nfimpp, nfproc, nfjpi |
---|
117 | |
---|
118 | !!---------------------------------------------------------------------- |
---|
119 | !! horizontal curvilinear coordinate and scale factors |
---|
120 | !! --------------------------------------------------------------------- |
---|
121 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE , DIMENSION(:,:) :: glamt , glamu, glamv , glamf !: longitude at t, u, v, f-points [degree] |
---|
122 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE , DIMENSION(:,:) :: gphit , gphiu, gphiv , gphif !: latitude at t, u, v, f-points [degree] |
---|
123 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, TARGET, DIMENSION(:,:) :: e1t , e2t , r1_e1t, r1_e2t !: t-point horizontal scale factors [m] |
---|
124 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, TARGET, DIMENSION(:,:) :: e1u , e2u , r1_e1u, r1_e2u !: horizontal scale factors at u-point [m] |
---|
125 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, TARGET, DIMENSION(:,:) :: e1v , e2v , r1_e1v, r1_e2v !: horizontal scale factors at v-point [m] |
---|
126 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, TARGET, DIMENSION(:,:) :: e1f , e2f , r1_e1f, r1_e2f !: horizontal scale factors at f-point [m] |
---|
127 | ! |
---|
128 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE , DIMENSION(:,:) :: e1e2t , r1_e1e2t !: associated metrics at t-point |
---|
129 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE , DIMENSION(:,:) :: e1e2u , e2_e1u, r1_e1e2u !: associated metrics at u-point |
---|
130 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE , DIMENSION(:,:) :: e1e2v , e1_e2v, r1_e1e2v !: associated metrics at v-point |
---|
131 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE , DIMENSION(:,:) :: e1e2f , r1_e1e2f !: associated metrics at f-point |
---|
132 | ! |
---|
133 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: ff_f , ff_t !: Coriolis factor at f- & t-points [1/s] |
---|
134 | !!---------------------------------------------------------------------- |
---|
135 | !! vertical coordinate and scale factors |
---|
136 | !! --------------------------------------------------------------------- |
---|
137 | LOGICAL, PUBLIC :: ln_zco !: z-coordinate - full step |
---|
138 | LOGICAL, PUBLIC :: ln_zps !: z-coordinate - partial step |
---|
139 | LOGICAL, PUBLIC :: ln_sco !: s-coordinate or hybrid z-s coordinate |
---|
140 | LOGICAL, PUBLIC :: ln_isfcav !: presence of ISF |
---|
141 | ! ! reference scale factors |
---|
142 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: e3t_0 !: t- vert. scale factor [m] |
---|
143 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: e3u_0 !: u- vert. scale factor [m] |
---|
144 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: e3v_0 !: v- vert. scale factor [m] |
---|
145 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: e3f_0 !: f- vert. scale factor [m] |
---|
146 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: e3w_0 !: w- vert. scale factor [m] |
---|
147 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: e3uw_0 !: uw-vert. scale factor [m] |
---|
148 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: e3vw_0 !: vw-vert. scale factor [m] |
---|
149 | ! ! time-dependent scale factors |
---|
150 | #if ! defined key_qco |
---|
151 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) :: e3t, e3u, e3v, e3w, e3uw, e3vw !: vert. scale factor [m] |
---|
152 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: e3f !: F-point vert. scale factor [m] |
---|
153 | #endif |
---|
154 | ! ! time-dependent ratio ssh / h_0 |
---|
155 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: r3t, r3u, r3v !: time-dependent ratio at t-, u- and v-point [-] |
---|
156 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: r3f !: mid-time-level ratio at f-point [-] |
---|
157 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: r3t_f, r3u_f, r3v_f !: now time-filtered ratio at t-, u- and v-point [-] |
---|
158 | |
---|
159 | ! ! reference depths of cells |
---|
160 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: gdept_0 !: t- depth [m] |
---|
161 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: gdepw_0 !: w- depth [m] |
---|
162 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: gde3w_0 !: w- depth (sum of e3w) [m] |
---|
163 | ! ! time-dependent depths of cells |
---|
164 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) :: gdept, gdepw |
---|
165 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: gde3w |
---|
166 | |
---|
167 | ! ! reference heights of ocean water column and its inverse |
---|
168 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: ht_0, r1_ht_0 !: t-depth [m] and [1/m] |
---|
169 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: hu_0, r1_hu_0 !: u-depth [m] and [1/m] |
---|
170 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: hv_0, r1_hv_0 !: v-depth [m] and [1/m] |
---|
171 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: hf_0, r1_hf_0 !: f-depth [m] and [1/m] |
---|
172 | ! ! time-dependent heights of ocean water column |
---|
173 | #if ! defined key_qco |
---|
174 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: ht !: t-points [m] |
---|
175 | #endif |
---|
176 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: hu, r1_hu !: u-depth [m] and [1/m] |
---|
177 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: hv, r1_hv !: v-depth [m] and [1/m] |
---|
178 | |
---|
179 | INTEGER, PUBLIC :: nla10 !: deepest W level Above ~10m (nlb10 - 1) |
---|
180 | INTEGER, PUBLIC :: nlb10 !: shallowest W level Bellow ~10m (nla10 + 1) |
---|
181 | |
---|
182 | !! 1D reference vertical coordinate |
---|
183 | !! =-----------------====------ |
---|
184 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: gdept_1d, gdepw_1d !: reference depth of t- and w-points (m) |
---|
185 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: e3t_1d , e3w_1d !: reference vertical scale factors at T- and W-pts (m) |
---|
186 | |
---|
187 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: risfdep, bathy |
---|
188 | |
---|
189 | !!---------------------------------------------------------------------- |
---|
190 | !! masks, top and bottom ocean point position |
---|
191 | !! --------------------------------------------------------------------- |
---|
192 | !!gm Proposition of new name for top/bottom vertical indices |
---|
193 | ! INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: mtk_t, mtk_u, mtk_v !: top first wet T-, U-, and V-level (ISF) |
---|
194 | ! INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: mbk_t, mbk_u, mbk_v !: bottom last wet T-, U-, and V-level |
---|
195 | !!gm |
---|
196 | INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: mbkt, mbku, mbkv !: bottom last wet T-, U- and V-level |
---|
197 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: tmask_i !: interior domain T-point mask |
---|
198 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: tmask_h !: internal domain T-point mask (Figure 8.5 NEMO book) |
---|
199 | |
---|
200 | INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: mikt, miku, mikv, mikf !: top first wet T-, U-, V-, F-level (ISF) |
---|
201 | |
---|
202 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: ssmask, ssumask, ssvmask, ssfmask !: surface mask at T-,U-, V- and F-pts |
---|
203 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:), TARGET :: tmask, umask, vmask, wmask, fmask !: land/ocean mask at T-, U-, V-, W- and F-pts |
---|
204 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:), TARGET :: wumask, wvmask !: land/ocean mask at WT-, WU- and WV-pts |
---|
205 | |
---|
206 | !!---------------------------------------------------------------------- |
---|
207 | !! calendar variables |
---|
208 | !! --------------------------------------------------------------------- |
---|
209 | INTEGER , PUBLIC :: nyear !: current year |
---|
210 | INTEGER , PUBLIC :: nmonth !: current month |
---|
211 | INTEGER , PUBLIC :: nday !: current day of the month |
---|
212 | INTEGER , PUBLIC :: nhour !: current hour |
---|
213 | INTEGER , PUBLIC :: nminute !: current minute |
---|
214 | INTEGER , PUBLIC :: ndastp !: time step date in yyyymmdd format |
---|
215 | INTEGER , PUBLIC :: nday_year !: current day counted from jan 1st of the current year |
---|
216 | INTEGER , PUBLIC :: nsec_year !: seconds between 00h jan 1st of the current year and half of the current time step |
---|
217 | INTEGER , PUBLIC :: nsec_month !: seconds between 00h 1st day of the current month and half of the current time step |
---|
218 | INTEGER , PUBLIC :: nsec_monday !: seconds between 00h of the last Monday and half of the current time step |
---|
219 | INTEGER , PUBLIC :: nsec_day !: seconds between 00h of the current day and half of the current time step |
---|
220 | REAL(wp), PUBLIC :: fjulday !: current julian day |
---|
221 | REAL(wp), PUBLIC :: fjulstartyear !: first day of the current year in julian days |
---|
222 | REAL(wp), PUBLIC :: adatrj !: number of elapsed days since the begining of the whole simulation |
---|
223 | ! !: (cumulative duration of previous runs that may have used different time-step size) |
---|
224 | INTEGER , PUBLIC, DIMENSION( 0: 2) :: nyear_len !: length in days of the previous/current/next year |
---|
225 | INTEGER , PUBLIC, DIMENSION(-11:25) :: nmonth_len !: length in days of the months of the current year |
---|
226 | INTEGER , PUBLIC, DIMENSION(-11:25) :: nmonth_beg !: second since Jan 1st 0h of the current year and the half of the months |
---|
227 | INTEGER , PUBLIC :: nsec1jan000 !: second since Jan 1st 0h of nit000 year and Jan 1st 0h the current year |
---|
228 | INTEGER , PUBLIC :: nsec000_1jan000 !: second since Jan 1st 0h of nit000 year and nit000 |
---|
229 | INTEGER , PUBLIC :: nsecend_1jan000 !: second since Jan 1st 0h of nit000 year and nitend |
---|
230 | |
---|
231 | !!---------------------------------------------------------------------- |
---|
232 | !! variable defined here to avoid circular dependencies... |
---|
233 | !! --------------------------------------------------------------------- |
---|
234 | INTEGER, PUBLIC :: nbasin ! number of basin to be considered in diaprt (glo, atl, pac, ind, ipc) |
---|
235 | |
---|
236 | !!---------------------------------------------------------------------- |
---|
237 | !! agrif domain |
---|
238 | !!---------------------------------------------------------------------- |
---|
239 | #if defined key_agrif |
---|
240 | LOGICAL, PUBLIC, PARAMETER :: lk_agrif = .TRUE. !: agrif flag |
---|
241 | LOGICAL, PUBLIC :: lk_south, lk_north, lk_west, lk_east !: Child grid boundaries (interpolation or not) |
---|
242 | #else |
---|
243 | LOGICAL, PUBLIC, PARAMETER :: lk_agrif = .FALSE. !: agrif flag |
---|
244 | #endif |
---|
245 | |
---|
246 | !!---------------------------------------------------------------------- |
---|
247 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
---|
248 | !! $Id$ |
---|
249 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
250 | !!---------------------------------------------------------------------- |
---|
251 | CONTAINS |
---|
252 | |
---|
253 | #if ! defined key_agrif |
---|
254 | !!---------------------------------------------------------------------- |
---|
255 | !! NOT 'key_agrif' dummy function No AGRIF zoom |
---|
256 | !!---------------------------------------------------------------------- |
---|
257 | LOGICAL FUNCTION Agrif_Root() |
---|
258 | Agrif_Root = .TRUE. |
---|
259 | END FUNCTION Agrif_Root |
---|
260 | |
---|
261 | INTEGER FUNCTION Agrif_Fixed() |
---|
262 | Agrif_Fixed = 0 |
---|
263 | END FUNCTION Agrif_Fixed |
---|
264 | |
---|
265 | CHARACTER(len=3) FUNCTION Agrif_CFixed() |
---|
266 | Agrif_CFixed = '0' |
---|
267 | END FUNCTION Agrif_CFixed |
---|
268 | #endif |
---|
269 | |
---|
270 | INTEGER FUNCTION dom_oce_alloc() |
---|
271 | !!---------------------------------------------------------------------- |
---|
272 | INTEGER :: ii |
---|
273 | INTEGER, DIMENSION(30) :: ierr |
---|
274 | !!---------------------------------------------------------------------- |
---|
275 | ii = 0 ; ierr(:) = 0 |
---|
276 | ! |
---|
277 | ii = ii+1 |
---|
278 | ALLOCATE( mig(jpi), mjg(jpj), mig0(jpi), mjg0(jpj), mig0_oldcmp(jpi), mjg0_oldcmp(jpj), STAT=ierr(ii) ) |
---|
279 | ! |
---|
280 | ii = ii+1 |
---|
281 | ALLOCATE( mi0(jpiglo), mi1(jpiglo), mj0(jpjglo), mj1(jpjglo), STAT=ierr(ii) ) |
---|
282 | ! |
---|
283 | ii = ii+1 |
---|
284 | ALLOCATE( glamt(jpi,jpj) , glamu(jpi,jpj) , glamv(jpi,jpj) , glamf(jpi,jpj) , & |
---|
285 | & gphit(jpi,jpj) , gphiu(jpi,jpj) , gphiv(jpi,jpj) , gphif(jpi,jpj) , & |
---|
286 | & e1t (jpi,jpj) , e2t (jpi,jpj) , r1_e1t(jpi,jpj) , r1_e2t(jpi,jpj) , & |
---|
287 | & e1u (jpi,jpj) , e2u (jpi,jpj) , r1_e1u(jpi,jpj) , r1_e2u(jpi,jpj) , & |
---|
288 | & e1v (jpi,jpj) , e2v (jpi,jpj) , r1_e1v(jpi,jpj) , r1_e2v(jpi,jpj) , & |
---|
289 | & e1f (jpi,jpj) , e2f (jpi,jpj) , r1_e1f(jpi,jpj) , r1_e2f(jpi,jpj) , & |
---|
290 | & e1e2t(jpi,jpj) , r1_e1e2t(jpi,jpj) , & |
---|
291 | & e1e2u(jpi,jpj) , r1_e1e2u(jpi,jpj) , e2_e1u(jpi,jpj) , & |
---|
292 | & e1e2v(jpi,jpj) , r1_e1e2v(jpi,jpj) , e1_e2v(jpi,jpj) , & |
---|
293 | & e1e2f(jpi,jpj) , r1_e1e2f(jpi,jpj) , & |
---|
294 | & ff_f (jpi,jpj) , ff_t (jpi,jpj) , STAT=ierr(ii) ) |
---|
295 | ! |
---|
296 | ii = ii+1 |
---|
297 | ALLOCATE( gdept_0(jpi,jpj,jpk) , gdepw_0(jpi,jpj,jpk) , gde3w_0(jpi,jpj,jpk) , & |
---|
298 | & gdept (jpi,jpj,jpk,jpt) , gdepw (jpi,jpj,jpk,jpt) , gde3w (jpi,jpj,jpk) , STAT=ierr(ii) ) |
---|
299 | ! |
---|
300 | ii = ii+1 |
---|
301 | ALLOCATE( e3t_0(jpi,jpj,jpk) , e3u_0 (jpi,jpj,jpk) , e3v_0 (jpi,jpj,jpk) , e3f_0(jpi,jpj,jpk) , & |
---|
302 | & e3w_0(jpi,jpj,jpk) , e3uw_0(jpi,jpj,jpk) , e3vw_0(jpi,jpj,jpk) , STAT=ierr(ii) ) |
---|
303 | ! |
---|
304 | #if ! defined key_qco |
---|
305 | ii = ii+1 |
---|
306 | ALLOCATE( e3t(jpi,jpj,jpk,jpt) , e3u (jpi,jpj,jpk,jpt) , e3v (jpi,jpj,jpk,jpt) , e3f(jpi,jpj,jpk) , & |
---|
307 | & e3w(jpi,jpj,jpk,jpt) , e3uw(jpi,jpj,jpk,jpt) , e3vw(jpi,jpj,jpk,jpt) , STAT=ierr(ii) ) |
---|
308 | #endif |
---|
309 | ! |
---|
310 | ii = ii+1 |
---|
311 | ALLOCATE( r3t (jpi,jpj,jpt) , r3u (jpi,jpj,jpt) , r3v (jpi,jpj,jpt) , r3f (jpi,jpj) , & |
---|
312 | & r3t_f(jpi,jpj) , r3u_f(jpi,jpj) , r3v_f(jpi,jpj) , STAT=ierr(ii) ) |
---|
313 | ! |
---|
314 | ii = ii+1 |
---|
315 | ALLOCATE( ht_0(jpi,jpj) , hu_0(jpi,jpj) , hv_0(jpi,jpj) , hf_0(jpi,jpj) , & |
---|
316 | & r1_ht_0(jpi,jpj) , r1_hu_0(jpi,jpj) , r1_hv_0(jpi,jpj), r1_hf_0(jpi,jpj) , STAT=ierr(ii) ) |
---|
317 | ! |
---|
318 | #if ! defined key_qco |
---|
319 | ii = ii+1 |
---|
320 | ALLOCATE( ht (jpi,jpj) , hu (jpi,jpj,jpt), hv (jpi,jpj,jpt) , & |
---|
321 | & r1_hu (jpi,jpj,jpt), r1_hv (jpi,jpj,jpt) , STAT=ierr(ii) ) |
---|
322 | #else |
---|
323 | ii = ii+1 |
---|
324 | ALLOCATE( hu (jpi,jpj,jpt), hv (jpi,jpj,jpt) , & |
---|
325 | & r1_hu (jpi,jpj,jpt), r1_hv (jpi,jpj,jpt) , STAT=ierr(ii) ) |
---|
326 | #endif |
---|
327 | ! |
---|
328 | ii = ii+1 |
---|
329 | ALLOCATE( risfdep(jpi,jpj) , bathy(jpi,jpj) , STAT=ierr(ii) ) |
---|
330 | ! |
---|
331 | ii = ii+1 |
---|
332 | ALLOCATE( gdept_1d(jpk) , gdepw_1d(jpk) , e3t_1d(jpk) , e3w_1d(jpk) , STAT=ierr(ii) ) |
---|
333 | ! |
---|
334 | ii = ii+1 |
---|
335 | ALLOCATE( tmask_i(jpi,jpj) , tmask_h(jpi,jpj) , & |
---|
336 | & ssmask (jpi,jpj) , ssumask(jpi,jpj) , ssvmask(jpi,jpj) , ssfmask(jpi,jpj) , & |
---|
337 | & mbkt (jpi,jpj) , mbku (jpi,jpj) , mbkv (jpi,jpj) , STAT=ierr(ii) ) |
---|
338 | ! |
---|
339 | ii = ii+1 |
---|
340 | ALLOCATE( mikt(jpi,jpj), miku(jpi,jpj), mikv(jpi,jpj), mikf(jpi,jpj), STAT=ierr(ii) ) |
---|
341 | ! |
---|
342 | ii = ii+1 |
---|
343 | ALLOCATE( tmask(jpi,jpj,jpk) , umask(jpi,jpj,jpk) , & |
---|
344 | & vmask(jpi,jpj,jpk) , fmask(jpi,jpj,jpk) , STAT=ierr(ii) ) |
---|
345 | ! |
---|
346 | ii = ii+1 |
---|
347 | ALLOCATE( wmask(jpi,jpj,jpk) , wumask(jpi,jpj,jpk), wvmask(jpi,jpj,jpk) , STAT=ierr(ii) ) |
---|
348 | ! |
---|
349 | dom_oce_alloc = MAXVAL(ierr) |
---|
350 | ! |
---|
351 | END FUNCTION dom_oce_alloc |
---|
352 | |
---|
353 | !!====================================================================== |
---|
354 | END MODULE dom_oce |
---|