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 @ 65

Last change on this file since 65 was 65, checked in by opalod, 20 years ago

CT : BUGFIX039 : Indices and comments correction for zoom functionalities
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 9.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   !!  OPA 9.0 , LODYC-IPSL (2003)
8   !!----------------------------------------------------------------------
9   !! * Modules used
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   !! space domain parameters
18   !! -----------------------
19   LOGICAL, PUBLIC ::   &   !:
20      lclosea    =  .FALSE. ,   &  !: closed sea flag
21      lzoom      =  .FALSE. ,   &  !: zoom flag
22      lzoom_e    =  .FALSE. ,   &  !: East  zoom type flag
23      lzoom_w    =  .FALSE. ,   &  !: West  zoom type flag
24      lzoom_s    =  .FALSE. ,   &  !: South zoom type flag
25      lzoom_n    =  .FALSE. ,   &  !: North zoom type flag
26      lzoom_arct =  .FALSE. ,   &  !: ORCA    arctic zoom flag
27      lzoom_anta =  .FALSE.        !: ORCA antarctic zoom flag
28
29   INTEGER, PUBLIC ::           & !!: namdom : space domain (bathymetry, mesh)
30      ntopo   =  0 ,            &  !: = 0/1 ,compute/read the bathymetry file
31      ngrid   =  0 ,            &  !: = 0/1, compute/read the horizontal mesh file
32      nmsh    =  0                 !: = 1 create a mesh-mask file
33
34   INTEGER, PUBLIC ::         &   !:
35      ! domain parameters linked to mpp
36      nperio,          &  !: type of lateral boundary condition
37      nimpp, njmpp,    &  !: i- & j-indexes for mpp-subdomain left bottom
38      nreci, nrecj,    &  !: overlap region in i and j
39      nproc,           &  !: number for local processor
40      narea,           &  !: number for local area
41      nbondi, nbondj,  &  !: mark of i- and j-direction local boundaries
42      npolj,           &  !: north fold mark (0, 3 or 4)
43      nlci, nlcj,      &  !: i- & j-dimensions of the local subdomain
44      nldi, nlei,      &  !: first and last indoor i- and j-indexes
45      nldj, nlej,      &  !:
46      noea, nowe,      &  !: index of the local neighboring processors in
47      noso, nono,      &  !: east, west, south and north directions
48      npne, npnw,      &  !: index of north east and north west processor
49      npse, npsw,      &  !: index of south east and south west processor
50      nbne, nbnw,      &  !: logical of north east & north west processor
51      nbse, nbsw          !: logical of south east & south west processor
52
53   INTEGER, PUBLIC, DIMENSION(jpi) ::   &   !:
54      mig                 !: local  ==> global  domain i-indice
55   INTEGER, PUBLIC, DIMENSION(jpj) ::   &   !:
56      mjg                 !: local  ==> global  domain j-indice
57   INTEGER, PUBLIC, DIMENSION( jpidta ) ::   &  !:  !!bug ==> other solution?
58      mi0, mi1            !: global ==> local domain i-indice
59      !                   !  (mi0=1 and mi1=0 if the global indice is not in the local domain)
60   INTEGER, PUBLIC, DIMENSION( jpjdta ) ::   &  !:
61      mj0, mj1            !: global ==> local domain j-indice
62      !                   ! (mi0=1 and mi1=0 if the global indice is not in the local domain)
63
64   INTEGER, PUBLIC, DIMENSION(jpnij) ::   &  !:
65      nimppt, njmppt,  &  !: i-, j-indexes for each processor
66      nlcit, nlcjt,    &  !: dimensions of every subdomain
67      nldit, nldjt,    &  !: first, last indoor index for each i-domain
68      nleit, nlejt        !: first, last indoor index for each j-domain
69
70   !!----------------------------------------------------------------------
71   !! horizontal curvilinear coordinate and scale factors
72   !! ---------------------------------------------------------------------
73
74   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   &  !:
75      glamt, glamu,    &  !: longitude of t-, u-, v- and f-points (degre)
76      glamv, glamf,    &  !:
77      gphit, gphiu,    &  !: latitude  of t-, u-, v- and f-points (degre)
78      gphiv, gphif,    &  !:
79      e1t, e2t,        &  !: horizontal scale factors at t-point (m)
80      e1u, e2u,        &  !: horizontal scale factors at u-point (m)
81      e1v, e2v,        &  !: horizontal scale factors at v-point (m)
82      e1f, e2f,        &  !: horizontal scale factors at f-point (m)
83      ff                  !: coriolis factor (2.*omega*sin(yphi) ) (s-1)
84
85   !!----------------------------------------------------------------------
86   !! vertical coordinate and scale factors
87   !! --------------------------------------
88
89   REAL(wp), PUBLIC ::   & !!: * namelist namdom *
90      e3zps_min = 5.0,   &  !: miminum thickness for partial steps (meters)
91      e3zps_rat = 0.1       !: minimum thickness ration for partial steps
92
93   !! z-coordinate (default option) (also used in the other cases
94   !! -----------------------------  as reference z-coordinate)
95   REAL(wp), PUBLIC, DIMENSION(jpk) ::   &  !:
96      gdept, gdepw,    &  !: reference depth of t- and w-points (m)
97      e3t, e3w            !: reference vertical scale factors at T- and W-pts (m)
98
99#if defined key_partial_steps
100   !! Partial steps ('key_partial_steps')
101   !! -----------------------------------
102   LOGICAL, PUBLIC, PARAMETER ::   lk_zps = .TRUE.   !: partial steps flag
103   LOGICAL, PUBLIC, PARAMETER ::   lk_sco = .FALSE.  !: s-coordinate flag
104   LOGICAL, PUBLIC, PARAMETER ::   lk_zco = .FALSE.  !: z-coordinate flag
105   REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) ::   &  !:
106      gdep3w,                 &  !: ???
107      gdept_ps, gdepw_ps,     &  !: depth of t- and w-points (m)
108      e3t_ps, e3u_ps, e3v_ps, &  !: vertical scale factors at t-, u-, w-,
109      e3w_ps, e3f_ps,         &  !: w- and f- points (m)
110      e3uw_ps, e3vw_ps           !: uw- and vw- points (m)
111
112   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   &  !:
113      hdept, hdepw, e3tp, e3wp   !: ???
114
115#elif defined key_s_coord
116   !! s-coordinate ('key_s_coord')
117   !! ----------------------------
118   LOGICAL, PUBLIC, PARAMETER ::   lk_zps = .FALSE.   !: partial steps flag
119   LOGICAL, PUBLIC, PARAMETER ::   lk_sco = .TRUE.    !: s-coordinate flag
120   LOGICAL, PUBLIC, PARAMETER ::   lk_zco = .FALSE.   !: z-coordinate flag
121   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   &   !:
122      hbatt, hbatu,    &  !: ocean depth at the vertical of  t-, u-, v-
123      hbatv, hbatf        !: and f-point (m)
124
125   REAL(wp), PUBLIC, DIMENSION(jpk) ::   &   !:
126      gsigt, gsigw ,   &  !: model level depth coefficient at t-, w-levels
127      gsi3w,           &  !: model level depth coefficient at w-level
128                          !  defined as the sum of e3w scale factors
129      esigt, esigw        !: vertical scale factor coef. at t-, w-levels
130
131#else
132   !! z-coordinate (Default option)
133   !! -----------------------------
134   LOGICAL, PUBLIC, PARAMETER ::   lk_zps = .FALSE.   !: partial steps flag
135   LOGICAL, PUBLIC, PARAMETER ::   lk_sco = .FALSE.   !: s-coordinate flag
136   LOGICAL, PUBLIC, PARAMETER ::   lk_zco = .TRUE.    !: s-coordinate flag
137#endif
138   !!----------------------------------------------------------------------
139   !! masks, bathymetry
140   !! -----------------
141
142   INTEGER , PUBLIC, DIMENSION(jpi,jpj) ::   &   !:
143      mbathy     !: number of ocean level (=0, 1, ... , jpk-1)
144
145   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   &   !:
146      bathy  ,         &  !: ocean depth (meters)
147      tmask_i             !: interior domain T-point mask
148
149   REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) ::   &   !:
150      tmask, umask,    &  !: land/ocean mask at T-, U-, V- and F-points
151      vmask, fmask        !:
152
153   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) ::   &   !:
154      bmask               !: land/ocean mask of barotropic stream function
155
156   REAL(wp), PUBLIC, DIMENSION(jpiglo) ::   &   !:
157      tpol, fpol          !: north fold mask (nperio= 3 or 4)
158
159#if defined key_noslip_accurate
160   INTEGER, PUBLIC, DIMENSION(4,jpk) ::   &   !:
161      npcoa               !: ???
162   INTEGER, PUBLIC, DIMENSION(2*(jpi+jpj),4,jpk) ::   &   !:
163      nicoa,           &  !: ???
164      njcoa               !: ???
165
166#endif
167
168   !!----------------------------------------------------------------------
169   !! time domain
170   !!----------------------------------------------------------------------
171   INTEGER, PUBLIC ::    & !!: * Namelist * ???
172      nacc   = 0 ,       &  !: = 0/1 use of the acceleration of convergence technique
173      neuler                !: restart euler forward option (0=Euler)
174
175
176   REAL(wp), PUBLIC ::       & !!: * Namelist ??? *
177      rdt    = 3600._wp ,    &  !: time step for the dynamics (and tracer if nacc=0)
178      rdtmin = 3600._wp ,    &  !: minimum time step on tracers
179      rdtmax = 3600._wp ,    &  !: maximum time step on tracers
180      rdth   =  800._wp ,    &  !: depth variation of tracer step
181      atfp   = 0.1_wp   ,    &  !: asselin time filter parameter
182      atfp1                     !: asselin time filter coeff. (atfp1= 1-2*atfp)
183
184   REAL(wp), PUBLIC, DIMENSION(jpk) ::   &  !:
185      rdttra                    !: vertical profile of tracer time step
186
187   !!----------------------------------------------------------------------
188   !! cross land advection
189   !!----------------------------------------------------------------------
190
191   INTEGER, PUBLIC ::       & !!: namelist ???
192      n_cla                    !: flag (0/1) for cross land advection to
193      !                        ! parameterize exchanges through straits
194
195   !!----------------------------------------------------------------------
196END MODULE dom_oce
Note: See TracBrowser for help on using the repository browser.