New URL for NEMO forge! http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.

dom_oce.F90 in branches/2015/dev_MetOffice_merge_2015/NEMOGCM/NEMO/OPA_SRC/DOM – NEMO

Context Navigation

source: branches/2015/dev_MetOffice_merge_2015/NEMOGCM/NEMO/OPA_SRC/DOM/dom_oce.F90 @ 6006

Last change on this file since 6006 was 6006, checked in by mathiot, 8 years ago
Merged ice sheet coupling branch
Property svn:keywords set to `Id`
File size: 30.0 KB

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

Note: See TracBrowser for help on using the repository browser.

Download in other formats: