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

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
dom_oce.F90 in branches/2016/dev_r6409_SIMPLIF_2_usrdef/NEMOGCM/NEMO/OPA_SRC/DOM – NEMO

source: branches/2016/dev_r6409_SIMPLIF_2_usrdef/NEMOGCM/NEMO/OPA_SRC/DOM/dom_oce.F90 @ 6624

Last change on this file since 6624 was 6624, checked in by gm, 8 years ago

#1692 - branch SIMPLIF_2_usrdef: add domain_cfg.nc file which includes jperio, and vert. coord. logicals. +code cleaning

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