source: branches/2017/dev_merge_2017/NEMOGCM/TOOLS/DOMAINcfg/src/dom_oce.f90 @ 9033

Last change on this file since 9033 was 9033, checked in by timgraham, 3 years ago

Commit final files from merge of NEMOGCM and some fixes for waves (taooc renamed tauwoc)

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