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/2015/dev_merge_2015/NEMOGCM/NEMO/OPA_SRC/DOM – NEMO

source: branches/2015/dev_merge_2015/NEMOGCM/NEMO/OPA_SRC/DOM/dom_oce.F90 @ 6069

Last change on this file since 6069 was 6069, checked in by timgraham, 8 years ago

Merge of dev_MetOffice_merge_2015 into branch (only NEMO directory for now).

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