source: NEMO/branches/2019/ENHANCE-03_domcfg/src/dom_oce.F90 @ 11129

Last change on this file since 11129 was 11129, checked in by mathiot, 15 months ago

simplification of domcfg (rm all var_n and var_b as it is not needed) (ticket #2143)

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