source: branches/UKMO/dev_r5518_GO6_under_ice_relax_dr_hook/NEMOGCM/NEMO/OPA_SRC/DOM/dom_oce.F90 @ 11738

Last change on this file since 11738 was 11738, checked in by marc, 12 months ago

The Dr Hook changes from my perl code.

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