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 tags/start/NEMO/OFF_SRC/DOM – NEMO

source: tags/start/NEMO/OFF_SRC/DOM/dom_oce.F90 @ 8479

Last change on this file since 8479 was 325, checked in by opalod, 19 years ago

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