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

source: branches/UKMO/AMM15_v3_6_STABLE_package/NEMOGCM/NEMO/OPA_SRC/par_oce.F90 @ 8561

Last change on this file since 8561 was 8058, checked in by jgraham, 7 years ago

Clear keywords

File size: 6.4 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   !!----------------------------------------------------------------------
28   !!                   namcfg namelist parameters
29   !!----------------------------------------------------------------------
30   CHARACTER(lc) ::   cp_cfg           !: name of the configuration
31   CHARACTER(lc) ::   cp_cfz           !: name of the zoom of configuration
32   INTEGER       ::   jp_cfg           !: resolution of the configuration
33
34   ! data size                                       !!! * size of all input files *
35   INTEGER       ::   jpidta           !: 1st lateral dimension ( >= jpi )
36   INTEGER       ::   jpjdta           !: 2nd    "         "    ( >= jpj )
37   INTEGER       ::   jpkdta           !: number of levels      ( >= jpk )
38
39   ! global or zoom domain size                      !!! * computational domain *
40   INTEGER       ::   jpiglo           !: 1st dimension of global domain --> i
41   INTEGER       ::   jpjglo           !: 2nd    -                  -    --> j
42
43   ! zoom starting position
44   INTEGER       ::   jpizoom          !: left bottom (i,j) indices of the zoom
45   INTEGER       ::   jpjzoom          !: in data domain indices
46
47   ! Domain characteristics
48   INTEGER       ::   jperio           !: lateral cond. type (between 0 and 6)
49   !                                       !  = 0 closed                 ;   = 1 cyclic East-West
50   !                                       !  = 2 equatorial symmetric   ;   = 3 North fold T-point pivot
51   !                                       !  = 4 cyclic East-West AND North fold T-point pivot
52   !                                       !  = 5 North fold F-point pivot
53   !                                       !  = 6 cyclic East-West AND North fold F-point pivot
54
55   ! Input file read offset
56   LOGICAL       ::   ln_use_jattr     !: Use file global attribute: open_ocean_jstart to determine start j-row
57                                           ! when reading input from those netcdf files that have the
58                                           ! attribute defined. This is designed to enable input files associated
59                                           ! with the extended grids used in the under ice shelf configurations to
60                                           ! be used without redundant rows when the ice shelves are not in use.
61
62   !!  Values set to pp_not_used indicates that this parameter is not used in THIS config.
63   !!  Values set to pp_to_be_computed  indicates that variables will be computed in domzgr
64   REAL(wp)      ::   pp_not_used       = 999999._wp   !: vertical grid parameter
65   REAL(wp)      ::   pp_to_be_computed = 999999._wp   !:    -      -       -
66
67
68
69
70   !!---------------------------------------------------------------------
71   !! Active tracer parameters
72   !!---------------------------------------------------------------------
73   INTEGER, PUBLIC, PARAMETER ::   jpts   = 2    !: Number of active tracers (=2, i.e. T & S )
74   INTEGER, PUBLIC, PARAMETER ::   jp_tem = 1    !: indice for temperature
75   INTEGER, PUBLIC, PARAMETER ::   jp_sal = 2    !: indice for salinity
76
77   !!---------------------------------------------------------------------
78   !! Domain Matrix size  (if AGRIF, they are not all parameters)
79   !!---------------------------------------------------------------------
80#if defined key_agrif
81   INTEGER, PUBLIC, PARAMETER ::   nbghostcells = 1                             !: number of ghost cells
82   INTEGER, PUBLIC            ::   nbcellsx     = jpiglo - 2 - 2*nbghostcells   !: number of cells in i-direction
83   INTEGER, PUBLIC            ::   nbcellsy     = jpjglo - 2 - 2*nbghostcells   !: number of cells in j-direction
84   !
85#endif
86   INTEGER, PUBLIC  ::   jpi   ! = ( jpiglo-2*jpreci + (jpni-1) ) / jpni + 2*jpreci   !: first  dimension
87   INTEGER, PUBLIC  ::   jpj   ! = ( jpjglo-2*jprecj + (jpnj-1) ) / jpnj + 2*jprecj   !: second dimension
88   INTEGER, PUBLIC  ::   jpk   ! = jpkdta
89   INTEGER, PUBLIC  ::   jpim1 ! = jpi-1                                            !: inner domain indices
90   INTEGER, PUBLIC  ::   jpjm1 ! = jpj-1                                            !:   -     -      -
91   INTEGER, PUBLIC  ::   jpkm1 ! = jpk-1                                            !:   -     -      -
92   INTEGER, PUBLIC  ::   jpij  ! = jpi*jpj                                          !:  jpi x jpj
93
94   !!---------------------------------------------------------------------
95   !! Optimization/control flags
96   !!---------------------------------------------------------------------
97#if defined key_esopa
98   LOGICAL, PUBLIC, PARAMETER ::   lk_esopa     = .TRUE.   !: flag to activate the all options
99#else
100   LOGICAL, PUBLIC, PARAMETER ::   lk_esopa     = .FALSE.  !: flag to activate the all options
101#endif
102
103   !!----------------------------------------------------------------------
104   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
105   !! $Id$
106   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
107   !!======================================================================
108END MODULE par_oce
Note: See TracBrowser for help on using the repository browser.