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 NEMO/trunk/src/OCE/DOM – NEMO

source: NEMO/trunk/src/OCE/DOM/dom_oce.F90 @ 14143

Last change on this file since 14143 was 14143, checked in by techene, 3 years ago

#2385 add key_linssh equivalent to ln_linssh using domzr_substitute

  • Property svn:keywords set to Id
File size: 24.9 KB
Line 
1MODULE dom_oce
2   !!======================================================================
3   !!                       ***  MODULE dom_oce  ***
4   !! ** Purpose :   Define in memory all the ocean space domain variables
5   !!======================================================================
6   !! History :  1.0  ! 2005-10  (A. Beckmann, G. Madec)  reactivate s-coordinate
7   !!            3.3  ! 2010-11  (G. Madec) add mbk. arrays associated to the deepest ocean level
8   !!            3.4  ! 2011-01  (A. R. Porter, STFC Daresbury) dynamical allocation
9   !!            3.5  ! 2012     (S. Mocavero, I. Epicoco) Add arrays associated
10   !!                             to the optimization of BDY communications
11   !!            3.7  ! 2015-11  (G. Madec) introduce surface and scale factor ratio
12   !!             -   ! 2015-11  (G. Madec, A. Coward)  time varying zgr by default
13   !!            4.1  ! 2019-08  (A. Coward, D. Storkey) rename prognostic variables in preparation for new time scheme.
14   !!            4.x  ! 2020-02  (G. Madec, S. Techene) introduce ssh to h0 ratio
15   !!----------------------------------------------------------------------
16
17   !!----------------------------------------------------------------------
18   !!   Agrif_Root    : dummy function used when lk_agrif=F
19   !!   Agrif_Fixed   : dummy function used when lk_agrif=F
20   !!   Agrif_CFixed  : dummy function used when lk_agrif=F
21   !!   dom_oce_alloc : dynamical allocation of dom_oce arrays
22   !!----------------------------------------------------------------------
23   USE par_oce        ! ocean parameters
24
25   IMPLICIT NONE
26   PUBLIC             ! allows the acces to par_oce when dom_oce is used (exception to coding rules)
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   LOGICAL , PUBLIC ::   ln_linssh      !: =T  linear free surface ==>> model level are fixed in time
35   LOGICAL , PUBLIC ::   ln_meshmask    !: =T  create a mesh-mask file (mesh_mask.nc)
36   REAL(wp), PUBLIC ::   rn_Dt          !: time step for the dynamics and tracer
37   REAL(wp), PUBLIC ::   rn_atfp        !: asselin time filter parameter
38   LOGICAL , PUBLIC ::   ln_1st_euler   !: =T start with forward time step or not (=F)
39   LOGICAL , PUBLIC ::   ln_crs         !: Apply grid coarsening to dynamical model output or online passive tracers
40
41   !! Free surface parameters
42   !! =======================
43   LOGICAL , PUBLIC :: ln_dynspg_exp    !: Explicit free surface flag
44   LOGICAL , PUBLIC :: ln_dynspg_ts     !: Split-Explicit free surface flag
45
46   !! Time splitting parameters
47   !! =========================
48   LOGICAL,  PUBLIC :: ln_bt_fw         !: Forward integration of barotropic sub-stepping
49   LOGICAL,  PUBLIC :: ln_bt_av         !: Time averaging of barotropic variables
50   LOGICAL,  PUBLIC :: ln_bt_auto       !: Set number of barotropic iterations automatically
51   INTEGER,  PUBLIC :: nn_bt_flt        !: Filter choice
52   INTEGER,  PUBLIC :: nn_e          !: Number of barotropic iterations during one baroclinic step (rn_Dt)
53   REAL(wp), PUBLIC :: rn_bt_cmax       !: Maximum allowed courant number (used if ln_bt_auto=T)
54   REAL(wp), PUBLIC :: rn_bt_alpha      !: Time stepping diffusion parameter
55
56
57   !                                   !!! associated variables
58   LOGICAL , PUBLIC ::   l_1st_euler    !: Euler 1st time-step flag (=T if ln_restart=F or ln_1st_euler=T)
59   REAL(wp), PUBLIC ::   rDt, r1_Dt     !: Current model timestep and reciprocal
60                                        !: rDt = 2 * rn_Dt if leapfrog and l_1st_euler = F
61                                        !:     =     rn_Dt if leapfrog and l_1st_euler = T
62                                        !:     =     rn_Dt if RK3
63
64   !!----------------------------------------------------------------------
65   !! space domain parameters
66   !!----------------------------------------------------------------------
67   INTEGER, PUBLIC ::   jperio   !: Global domain lateral boundary type (between 0 and 7)
68   !                                !  = 0 closed                 ;   = 1 cyclic East-West
69   !                                !  = 2 cyclic North-South     ;   = 3 North fold T-point pivot
70   !                                !  = 4 cyclic East-West AND North fold T-point pivot
71   !                                !  = 5 North fold F-point pivot
72   !                                !  = 6 cyclic East-West AND North fold F-point pivot
73   !                                !  = 7 bi-cyclic East-West AND North-South
74   LOGICAL, PUBLIC ::   l_Iperio, l_Jperio   !   should we explicitely take care I/J periodicity
75
76   ! Tiling namelist
77   LOGICAL, PUBLIC ::   ln_tile
78   INTEGER         ::   nn_ltile_i, nn_ltile_j
79
80   ! Domain tiling (all tiles)
81   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   ntsi_a       !: start of internal part of tile domain
82   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   ntsj_a       !
83   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   ntei_a       !: end of internal part of tile domain
84   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   ntej_a       !
85
86   !                             !: domain MPP decomposition parameters
87   INTEGER             , PUBLIC ::   nimpp, njmpp     !: i- & j-indexes for mpp-subdomain left bottom
88   INTEGER             , PUBLIC ::   nproc            !: number for local processor
89   INTEGER             , PUBLIC ::   narea            !: number for local area
90   INTEGER             , PUBLIC ::   nbondi, nbondj   !: mark of i- and j-direction local boundaries
91   INTEGER, ALLOCATABLE, PUBLIC ::   nbondi_bdy(:)    !: mark i-direction local boundaries for BDY open boundaries
92   INTEGER, ALLOCATABLE, PUBLIC ::   nbondj_bdy(:)    !: mark j-direction local boundaries for BDY open boundaries
93   INTEGER, ALLOCATABLE, PUBLIC ::   nbondi_bdy_b(:)  !: mark i-direction of neighbours local boundaries for BDY open boundaries
94   INTEGER, ALLOCATABLE, PUBLIC ::   nbondj_bdy_b(:)  !: mark j-direction of neighbours local boundaries for BDY open boundaries
95
96   INTEGER, PUBLIC ::   npolj             !: north fold mark (0, 3 or 4)
97   INTEGER, PUBLIC ::   noea, nowe        !: index of the local neighboring processors in
98   INTEGER, PUBLIC ::   noso, nono        !: east, west, south and north directions
99   INTEGER, PUBLIC ::   nones, nonws        !: north-east, north-west directions for sending
100   INTEGER, PUBLIC ::   noses, nosws        !: south-east, south-west directions for sending
101   INTEGER, PUBLIC ::   noner, nonwr        !: north-east, north-west directions for receiving
102   INTEGER, PUBLIC ::   noser, noswr        !: south-east, south-west directions for receiving
103   INTEGER, PUBLIC ::   nidom             !: ???
104
105   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   mig        !: local ==> global domain, including halos (jpiglo), i-index
106   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   mjg        !: local ==> global domain, including halos (jpjglo), j-index
107   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   mig0       !: local ==> global domain, excluding halos (Ni0glo), i-index
108   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   mjg0       !: local ==> global domain, excluding halos (Nj0glo), j-index
109   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   mig0_oldcmp !: local ==> global domain, excluding halos (Ni0glo), i-index
110   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   mjg0_oldcmp !: local ==> global domain, excluding halos (Nj0glo), j-index
111   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   mi0, mi1   !: global, including halos (jpiglo) ==> local domain i-index
112   !                                                                !:    (mi0=1 and mi1=0 if global index not in local domain)
113   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   mj0, mj1   !: global, including halos (jpjglo) ==> local domain j-index
114   !                                                                !:    (mj0=1 and mj1=0 if global index not in local domain)
115   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   nimppt,  njmppt   !: i-, j-indexes for each processor
116   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   ibonit,  ibonjt   !: i-, j- processor neighbour existence
117   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   jpiall,  jpjall   !: dimensions of all subdomain
118   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   nis0all, njs0all  !: first, last indoor index for all i-subdomain
119   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   nie0all, nje0all  !: first, last indoor index for all j-subdomain
120   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   nfimpp, nfproc, nfjpi
121
122   !!----------------------------------------------------------------------
123   !! horizontal curvilinear coordinate and scale factors
124   !! ---------------------------------------------------------------------
125   REAL(wp), PUBLIC, ALLOCATABLE, SAVE        , DIMENSION(:,:) ::   glamt , glamu, glamv , glamf    !: longitude at t, u, v, f-points [degree]
126   REAL(wp), PUBLIC, ALLOCATABLE, SAVE        , DIMENSION(:,:) ::   gphit , gphiu, gphiv , gphif    !: latitude  at t, u, v, f-points [degree]
127   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, TARGET, DIMENSION(:,:) ::   e1t   , e2t  , r1_e1t, r1_e2t   !: t-point horizontal scale factors    [m]
128   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, TARGET, DIMENSION(:,:) ::   e1u   , e2u  , r1_e1u, r1_e2u   !: horizontal scale factors at u-point [m]
129   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, TARGET, DIMENSION(:,:) ::   e1v   , e2v  , r1_e1v, r1_e2v   !: horizontal scale factors at v-point [m]
130   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, TARGET, DIMENSION(:,:) ::   e1f   , e2f  , r1_e1f, r1_e2f   !: horizontal scale factors at f-point [m]
131   !
132   REAL(wp), PUBLIC, ALLOCATABLE, SAVE        , DIMENSION(:,:) ::   e1e2t , r1_e1e2t                !: associated metrics at t-point
133   REAL(wp), PUBLIC, ALLOCATABLE, SAVE        , DIMENSION(:,:) ::   e1e2u , r1_e1e2u , e2_e1u       !: associated metrics at u-point
134   REAL(wp), PUBLIC, ALLOCATABLE, SAVE        , DIMENSION(:,:) ::   e1e2v , r1_e1e2v , e1_e2v       !: associated metrics at v-point
135   REAL(wp), PUBLIC, ALLOCATABLE, SAVE        , DIMENSION(:,:) ::   e1e2f , r1_e1e2f                !: associated metrics at f-point
136   !
137   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   ff_f  , ff_t                    !: Coriolis factor at f- & t-points  [1/s]
138   
139   !!----------------------------------------------------------------------
140   !! vertical coordinate and scale factors
141   !! ---------------------------------------------------------------------
142#if defined key_qco
143   LOGICAL, PUBLIC, PARAMETER ::   lk_qco    = .TRUE.   !: qco key flag
144#else
145   LOGICAL, PUBLIC, PARAMETER ::   lk_qco    = .FALSE.  !: qco key flag
146#endif
147#if defined key_linssh
148   LOGICAL, PUBLIC, PARAMETER ::   lk_linssh = .TRUE.   !: linssh key flag
149#else
150   LOGICAL, PUBLIC, PARAMETER ::   lk_linssh = .FALSE.  !: linssh key flag
151#endif
152   LOGICAL, PUBLIC ::   ln_zco       !: z-coordinate - full step
153   LOGICAL, PUBLIC ::   ln_zps       !: z-coordinate - partial step
154   LOGICAL, PUBLIC ::   ln_sco       !: s-coordinate or hybrid z-s coordinate
155   LOGICAL, PUBLIC ::   ln_isfcav    !: presence of ISF
156   !                                                        !  reference scale factors
157   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::     e3t_0   !: t- vert. scale factor [m]
158   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::     e3u_0   !: u- vert. scale factor [m]
159   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::     e3v_0   !: v- vert. scale factor [m]
160   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::     e3f_0   !: f- vert. scale factor [m]
161   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::     e3w_0   !: w- vert. scale factor [m]
162   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::    e3uw_0   !: uw-vert. scale factor [m]
163   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::    e3vw_0   !: vw-vert. scale factor [m]
164
165   !                                                        !  time-dependent scale factors     (domvvl)
166   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) ::   e3t, e3u, e3v, e3w, e3uw, e3vw  !: vert. scale factor [m]
167   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:)   ::   e3f                             !: F-point vert. scale factor [m]
168
169   !                                                        !  time-dependent ratio ssh / h_0   (domqco)
170   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:)   ::   r3t, r3u, r3v                   !: time-dependent    ratio at t-, u- and v-point [-]
171   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)     ::   r3f                             !: mid-time-level    ratio at f-point            [-]
172   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)     ::   r3t_f, r3u_f, r3v_f             !: now time-filtered ratio at t-, u- and v-point [-]
173
174   !                                                        !  reference depths of cells
175   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:)   ::   gdept_0  !: t- depth              [m]
176   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:)   ::   gdepw_0  !: w- depth              [m]
177   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:)   ::   gde3w_0  !: w- depth (sum of e3w) [m]
178   
179   !                                                        !  time-dependent depths of cells   (domvvl)
180   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) ::  gdept, gdepw
181   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:)   ::  gde3w
182
183   !                                                        !  reference heights of ocean water column and its inverse
184   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)     ::   ht_0, r1_ht_0   !: t-depth        [m] and [1/m]
185   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)     ::   hu_0, r1_hu_0   !: u-depth        [m] and [1/m]
186   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)     ::   hv_0, r1_hv_0   !: v-depth        [m] and [1/m]
187   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)     ::   hf_0, r1_hf_0   !: f-depth        [m] and [1/m]
188   
189   !                                                        ! time-dependent heights of ocean water column   (domvvl)
190   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)     ::   ht          !: t-points           [m]
191   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:)   ::   hu, r1_hu   !: u-depth            [m] and [1/m]
192   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:)   ::   hv, r1_hv   !: v-depth            [m] and [1/m]
193
194   INTEGER, PUBLIC ::   nla10              !: deepest    W level Above  ~10m (nlb10 - 1)
195   INTEGER, PUBLIC ::   nlb10              !: shallowest W level Bellow ~10m (nla10 + 1)
196
197   !! 1D reference  vertical coordinate
198   !! =-----------------====------
199   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:)   ::   gdept_1d, gdepw_1d !: reference depth of t- and w-points (m)
200   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:)   ::   e3t_1d  , e3w_1d   !: reference vertical scale factors at T- and W-pts (m)
201
202   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   risfdep, bathy
203
204   !!----------------------------------------------------------------------
205   !! masks, top and bottom ocean point position
206   !! ---------------------------------------------------------------------
207!!gm Proposition of new name for top/bottom vertical indices
208!   INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   mtk_t, mtk_u, mtk_v   !: top    first wet T-, U-, and V-level (ISF)
209!   INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   mbk_t, mbk_u, mbk_v   !: bottom last  wet T-, U-, and V-level
210!!gm
211   INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   mbkt, mbku, mbkv   !: bottom last wet T-, U- and V-level
212   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   tmask_i            !: interior domain T-point mask
213   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   tmask_h            !: internal domain T-point mask (Figure 8.5 NEMO book)
214
215   INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   mikt, miku, mikv, mikf   !: top first wet T-, U-, V-, F-level           (ISF)
216
217   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)           ::   ssmask, ssumask, ssvmask, ssfmask   !: surface mask at T-,U-, V- and F-pts
218   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:), TARGET ::   tmask, umask, vmask, wmask, fmask   !: land/ocean mask at T-, U-, V-, W- and F-pts
219   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:), TARGET ::   wumask, wvmask                      !: land/ocean mask at WU- and WV-pts
220   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:), TARGET ::   fe3mask                             !: land/ocean mask at F-pts (qco only)
221
222   !!----------------------------------------------------------------------
223   !! calendar variables
224   !! ---------------------------------------------------------------------
225   INTEGER , PUBLIC ::   nyear         !: current year
226   INTEGER , PUBLIC ::   nmonth        !: current month
227   INTEGER , PUBLIC ::   nday          !: current day of the month
228   INTEGER , PUBLIC ::   nhour         !: current hour
229   INTEGER , PUBLIC ::   nminute       !: current minute
230   INTEGER , PUBLIC ::   ndastp        !: time step date in yyyymmdd format
231   INTEGER , PUBLIC ::   nday_year     !: current day counted from jan 1st of the current year
232   INTEGER , PUBLIC ::   nsec_year     !: seconds between 00h jan 1st of the current  year and half of the current time step
233   INTEGER , PUBLIC ::   nsec_month    !: seconds between 00h 1st day of the current month and half of the current time step
234   INTEGER , PUBLIC ::   nsec_monday   !: seconds between 00h         of the last Monday   and half of the current time step
235   INTEGER , PUBLIC ::   nsec_day      !: seconds between 00h         of the current   day and half of the current time step
236   REAL(wp), PUBLIC ::   fjulday       !: current julian day
237   REAL(wp), PUBLIC ::   fjulstartyear !: first day of the current year in julian days
238   REAL(wp), PUBLIC ::   adatrj        !: number of elapsed days since the begining of the whole simulation
239   !                                   !: (cumulative duration of previous runs that may have used different time-step size)
240   INTEGER , PUBLIC, DIMENSION(  0: 2) ::   nyear_len     !: length in days of the previous/current/next year
241   INTEGER , PUBLIC, DIMENSION(-11:25) ::   nmonth_len    !: length in days of the months of the current year
242   INTEGER , PUBLIC, DIMENSION(-11:25) ::   nmonth_beg    !: second since Jan 1st 0h of the current year and the half of the months
243   INTEGER , PUBLIC                  ::   nsec1jan000     !: second since Jan 1st 0h of nit000 year and Jan 1st 0h the current year
244   INTEGER , PUBLIC                  ::   nsec000_1jan000   !: second since Jan 1st 0h of nit000 year and nit000
245   INTEGER , PUBLIC                  ::   nsecend_1jan000   !: second since Jan 1st 0h of nit000 year and nitend
246
247   !!----------------------------------------------------------------------
248   !! variable defined here to avoid circular dependencies...
249   !! ---------------------------------------------------------------------
250   INTEGER, PUBLIC ::   nbasin         ! number of basin to be considered in diaprt (glo, atl, pac, ind, ipc)
251
252   !!----------------------------------------------------------------------
253   !! agrif domain
254   !!----------------------------------------------------------------------
255#if defined key_agrif
256   LOGICAL, PUBLIC, PARAMETER ::   lk_agrif = .TRUE.    !: agrif flag
257   LOGICAL, PUBLIC            ::   lk_south, lk_north, lk_west, lk_east !: Child grid boundaries (interpolation or not)
258#else
259   LOGICAL, PUBLIC, PARAMETER ::   lk_agrif = .FALSE.   !: agrif flag
260#endif
261
262   !!----------------------------------------------------------------------
263   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
264   !! $Id$
265   !! Software governed by the CeCILL license (see ./LICENSE)
266   !!----------------------------------------------------------------------
267CONTAINS
268
269#if ! defined key_agrif
270   !!----------------------------------------------------------------------
271   !! NOT 'key_agrif'      dummy function                     No AGRIF zoom
272   !!----------------------------------------------------------------------
273   LOGICAL FUNCTION Agrif_Root()
274      Agrif_Root = .TRUE.
275   END FUNCTION Agrif_Root
276
277   INTEGER FUNCTION Agrif_Fixed()
278      Agrif_Fixed = 0
279   END FUNCTION Agrif_Fixed
280
281   CHARACTER(len=3) FUNCTION Agrif_CFixed()
282      Agrif_CFixed = '0'
283   END FUNCTION Agrif_CFixed
284#endif
285
286   INTEGER FUNCTION dom_oce_alloc()
287      !!----------------------------------------------------------------------
288      INTEGER                ::   ii
289      INTEGER, DIMENSION(30) :: ierr
290      !!----------------------------------------------------------------------
291      ii = 0   ;   ierr(:) = 0
292      !
293      ii = ii+1
294      ALLOCATE( mig(jpi), mjg(jpj), mig0(jpi), mjg0(jpj), mig0_oldcmp(jpi), mjg0_oldcmp(jpj), STAT=ierr(ii) )
295         !
296      ii = ii+1
297      ALLOCATE( mi0(jpiglo), mi1(jpiglo), mj0(jpjglo), mj1(jpjglo), STAT=ierr(ii) )
298         !
299      ii = ii+1
300      ALLOCATE( glamt(jpi,jpj) ,    glamu(jpi,jpj) ,  glamv(jpi,jpj) ,  glamf(jpi,jpj) ,     &
301         &      gphit(jpi,jpj) ,    gphiu(jpi,jpj) ,  gphiv(jpi,jpj) ,  gphif(jpi,jpj) ,     &
302         &       e1t (jpi,jpj) ,     e2t (jpi,jpj) , r1_e1t(jpi,jpj) , r1_e2t(jpi,jpj) ,     &
303         &       e1u (jpi,jpj) ,     e2u (jpi,jpj) , r1_e1u(jpi,jpj) , r1_e2u(jpi,jpj) ,     &
304         &       e1v (jpi,jpj) ,     e2v (jpi,jpj) , r1_e1v(jpi,jpj) , r1_e2v(jpi,jpj) ,     &
305         &       e1f (jpi,jpj) ,     e2f (jpi,jpj) , r1_e1f(jpi,jpj) , r1_e2f(jpi,jpj) ,     &
306         &      e1e2t(jpi,jpj) , r1_e1e2t(jpi,jpj)                                     ,     &
307         &      e1e2u(jpi,jpj) , r1_e1e2u(jpi,jpj) , e2_e1u(jpi,jpj)                   ,     &
308         &      e1e2v(jpi,jpj) , r1_e1e2v(jpi,jpj) , e1_e2v(jpi,jpj)                   ,     &
309         &      e1e2f(jpi,jpj) , r1_e1e2f(jpi,jpj)                                     ,     &
310         &      ff_f (jpi,jpj) ,    ff_t (jpi,jpj)                                     , STAT=ierr(ii) )
311         !
312      ii = ii+1
313      ALLOCATE( gdept_0 (jpi,jpj,jpk) , gdepw_0 (jpi,jpj,jpk) , gde3w_0(jpi,jpj,jpk) ,     &
314         &      gdept_1d(        jpk) , gdepw_1d(        jpk)                        , STAT=ierr(ii) )
315         !
316      ii = ii+1
317      ALLOCATE(  e3t_0 (jpi,jpj,jpk) , e3u_0 (jpi,jpj,jpk) , e3v_0 (jpi,jpj,jpk) , e3f_0(jpi,jpj,jpk) ,     &
318         &       e3w_0 (jpi,jpj,jpk) , e3uw_0(jpi,jpj,jpk) , e3vw_0(jpi,jpj,jpk)                      ,     &
319         &       e3t_1d(        jpk) , e3w_1d(        jpk)                                            , STAT=ierr(ii) )
320         !
321      ii = ii+1
322      ALLOCATE( ht_0(jpi,jpj) ,    hu_0(jpi,jpj)    ,    hv_0(jpi,jpj)     , hf_0(jpi,jpj) ,       &
323         &   r1_ht_0(jpi,jpj) , r1_hu_0(jpi,jpj) ,    r1_hv_0(jpi,jpj),   r1_hf_0(jpi,jpj) ,   STAT=ierr(ii)  )
324         !
325#if defined key_qco
326         ! qco : ssh to h ratio and specific fmask
327      ii = ii+1
328      ALLOCATE( r3t  (jpi,jpj,jpt) , r3u  (jpi,jpj,jpt) , r3v  (jpi,jpj,jpt) , r3f  (jpi,jpj) ,      &
329         &      r3t_f(jpi,jpj)     , r3u_f(jpi,jpj)     , r3v_f(jpi,jpj)                      ,  STAT=ierr(ii) )
330         !
331      ii = ii+1
332      ALLOCATE( fe3mask(jpi,jpj,jpk) , STAT=ierr(ii) )
333         !
334#elif defined key_linssh
335         ! linear ssh no time varying coordinate arrays
336#else
337         ! vvl : time varation for all vertical coordinate variables
338      ii = ii+1
339      ALLOCATE( gdept  (jpi,jpj,jpk,jpt) , gdepw  (jpi,jpj,jpk,jpt) , gde3w  (jpi,jpj,jpk) , STAT=ierr(ii) )
340         !
341      ii = ii+1
342      ALLOCATE( e3t(jpi,jpj,jpk,jpt) , e3u (jpi,jpj,jpk,jpt) , e3v (jpi,jpj,jpk,jpt) , e3f(jpi,jpj,jpk) ,      &
343         &      e3w(jpi,jpj,jpk,jpt) , e3uw(jpi,jpj,jpk,jpt) , e3vw(jpi,jpj,jpk,jpt)                    ,  STAT=ierr(ii) )
344         !
345      ii = ii+1
346      ALLOCATE( ht  (jpi,jpj) ,    hu  (jpi,jpj,jpt),    hv  (jpi,jpj,jpt) ,       &
347         &                      r1_hu  (jpi,jpj,jpt), r1_hv  (jpi,jpj,jpt) ,   STAT=ierr(ii)  )
348#endif
349         !
350      ii = ii+1
351      ALLOCATE( risfdep(jpi,jpj) , bathy(jpi,jpj) , STAT=ierr(ii)  )
352         !
353      ii = ii+1
354      ALLOCATE( tmask_i(jpi,jpj) , tmask_h(jpi,jpj) ,                                           &
355         &      ssmask (jpi,jpj) , ssumask(jpi,jpj) , ssvmask(jpi,jpj) , ssfmask(jpi,jpj) ,     &
356         &      mbkt   (jpi,jpj) , mbku   (jpi,jpj) , mbkv   (jpi,jpj)                    , STAT=ierr(ii) )
357         !
358      ii = ii+1
359      ALLOCATE( mikt(jpi,jpj), miku(jpi,jpj), mikv(jpi,jpj), mikf(jpi,jpj), STAT=ierr(ii) )
360         !
361      ii = ii+1
362      ALLOCATE( tmask(jpi,jpj,jpk) , umask(jpi,jpj,jpk) ,     &
363         &      vmask(jpi,jpj,jpk) , fmask(jpi,jpj,jpk) , STAT=ierr(ii) )
364         !
365      ii = ii+1
366      ALLOCATE( wmask(jpi,jpj,jpk) , wumask(jpi,jpj,jpk), wvmask(jpi,jpj,jpk) , STAT=ierr(ii) )
367      !
368      dom_oce_alloc = MAXVAL(ierr)
369      !
370   END FUNCTION dom_oce_alloc
371
372   !!======================================================================
373END MODULE dom_oce
Note: See TracBrowser for help on using the repository browser.