1 | MODULE 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 | !! namcfg namelist parameters |
---|
17 | !!---------------------------------------------------------------------- |
---|
18 | LOGICAL :: ln_read_cfg !: (=T) read the domain configuration file or (=F) not |
---|
19 | CHARACTER(lc) :: cn_domcfg !: filename the configuration file to be read |
---|
20 | LOGICAL :: ln_write_cfg !: (=T) create the domain configuration file |
---|
21 | CHARACTER(lc) :: cn_domcfg_out !: filename the configuration file to be read |
---|
22 | ! |
---|
23 | LOGICAL :: ln_use_jattr !: input file read offset |
---|
24 | ! ! Use file global attribute: open_ocean_jstart to determine start j-row |
---|
25 | ! ! when reading input from those netcdf files that have the |
---|
26 | ! ! attribute defined. This is designed to enable input files associated |
---|
27 | ! ! with the extended grids used in the under ice shelf configurations to |
---|
28 | ! ! be used without redundant rows when the ice shelves are not in use. |
---|
29 | LOGICAL :: ln_closea !: (=T) special treatment of closed sea |
---|
30 | ! |
---|
31 | |
---|
32 | !!--------------------------------------------------------------------- |
---|
33 | !! Domain Matrix size |
---|
34 | !!--------------------------------------------------------------------- |
---|
35 | ! configuration name & resolution (required only in ORCA family case) |
---|
36 | CHARACTER(lc) :: cn_cfg !: name of the configuration |
---|
37 | INTEGER :: nn_cfg !: resolution of the configuration |
---|
38 | |
---|
39 | ! time dimension |
---|
40 | INTEGER, PUBLIC, PARAMETER :: jpt = 3 !: time dimension |
---|
41 | |
---|
42 | ! global domain size !!! * total computational domain * |
---|
43 | INTEGER :: jpiglo !: 1st dimension of global domain --> i-direction |
---|
44 | INTEGER :: jpjglo !: 2nd - - --> j-direction |
---|
45 | INTEGER :: jpkglo !: 3nd - - --> k levels |
---|
46 | |
---|
47 | ! global domain size for AGRIF !!! * total AGRIF computational domain * |
---|
48 | INTEGER, PUBLIC :: nbug_in_agrif_conv_do_not_remove_or_modify = 1 - 1 |
---|
49 | INTEGER, PUBLIC, PARAMETER :: nbghostcells = 4 !: number of ghost cells: default value |
---|
50 | INTEGER, PUBLIC :: nbghostcells_x !: number of ghost cells in i-direction |
---|
51 | INTEGER, PUBLIC :: nbghostcells_y_s !: number of ghost cells in j-direction at south |
---|
52 | INTEGER, PUBLIC :: nbghostcells_y_n !: number of ghost cells in j-direction at north |
---|
53 | INTEGER, PUBLIC :: nbcellsx !: number of cells in i-direction |
---|
54 | INTEGER, PUBLIC :: nbcellsy !: number of cells in j-direction |
---|
55 | |
---|
56 | ! local domain size !!! * local computational domain * |
---|
57 | INTEGER, PUBLIC :: jpi ! !: first dimension |
---|
58 | INTEGER, PUBLIC :: jpj ! !: second dimension |
---|
59 | INTEGER, PUBLIC :: jpk ! = jpkglo !: third dimension |
---|
60 | INTEGER, PUBLIC :: jpim1 ! = jpi-1 !: inner domain indices |
---|
61 | INTEGER, PUBLIC :: jpjm1 ! = jpj-1 !: - - - |
---|
62 | INTEGER, PUBLIC :: jpkm1 ! = jpk-1 !: - - - |
---|
63 | INTEGER, PUBLIC :: jpij ! = jpi*jpj !: jpi x jpj |
---|
64 | INTEGER, PUBLIC :: jpimax! = ( Ni0glo + jpni-1 ) / jpni + 2*nn_hls !: maximum jpi |
---|
65 | INTEGER, PUBLIC :: jpjmax! = ( Nj0glo + jpnj-1 ) / jpnj + 2*nn_hls !: maximum jpj |
---|
66 | |
---|
67 | ! Domain tiling |
---|
68 | INTEGER, PUBLIC :: nijtile !: number of tiles in total |
---|
69 | INTEGER, PUBLIC :: ntile !: current tile number |
---|
70 | INTEGER, PUBLIC :: ntsi !: start of internal part of tile domain |
---|
71 | INTEGER, PUBLIC :: ntsj ! |
---|
72 | INTEGER, PUBLIC :: ntei !: end of internal part of tile domain |
---|
73 | INTEGER, PUBLIC :: ntej ! |
---|
74 | INTEGER, PUBLIC :: nthl, nthr !: Modifier on DO loop macro bound offset (left, right) |
---|
75 | INTEGER, PUBLIC :: nthb, ntht !: " " (bottom, top) |
---|
76 | |
---|
77 | !!--------------------------------------------------------------------- |
---|
78 | !! Active tracer parameters |
---|
79 | !!--------------------------------------------------------------------- |
---|
80 | INTEGER, PUBLIC, PARAMETER :: jpts = 2 !: Number of active tracers (=2, i.e. T & S ) |
---|
81 | INTEGER, PUBLIC, PARAMETER :: jp_tem = 1 !: indice for temperature |
---|
82 | INTEGER, PUBLIC, PARAMETER :: jp_sal = 2 !: indice for salinity |
---|
83 | |
---|
84 | !!---------------------------------------------------------------------- |
---|
85 | !! Domain decomposition |
---|
86 | !!---------------------------------------------------------------------- |
---|
87 | !! if we dont use massively parallel computer (parameters jpni=jpnj=1) so jpiglo=jpi and jpjglo=jpj |
---|
88 | INTEGER, PUBLIC :: jpni !: number of processors following i |
---|
89 | INTEGER, PUBLIC :: jpnj !: number of processors following j |
---|
90 | INTEGER, PUBLIC :: jpnij !: nb of local domain = nb of processors ( <= jpni x jpnj ) |
---|
91 | INTEGER, PUBLIC, PARAMETER :: jpr2di = 0 !: number of columns for extra outer halo |
---|
92 | INTEGER, PUBLIC, PARAMETER :: jpr2dj = 0 !: number of rows for extra outer halo |
---|
93 | |
---|
94 | ! halo with and starting/inding DO-loop indices |
---|
95 | INTEGER, PUBLIC :: nn_hls !: halo width (applies to both rows and columns) |
---|
96 | INTEGER, PUBLIC :: Nis0 !: start I-index without halo |
---|
97 | INTEGER, PUBLIC :: Nie0 !: end I-index without halo |
---|
98 | INTEGER, PUBLIC :: Njs0 !: start J-index without halo |
---|
99 | INTEGER, PUBLIC :: Nje0 !: end J-index without halo |
---|
100 | INTEGER, PUBLIC :: Ni_0, Nj_0 !: local domain size without halo |
---|
101 | INTEGER, PUBLIC :: Ni0glo, Nj0glo !: global domain size without halo |
---|
102 | |
---|
103 | !!---------------------------------------------------------------------- |
---|
104 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
---|
105 | !! $Id$ |
---|
106 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
107 | !!====================================================================== |
---|
108 | END MODULE par_oce |
---|