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/NEMO/OPA_SRC – NEMO

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

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

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