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/UKMO/dev_r5518_GO6_package/NEMOGCM/NEMO/OPA_SRC/DOM – NEMO

source: branches/UKMO/dev_r5518_GO6_package/NEMOGCM/NEMO/OPA_SRC/DOM/dom_oce.F90 @ 9830

Last change on this file since 9830 was 9830, checked in by frrh, 6 years ago

Merge revisions 9607:9721 of/branches/UKMO/dev_r5518_GO6_diag_bitcomp
into GO6 package branch.

This change ensures most 2D and 3D diagnostics produced by NEMO and MEDUSA
are bit reproducible on different PE decompositions.

Command used:
svn merge -r 9607:9721 ​svn+ssh://forge.ipsl.jussieu.fr/ipsl/forge/projets/nemo/svn/branches/UKMO/dev_r5518_GO6_diag_bitcomp

Met Office GMED ticket 389 refers.

This change applies a mask to all duplicate grid points
output on diagnistic grids for T, U and V points. i.e. it masks
any wrap columns and duplicated grid points across the N-fold.
Fields affected are all "standard" NEMO diagnostics (scalar and
diaptr diagnostics are not on "normal" grids).

It also introduces some corrections/initialisations to achieve
PE decomposition bit comparison.

Most 2D or 3D fields are now bit comparable on different PE decompositions.
Only diaptr diagnostics can not be guaranteed bit reproducible
(due to their method of computation).

This change does nothing to CICE output.

