source: branches/2011/dev_r2802_NOCL_bfrimp/NEMOGCM/NEMO/OPA_SRC/par_oce.F90 @ 2872

Last change on this file since 2872 was 2872, checked in by hliu, 9 years ago

1) added the semi-implicit bottom friction code (3 in DYN, 1 in ZDF), 2) added par_AMM7/12.h90, 3) added two arch files for NOCL mobius and ubuntu linux

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