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 branches/2011/dev_r2802_LOCEAN10_agrif_lim/NEMOGCM/NEMO/OPA_SRC – NEMO

source: branches/2011/dev_r2802_LOCEAN10_agrif_lim/NEMOGCM/NEMO/OPA_SRC/par_oce.F90 @ 2815

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

branch dev_r2802_LOCEAN10_agrif_lim2: avoid to recompile everything with key_agrif, allow parallel compilation with agrif etc

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