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

source: branches/2013/dev_r3940_CNRS4_IOCRS/NEMOGCM/NEMO/OPA_SRC/par_oce.F90 @ 4015

Last change on this file since 4015 was 4015, checked in by cetlod, 11 years ago

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