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.
par_oce.F90 in trunk/NEMOGCM/NEMO/OPA_SRC – NEMO

source: trunk/NEMOGCM/NEMO/OPA_SRC/par_oce.F90 @ 2528

Last change on this file since 2528 was 2528, checked in by rblod, 13 years ago

Update NEMOGCM from branch nemo_v3_3_beta
  • Property svn:keywords set to Id
File size: 13.5 KB
Line 
1MODULE par_oce
2   !!======================================================================
3   !!                        ***  par_oce  ***
4   !! Ocean :   set the ocean parameters
5   !!======================================================================
6   !! History :  OPA  !  1991     (Imbard, Levy, Madec)  Original code
7   !!   NEMO     1.0  !  2004-01  (G. Madec, J.-M. Molines)  Free form and module
8   !!            3.3  !  2010-09  (C. Ethe) TRA-TRC merge: add jpts, jp_tem & jp_sal
9   !!----------------------------------------------------------------------
10   USE par_kind          ! kind parameters
11
12   IMPLICIT NONE
13   PUBLIC
14
15   !!----------------------------------------------------------------------
16   !!   Domain decomposition
17   !!----------------------------------------------------------------------
18   !! if we dont use massively parallel computer (parameters jpni=jpnj=1) so jpiglo=jpi and jpjglo=jpj
19#if ! defined key_mpp_dyndist
20   INTEGER, PUBLIC, PARAMETER ::    &  !:
21# if ! defined key_nproci
22      jpni   = 1,                   &  !: number of processors following i
23      jpnj   = 1,                   &  !: number of processors following j
24      jpnij  = 1                       !: nb of local domain = nb of processors
25      !                                !  ( <= jpni x jpnj )
26# else
27      jpni   = key_nproci,          &  !: number of processors following i
28      jpnj   = key_nprocj,          &  !: number of processors following j
29#  if ! defined key_nprocij
30      jpnij  = key_nproci * key_nprocj !: nb of local domain = nb of processors
31      !                                !  ( <= jpni x jpnj )
32#  else
33      jpnij  = key_nprocij             !: nb of local domain = nb of processors
34      !                                !  ( <= jpni x jpnj )
35#  endif
36# endif
37#else
38   INTEGER, PUBLIC            ::   jpni         !: number of processors following i
39   INTEGER, PUBLIC            ::   jpnj         !: number of processors following j
40   INTEGER, PUBLIC            ::   jpnij        !: nb of local domain = nb of processors ( <= jpni x jpnj )
41#endif
42   INTEGER, PUBLIC, PARAMETER ::   jpr2di = 0   !: number of columns for extra outer halo
43   INTEGER, PUBLIC, PARAMETER ::   jpr2dj = 0   !: number of rows    for extra outer halo
44   INTEGER, PUBLIC, PARAMETER ::   jpreci = 1   !: number of columns for overlap
45   INTEGER, PUBLIC, PARAMETER ::   jprecj = 1   !: number of rows    for overlap
46
47   !! Ocean Domain sizes
48   !! ------------------
49   !!   data           domain   (jpidta,jpjdta)
50   !!   global or zoom domain   (jpiglo,jpjglo)
51   !!   local          domain   ( jpi  , jpj  )
52   
53#if   defined key_orca_r4
54   !!---------------------------------------------------------------------
55   !!   'key_orca_r4'   :                           global ocean : ORCA R4
56   !!---------------------------------------------------------------------
57#             include "par_ORCA_R4.h90"
58#elif defined key_orca_r2
59   !!---------------------------------------------------------------------
60   !!   'key_orca_r2'   :                           global ocean : ORCA R4
61   !!---------------------------------------------------------------------
62#             include "par_ORCA_R2.h90"
63#elif defined key_orca_r1
64   !!---------------------------------------------------------------------
65   !!   'key_orca_r1'   :                           global ocean : ORCA R1
66   !!---------------------------------------------------------------------
67#             include "par_ORCA_R1.h90"
68#elif defined key_orca_r05
69   !!---------------------------------------------------------------------
70   !!   'key_orca_r05'  :                          global ocean : ORCA R05
71   !!---------------------------------------------------------------------
72#             include "par_ORCA_R05.h90"
73#elif defined key_orca_r025
74   !!---------------------------------------------------------------------
75   !!   'key_orca_r025' :                         global ocean : ORCA R025
76   !!---------------------------------------------------------------------
77#             include "par_ORCA_R025.h90"
78#elif defined key_eel_r2
79   !!---------------------------------------------------------------------
80   !!   'key_eel_r2'    :                                 channel : EEL R2
81   !!---------------------------------------------------------------------
82#             include "par_EEL_R2.h90"
83#elif defined key_eel_r5
84   !!---------------------------------------------------------------------
85   !!   'key_eel_r5'    :                                 channel : EEL R5
86   !!---------------------------------------------------------------------
87#             include "par_EEL_R5.h90"
88#elif defined key_eel_r6
89   !!---------------------------------------------------------------------
90   !!   'key_eel_r6'    :                                 channel : EEL R6
91   !!---------------------------------------------------------------------
92#             include "par_EEL_R6.h90"
93#elif defined key_gyre
94   !!---------------------------------------------------------------------
95   !!   'key_gyre'      :                        mid-latitude basin : GYRE
96   !!---------------------------------------------------------------------
97#             include "par_GYRE.h90"
98#elif defined key_pomme_r025
99   !!---------------------------------------------------------------------
100   !!   'key_pomme_r025':                        regional basin : POMME025
101   !!---------------------------------------------------------------------
102#             include "par_POMME_R025.h90"
103#else
104   !!---------------------------------------------------------------------
105   !!   default option  :                               small closed basin
106   !!---------------------------------------------------------------------
107   CHARACTER(len=16), PUBLIC, PARAMETER ::   cp_cfg = "default"   !: name of the configuration
108   INTEGER          , PUBLIC, PARAMETER ::   jp_cfg = 0           !: resolution of the configuration
109
110   ! data size                                       !!! * size of all input files *
111   INTEGER, PUBLIC, PARAMETER ::   jpidta  = 10       !: 1st lateral dimension ( >= jpi )
112   INTEGER, PUBLIC, PARAMETER ::   jpjdta  = 12       !: 2nd    "         "    ( >= jpj )
113   INTEGER, PUBLIC, PARAMETER ::   jpkdta  = 31       !: number of levels      ( >= jpk )
114
115   ! global or zoom domain size                      !!! * computational domain *
116   INTEGER, PUBLIC, PARAMETER ::   jpiglo  = jpidta   !: 1st dimension of global domain --> i
117   INTEGER, PUBLIC, PARAMETER ::   jpjglo  = jpjdta   !: 2nd    -                  -    --> j
118   INTEGER, PUBLIC, PARAMETER ::   jpk     = jpkdta   !: number of vertical levels
119   ! zoom starting position
120   INTEGER, PUBLIC, PARAMETER ::   jpizoom =   1      !: left bottom (i,j) indices of the zoom
121   INTEGER, PUBLIC, PARAMETER ::   jpjzoom =   1      !: in data domain indices
122
123   ! Domain characteristics
124   INTEGER, PUBLIC, PARAMETER ::   jperio  =  0       !: lateral cond. type (between 0 and 6)
125   !                                                  !  = 0 closed                 ;   = 1 cyclic East-West
126   !                                                  !  = 2 equatorial symmetric   ;   = 3 North fold T-point pivot
127   !                                                  !  = 4 cyclic East-West AND North fold T-point pivot
128   !                                                  !  = 5 North fold F-point pivot
129   !                                                  !  = 6 cyclic East-West AND North fold F-point pivot
130
131   !!  Values set to pp_not_used indicates that this parameter is not used in THIS config.
132   !!  Values set to pp_to_be_computed  indicates that variables will be computed in domzgr
133   REAL(wp), PUBLIC, PARAMETER ::   pp_not_used       = 999999._wp   !: vertical grid parameter
134   REAL(wp), PUBLIC, PARAMETER ::   pp_to_be_computed = 999999._wp   !:    -      -       -
135
136
137   !! Horizontal grid parameters for domhgr
138   !! =====================================
139   INTEGER, PUBLIC, PARAMETER  ::   jphgr_msh = 0   !: type of horizontal mesh
140   !                                                !  = 0 curvilinear coordinate on the sphere read in coordinate.nc
141   !                                                !  = 1 geographical mesh on the sphere with regular grid-spacing
142   !                                                !  = 2 f-plane with regular grid-spacing
143   !                                                !  = 3 beta-plane with regular grid-spacing
144   !                                                !  = 4 Mercator grid with T/U point at the equator
145
146   REAL(wp) , PUBLIC, PARAMETER ::   ppglam0  =    0.0_wp   !: longitude of first raw and column T-point (jphgr_msh = 1)
147   REAL(wp) , PUBLIC, PARAMETER ::   ppgphi0  =  -35.0_wp   !: latitude  of first raw and column T-point (jphgr_msh = 1)
148   !                                                        !  used for Coriolis & Beta parameters (jphgr_msh = 2 or 3)
149   REAL(wp) , PUBLIC, PARAMETER ::   ppe1_deg =    1.0_wp   !: zonal      grid-spacing (degrees)
150   REAL(wp) , PUBLIC, PARAMETER ::   ppe2_deg =    0.5_wp   !: meridional grid-spacing (degrees)
151   REAL(wp) , PUBLIC, PARAMETER ::   ppe1_m   = 5000.0_wp   !: zonal      grid-spacing (degrees)
152   REAL(wp) , PUBLIC, PARAMETER ::   ppe2_m   = 5000.0_wp   !: meridional grid-spacing (degrees)
153
154   !! Vertical grid parameter for domzgr
155   !! ==================================
156   REAL(wp), PUBLIC, PARAMETER ::   ppsur = -4762.96143546300_wp   !: ORCA r4, r2 and r05 coefficients
157   REAL(wp), PUBLIC, PARAMETER ::   ppa0  =   255.58049070440_wp   !: (default coefficients)
158   REAL(wp), PUBLIC, PARAMETER ::   ppa1  =   245.58132232490_wp   !:
159   REAL(wp), PUBLIC, PARAMETER ::   ppkth =    21.43336197938_wp   !:
160   REAL(wp), PUBLIC, PARAMETER ::   ppacr =     3.00000000000_wp   !:
161   !
162   !  If both ppa0 ppa1 and ppsur are specified to 0, then
163   !  they are computed from ppdzmin, pphmax , ppkth, ppacr in dom_zgr
164   REAL(wp), PUBLIC, PARAMETER ::   ppdzmin = 10._wp     !: Minimum vertical spacing
165   REAL(wp), PUBLIC, PARAMETER ::   pphmax  = 5000._wp   !: Maximum depth
166   !
167   LOGICAL , PUBLIC, PARAMETER ::   ldbletanh = .TRUE.   !: Use/do not use double tanf function for vertical coordinates
168   REAL(wp), PUBLIC, PARAMETER ::   ppa2  =   100.760928500000_wp   !: Double tanh function parameters
169   REAL(wp), PUBLIC, PARAMETER ::   ppkth2=    48.029893720000_wp   !:
170   REAL(wp), PUBLIC, PARAMETER ::   ppacr2=    13.000000000000_wp   !:
171   !
172#endif
173
174
175   !!---------------------------------------------------------------------
176   !! Active tracer parameters
177   !!---------------------------------------------------------------------
178   INTEGER, PUBLIC, PARAMETER ::   jpts   = 2    !: Number of active tracers (=2, i.e. T & S )
179   INTEGER, PUBLIC, PARAMETER ::   jp_tem = 1    !: indice for temperature
180   INTEGER, PUBLIC, PARAMETER ::   jp_sal = 2    !: indice for salinity
181
182   !!---------------------------------------------------------------------
183   !! Domain Matrix size  (if AGRIF, they are not all parameters)
184   !!---------------------------------------------------------------------
185#if defined key_agrif
186   INTEGER, PUBLIC, PARAMETER ::   nbghostcells = 1                             !: number of ghost cells
187   INTEGER, PUBLIC            ::   nbcellsx     = jpiglo - 2 - 2*nbghostcells   !: number of cells in i-direction
188   INTEGER, PUBLIC            ::   nbcellsy     = jpjglo - 2 - 2*nbghostcells   !: number of cells in j-direction
189   !
190   INTEGER, PUBLIC            ::   jpi = ( jpiglo-2*jpreci + (jpni-1) ) / jpni + 2*jpreci   !: first  dimension
191   INTEGER, PUBLIC            ::   jpj = ( jpjglo-2*jprecj + (jpnj-1) ) / jpnj + 2*jprecj   !: second dimension
192   INTEGER, PUBLIC            ::   jpim1 = jpi-1                                            !: inner domain indices
193   INTEGER, PUBLIC            ::   jpjm1 = jpj-1                                            !:   -     -      -
194   INTEGER, PUBLIC            ::   jpkm1 = jpk-1                                            !:   -     -      -
195   INTEGER, PUBLIC            ::   jpij  = jpi*jpj                                          !:  jpi x jpj
196#else
197   INTEGER, PUBLIC, PARAMETER ::   jpi = ( jpiglo-2*jpreci + (jpni-1) ) / jpni + 2*jpreci   !: first  dimension
198   INTEGER, PUBLIC, PARAMETER ::   jpj = ( jpjglo-2*jprecj + (jpnj-1) ) / jpnj + 2*jprecj   !: second dimension
199   INTEGER, PUBLIC, PARAMETER ::   jpim1 = jpi-1                                            !: inner domain indices
200   INTEGER, PUBLIC, PARAMETER ::   jpjm1 = jpj-1                                            !:   -     -      -
201   INTEGER, PUBLIC, PARAMETER ::   jpkm1 = jpk-1                                            !:   -     -      -
202   INTEGER, PUBLIC, PARAMETER ::   jpij  = jpi*jpj                                          !:  jpi x jpj
203#endif
204
205   !!---------------------------------------------------------------------
206   !! Optimization/control flags
207   !!---------------------------------------------------------------------
208#if defined key_esopa
209   LOGICAL, PUBLIC, PARAMETER ::   lk_esopa     = .TRUE.   !: flag to activate the all options
210#else
211   LOGICAL, PUBLIC, PARAMETER ::   lk_esopa     = .FALSE.  !: flag to activate the all options
212#endif
213
214#if defined key_vectopt_loop
215   LOGICAL, PUBLIC, PARAMETER ::   lk_vopt_loop = .TRUE.   !: vector optimization flag
216#else
217   LOGICAL, PUBLIC, PARAMETER ::   lk_vopt_loop = .FALSE.  !: vector optimization flag
218#endif
219
220   !!----------------------------------------------------------------------
221   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
222   !! $Id$
223   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
224   !!======================================================================
225END MODULE par_oce
Note: See TracBrowser for help on using the repository browser.