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

source: branches/nemo_v3_3_beta/NEMOGCM/NEMO/OPA_SRC/DOM/dom_oce.F90 @ 2482

Last change on this file since 2482 was 2482, checked in by gm, 13 years ago

v3.3beta: #777 backward compatibility with the setting of the minimum ocean depth: add a namelist param

  • Property svn:keywords set to Id
File size: 16.6 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   !!----------------------------------------------------------------------
10   USE par_oce      ! ocean parameters
11
12   IMPLICIT NONE
13   PUBLIC           ! allows the acces to par_oce when dom_oce is used
14   !                ! exception to coding rules... to be suppressed ???
15
16   !!----------------------------------------------------------------------
17   !! time & space domain namelist
18   !! ----------------------------
19   !                                              !!* Namelist namdom : time & space domain *
20   INTEGER , PUBLIC ::   nn_bathy     =    0       !: = 0/1 ,compute/read the bathymetry file
21   REAL(wp), PUBLIC ::   rn_hmin      =   -3.0_wp  !: minimum ocean depth (>0) or minimum number of ocean levels (<0)
22   REAL(wp), PUBLIC ::   rn_e3zps_min =    5.0_wp  !: miminum thickness for partial steps (meters)
23   REAL(wp), PUBLIC ::   rn_e3zps_rat =    0.1_wp  !: minimum thickness ration for partial steps
24   INTEGER , PUBLIC ::   nn_msh       =    0       !: = 1 create a mesh-mask file
25   INTEGER , PUBLIC ::   nn_acc       =    0       !: = 0/1 use of the acceleration of convergence technique
26   REAL(wp), PUBLIC ::   rn_atfp      =    0.1_wp  !: asselin time filter parameter
27   REAL(wp), PUBLIC ::   rn_rdt       = 3600._wp   !: time step for the dynamics (and tracer if nacc=0)
28   REAL(wp), PUBLIC ::   rn_rdtmin    = 3600._wp   !: minimum time step on tracers
29   REAL(wp), PUBLIC ::   rn_rdtmax    = 3600._wp   !: maximum time step on tracers
30   REAL(wp), PUBLIC ::   rn_rdth      =  800._wp   !: depth variation of tracer step
31   INTEGER , PUBLIC ::   nn_baro      =   64       !: number of barotropic time steps (key_dynspg_ts)
32   INTEGER , PUBLIC ::   nn_closea    =    0       !: =0 suppress closed sea/lake from the ORCA domain or not (=1)
33
34   !                                    !! old non-DOCTOR names still used in the model
35   INTEGER , PUBLIC ::   ntopo           !: = 0/1 ,compute/read the bathymetry file
36   REAL(wp), PUBLIC ::   e3zps_min       !: miminum thickness for partial steps (meters)
37   REAL(wp), PUBLIC ::   e3zps_rat       !: minimum thickness ration for partial steps
38   INTEGER , PUBLIC ::   nmsh            !: = 1 create a mesh-mask file
39   INTEGER , PUBLIC ::   nacc            !: = 0/1 use of the acceleration of convergence technique
40   REAL(wp), PUBLIC ::   atfp            !: asselin time filter parameter
41   REAL(wp), PUBLIC ::   rdt             !: time step for the dynamics (and tracer if nacc=0)
42   REAL(wp), PUBLIC ::   rdtmin          !: minimum time step on tracers
43   REAL(wp), PUBLIC ::   rdtmax          !: maximum time step on tracers
44   REAL(wp), PUBLIC ::   rdth            !: depth variation of tracer step
45   INTEGER , PUBLIC ::   nclosea         !: =0 suppress closed sea/lake from the ORCA domain or not (=1)
46
47
48   !                                                  !!! associated variables
49   INTEGER , PUBLIC                 ::   neuler  = 0   !: restart euler forward option (0=Euler)
50   REAL(wp), PUBLIC                 ::   atfp1         !: asselin time filter coeff. (atfp1= 1-2*atfp)
51   REAL(wp), PUBLIC, DIMENSION(jpk) ::   rdttra        !: vertical profile of tracer time step
52
53   !                                         !!* Namelist namcla : cross land advection
54   INTEGER, PUBLIC ::   nn_cla = 0            !: =1 cross land advection for exchanges through some straits (ORCA2)
55
56   !!----------------------------------------------------------------------
57   !! space domain parameters
58   !!----------------------------------------------------------------------
59   LOGICAL, PUBLIC ::   lzoom      =  .FALSE.   !: zoom flag
60   LOGICAL, PUBLIC ::   lzoom_e    =  .FALSE.   !: East  zoom type flag
61   LOGICAL, PUBLIC ::   lzoom_w    =  .FALSE.   !: West  zoom type flag
62   LOGICAL, PUBLIC ::   lzoom_s    =  .FALSE.   !: South zoom type flag
63   LOGICAL, PUBLIC ::   lzoom_n    =  .FALSE.   !: North zoom type flag
64   LOGICAL, PUBLIC ::   lzoom_arct =  .FALSE.   !: ORCA    arctic zoom flag
65   LOGICAL, PUBLIC ::   lzoom_anta =  .FALSE.   !: ORCA antarctic zoom flag
66
67   !                                     !!! domain parameters linked to mpp
68   INTEGER, PUBLIC ::   nperio            !: type of lateral boundary condition
69   INTEGER, PUBLIC ::   nimpp, njmpp      !: i- & j-indexes for mpp-subdomain left bottom
70   INTEGER, PUBLIC ::   nreci, nrecj      !: overlap region in i and j
71   INTEGER, PUBLIC ::   nproc             !: number for local processor
72   INTEGER, PUBLIC ::   narea             !: number for local area
73   INTEGER, PUBLIC ::   nbondi, nbondj    !: mark of i- and j-direction local boundaries
74   INTEGER, PUBLIC ::   npolj             !: north fold mark (0, 3 or 4)
75   INTEGER, PUBLIC ::   nlci, nldi, nlei  !: i-dimensions of the local subdomain and its first and last indoor indices
76   INTEGER, PUBLIC ::   nlcj, nldj, nlej  !: i-dimensions of the local subdomain and its first and last indoor indices
77   INTEGER, PUBLIC ::   noea, nowe        !: index of the local neighboring processors in
78   INTEGER, PUBLIC ::   noso, nono        !: east, west, south and north directions
79   INTEGER, PUBLIC ::   npne, npnw        !: index of north east and north west processor
80   INTEGER, PUBLIC ::   npse, npsw        !: index of south east and south west processor
81   INTEGER, PUBLIC ::   nbne, nbnw        !: logical of north east & north west processor
82   INTEGER, PUBLIC ::   nbse, nbsw        !: logical of south east & south west processor
83   INTEGER, PUBLIC ::   nidom             !: ???
84
85   INTEGER, PUBLIC, DIMENSION(jpi)    ::   mig        !: local  ==> global domain i-index
86   INTEGER, PUBLIC, DIMENSION(jpj)    ::   mjg        !: local  ==> global domain j-index
87   INTEGER, PUBLIC, DIMENSION(jpidta) ::   mi0, mi1   !: global ==> local  domain i-index    !!bug ==> other solution?
88   !                                                  ! (mi0=1 and mi1=0 if the global index is not in the local domain)
89   INTEGER, PUBLIC, DIMENSION(jpjdta) ::   mj0, mj1   !: global ==> local  domain j-index     !!bug ==> other solution?
90   !                                                  ! (mi0=1 and mi1=0 if the global index is not in the local domain)
91   INTEGER, PUBLIC, DIMENSION(jpnij)  ::   nimppt, njmppt   !: i-, j-indexes for each processor
92   INTEGER, PUBLIC, DIMENSION(jpnij)  ::   ibonit, ibonjt   !: i-, j- processor neighbour existence
93   INTEGER, PUBLIC, DIMENSION(jpnij)  ::   nlcit , nlcjt    !: dimensions of every subdomain
94   INTEGER, PUBLIC, DIMENSION(jpnij)  ::   nldit , nldjt    !: first, last indoor index for each i-domain
95   INTEGER, PUBLIC, DIMENSION(jpnij)  ::   nleit , nlejt    !: first, last indoor index for each j-domain
96
97   !!----------------------------------------------------------------------
98   !! horizontal curvilinear coordinate and scale factors
99   !! ---------------------------------------------------------------------
100   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   glamt, glamu   !: longitude of t-, u-, v- and f-points (degre)
101   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   glamv, glamf   !:
102   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   gphit, gphiu   !: latitude  of t-, u-, v- and f-points (degre)
103   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   gphiv, gphif   !:
104   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   e1t, e2t       !: horizontal scale factors at t-point (m)
105   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   e1u, e2u       !: horizontal scale factors at u-point (m)
106   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   e1v, e2v       !: horizontal scale factors at v-point (m)
107   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   e1f, e2f       !: horizontal scale factors at f-point (m)
108   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   ff             !: coriolis factor (2.*omega*sin(yphi) ) (s-1)
109
110   !!----------------------------------------------------------------------
111   !! vertical coordinate and scale factors
112   !! ---------------------------------------------------------------------
113   !                                           !!* Namelist namzgr : vertical coordinate *
114   LOGICAL, PUBLIC ::   ln_zco     =  .TRUE.    !: z-coordinate - full step
115   LOGICAL, PUBLIC ::   ln_zps     =  .FALSE.   !: z-coordinate - partial step
116   LOGICAL, PUBLIC ::   ln_sco     =  .FALSE.   !: s-coordinate or hybrid z-s coordinate
117
118   !! All coordinates
119   !! ---------------
120   REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) ::   gdep3w          !: depth of T-points (sum of e3w) (m)
121   REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) ::   gdept , gdepw   !: analytical depth at T-W  points (m)
122   REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) ::   e3v   , e3f     !: analytical vertical scale factors at  V--F
123   REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) ::   e3t   , e3u     !:                                       T--U  points (m)
124   REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) ::   e3vw            !: analytical vertical scale factors at  VW--
125   REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) ::   e3w   , e3uw    !:                                        W--UW  points (m)
126#if defined key_vvl
127   LOGICAL, PUBLIC, PARAMETER ::   lk_vvl = .TRUE.    !: variable grid flag
128
129   !! All coordinates
130   !! ---------------
131   REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) ::   gdep3w_1           !: depth of T-points (sum of e3w) (m)
132   REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) ::   gdept_1, gdepw_1   !: analytical depth at T-W  points (m)
133   REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) ::   e3v_1  , e3f_1     !: analytical vertical scale factors at  V--F
134   REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) ::   e3t_1  , e3u_1     !:                                       T--U  points (m)
135   REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) ::   e3vw_1             !: analytical vertical scale factors at  VW--
136   REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) ::   e3w_1  , e3uw_1    !:                                       W--UW  points (m)
137   REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) ::   e3t_b              !: before         -      -      -    -   T      points (m)
138   REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) ::   e3u_b  , e3v_b     !:   -            -      -      -    -   U--V   points (m)
139#else
140   LOGICAL, PUBLIC, PARAMETER ::   lk_vvl = .FALSE.   !: fixed grid flag
141#endif
142   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   hur  , hvr    !: inverse of u and v-points ocean depth (1/m)
143   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   hu   , hv     !: depth at u- and v-points (meters)
144   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   hu_0 , hv_0   !: refernce depth at u- and v-points (meters)
145
146   INTEGER, PUBLIC ::   nla10              !: deepest    W level Above  ~10m (nlb10 - 1)
147   INTEGER, PUBLIC ::   nlb10              !: shallowest W level Bellow ~10m (nla10 + 1)
148
149   !! z-coordinate with full steps (also used in the other cases as reference z-coordinate)
150   !! =-----------------====------
151   REAL(wp), PUBLIC, DIMENSION(jpk)     ::   gdept_0, gdepw_0   !: reference depth of t- and w-points (m)
152   REAL(wp), PUBLIC, DIMENSION(jpk)     ::   e3t_0  , e3w_0     !: reference vertical scale factors at T- and W-pts (m)
153   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   e3tp   , e3wp      !: ocean bottom level thickness at T and W points
154
155   !! s-coordinate and hybrid z-s-coordinate
156   !! =----------------======---------------
157   REAL(wp), PUBLIC, DIMENSION(jpk) ::   gsigt, gsigw   !: model level depth coefficient at t-, w-levels (analytic)
158   REAL(wp), PUBLIC, DIMENSION(jpk) ::   gsi3w          !: model level depth coefficient at w-level (sum of gsigw)
159   REAL(wp), PUBLIC, DIMENSION(jpk) ::   esigt, esigw   !: vertical scale factor coef. at t-, w-levels
160
161   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   hbatv , hbatf    !: ocean depth at the vertical of  V--F
162   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   hbatt , hbatu    !:                                 T--U  points (m)
163   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   scosrf, scobot   !: ocean surface and bottom topographies
164   !                                                          !  (if deviating from coordinate surfaces in HYBRID)
165   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   hifv  , hiff     !: interface depth between stretching at  V--F
166   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   hift  , hifu     !: and quasi-uniform spacing              T--U  points (m)
167
168   !!----------------------------------------------------------------------
169   !! masks, bathymetry
170   !! ---------------------------------------------------------------------
171   INTEGER , PUBLIC, DIMENSION(jpi,jpj) ::   mbathy       !: number of ocean level (=0, 1, ... , jpk-1)
172   INTEGER , PUBLIC, DIMENSION(jpi,jpj) ::   mbkt         !: vertical index of the bottom last T- ocean level
173   INTEGER , PUBLIC, DIMENSION(jpi,jpj) ::   mbku, mbkv   !: vertical index of the bottom last U- and W- ocean level
174   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   bathy        !: ocean depth (meters)
175   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   tmask_i      !: interior domain T-point mask
176   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   bmask        !: land/ocean mask of barotropic stream function
177
178   REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) ::   tmask, umask, vmask, fmask   !: land/ocean mask at T-, U-, V- and F-pts
179
180   REAL(wp), PUBLIC, DIMENSION(jpiglo) ::   tpol, fpol          !: north fold mask (jperio= 3 or 4)
181
182#if defined key_noslip_accurate
183   INTEGER, PUBLIC, DIMENSION            (4,jpk) ::   npcoa          !: ???
184   INTEGER, PUBLIC, DIMENSION(2*(jpi+jpj),4,jpk) ::   nicoa, njcoa   !: ???
185#endif
186
187   !!----------------------------------------------------------------------
188   !! calendar variables
189   !! ---------------------------------------------------------------------
190   INTEGER , PUBLIC ::   nyear         !: current year
191   INTEGER , PUBLIC ::   nmonth        !: current month
192   INTEGER , PUBLIC ::   nday          !: current day of the month
193   INTEGER , PUBLIC ::   ndastp        !: time step date in yyyymmdd format
194   INTEGER , PUBLIC ::   nday_year     !: current day counted from jan 1st of the current year
195   INTEGER , PUBLIC ::   nsec_year     !: current time step counted in second since 00h jan 1st of the current year
196   INTEGER , PUBLIC ::   nsec_month    !: current time step counted in second since 00h 1st day of the current month
197   INTEGER , PUBLIC ::   nsec_week     !: current time step counted in second since 00h of last monday
198   INTEGER , PUBLIC ::   nsec_day      !: current time step counted in second since 00h of the current day
199   REAL(wp), PUBLIC ::   fjulday       !: current julian day
200   REAL(wp), PUBLIC ::   fjulstartyear !: first day of the current year in julian days
201   REAL(wp), PUBLIC ::   adatrj        !: number of elapsed days since the begining of the whole simulation
202   !                                   !: (cumulative duration of previous runs that may have used different time-step size)
203   INTEGER , PUBLIC, DIMENSION(0: 1) ::   nyear_len     !: length in days of the previous/current year
204   INTEGER , PUBLIC, DIMENSION(0:13) ::   nmonth_len    !: length in days of the months of the current year
205   INTEGER , PUBLIC, DIMENSION(0:13) ::   nmonth_half   !: second since Jan 1st 0h of the current year and the half of the months
206   INTEGER , PUBLIC, DIMENSION(0:13) ::   nmonth_end    !: second since Jan 1st 0h of the current year and the end of the months
207   INTEGER , PUBLIC                  ::   nsec1jan000   !: second since Jan 1st 0h of nit000 year and Jan 1st 0h the current year
208
209   !!----------------------------------------------------------------------
210   !! mpp reproducibility
211   !!----------------------------------------------------------------------
212#if defined key_mpp_rep
213   LOGICAL, PUBLIC, PARAMETER ::   lk_mpp_rep = .TRUE.    !: agrif flag
214#else
215   LOGICAL, PUBLIC, PARAMETER ::   lk_mpp_rep = .FALSE.   !: agrif flag
216#endif
217   !!----------------------------------------------------------------------
218   !! agrif domain
219   !!----------------------------------------------------------------------
220#if defined key_agrif
221   LOGICAL, PUBLIC, PARAMETER ::   lk_agrif = .TRUE.    !: agrif flag
222#else
223   LOGICAL, PUBLIC, PARAMETER ::   lk_agrif = .FALSE.   !: agrif flag
224
225CONTAINS
226   LOGICAL FUNCTION Agrif_Root()
227      Agrif_Root = .TRUE.
228   END FUNCTION Agrif_Root
229
230   CHARACTER(len=3) FUNCTION Agrif_CFixed()
231     Agrif_CFixed = '0' 
232   END FUNCTION Agrif_CFixed
233#endif
234   !!----------------------------------------------------------------------
235   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
236   !! $Id$
237   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
238   !!======================================================================
239END MODULE dom_oce
Note: See TracBrowser for help on using the repository browser.