source: trunk/NEMO/OPA_SRC/par_oce.F90 @ 389

Last change on this file since 389 was 389, checked in by opalod, 15 years ago

RB:nemo_v1_update_038: first integration of Agrif :

  • configuration parameters are just integer when agrif is used
  • add call to agrif routines with key_agrif
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 10.9 KB
Line 
1MODULE par_oce
2   !!======================================================================
3   !!                        ***  par_oce  ***
4   !! Ocean :   set the ocean parameters
5   !!======================================================================
6   !! History :
7   !!   4.0  !  91     (Imbard, Levy, Madec)  Original code
8   !!   9.0  !  04-01  (G. Madec, J.-M. Molines)  Free form and module
9   !!    "   !  05-11  (V. Garnier) Surface pressure gradient organization
10   !!----------------------------------------------------------------------
11   !!  OPA 9.0 , LOCEAN-IPSL (2005)
12   !! $Header$
13   !! This software is governed by the CeCILL licence see modipsl/doc/NEMO_CeCILL.txt
14   !!----------------------------------------------------------------------
15   !! * Modules used
16   USE par_kind          ! kind parameters
17
18   IMPLICIT NONE
19   PUBLIC
20
21   !!----------------------------------------------------------------------
22   !!   Domain decomposition
23   !!----------------------------------------------------------------------
24   !! * if we dont use massively parallel computer (parameters jpni=jpnj=1)
25   !!      so jpiglo=jpi and jpjglo=jpj
26
27   INTEGER, PUBLIC, PARAMETER ::    &  !:
28      jpni   = 1,                   &  !: number of processors following i
29      jpnj   = 1,                   &  !: number of processors following j
30      jpnij  = 1,                   &  !: nb of local domain = nb of processors
31      !                                !  ( <= jpni x jpnj )
32      jpr2di = 0,                   &  !: number of columns for extra outer halo
33      jpr2dj = 0,                   &  !: number of rows    for extra outer halo
34      jpreci = 1,                   &  !: number of columns for overlap
35      jprecj = 1                       !: number of rows    for overlap
36
37   !! Ocean Domain sizes
38   !! ------------------
39   !!   data           domain   (jpidta,jpjdta)
40   !!   global or zoom domain   (jpiglo,jpjglo)
41   !!   local          domain   ( jpi  , jpj  )
42   
43#if   defined key_orca_r4
44   !!---------------------------------------------------------------------
45   !!   'key_orca_r4'   :                           global ocean : ORCA R4
46   !!---------------------------------------------------------------------
47#             include "par_ORCA_R4.h90"
48#elif defined key_orca_r2
49   !!---------------------------------------------------------------------
50   !!   'key_orca_r2'   :                           global ocean : ORCA R4
51   !!---------------------------------------------------------------------
52#             include "par_ORCA_R2.h90"
53#elif defined key_orca_r05
54   !!---------------------------------------------------------------------
55   !!   'key_orca_r05'  :                          global ocean : ORCA R05
56   !!---------------------------------------------------------------------
57#             include "par_ORCA_R05.h90"
58#elif defined key_orca_r025
59   !!---------------------------------------------------------------------
60   !!   'key_orca_r025' :                         global ocean : ORCA R025
61   !!---------------------------------------------------------------------
62#             include "par_ORCA_R025.h90"
63#elif defined key_eel_r2
64   !!---------------------------------------------------------------------
65   !!   'key_eel_r2'    :                                 channel : EEL R2
66   !!---------------------------------------------------------------------
67#             include "par_EEL_R2.h90"
68#elif defined key_eel_r5
69   !!---------------------------------------------------------------------
70   !!   'key_eel_r5'    :                                 channel : EEL R5
71   !!---------------------------------------------------------------------
72#             include "par_EEL_R5.h90"
73#elif defined key_eel_r6
74   !!---------------------------------------------------------------------
75   !!   'key_eel_r6'    :                                 channel : EEL R6
76   !!---------------------------------------------------------------------
77#             include "par_EEL_R6.h90"
78#elif defined key_gyre
79   !!---------------------------------------------------------------------
80   !!   'key_gyre'      :                        mid-latitude basin : GYRE
81   !!---------------------------------------------------------------------
82#             include "par_GYRE.h90"
83#else
84   !!---------------------------------------------------------------------
85   !!   default option  :                               small closed basin
86   !!---------------------------------------------------------------------
87   CHARACTER(len=16), PUBLIC, PARAMETER ::   &  !:
88      cp_cfg = "default"               !: name of the configuration
89   INTEGER, PARAMETER ::            &  !:
90      jp_cfg = 0  ,                 &  !: resolution of the configuration
91
92      ! data size                     !!! * size of all input files *
93      jpidta  = 10,                 &  !: 1st lateral dimension ( >= jpi )
94      jpjdta  = 12,                 &  !: 2nd    "         "    ( >= jpj )
95      jpkdta  = 31,                 &  !: number of levels      ( >= jpk )
96
97      ! global or zoom domain size    !!! * computational domain *
98      jpiglo  = jpidta,             &  !: 1st dimension of global domain --> i
99      jpjglo  = jpjdta,             &  !: 2nd    "                  "    --> j
100      jpk     = jpkdta,             &  !: number of vertical levels
101      ! zoom starting position
102      jpizoom =   1   ,             &  !: left bottom (i,j) indices of the zoom
103      jpjzoom =   1   ,             &  !: in data domain indices
104
105      ! Domain characteristics
106      jperio  =  0,                 &  !: lateral cond. type (between 0 and 6)
107         !                             !  = 0 closed
108         !                             !  = 1 cyclic East-West
109         !                             !  = 2 equatorial symmetric
110         !                             !  = 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      jpisl   =  0,                 &  !: number of islands (rigid-lid only)
115      jpnisl  =  0                     !: maximum number of points per island
116
117      !!  Values set to pp_not_used indicates that this parameter is not used in THIS config.
118      !!  Values set to pp_to_be_computed  indicates that variables will be computed in domzgr
119      REAL(wp), PARAMETER ::   &  !:
120         pp_not_used       = 999999._wp , &  !:
121         pp_to_be_computed = 999999._wp      !:
122
123
124   !! Horizontal grid parameters for domhgr
125   !! =====================================
126
127   INTEGER, PUBLIC, PARAMETER   ::   &  !:
128      jphgr_msh = 0            !: type of horizontal mesh
129      !                        !  = 0 curvilinear coordinate on the sphere
130      !                        !      read in coordinate.nc file
131      !                        !  = 1 geographical mesh on the sphere
132      !                        !      with regular grid-spacing
133      !                        !  = 2 f-plane with regular grid-spacing
134      !                        !  = 3 beta-plane with regular grid-spacing
135      !                        !  = 4 Mercator grid with T/U point at the equator  with
136      !                        !      isotropic resolution (e1_deg)
137
138   REAL(wp) , PUBLIC, PARAMETER ::   &   !:
139      ppglam0  =    0.0_wp,   &  !: longitude of first raw and column T-point (jphgr_msh = 1)
140      ppgphi0  =  -35.0_wp,   &  !: latitude  of first raw and column T-point (jphgr_msh = 1)
141      !                          !  latitude for the Coriolis or Beta parameter (jphgr_msh = 2 or 3)
142      ppe1_deg =    1.0_wp,   &  !: zonal      grid-spacing (degrees)
143      ppe2_deg =    0.5_wp,   &  !: meridional grid-spacing (degrees)
144      ppe1_m   = 5000.0_wp,   &  !: zonal      grid-spacing (degrees)
145      ppe2_m   = 5000.0_wp       !: meridional grid-spacing (degrees)
146
147   !! Vertical grid parameter for domzgr
148   !! ==================================
149
150   REAL(wp), PUBLIC, PARAMETER  ::   &  !:
151      &     ppsur = -4762.96143546300_wp ,  &  !: ORCA r4, r2 and r05 coefficients
152      &     ppa0  =   255.58049070440_wp ,  &  !: (default coefficients)
153      &     ppa1  =   245.58132232490_wp ,  &  !:
154      &     ppkth =    21.43336197938_wp ,  &  !:
155      &     ppacr =     3.00000000000_wp       !:
156
157   !!  If both ppa0 ppa1 and ppsur are specified to 0, then
158   !!  they are computed from ppdzmin, pphmax , ppkth, ppacr in dom_zgr
159
160   REAL(wp), PUBLIC, PARAMETER ::   &  !:
161      &     ppdzmin = 10._wp             ,  &  !: Minimum vertical spacing
162      &     pphmax  = 5000._wp                 !: Maximum depth
163
164   !!---------------------------------------------------------------------
165#endif
166
167   !!---------------------------------------------------------------------
168   !! Domain Matrix size
169   !!---------------------------------------------------------------------
170   INTEGER  &  !:
171#if !defined key_AGRIF
172      ,PARAMETER  &
173#endif
174    :: &
175      jpi = ( jpiglo-2*jpreci + (jpni-1) ) / jpni + 2*jpreci ,   &  !: first  dimension
176      jpj = ( jpjglo-2*jprecj + (jpnj-1) ) / jpnj + 2*jprecj ,   &  !: second dimension
177      jpim1 = jpi-1,                                             &  !: inner domain indices
178      jpjm1 = jpj-1,                                             &  !:   "            "
179      jpkm1 = jpk-1,                                             &  !:   "            "
180      jpij  = jpi*jpj                                               !:  jpi x jpj
181
182#if defined key_AGRIF
183   !!---------------------------------------------------------------------
184   !! Agrif variables
185   !!---------------------------------------------------------------------
186   INTEGER, PUBLIC, PARAMETER :: nbghostcells = 1
187   INTEGER, PUBLIC :: nbcellsx = jpiglo - 2 - 2*nbghostcells
188   INTEGER, PUBLIC :: nbcellsy = jpjglo - 2 - 2*nbghostcells
189#endif
190   !!---------------------------------------------------------------------
191   !! Optimization/control flags
192   !!---------------------------------------------------------------------
193#if defined key_esopa
194   LOGICAL, PUBLIC, PARAMETER ::   lk_esopa     = .TRUE.   !: flag to activate the all options
195#else
196   LOGICAL, PUBLIC, PARAMETER ::   lk_esopa     = .FALSE.  !: flag to activate the all options
197#endif
198
199#if defined key_vectopt_memory
200   LOGICAL, PUBLIC, PARAMETER ::   lk_vopt_mem  = .TRUE.   !: vector optimization flag
201#else
202   LOGICAL, PUBLIC, PARAMETER ::   lk_vopt_mem  = .FALSE.  !: vector optimization flag
203#endif
204
205#if defined key_vectopt_loop
206   LOGICAL, PUBLIC, PARAMETER ::   lk_vopt_loop = .TRUE.   !: vector optimization flag
207#else
208   LOGICAL, PUBLIC, PARAMETER ::   lk_vopt_loop = .FALSE.  !: vector optimization flag
209#endif
210
211#if defined key_autotasking
212   LOGICAL, PUBLIC, PARAMETER ::   lk_jki = .TRUE.   !: j-k-i loop flag
213#else
214   LOGICAL, PUBLIC, PARAMETER ::   lk_jki = .FALSE.  !: k-j-i loop flag
215#endif
216
217   !!======================================================================
218END MODULE par_oce
Note: See TracBrowser for help on using the repository browser.