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