Model evolution is unaffected.
File size: 31.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   !!            4.0  ! 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   !!----------------------------------------------------------------------
13
14   !!----------------------------------------------------------------------
15   !!   Agrif_Root    : dummy function used when lk_agrif=F
16   !!   Agrif_CFixed  : dummy function used when lk_agrif=F
17   !!   dom_oce_alloc : dynamical allocation of dom_oce arrays
18   !!----------------------------------------------------------------------
19   USE par_oce        ! ocean parameters
20
21   IMPLICIT NONE
22   PUBLIC             ! allows the acces to par_oce when dom_oce is used
23   !                  ! exception to coding rules... to be suppressed ???
24
25   PUBLIC dom_oce_alloc  ! Called from nemogcm.F90
26
27   !!----------------------------------------------------------------------
28   !! time & space domain namelist
29   !! ----------------------------
30   !                                    !!* Namelist namdom : time & space domain *
31   INTEGER , PUBLIC ::   nn_bathy        !: = 0/1 ,compute/read the bathymetry file
32   REAL(wp), PUBLIC ::   rn_bathy        !: depth of flat bottom (active if nn_bathy=0; if =0 depth=jpkm1)
33   REAL(wp), PUBLIC ::   rn_hmin         !: minimum ocean depth (>0) or minimum number of ocean levels (<0)
34   REAL(wp), PUBLIC ::   rn_e3zps_min    !: miminum thickness for partial steps (meters)
35   REAL(wp), PUBLIC ::   rn_e3zps_rat    !: minimum thickness ration for partial steps
36   INTEGER , PUBLIC ::   nn_msh          !: = 1 create a mesh-mask file
37   INTEGER , PUBLIC ::   nn_acc          !: = 0/1 use of the acceleration of convergence technique
38   REAL(wp), PUBLIC ::   rn_atfp         !: asselin time filter parameter
39   REAL(wp), PUBLIC ::   rn_rdt          !: time step for the dynamics (and tracer if nacc=0)
40   REAL(wp), PUBLIC ::   rn_rdtmin       !: minimum time step on tracers
41   REAL(wp), PUBLIC ::   rn_rdtmax       !: maximum time step on tracers
42   REAL(wp), PUBLIC ::   rn_rdth         !: depth variation of tracer step
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_crs          !: Apply grid coarsening to dynamical model output or online passive tracers
46
47   !! Time splitting parameters
48   !! =========================
49   LOGICAL,  PUBLIC :: ln_bt_fw          !: Forward integration of barotropic sub-stepping
50   LOGICAL,  PUBLIC :: ln_bt_av          !: Time averaging of barotropic variables
51   LOGICAL,  PUBLIC :: ln_bt_nn_auto     !: Set number of barotropic iterations automatically
52   INTEGER,  PUBLIC :: nn_bt_flt         !: Filter choice
53   INTEGER,  PUBLIC :: nn_baro           !: Number of barotropic iterations during one baroclinic step (rdt)
54   REAL(wp), PUBLIC :: rn_bt_cmax        !: Maximum allowed courant number (used if ln_bt_nn_auto=T)
55
56   !! Horizontal grid parameters for domhgr
57   !! =====================================
58   INTEGER       ::   jphgr_msh        !: type of horizontal mesh
59   !                                       !  = 0 curvilinear coordinate on the sphere read in coordinate.nc
60   !                                       !  = 1 geographical mesh on the sphere with regular grid-spacing
61   !                                       !  = 2 f-plane with regular grid-spacing
62   !                                       !  = 3 beta-plane with regular grid-spacing
63   !                                       !  = 4 Mercator grid with T/U point at the equator
64
65   REAL(wp)      ::   ppglam0              !: longitude of first raw and column T-point (jphgr_msh = 1)
66   REAL(wp)      ::   ppgphi0              !: latitude  of first raw and column T-point (jphgr_msh = 1)
67   !                                                        !  used for Coriolis & Beta parameters (jphgr_msh = 2 or 3)
68   REAL(wp)      ::   ppe1_deg             !: zonal      grid-spacing (degrees)
69   REAL(wp)      ::   ppe2_deg             !: meridional grid-spacing (degrees)
70   REAL(wp)      ::   ppe1_m               !: zonal      grid-spacing (degrees)
71   REAL(wp)      ::   ppe2_m               !: meridional grid-spacing (degrees)
72
73   !! Vertical grid parameter for domzgr
74   !! ==================================
75   REAL(wp)      ::   ppsur                !: ORCA r4, r2 and r05 coefficients
76   REAL(wp)      ::   ppa0                 !: (default coefficients)
77   REAL(wp)      ::   ppa1                 !:
78   REAL(wp)      ::   ppkth                !:
79   REAL(wp)      ::   ppacr                !:
80   !
81   !  If both ppa0 ppa1 and ppsur are specified to 0, then
82   !  they are computed from ppdzmin, pphmax , ppkth, ppacr in dom_zgr
83   REAL(wp)      ::   ppdzmin              !: Minimum vertical spacing
84   REAL(wp)      ::   pphmax               !: Maximum depth
85   !
86   LOGICAL       ::   ldbletanh            !: Use/do not use double tanf function for vertical coordinates
87   REAL(wp)      ::   ppa2                 !: Double tanh function parameters
88   REAL(wp)      ::   ppkth2               !:
89   REAL(wp)      ::   ppacr2               !:
90
91   !                                    !! old non-DOCTOR names still used in the model
92   INTEGER , PUBLIC ::   ntopo           !: = 0/1 ,compute/read the bathymetry file
93   REAL(wp), PUBLIC ::   e3zps_min       !: miminum thickness for partial steps (meters)
94   REAL(wp), PUBLIC ::   e3zps_rat       !: minimum thickness ration for partial steps
95   INTEGER , PUBLIC ::   nmsh            !: = 1 create a mesh-mask file
96   INTEGER , PUBLIC ::   nacc            !: = 0/1 use of the acceleration of convergence technique
97   REAL(wp), PUBLIC ::   atfp            !: asselin time filter parameter
98   REAL(wp), PUBLIC ::   rdt             !: time step for the dynamics (and tracer if nacc=0)
99   REAL(wp), PUBLIC ::   rdtmin          !: minimum time step on tracers
100   REAL(wp), PUBLIC ::   rdtmax          !: maximum time step on tracers
101   REAL(wp), PUBLIC ::   rdth            !: depth variation of tracer step
102
103   !                                                  !!! associated variables
104   INTEGER , PUBLIC                 ::   neuler        !: restart euler forward option (0=Euler)
105   REAL(wp), PUBLIC                 ::   atfp1         !: asselin time filter coeff. (atfp1= 1-2*atfp)
106   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   rdttra  !: vertical profile of tracer time step
107   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   r2dtra  !: = 2*rdttra except at nit000 (=rdttra) if neuler=0
108
109   !                                         !!* Namelist namcla : cross land advection
110   INTEGER, PUBLIC ::   nn_cla               !: =1 cross land advection for exchanges through some straits (ORCA2)
111
112   !!----------------------------------------------------------------------
113   !! space domain parameters
114   !!----------------------------------------------------------------------
115   LOGICAL, PUBLIC ::   lzoom      =  .FALSE.   !: zoom flag
116   LOGICAL, PUBLIC ::   lzoom_e    =  .FALSE.   !: East  zoom type flag
117   LOGICAL, PUBLIC ::   lzoom_w    =  .FALSE.   !: West  zoom type flag
118   LOGICAL, PUBLIC ::   lzoom_s    =  .FALSE.   !: South zoom type flag
119   LOGICAL, PUBLIC ::   lzoom_n    =  .FALSE.   !: North zoom type flag
120
121   !                                     !!! domain parameters linked to mpp
122   INTEGER, PUBLIC ::   nperio            !: type of lateral boundary condition
123   INTEGER, PUBLIC ::   nimpp, njmpp      !: i- & j-indexes for mpp-subdomain left bottom
124   INTEGER, PUBLIC ::   nreci, nrecj      !: overlap region in i and j
125   INTEGER, PUBLIC ::   nproc             !: number for local processor
126   INTEGER, PUBLIC ::   narea             !: number for local area
127   INTEGER, PUBLIC ::   nbondi, nbondj    !: mark of i- and j-direction local boundaries
128   INTEGER, ALLOCATABLE, PUBLIC ::   nbondi_bdy(:)    !: mark i-direction local boundaries for BDY open boundaries
129   INTEGER, ALLOCATABLE, PUBLIC ::   nbondj_bdy(:)    !: mark j-direction local boundaries for BDY open boundaries
130   INTEGER, ALLOCATABLE, PUBLIC ::   nbondi_bdy_b(:)  !: mark i-direction of neighbours local boundaries for BDY open boundaries 
131   INTEGER, ALLOCATABLE, PUBLIC ::   nbondj_bdy_b(:)  !: mark j-direction of neighbours local boundaries for BDY open boundaries 
132
133   INTEGER, PUBLIC ::   npolj             !: north fold mark (0, 3 or 4)
134   INTEGER, PUBLIC ::   nlci, nldi, nlei  !: i-dimensions of the local subdomain and its first and last indoor indices
135   INTEGER, PUBLIC ::   nlcj, nldj, nlej  !: i-dimensions of the local subdomain and its first and last indoor indices
136   INTEGER, PUBLIC ::   noea, nowe        !: index of the local neighboring processors in
137   INTEGER, PUBLIC ::   noso, nono        !: east, west, south and north directions
138   INTEGER, PUBLIC ::   npne, npnw        !: index of north east and north west processor
139   INTEGER, PUBLIC ::   npse, npsw        !: index of south east and south west processor
140   INTEGER, PUBLIC ::   nbne, nbnw        !: logical of north east & north west processor
141   INTEGER, PUBLIC ::   nbse, nbsw        !: logical of south east & south west processor
142   INTEGER, PUBLIC ::   nidom             !: ???
143
144   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   mig        !: local  ==> global domain i-index
145   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   mjg        !: local  ==> global domain j-index
146   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   mi0, mi1   !: global ==> local  domain i-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(:) ::   mj0, mj1   !: global ==> local  domain j-index     !!bug ==> other solution?
149   !                                                  ! (mi0=1 and mi1=0 if the global index is not in the local domain)
150   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   nimppt, njmppt   !: i-, j-indexes for each processor
151   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   ibonit, ibonjt   !: i-, j- processor neighbour existence
152   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   nlcit , nlcjt    !: dimensions of every subdomain
153   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   nldit , nldjt    !: first, last indoor index for each i-domain
154   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   nleit , nlejt    !: first, last indoor index for each j-domain
155   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: nfiimpp, nfipproc, nfilcit
156
157   !!----------------------------------------------------------------------
158   !! horizontal curvilinear coordinate and scale factors
159   !! ---------------------------------------------------------------------
160   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::  glamt, glamu   !: longitude of t-, u-, v- and f-points (degre)
161   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::  glamv, glamf   !:
162   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::  gphit, gphiu   !: latitude  of t-, u-, v- and f-points (degre)
163   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::  gphiv, gphif   !:
164   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, TARGET, DIMENSION(:,:) ::  e1t, e2t, r1_e1t, r1_e2t   !: horizontal scale factors and inverse at t-point (m)
165   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, TARGET, DIMENSION(:,:) ::  e1u, e2u, r1_e1u, r1_e2u   !: horizontal scale factors and inverse at u-point (m)
166   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, TARGET, DIMENSION(:,:) ::  e1v, e2v, r1_e1v, r1_e2v   !: horizontal scale factors and inverse at v-point (m)
167   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, TARGET, DIMENSION(:,:) ::  e1f, e2f, r1_e1f, r1_e2f   !: horizontal scale factors and inverse at f-point (m)
168   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::  e1e2t          !: surface at t-point (m2)
169   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::  ff             !: coriolis factor (2.*omega*sin(yphi) ) (s-1)
170
171   !!----------------------------------------------------------------------
172   !! vertical coordinate and scale factors
173   !! ---------------------------------------------------------------------
174   !                                 !!* Namelist namzgr : vertical coordinate *
175   LOGICAL, PUBLIC ::   ln_zco        !: z-coordinate - full step
176   LOGICAL, PUBLIC ::   ln_zps        !: z-coordinate - partial step
177   LOGICAL, PUBLIC ::   ln_sco        !: s-coordinate or hybrid z-s coordinate
178   LOGICAL, PUBLIC ::   ln_isfcav     !: presence of ISF
179
180   !! All coordinates
181   !! ---------------
182   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   gdep3w_0           !: depth of t-points (sum of e3w) (m)
183   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   gdept_0, gdepw_0   !: analytical (time invariant) depth at t-w  points (m)
184   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   e3v_0  , e3f_0     !: analytical (time invariant) vertical scale factors at  v-f
185   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   e3t_0  , e3u_0     !:                                      t-u  points (m)
186   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   e3vw_0             !: analytical (time invariant) vertical scale factors at  vw
187   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   e3w_0  , e3uw_0    !:                                      w-uw points (m)
188#if defined key_vvl
189   LOGICAL, PUBLIC, PARAMETER ::   lk_vvl = .TRUE.    !: variable grid flag
190
191   !! All coordinates
192   !! ---------------
193   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   gdep3w_n           !: now depth of T-points (sum of e3w) (m)
194   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   gdept_n, gdepw_n   !: now depth at T-W  points (m)
195   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   gdept_b, gdepw_b   !: before depth at T-W  points (m)
196   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   e3t_n              !: now    vertical scale factors at  t       point  (m)
197   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   e3u_n  , e3v_n     !:            -      -      -    -   u --v   points (m)
198   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   e3w_n  , e3f_n     !:            -      -      -    -   w --f   points (m)
199   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   e3uw_n , e3vw_n    !:            -      -      -    -   uw--vw  points (m)
200   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   e3t_b              !: before     -      -      -    -   t       points (m)
201   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   e3w_b              !: before     -      -      -    -   t       points (m)
202   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   e3u_b  , e3v_b     !:   -        -      -      -    -   u --v   points (m)
203   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   e3uw_b , e3vw_b    !:   -        -      -      -    -   uw--vw  points (m)
204   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   e3t_a              !: after      -      -      -    -   t       point  (m)
205   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   e3u_a  , e3v_a     !:   -        -      -      -    -   u --v   points (m)
206#else
207   LOGICAL, PUBLIC, PARAMETER ::   lk_vvl = .FALSE.   !: fixed grid flag
208#endif
209   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   hur  , hvr     !: Now    inverse of u and v-points ocean depth (1/m)
210   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   hu   , hv      !:        depth at u- and v-points (meters)
211   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   ht             !:        depth at t-points (meters)
212   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   ehur_a, ehvr_a !: After  inverse of u and v-points ocean depth (1/m)
213   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   ehu_a , ehv_a  !:        depth at u- and v-points (meters)
214   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   ehur_b, ehvr_b !: Before inverse of u and v-points ocean depth (1/m)
215   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   ehu_b , ehv_b  !:        depth at u- and v-points (meters)
216   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   ht_0           !: reference depth at t-       points (meters)
217   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   hu_0 , hv_0    !: reference depth at u- and v-points (meters)
218   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   re2u_e1u       !: scale factor coeffs at u points (e2u/e1u)
219   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   re1v_e2v       !: scale factor coeffs at v points (e1v/e2v)
220   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   e12t , r1_e12t !: horizontal cell surface and inverse at t points
221   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   e12u , r1_e12u !: horizontal cell surface and inverse at u points
222   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   e12v , r1_e12v !: horizontal cell surface and inverse at v points
223   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   e12f , r1_e12f !: horizontal cell surface and inverse at f points
224
225   INTEGER, PUBLIC ::   nla10              !: deepest    W level Above  ~10m (nlb10 - 1)
226   INTEGER, PUBLIC ::   nlb10              !: shallowest W level Bellow ~10m (nla10 + 1)
227
228   !! z-coordinate with full steps (also used in the other cases as reference z-coordinate)
229   !! =-----------------====------
230   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:)   ::   gdept_1d, gdepw_1d !: reference depth of t- and w-points (m)
231   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:)   ::   e3t_1d  , e3w_1d   !: reference vertical scale factors at T- and W-pts (m)
232   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   e3tp    , e3wp     !: ocean bottom level thickness at T and W points
233
234   !! s-coordinate and hybrid z-s-coordinate
235   !! =----------------======---------------
236   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:)   ::   gsigt, gsigw       !: model level depth coefficient at t-, w-levels (analytic)
237   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:)   ::   gsi3w              !: model level depth coefficient at w-level (sum of gsigw)
238   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:)   ::   esigt, esigw       !: vertical scale factor coef. at t-, w-levels
239
240   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   hbatv , hbatf      !: ocean depth at the vertical of  v--f
241   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   hbatt , hbatu      !:                                 t--u points (m)
242   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   scosrf, scobot     !: ocean surface and bottom topographies
243   !                                                                           !  (if deviating from coordinate surfaces in HYBRID)
244   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   hifv  , hiff       !: interface depth between stretching at v--f
245   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   hift  , hifu       !: and quasi-uniform spacing             t--u points (m)
246   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   rx1                !: Maximum grid stiffness ratio
247
248   !!----------------------------------------------------------------------
249   !! masks, bathymetry
250   !! ---------------------------------------------------------------------
251   INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   mbathy             !: number of ocean level (=0, 1, ... , jpk-1)
252   INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   mbkt               !: vertical index of the bottom last T- ocean level
253   INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   mbku, mbkv         !: vertical index of the bottom last U- and W- ocean level
254   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   bathy                              !: ocean depth (meters)
255   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   tmask_i, umask_i, vmask_i, fmask_i !: interior domain T-point mask
256   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: tmask_i_diag     !: partial mask for use in T diagnostic mask calc.
257   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: umask_i_diag     !: partial mask for use in U diagnostic mask calc.
258   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: vmask_i_diag     !: partial mask for use in V diagnostic mask calc.
259   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   bmask                              !: land/ocean mask of barotropic stream function
260
261   INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   misfdep                 !: top first ocean level                (ISF)
262   INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   mikt, miku, mikv, mikf  !: first wet T-, U-, V-, F- ocean level (ISF)
263   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   risfdep                 !: Iceshelf draft                       (ISF)
264   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   ssmask                   !: surface domain T-point mask
265
266   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:), TARGET :: tmask, umask, vmask, fmask   !: land/ocean mask at T-, U-, V- and F-pts
267   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:), TARGET :: wmask, wumask, wvmask        !: land/ocean mask at WT-, WU- and WV-pts
268
269   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   tpol, fpol          !: north fold mask (jperio= 3 or 4)
270
271#if defined key_noslip_accurate
272   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:  )  :: npcoa              !: ???
273   INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:)  :: nicoa, njcoa       !: ???
274#endif
275
276   !!----------------------------------------------------------------------
277   !! calendar variables
278   !! ---------------------------------------------------------------------
279   INTEGER , PUBLIC ::   nyear         !: current year
280   INTEGER , PUBLIC ::   nmonth        !: current month
281   INTEGER , PUBLIC ::   nday          !: current day of the month
282   INTEGER , PUBLIC ::   ndastp        !: time step date in yyyymmdd format
283   INTEGER , PUBLIC ::   nday_year     !: current day counted from jan 1st of the current year
284   INTEGER , PUBLIC ::   nsec_year     !: current time step counted in second since 00h jan 1st of the current year
285   INTEGER , PUBLIC ::   nsec_month    !: current time step counted in second since 00h 1st day of the current month
286   INTEGER , PUBLIC ::   nsec_week     !: current time step counted in second since 00h of last monday
287   INTEGER , PUBLIC ::   nsec_day      !: current time step counted in second since 00h of the current day
288   REAL(wp), PUBLIC ::   fjulday       !: current julian day
289   REAL(wp), PUBLIC ::   fjulstartyear !: first day of the current year in julian days
290   REAL(wp), PUBLIC ::   adatrj        !: number of elapsed days since the begining of the whole simulation
291   !                                   !: (cumulative duration of previous runs that may have used different time-step size)
292   INTEGER , PUBLIC, DIMENSION(0: 2) ::   nyear_len     !: length in days of the previous/current/next year
293   INTEGER , PUBLIC, DIMENSION(0:13) ::   nmonth_len    !: length in days of the months of the current year
294   INTEGER , PUBLIC, DIMENSION(0:13) ::   nmonth_half   !: second since Jan 1st 0h of the current year and the half of the months
295   INTEGER , PUBLIC, DIMENSION(0:13) ::   nmonth_end    !: second since Jan 1st 0h of the current year and the end of the months
296   INTEGER , PUBLIC                  ::   nsec1jan000   !: second since Jan 1st 0h of nit000 year and Jan 1st 0h the current year
297
298   !!----------------------------------------------------------------------
299   !! mpp reproducibility
300   !!----------------------------------------------------------------------
301#if defined key_mpp_rep
302   LOGICAL, PUBLIC, PARAMETER ::   lk_mpp_rep = .TRUE.    !: agrif flag
303#else
304   LOGICAL, PUBLIC, PARAMETER ::   lk_mpp_rep = .FALSE.   !: agrif flag
305#endif
306
307   !!----------------------------------------------------------------------
308   !! agrif domain
309   !!----------------------------------------------------------------------
310#if defined key_agrif
311   LOGICAL, PUBLIC, PARAMETER ::   lk_agrif = .TRUE.    !: agrif flag
312#else
313   LOGICAL, PUBLIC, PARAMETER ::   lk_agrif = .FALSE.   !: agrif flag
314#endif
315
316   !!----------------------------------------------------------------------
317   !! NEMO/OPA 4.0 , NEMO Consortium (2011)
318   !! $Id$
319   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
320   !!----------------------------------------------------------------------
321CONTAINS
322
323#if ! defined key_agrif
324   !!----------------------------------------------------------------------
325   !! NOT 'key_agrif'      dummy function                     No AGRIF zoom
326   !!----------------------------------------------------------------------
327   LOGICAL FUNCTION Agrif_Root()
328      Agrif_Root = .TRUE.
329   END FUNCTION Agrif_Root
330
331   CHARACTER(len=3) FUNCTION Agrif_CFixed()
332      Agrif_CFixed = '0' 
333   END FUNCTION Agrif_CFixed
334#endif
335
336   INTEGER FUNCTION dom_oce_alloc()
337      !!----------------------------------------------------------------------
338      INTEGER, DIMENSION(12) :: ierr
339      !!----------------------------------------------------------------------
340      ierr(:) = 0
341      !
342      ALLOCATE( rdttra(jpk), r2dtra(jpk), mig(jpi), mjg(jpj), nfiimpp(jpni,jpnj),  &
343         &      nfipproc(jpni,jpnj), nfilcit(jpni,jpnj), STAT=ierr(1) )
344         !
345      ALLOCATE( nimppt(jpnij) , ibonit(jpnij) , nlcit(jpnij) , nlcjt(jpnij) ,     &
346         &      njmppt(jpnij) , ibonjt(jpnij) , nldit(jpnij) , nldjt(jpnij) ,     &
347         &                                      nleit(jpnij) , nlejt(jpnij) ,     &
348         &      mi0(jpidta)   , mi1 (jpidta),  mj0(jpjdta)   , mj1 (jpjdta),      &
349         &      tpol(jpiglo)  , fpol(jpiglo)                               , STAT=ierr(2) )
350         !
351      ALLOCATE( glamt(jpi,jpj) , gphit(jpi,jpj) , e1t(jpi,jpj) , e2t(jpi,jpj) , r1_e1t(jpi,jpj) , r1_e2t(jpi,jpj) ,   & 
352         &      glamu(jpi,jpj) , gphiu(jpi,jpj) , e1u(jpi,jpj) , e2u(jpi,jpj) , r1_e1u(jpi,jpj) , r1_e2u(jpi,jpj) ,   & 
353         &      glamv(jpi,jpj) , gphiv(jpi,jpj) , e1v(jpi,jpj) , e2v(jpi,jpj) , r1_e1v(jpi,jpj) , r1_e2v(jpi,jpj) ,   & 
354         &      glamf(jpi,jpj) , gphif(jpi,jpj) , e1f(jpi,jpj) , e2f(jpi,jpj) , r1_e1f(jpi,jpj) , r1_e2f(jpi,jpj) ,   &
355         &      e1e2t(jpi,jpj) , ff   (jpi,jpj) , STAT=ierr(3) )     
356         !
357      ALLOCATE( gdep3w_0(jpi,jpj,jpk) , e3v_0(jpi,jpj,jpk) , e3f_0 (jpi,jpj,jpk) ,                         &
358         &      gdept_0 (jpi,jpj,jpk) , e3t_0(jpi,jpj,jpk) , e3u_0 (jpi,jpj,jpk) ,                         &
359         &      gdepw_0 (jpi,jpj,jpk) , e3w_0(jpi,jpj,jpk) , e3vw_0(jpi,jpj,jpk) , e3uw_0(jpi,jpj,jpk) , STAT=ierr(4) )
360
361      ! Initilaise key variables at risk of being intercepted before properly set up.
362      e3t_0(:,:,:) = 0.0
363         !
364#if defined key_vvl
365      ALLOCATE( gdep3w_n(jpi,jpj,jpk) , e3t_n (jpi,jpj,jpk) , e3u_n (jpi,jpj,jpk) ,                           &
366         &      gdept_n (jpi,jpj,jpk) , e3v_n (jpi,jpj,jpk) , e3w_n (jpi,jpj,jpk) ,                           &
367         &      gdepw_n (jpi,jpj,jpk) , e3f_n (jpi,jpj,jpk) , e3vw_n(jpi,jpj,jpk) , e3uw_n(jpi,jpj,jpk) ,     &
368         &      e3t_b   (jpi,jpj,jpk) , e3u_b (jpi,jpj,jpk) , e3v_b (jpi,jpj,jpk) ,                           &
369         &      e3uw_b  (jpi,jpj,jpk) , e3vw_b(jpi,jpj,jpk) ,                                                 &
370         &      gdept_b (jpi,jpj,jpk) ,gdepw_b(jpi,jpj,jpk) , e3w_b (jpi,jpj,jpk) ,                           &
371         &      e3t_a   (jpi,jpj,jpk) , e3u_a (jpi,jpj,jpk) , e3v_a (jpi,jpj,jpk) ,                           &
372         &      ehu_a    (jpi,jpj)    , ehv_a  (jpi,jpj),                                                     &
373         &      ehur_a   (jpi,jpj)    , ehvr_a (jpi,jpj),                                                     &
374         &      ehu_b    (jpi,jpj)    , ehv_b  (jpi,jpj),                                                     &
375         &      ehur_b   (jpi,jpj)    , ehvr_b (jpi,jpj),                                  STAT=ierr(5) )                         
376
377      ! Initilaise key variables at risk of being intercepted before properly set up.
378      e3t_n(:,:,:) = 0.0
379#endif
380         !
381      ALLOCATE( hu      (jpi,jpj) , hur     (jpi,jpj) , hu_0(jpi,jpj) , ht_0  (jpi,jpj) ,     &
382         &      hv      (jpi,jpj) , hvr     (jpi,jpj) , hv_0(jpi,jpj) , ht    (jpi,jpj) ,     &
383         &      re2u_e1u(jpi,jpj) , re1v_e2v(jpi,jpj) ,                                       &
384         &      e12t    (jpi,jpj) , r1_e12t (jpi,jpj) ,                                       &
385         &      e12u    (jpi,jpj) , r1_e12u (jpi,jpj) ,                                       &
386         &      e12v    (jpi,jpj) , r1_e12v (jpi,jpj) ,                                       &
387         &      e12f    (jpi,jpj) , r1_e12f (jpi,jpj) ,                                   STAT=ierr(6)  )
388         !
389      ALLOCATE( gdept_1d(jpk) , gdepw_1d(jpk) ,                                     &
390         &      e3t_1d  (jpk) , e3w_1d  (jpk) , e3tp (jpi,jpj), e3wp(jpi,jpj) ,     &
391         &      gsigt   (jpk) , gsigw   (jpk) , gsi3w(jpk)    ,                     &
392         &      esigt   (jpk) , esigw   (jpk)                                 , STAT=ierr(7) )
393         !
394      ALLOCATE( hbatv (jpi,jpj) , hbatf (jpi,jpj) ,     &
395         &      hbatt (jpi,jpj) , hbatu (jpi,jpj) ,     &
396         &      scosrf(jpi,jpj) , scobot(jpi,jpj) ,     &
397         &      hifv  (jpi,jpj) , hiff  (jpi,jpj) ,     &
398         &      hift  (jpi,jpj) , hifu  (jpi,jpj) , rx1 (jpi,jpj) , STAT=ierr(8) )
399
400      ALLOCATE( mbathy(jpi,jpj) , bathy(jpi,jpj) ,                                      &
401         &     tmask_i(jpi,jpj) , umask_i(jpi,jpj), vmask_i(jpi,jpj), fmask_i(jpi,jpj), &
402         &     bmask(jpi,jpj)   ,                                                       &
403         &     mbkt   (jpi,jpj) , mbku (jpi,jpj) , mbkv(jpi,jpj) , STAT=ierr(9) )
404
405! (ISF) Allocation of basic array   
406      ALLOCATE( misfdep(jpi,jpj) , risfdep(jpi,jpj),     &
407         &     mikt(jpi,jpj), miku(jpi,jpj), mikv(jpi,jpj) ,           &
408         &     mikf(jpi,jpj), ssmask(jpi,jpj), STAT=ierr(10) )
409
410      ALLOCATE( tmask(jpi,jpj,jpk) , umask(jpi,jpj,jpk),     & 
411         &      vmask(jpi,jpj,jpk) , fmask(jpi,jpj,jpk),     &
412                tmask_i_diag(jpi,jpj,jpk),     &
413                umask_i_diag(jpi,jpj,jpk),     &
414                vmask_i_diag(jpi,jpj,jpk),     &
415                STAT=ierr(11) )
416
417      ALLOCATE( wmask(jpi,jpj,jpk) , wumask(jpi,jpj,jpk), wvmask(jpi,jpj,jpk) , STAT=ierr(12) )
418
419#if defined key_noslip_accurate
420      ALLOCATE( npcoa(4,jpk), nicoa(2*(jpi+jpj),4,jpk), njcoa(2*(jpi+jpj),4,jpk), STAT=ierr(12) )
421#endif
422      !
423      dom_oce_alloc = MAXVAL(ierr)
424      !
425   END FUNCTION dom_oce_alloc
426
427   !!======================================================================
428END MODULE dom_oce
429
Note: See TracBrowser for help on using the repository browser.