source: branches/2013/dev_LOCEAN_CMCC_INGV_MERC_UKMO_2013/NEMOGCM/NEMO/OPA_SRC/DOM/dom_oce.F90 @ 4247

Last change on this file since 4247 was 4247, checked in by cetlod, 8 years ago

dev_locean_cmcc_ingv_merc_ukmo : minor bugs corrections

  • Property svn:keywords set to Id
File size: 24.5 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   IMPLICIT NONE
22   PUBLIC             ! allows the acces to par_oce when dom_oce is used
23   !                  ! exception to coding rules... to be suppressed ???
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_e3zps_min    !: miminum thickness for partial steps (meters)
35   REAL(wp), PUBLIC ::   rn_e3zps_rat    !: minimum thickness ration for partial steps
36   INTEGER , PUBLIC ::   nn_msh          !: = 1 create a mesh-mask file
37   INTEGER , PUBLIC ::   nn_acc          !: = 0/1 use of the acceleration of convergence technique
38   REAL(wp), PUBLIC ::   rn_atfp         !: asselin time filter parameter
39   REAL(wp), PUBLIC ::   rn_rdt          !: time step for the dynamics (and tracer if nacc=0)
40   REAL(wp), PUBLIC ::   rn_rdtmin       !: minimum time step on tracers
41   REAL(wp), PUBLIC ::   rn_rdtmax       !: maximum time step on tracers
42   REAL(wp), PUBLIC ::   rn_rdth         !: depth variation of tracer step
43   INTEGER , PUBLIC ::   nn_baro         !: number of barotropic time steps (key_dynspg_ts)
44   INTEGER , PUBLIC ::   nn_closea       !: =0 suppress closed sea/lake from the ORCA domain or not (=1)
45   LOGICAL , PUBLIC ::   ln_crs          !: Apply grid coarsening to dynamical model output or online passive tracers
46
47   !! Horizontal grid parameters for domhgr
48   !! =====================================
49   INTEGER       ::   jphgr_msh        !: type of horizontal mesh
50   !                                       !  = 0 curvilinear coordinate on the sphere read in coordinate.nc
51   !                                       !  = 1 geographical mesh on the sphere with regular grid-spacing
52   !                                       !  = 2 f-plane with regular grid-spacing
53   !                                       !  = 3 beta-plane with regular grid-spacing
54   !                                       !  = 4 Mercator grid with T/U point at the equator
55
56   REAL(wp)      ::   ppglam0              !: longitude of first raw and column T-point (jphgr_msh = 1)
57   REAL(wp)      ::   ppgphi0              !: latitude  of first raw and column T-point (jphgr_msh = 1)
58   !                                                        !  used for Coriolis & Beta parameters (jphgr_msh = 2 or 3)
59   REAL(wp)      ::   ppe1_deg             !: zonal      grid-spacing (degrees)
60   REAL(wp)      ::   ppe2_deg             !: meridional grid-spacing (degrees)
61   REAL(wp)      ::   ppe1_m               !: zonal      grid-spacing (degrees)
62   REAL(wp)      ::   ppe2_m               !: meridional grid-spacing (degrees)
63
64   !! Vertical grid parameter for domzgr
65   !! ==================================
66   REAL(wp)      ::   ppsur                !: ORCA r4, r2 and r05 coefficients
67   REAL(wp)      ::   ppa0                 !: (default coefficients)
68   REAL(wp)      ::   ppa1                 !:
69   REAL(wp)      ::   ppkth                !:
70   REAL(wp)      ::   ppacr                !:
71   !
72   !  If both ppa0 ppa1 and ppsur are specified to 0, then
73   !  they are computed from ppdzmin, pphmax , ppkth, ppacr in dom_zgr
74   REAL(wp)      ::   ppdzmin              !: Minimum vertical spacing
75   REAL(wp)      ::   pphmax               !: Maximum depth
76   !
77   LOGICAL       ::   ldbletanh            !: Use/do not use double tanf function for vertical coordinates
78   REAL(wp)      ::   ppa2                 !: Double tanh function parameters
79   REAL(wp)      ::   ppkth2               !:
80   REAL(wp)      ::   ppacr2               !:
81
82   !                                    !! old non-DOCTOR names still used in the model
83   INTEGER , PUBLIC ::   ntopo           !: = 0/1 ,compute/read the bathymetry file
84   REAL(wp), PUBLIC ::   e3zps_min       !: miminum thickness for partial steps (meters)
85   REAL(wp), PUBLIC ::   e3zps_rat       !: minimum thickness ration for partial steps
86   INTEGER , PUBLIC ::   nmsh            !: = 1 create a mesh-mask file
87   INTEGER , PUBLIC ::   nacc            !: = 0/1 use of the acceleration of convergence technique
88   REAL(wp), PUBLIC ::   atfp            !: asselin time filter parameter
89   REAL(wp), PUBLIC ::   rdt             !: time step for the dynamics (and tracer if nacc=0)
90   REAL(wp), PUBLIC ::   rdtmin          !: minimum time step on tracers
91   REAL(wp), PUBLIC ::   rdtmax          !: maximum time step on tracers
92   REAL(wp), PUBLIC ::   rdth            !: depth variation of tracer step
93
94   !                                                  !!! associated variables
95   INTEGER , PUBLIC                 ::   neuler  = 0   !: restart euler forward option (0=Euler)
96   REAL(wp), PUBLIC                 ::   atfp1         !: asselin time filter coeff. (atfp1= 1-2*atfp)
97   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   rdttra  !: vertical profile of tracer time step
98   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   r2dtra  !: = 2*rdttra except at nit000 (=rdttra) if neuler=0
99
100   !                                         !!* Namelist namcla : cross land advection
101   INTEGER, PUBLIC ::   nn_cla               !: =1 cross land advection for exchanges through some straits (ORCA2)
102
103   !!----------------------------------------------------------------------
104   !! space domain parameters
105   !!----------------------------------------------------------------------
106   LOGICAL, PUBLIC ::   lzoom      =  .FALSE.   !: zoom flag
107   LOGICAL, PUBLIC ::   lzoom_e    =  .FALSE.   !: East  zoom type flag
108   LOGICAL, PUBLIC ::   lzoom_w    =  .FALSE.   !: West  zoom type flag
109   LOGICAL, PUBLIC ::   lzoom_s    =  .FALSE.   !: South zoom type flag
110   LOGICAL, PUBLIC ::   lzoom_n    =  .FALSE.   !: North zoom type flag
111
112   !                                     !!! domain parameters linked to mpp
113   INTEGER, PUBLIC ::   nperio            !: type of lateral boundary condition
114   INTEGER, PUBLIC ::   nimpp, njmpp      !: i- & j-indexes for mpp-subdomain left bottom
115   INTEGER, PUBLIC ::   nreci, nrecj      !: overlap region in i and j
116   INTEGER, PUBLIC ::   nproc             !: number for local processor
117   INTEGER, PUBLIC ::   narea             !: number for local area
118   INTEGER, PUBLIC ::   nbondi, nbondj    !: mark of i- and j-direction local boundaries
119   INTEGER, ALLOCATABLE, PUBLIC ::   nbondi_bdy(:)    !: mark i-direction local boundaries for BDY open boundaries
120   INTEGER, ALLOCATABLE, PUBLIC ::   nbondj_bdy(:)    !: mark j-direction local boundaries for BDY open boundaries
121   INTEGER, ALLOCATABLE, PUBLIC ::   nbondi_bdy_b(:)  !: mark i-direction of neighbours local boundaries for BDY open boundaries 
122   INTEGER, ALLOCATABLE, PUBLIC ::   nbondj_bdy_b(:)  !: mark j-direction of neighbours local boundaries for BDY open boundaries 
123
124   INTEGER, PUBLIC ::   npolj             !: north fold mark (0, 3 or 4)
125   INTEGER, PUBLIC ::   nlci, nldi, nlei  !: i-dimensions of the local subdomain and its first and last indoor indices
126   INTEGER, PUBLIC ::   nlcj, nldj, nlej  !: i-dimensions of the local subdomain and its first and last indoor indices
127   INTEGER, PUBLIC ::   noea, nowe        !: index of the local neighboring processors in
128   INTEGER, PUBLIC ::   noso, nono        !: east, west, south and north directions
129   INTEGER, PUBLIC ::   npne, npnw        !: index of north east and north west processor
130   INTEGER, PUBLIC ::   npse, npsw        !: index of south east and south west processor
131   INTEGER, PUBLIC ::   nbne, nbnw        !: logical of north east & north west processor
132   INTEGER, PUBLIC ::   nbse, nbsw        !: logical of south east & south west processor
133   INTEGER, PUBLIC ::   nidom             !: ???
134
135   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   mig        !: local  ==> global domain i-index
136   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   mjg        !: local  ==> global domain j-index
137   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   mi0, mi1   !: global ==> local  domain i-index    !!bug ==> other solution?
138   !                                                  ! (mi0=1 and mi1=0 if the global index is not in the local domain)
139   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   mj0, mj1   !: global ==> local  domain j-index     !!bug ==> other solution?
140   !                                                  ! (mi0=1 and mi1=0 if the global index is not in the local domain)
141   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   nimppt, njmppt   !: i-, j-indexes for each processor
142   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   ibonit, ibonjt   !: i-, j- processor neighbour existence
143   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   nlcit , nlcjt    !: dimensions of every subdomain
144   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   nldit , nldjt    !: first, last indoor index for each i-domain
145   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   nleit , nlejt    !: first, last indoor index for each j-domain
146
147   !!----------------------------------------------------------------------
148   !! horizontal curvilinear coordinate and scale factors
149   !! ---------------------------------------------------------------------
150   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::  glamt, glamu   !: longitude of t-, u-, v- and f-points (degre)
151   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::  glamv, glamf   !:
152   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::  gphit, gphiu   !: latitude  of t-, u-, v- and f-points (degre)
153   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::  gphiv, gphif   !:
154   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::  e1t, e2t       !: horizontal scale factors at t-point (m)
155   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::  e1u, e2u       !: horizontal scale factors at u-point (m)
156   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::  e1v, e2v       !: horizontal scale factors at v-point (m)
157   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::  e1f, e2f       !: horizontal scale factors at f-point (m)
158   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::  e1e2t          !: surface at t-point (m2)
159   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::  ff             !: coriolis factor (2.*omega*sin(yphi) ) (s-1)
160
161   !!----------------------------------------------------------------------
162   !! vertical coordinate and scale factors
163   !! ---------------------------------------------------------------------
164   !                                 !!* Namelist namzgr : vertical coordinate *
165   LOGICAL, PUBLIC ::   ln_zco        !: z-coordinate - full step
166   LOGICAL, PUBLIC ::   ln_zps        !: z-coordinate - partial step
167   LOGICAL, PUBLIC ::   ln_sco        !: s-coordinate or hybrid z-s coordinate
168
169   !! All coordinates
170   !! ---------------
171   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   gdep3w          !: depth of T-points (sum of e3w) (m)
172   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   gdept , gdepw   !: analytical depth at T-W  points (m)
173   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   e3v   , e3f     !: analytical vertical scale factors at  V--F
174   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   e3t   , e3u     !:                                       T--U  points (m)
175   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   e3vw            !: analytical vertical scale factors at  VW--
176   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   e3w   , e3uw    !:                                        W--UW  points (m)
177#if defined key_vvl
178   LOGICAL, PUBLIC, PARAMETER ::   lk_vvl = .TRUE.    !: variable grid flag
179
180   !! All coordinates
181   !! ---------------
182   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   gdep3w_1           !: depth of T-points (sum of e3w) (m)
183   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   gdept_1, gdepw_1   !: analytical depth at T-W  points (m)
184   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   e3v_1  , e3f_1     !: analytical vertical scale factors at  V--F
185   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   e3t_1  , e3u_1     !:                                       T--U  points (m)
186   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   e3vw_1             !: analytical vertical scale factors at  VW--
187   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   e3w_1  , e3uw_1    !:                                       W--UW  points (m)
188   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   e3t_b              !: before         -      -      -    -   T      points (m)
189   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   e3u_b  , e3v_b     !:   -            -      -      -    -   U--V   points (m)
190#else
191   LOGICAL, PUBLIC, PARAMETER ::   lk_vvl = .FALSE.   !: fixed grid flag
192#endif
193   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:), TARGET ::   hur  , hvr    !: inverse of u and v-points ocean depth (1/m)
194   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)         ::   hu   , hv     !: depth at u- and v-points (meters)
195   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)         ::   hu_0 , hv_0   !: refernce depth at u- and v-points (meters)
196
197   INTEGER, PUBLIC ::   nla10              !: deepest    W level Above  ~10m (nlb10 - 1)
198   INTEGER, PUBLIC ::   nlb10              !: shallowest W level Bellow ~10m (nla10 + 1)
199
200   !! z-coordinate with full steps (also used in the other cases as reference z-coordinate)
201   !! =-----------------====------
202   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:)   :: gdept_0, gdepw_0 !: reference depth of t- and w-points (m)
203   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:)   :: e3t_0  , e3w_0   !: reference vertical scale factors at T- and W-pts (m)
204   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: e3tp   , e3wp    !: ocean bottom level thickness at T and W points
205
206   !! s-coordinate and hybrid z-s-coordinate
207   !! =----------------======---------------
208   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   gsigt, gsigw   !: model level depth coefficient at t-, w-levels (analytic)
209   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   gsi3w          !: model level depth coefficient at w-level (sum of gsigw)
210   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   esigt, esigw   !: vertical scale factor coef. at t-, w-levels
211
212   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   hbatv , hbatf    !: ocean depth at the vertical of  V--F
213   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   hbatt , hbatu    !:                                 T--U  points (m)
214   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   scosrf, scobot   !: ocean surface and bottom topographies
215   !                                        !  (if deviating from coordinate surfaces in HYBRID)
216   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   hifv  , hiff     !: interface depth between stretching at  V--F
217   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   hift  , hifu     !: and quasi-uniform spacing              T--U  points (m)
218   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   rx1              !: Maximum grid stiffness ratio
219
220   !!----------------------------------------------------------------------
221   !! masks, bathymetry
222   !! ---------------------------------------------------------------------
223   INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   mbathy       !: number of ocean level (=0, 1, ... , jpk-1)
224   INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   mbkt         !: vertical index of the bottom last T- ocean level
225   INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   mbku, mbkv   !: vertical index of the bottom last U- and W- ocean level
226   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   bathy        !: ocean depth (meters)
227   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   tmask_i      !: interior domain T-point mask
228   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   bmask        !: land/ocean mask of barotropic stream function
229
230   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: tmask, umask, vmask, fmask   !: land/ocean mask at T-, U-, V- and F-pts
231
232   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   tpol, fpol          !: north fold mask (jperio= 3 or 4)
233
234#if defined key_noslip_accurate
235   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:  ) :: npcoa        !: ???
236   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: nicoa, njcoa !: ???
237#endif
238
239   !!----------------------------------------------------------------------
240   !! calendar variables
241   !! ---------------------------------------------------------------------
242   INTEGER , PUBLIC ::   nyear         !: current year
243   INTEGER , PUBLIC ::   nmonth        !: current month
244   INTEGER , PUBLIC ::   nday          !: current day of the month
245   INTEGER , PUBLIC ::   ndastp        !: time step date in yyyymmdd format
246   INTEGER , PUBLIC ::   nday_year     !: current day counted from jan 1st of the current year
247   INTEGER , PUBLIC ::   nsec_year     !: current time step counted in second since 00h jan 1st of the current year
248   INTEGER , PUBLIC ::   nsec_month    !: current time step counted in second since 00h 1st day of the current month
249   INTEGER , PUBLIC ::   nsec_week     !: current time step counted in second since 00h of last monday
250   INTEGER , PUBLIC ::   nsec_day      !: current time step counted in second since 00h of the current day
251   REAL(wp), PUBLIC ::   fjulday       !: current julian day
252   REAL(wp), PUBLIC ::   fjulstartyear !: first day of the current year in julian days
253   REAL(wp), PUBLIC ::   adatrj        !: number of elapsed days since the begining of the whole simulation
254   !                                   !: (cumulative duration of previous runs that may have used different time-step size)
255   INTEGER , PUBLIC, DIMENSION(0: 2) ::   nyear_len     !: length in days of the previous/current/next year
256   INTEGER , PUBLIC, DIMENSION(0:13) ::   nmonth_len    !: length in days of the months of the current year
257   INTEGER , PUBLIC, DIMENSION(0:13) ::   nmonth_half   !: second since Jan 1st 0h of the current year and the half of the months
258   INTEGER , PUBLIC, DIMENSION(0:13) ::   nmonth_end    !: second since Jan 1st 0h of the current year and the end of the months
259   INTEGER , PUBLIC                  ::   nsec1jan000   !: second since Jan 1st 0h of nit000 year and Jan 1st 0h the current year
260
261   !!----------------------------------------------------------------------
262   !! mpp reproducibility
263   !!----------------------------------------------------------------------
264#if defined key_mpp_rep
265   LOGICAL, PUBLIC, PARAMETER ::   lk_mpp_rep = .TRUE.    !: agrif flag
266#else
267   LOGICAL, PUBLIC, PARAMETER ::   lk_mpp_rep = .FALSE.   !: agrif flag
268#endif
269
270   !!----------------------------------------------------------------------
271   !! agrif domain
272   !!----------------------------------------------------------------------
273#if defined key_agrif
274   LOGICAL, PUBLIC, PARAMETER ::   lk_agrif = .TRUE.    !: agrif flag
275#else
276   LOGICAL, PUBLIC, PARAMETER ::   lk_agrif = .FALSE.   !: agrif flag
277#endif
278
279   !!----------------------------------------------------------------------
280   !! NEMO/OPA 4.0 , NEMO Consortium (2011)
281   !! $Id$
282   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
283   !!----------------------------------------------------------------------
284CONTAINS
285
286#if ! defined key_agrif
287   !!----------------------------------------------------------------------
288   !! NOT 'key_agrif'      dummy function                     No AGRIF zoom
289   !!----------------------------------------------------------------------
290   LOGICAL FUNCTION Agrif_Root()
291      Agrif_Root = .TRUE.
292   END FUNCTION Agrif_Root
293
294   CHARACTER(len=3) FUNCTION Agrif_CFixed()
295      Agrif_CFixed = '0' 
296   END FUNCTION Agrif_CFixed
297#endif
298
299   INTEGER FUNCTION dom_oce_alloc()
300      !!----------------------------------------------------------------------
301      INTEGER, DIMENSION(11) :: ierr
302      !!----------------------------------------------------------------------
303      ierr(:) = 0
304      !
305      ALLOCATE( rdttra(jpk), r2dtra(jpk), mig(jpi), mjg(jpj), STAT=ierr(1) )
306         !
307      ALLOCATE( nimppt(jpnij) , ibonit(jpnij) , nlcit(jpnij) , nlcjt(jpnij) ,     &
308         &      njmppt(jpnij) , ibonjt(jpnij) , nldit(jpnij) , nldjt(jpnij) ,     &
309         &                                      nleit(jpnij) , nlejt(jpnij) ,     &
310         &      mi0(jpidta)   , mi1 (jpidta),  mj0(jpjdta)   , mj1 (jpjdta),      &
311         &      tpol(jpiglo)  , fpol(jpiglo)                               , STAT=ierr(2) )
312         !
313      ALLOCATE( glamt(jpi,jpj) , gphit(jpi,jpj) , e1t(jpi,jpj) , e2t(jpi,jpj) ,                      & 
314         &      glamu(jpi,jpj) , gphiu(jpi,jpj) , e1u(jpi,jpj) , e2u(jpi,jpj) ,                      & 
315         &      glamv(jpi,jpj) , gphiv(jpi,jpj) , e1v(jpi,jpj) , e2v(jpi,jpj) , e1e2t(jpi,jpj) ,     & 
316         &      glamf(jpi,jpj) , gphif(jpi,jpj) , e1f(jpi,jpj) , e2f(jpi,jpj) , ff   (jpi,jpj) , STAT=ierr(3) )     
317         !
318      ALLOCATE( gdep3w(jpi,jpj,jpk) , e3v(jpi,jpj,jpk) , e3f (jpi,jpj,jpk) ,                         &
319         &      gdept (jpi,jpj,jpk) , e3t(jpi,jpj,jpk) , e3u (jpi,jpj,jpk) ,                         &
320         &      gdepw (jpi,jpj,jpk) , e3w(jpi,jpj,jpk) , e3vw(jpi,jpj,jpk) , e3uw(jpi,jpj,jpk) , STAT=ierr(4) )
321         !
322#if defined key_vvl
323      ALLOCATE( gdep3w_1(jpi,jpj,jpk) , e3v_1(jpi,jpj,jpk) , e3f_1 (jpi,jpj,jpk) ,                           &
324         &      gdept_1 (jpi,jpj,jpk) , e3t_1(jpi,jpj,jpk) , e3u_1 (jpi,jpj,jpk) ,                           &
325         &      gdepw_1 (jpi,jpj,jpk) , e3w_1(jpi,jpj,jpk) , e3vw_1(jpi,jpj,jpk) , e3uw_1(jpi,jpj,jpk) ,     &
326         &      e3t_b   (jpi,jpj,jpk) , e3u_b(jpi,jpj,jpk) , e3v_b (jpi,jpj,jpk)                       , STAT=ierr(5) )
327#endif
328         !
329      ALLOCATE( hu(jpi,jpj) , hur(jpi,jpj) , hu_0(jpi,jpj) ,     &
330         &      hv(jpi,jpj) , hvr(jpi,jpj) , hv_0(jpi,jpj) , STAT=ierr(6) )
331         !
332      ALLOCATE( gdept_0(jpk) , gdepw_0(jpk) ,                                     &
333         &      e3t_0  (jpk) , e3w_0  (jpk) , e3tp (jpi,jpj), e3wp(jpi,jpj) ,     &
334         &      gsigt  (jpk) , gsigw  (jpk) , gsi3w(jpk)    ,                     &
335         &      esigt  (jpk) , esigw  (jpk)                                 , STAT=ierr(7) )
336         !
337      ALLOCATE( hbatv (jpi,jpj) , hbatf (jpi,jpj) ,     &
338         &      hbatt (jpi,jpj) , hbatu (jpi,jpj) ,     &
339         &      scosrf(jpi,jpj) , scobot(jpi,jpj) ,     &
340         &      hifv  (jpi,jpj) , hiff  (jpi,jpj) ,     &
341         &      hift  (jpi,jpj) , hifu  (jpi,jpj) , rx1 (jpi,jpj) , STAT=ierr(8) )
342
343      ALLOCATE( mbathy(jpi,jpj) , bathy(jpi,jpj) ,                     &
344         &     tmask_i(jpi,jpj) , bmask(jpi,jpj) ,                     &
345         &     mbkt   (jpi,jpj) , mbku (jpi,jpj) , mbkv(jpi,jpj) , STAT=ierr(9) )
346
347      ALLOCATE( tmask(jpi,jpj,jpk) , umask(jpi,jpj,jpk),     & 
348         &      vmask(jpi,jpj,jpk) , fmask(jpi,jpj,jpk), STAT=ierr(10) )
349
350#if defined key_noslip_accurate
351      ALLOCATE( npcoa(4,jpk), nicoa(2*(jpi+jpj),4,jpk), njcoa(2*(jpi+jpj),4,jpk), STAT=ierr(11) )
352#endif
353      !
354      dom_oce_alloc = MAXVAL(ierr)
355      !
356   END FUNCTION dom_oce_alloc
357
358   !!======================================================================
359END MODULE dom_oce
Note: See TracBrowser for help on using the repository browser.