| [3] | 1 | MODULE par_oce |
|---|
| 2 | !!====================================================================== |
|---|
| 3 | !! *** par_oce *** |
|---|
| 4 | !! Ocean : set the ocean parameters |
|---|
| 5 | !!====================================================================== |
|---|
| [2528] | 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 |
|---|
| [3] | 9 | !!---------------------------------------------------------------------- |
|---|
| [15] | 10 | USE par_kind ! kind parameters |
|---|
| [3] | 11 | |
|---|
| 12 | IMPLICIT NONE |
|---|
| 13 | PUBLIC |
|---|
| 14 | |
|---|
| 15 | !!---------------------------------------------------------------------- |
|---|
| [4147] | 16 | !! namcfg namelist parameters |
|---|
| 17 | !!---------------------------------------------------------------------- |
|---|
| [7646] | 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 |
|---|
| [14072] | 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 |
|---|
| [7646] | 28 | ! ! be used without redundant rows when the ice shelves are not in use. |
|---|
| [12377] | 29 | LOGICAL :: ln_closea !: (=T) special treatment of closed sea |
|---|
| [14072] | 30 | ! |
|---|
| [3] | 31 | |
|---|
| [7646] | 32 | !!--------------------------------------------------------------------- |
|---|
| [14072] | 33 | !! Domain Matrix size |
|---|
| [7646] | 34 | !!--------------------------------------------------------------------- |
|---|
| 35 | ! configuration name & resolution (required only in ORCA family case) |
|---|
| 36 | CHARACTER(lc) :: cn_cfg !: name of the configuration |
|---|
| [14072] | 37 | INTEGER :: nn_cfg !: resolution of the configuration |
|---|
| [3] | 38 | |
|---|
| [12377] | 39 | ! time dimension |
|---|
| 40 | INTEGER, PUBLIC, PARAMETER :: jpt = 3 !: time dimension |
|---|
| 41 | |
|---|
| [7646] | 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 |
|---|
| [3294] | 46 | |
|---|
| [7646] | 47 | ! global domain size for AGRIF !!! * total AGRIF computational domain * |
|---|
| [9449] | 48 | INTEGER, PUBLIC :: nbug_in_agrif_conv_do_not_remove_or_modify = 1 - 1 |
|---|
| [14976] | 49 | INTEGER, PUBLIC, PARAMETER :: nbghostcells = 4 !: number of ghost cells: default value |
|---|
| [15119] | 50 | INTEGER, PUBLIC :: nbghostcells_x_w !: number of ghost cells in i-direction at west |
|---|
| 51 | INTEGER, PUBLIC :: nbghostcells_x_e !: number of ghost cells in i-direction at east |
|---|
| [13216] | 52 | INTEGER, PUBLIC :: nbghostcells_y_s !: number of ghost cells in j-direction at south |
|---|
| [13286] | 53 | INTEGER, PUBLIC :: nbghostcells_y_n !: number of ghost cells in j-direction at north |
|---|
| 54 | INTEGER, PUBLIC :: nbcellsx !: number of cells in i-direction |
|---|
| 55 | INTEGER, PUBLIC :: nbcellsy !: number of cells in j-direction |
|---|
| [5118] | 56 | |
|---|
| [7646] | 57 | ! local domain size !!! * local computational domain * |
|---|
| [9449] | 58 | INTEGER, PUBLIC :: jpi ! !: first dimension |
|---|
| 59 | INTEGER, PUBLIC :: jpj ! !: second dimension |
|---|
| 60 | INTEGER, PUBLIC :: jpk ! = jpkglo !: third dimension |
|---|
| [7646] | 61 | INTEGER, PUBLIC :: jpkm1 ! = jpk-1 !: - - - |
|---|
| 62 | INTEGER, PUBLIC :: jpij ! = jpi*jpj !: jpi x jpj |
|---|
| [13286] | 63 | INTEGER, PUBLIC :: jpimax! = ( Ni0glo + jpni-1 ) / jpni + 2*nn_hls !: maximum jpi |
|---|
| 64 | INTEGER, PUBLIC :: jpjmax! = ( Nj0glo + jpnj-1 ) / jpnj + 2*nn_hls !: maximum jpj |
|---|
| [15] | 65 | |
|---|
| [13982] | 66 | ! Domain tiling |
|---|
| 67 | INTEGER, PUBLIC :: nijtile !: number of tiles in total |
|---|
| 68 | INTEGER, PUBLIC :: ntile !: current tile number |
|---|
| 69 | INTEGER, PUBLIC :: ntsi !: start of internal part of tile domain |
|---|
| 70 | INTEGER, PUBLIC :: ntsj ! |
|---|
| 71 | INTEGER, PUBLIC :: ntei !: end of internal part of tile domain |
|---|
| 72 | INTEGER, PUBLIC :: ntej ! |
|---|
| [14834] | 73 | INTEGER, PUBLIC :: nthl, nthr !: Modifier on DO loop macro bound offset (left, right) |
|---|
| 74 | INTEGER, PUBLIC :: nthb, ntht !: " " (bottom, top) |
|---|
| [13982] | 75 | |
|---|
| [3] | 76 | !!--------------------------------------------------------------------- |
|---|
| [2528] | 77 | !! Active tracer parameters |
|---|
| 78 | !!--------------------------------------------------------------------- |
|---|
| 79 | INTEGER, PUBLIC, PARAMETER :: jpts = 2 !: Number of active tracers (=2, i.e. T & S ) |
|---|
| 80 | INTEGER, PUBLIC, PARAMETER :: jp_tem = 1 !: indice for temperature |
|---|
| 81 | INTEGER, PUBLIC, PARAMETER :: jp_sal = 2 !: indice for salinity |
|---|
| [3] | 82 | |
|---|
| [7646] | 83 | !!---------------------------------------------------------------------- |
|---|
| 84 | !! Domain decomposition |
|---|
| 85 | !!---------------------------------------------------------------------- |
|---|
| 86 | !! if we dont use massively parallel computer (parameters jpni=jpnj=1) so jpiglo=jpi and jpjglo=jpj |
|---|
| [14072] | 87 | INTEGER, PUBLIC :: jpni !: number of processors following i |
|---|
| [7646] | 88 | INTEGER, PUBLIC :: jpnj !: number of processors following j |
|---|
| 89 | INTEGER, PUBLIC :: jpnij !: nb of local domain = nb of processors ( <= jpni x jpnj ) |
|---|
| [14072] | 90 | INTEGER, PUBLIC, PARAMETER :: jpr2di = 0 !: number of columns for extra outer halo |
|---|
| 91 | INTEGER, PUBLIC, PARAMETER :: jpr2dj = 0 !: number of rows for extra outer halo |
|---|
| [3] | 92 | |
|---|
| [13286] | 93 | ! halo with and starting/inding DO-loop indices |
|---|
| [14433] | 94 | INTEGER, PUBLIC :: nn_hls !: halo width (applies to both rows and columns) |
|---|
| 95 | INTEGER, PUBLIC :: Nis0 !: start I-index without halo |
|---|
| 96 | INTEGER, PUBLIC :: Nie0 !: end I-index without halo |
|---|
| 97 | INTEGER, PUBLIC :: Njs0 !: start J-index without halo |
|---|
| 98 | INTEGER, PUBLIC :: Nje0 !: end J-index without halo |
|---|
| 99 | INTEGER, PUBLIC :: Ni_0, Nj_0 !: local domain size without halo |
|---|
| 100 | INTEGER, PUBLIC :: Ni0glo, Nj0glo !: global domain size without halo |
|---|
| [13286] | 101 | |
|---|
| [2528] | 102 | !!---------------------------------------------------------------------- |
|---|
| [9598] | 103 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
|---|
| [14072] | 104 | !! $Id$ |
|---|
| [10068] | 105 | !! Software governed by the CeCILL license (see ./LICENSE) |
|---|
| [3] | 106 | !!====================================================================== |
|---|
| 107 | END MODULE par_oce |
|---|
