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

source: trunk/NEMO/OPA_SRC/DOM/dom_oce.F90 @ 454

Last change on this file since 454 was 454, checked in by opalod, 18 years ago

nemo_v1_update_047:RB: re-organization of coordinate definition, scale factors are now 3d by default, include file for partial steps has been removed
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 10.4 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 :
8   !!   9.0  !  05-10  (A. Beckmann, G. Madec)  reactivate s-coordinate
9   !!----------------------------------------------------------------------
10   !!  OPA 9.0 , LOCEAN-IPSL (2006)
11   !! $Header$
12   !! This software is governed by the CeCILL licence see modipsl/doc/NEMO_CeCILL.txt
13   !!----------------------------------------------------------------------
14   !! * Modules used
15   USE par_oce      ! ocean parameters
16
17   IMPLICIT NONE
18   PUBLIC           ! allows the acces to par_oce when dom_oce is used
19   !                ! exception to coding rules... to be suppressed ???
20
21   !!----------------------------------------------------------------------
22   !! space domain parameters
23   !! -----------------------
24   LOGICAL, PUBLIC ::   &   !:
25      lzoom      =  .FALSE. ,   &  !: zoom flag
26      lzoom_e    =  .FALSE. ,   &  !: East  zoom type flag
27      lzoom_w    =  .FALSE. ,   &  !: West  zoom type flag
28      lzoom_s    =  .FALSE. ,   &  !: South zoom type flag
29      lzoom_n    =  .FALSE. ,   &  !: North zoom type flag
30      lzoom_arct =  .FALSE. ,   &  !: ORCA    arctic zoom flag
31      lzoom_anta =  .FALSE.        !: ORCA antarctic zoom flag
32
33   INTEGER, PUBLIC ::           & !!: namdom : space domain (bathymetry, mesh)
34      ntopo   =  0 ,            &  !: = 0/1 ,compute/read the bathymetry file
35      ngrid   =  0 ,            &  !: = 0/1, compute/read the horizontal mesh file
36      nmsh    =  0                 !: = 1 create a mesh-mask file
37
38   INTEGER, PUBLIC ::         &   !:
39      ! domain parameters linked to mpp
40      nperio,          &  !: type of lateral boundary condition
41      nimpp, njmpp,    &  !: i- & j-indexes for mpp-subdomain left bottom
42      nreci, nrecj,    &  !: overlap region in i and j
43      nproc,           &  !: number for local processor
44      narea,           &  !: number for local area
45      nbondi, nbondj,  &  !: mark of i- and j-direction local boundaries
46      npolj,           &  !: north fold mark (0, 3 or 4)
47      nlci, nlcj,      &  !: i- & j-dimensions of the local subdomain
48      nldi, nlei,      &  !: first and last indoor i- and j-indexes
49      nldj, nlej,      &  !:
50      noea, nowe,      &  !: index of the local neighboring processors in
51      noso, nono,      &  !: east, west, south and north directions
52      npne, npnw,      &  !: index of north east and north west processor
53      npse, npsw,      &  !: index of south east and south west processor
54      nbne, nbnw,      &  !: logical of north east & north west processor
55      nbse, nbsw,      &  !: logical of south east & south west processor
56      nidom               !: ???
57
58   INTEGER, PUBLIC, DIMENSION(jpi) ::   &   !:
59      mig                 !: local  ==> global  domain i-indice
60   INTEGER, PUBLIC, DIMENSION(jpj) ::   &   !:
61      mjg                 !: local  ==> global  domain j-indice
62   INTEGER, PUBLIC, DIMENSION( jpidta ) ::   &  !:  !!bug ==> other solution?
63      mi0, mi1            !: global ==> local domain i-indice
64      !                   !  (mi0=1 and mi1=0 if the global indice is not in the local domain)
65   INTEGER, PUBLIC, DIMENSION( jpjdta ) ::   &  !:
66      mj0, mj1            !: global ==> local domain j-indice
67      !                   ! (mi0=1 and mi1=0 if the global indice is not in the local domain)
68
69   INTEGER, PUBLIC, DIMENSION(jpnij) ::   &  !:
70      nimppt, njmppt,  &  !: i-, j-indexes for each processor
71      ibonit, ibonjt,  &  !: i-, j- processor neighbour existence
72      nlcit , nlcjt,   &  !: dimensions of every subdomain
73      nldit , nldjt,   &  !: first, last indoor index for each i-domain
74      nleit , nlejt       !: first, last indoor index for each j-domain
75
76   !!----------------------------------------------------------------------
77   !! horizontal curvilinear coordinate and scale factors
78   !! ---------------------------------------------------------------------
79
80   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   &  !:
81      glamt, glamu,    &  !: longitude of t-, u-, v- and f-points (degre)
82      glamv, glamf,    &  !:
83      gphit, gphiu,    &  !: latitude  of t-, u-, v- and f-points (degre)
84      gphiv, gphif,    &  !:
85      e1t, e2t,        &  !: horizontal scale factors at t-point (m)
86      e1u, e2u,        &  !: horizontal scale factors at u-point (m)
87      e1v, e2v,        &  !: horizontal scale factors at v-point (m)
88      e1f, e2f,        &  !: horizontal scale factors at f-point (m)
89      ff                  !: coriolis factor (2.*omega*sin(yphi) ) (s-1)
90
91   !!----------------------------------------------------------------------
92   !! vertical coordinate and scale factors
93   !! --------------------------------------
94
95   LOGICAL, PUBLIC ::           & !!: namzgr : vertical coordinate
96      ln_zco     =  .TRUE.  ,   &  !: z-coordinate - full step
97      ln_zps     =  .FALSE. ,   &  !: z-coordinate - partial step
98      ln_sco     =  .FALSE.        !: s-coordinate or hybrid z-s coordinate
99
100#if defined key_zco
101   LOGICAL, PUBLIC, PARAMETER ::   lk_zco = .TRUE.    !: z-coordinate flag (1D arrays)
102#else
103   LOGICAL, PUBLIC, PARAMETER ::   lk_zco = .FALSE.   !: z-coordinate flag (3D arrays)
104
105   !! All coordinates
106   !! ---------------
107   REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) ::   &  !:
108      gdep3w        ,    &  !: depth of T-points (sum of e3w) (m)
109      gdept , gdepw ,    &  !: analytical depth at T-W  points (m)
110      e3v   , e3f   ,    &  !: analytical vertical scale factors at  V--F
111      e3t   , e3u   ,    &  !:                                       T--U  points (m)
112      e3vw          ,    &  !: analytical vertical scale factors at  VW--
113      e3w   , e3uw          !:                                        W--UW  points (m)
114#endif
115   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   &   !:
116      hur, hvr,          &  !: inverse of u and v-points ocean depth (1/m)
117      hu , hv               !: depth at u- and v-points (meters)
118
119   !! z-coordinate with full steps (also used in the other cases as reference z-coordinate)
120   !! =-----------------====------
121   REAL(wp), PUBLIC, DIMENSION(jpk) ::   &  !:
122      gdept_0, gdepw_0,       &  !: reference depth of t- and w-points (m)
123      e3t_0  , e3w_0             !: reference vertical scale factors at T- and W-pts (m)
124
125   !! z-coordinate with partial steps
126   !! =-----------------=======------
127   REAL(wp), PUBLIC ::      & !!: * namelist namdom *
128      e3zps_min = 5.0_wp,   &  !: miminum thickness for partial steps (meters)
129      e3zps_rat = 0.1_wp       !: minimum thickness ration for partial steps
130
131   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   &  !:
132      hdept, hdepw, e3tp, e3wp   !: ???
133
134   !! s-coordinate and hybrid z-s-coordinate
135   !! =----------------======---------------
136   REAL(wp), PUBLIC, DIMENSION(jpk) ::   &   !:
137      gsigt, gsigw ,   &  !: model level depth coefficient at t-, w-levels (analytic)
138      gsi3w        ,   &  !: model level depth coefficient at w-level (sum of gsigw)
139      esigt, esigw        !: vertical scale factor coef. at t-, w-levels
140
141   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   &   !:
142      hbatv , hbatf ,   &  !: ocean depth at the vertical of  V--F
143      hbatt , hbatu ,   &  !:                                 T--U  points (m)
144      scosrf, scobot,   &  !:  ocean surface and bottom topographies (if deviating from coordinate surfaces in HYBRID)
145      hifv  , hiff  ,   &  !: interface depth between stretching    at  V--F
146      hift  , hifu         !: and quasi-uniform spacing                 T--U  points (m)
147
148   !!----------------------------------------------------------------------
149   !! masks, bathymetry
150   !! -----------------
151
152   INTEGER , PUBLIC, DIMENSION(jpi,jpj) ::   &   !:
153      mbathy     !: number of ocean level (=0, 1, ... , jpk-1)
154
155   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   &   !:
156      bathy  ,         &  !: ocean depth (meters)
157      tmask_i,         &  !: interior domain T-point mask
158      bmask               !: land/ocean mask of barotropic stream function
159
160   REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) ::   &   !:
161      tmask, umask,    &  !: land/ocean mask at T-, U-, V- and F-points
162      vmask, fmask        !:
163
164   REAL(wp), PUBLIC, DIMENSION(jpiglo) ::   &   !:
165      tpol, fpol          !: north fold mask (nperio= 3 or 4)
166
167#if defined key_noslip_accurate
168   INTEGER, PUBLIC, DIMENSION(4,jpk) ::   &   !:
169      npcoa               !: ???
170   INTEGER, PUBLIC, DIMENSION(2*(jpi+jpj),4,jpk) ::   &   !:
171      nicoa,           &  !: ???
172      njcoa               !: ???
173#endif
174
175   !!----------------------------------------------------------------------
176   !! time domain
177   !!----------------------------------------------------------------------
178   INTEGER, PUBLIC ::    & !!: * Namelist * ???
179      nacc   = 0 ,       &  !: = 0/1 use of the acceleration of convergence technique
180      neuler                !: restart euler forward option (0=Euler)
181
182
183   REAL(wp), PUBLIC ::       & !!: * Namelist ??? *
184      rdt    = 3600._wp ,    &  !: time step for the dynamics (and tracer if nacc=0)
185      rdtmin = 3600._wp ,    &  !: minimum time step on tracers
186      rdtmax = 3600._wp ,    &  !: maximum time step on tracers
187      rdth   =  800._wp ,    &  !: depth variation of tracer step
188      rdtbt  =   90._wp ,    &  !: barotropic time step for the dynamics (lk_dynspg_ts=T)
189      atfp   = 0.1_wp   ,    &  !: asselin time filter parameter
190      atfp1                     !: asselin time filter coeff. (atfp1= 1-2*atfp)
191
192   REAL(wp), PUBLIC, DIMENSION(jpk) ::   &  !:
193      rdttra                    !: vertical profile of tracer time step
194
195   !!----------------------------------------------------------------------
196   !! cross land advection
197   !!----------------------------------------------------------------------
198
199   INTEGER, PUBLIC ::       & !!: namelist ???
200      n_cla                    !: flag (0/1) for cross land advection to
201      !                        ! parameterize exchanges through straits
202
203#if defined key_agrif
204   !!----------------------------------------------------------------------
205   !! agrif sponge layer
206   !!----------------------------------------------------------------------
207   LOGICAL, PUBLIC :: spongedoneT = .FALSE.  !: ???
208   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   &
209      zspe1ur, zspe2vr ,zspbtr2    !: ???
210   !!----------------------------------------------------------------------
211#endif
212
213END MODULE dom_oce
Note: See TracBrowser for help on using the repository browser.