[3] | 1 | MODULE par_oce |
---|
| 2 | !!====================================================================== |
---|
| 3 | !! *** par_oce *** |
---|
| 4 | !! Ocean : set the ocean parameters |
---|
| 5 | !!====================================================================== |
---|
[2104] | 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 | !!---------------------------------------------------------------------- |
---|
| 16 | !! Domain decomposition |
---|
| 17 | !!---------------------------------------------------------------------- |
---|
[2104] | 18 | !! if we dont use massively parallel computer (parameters jpni=jpnj=1) so jpiglo=jpi and jpjglo=jpj |
---|
[635] | 19 | #if ! defined key_mpp_dyndist |
---|
[2236] | 20 | INTEGER, PUBLIC, PARAMETER :: & !: |
---|
| 21 | # if ! defined key_nproci |
---|
| 22 | jpni = 1, & !: number of processors following i |
---|
| 23 | jpnj = 1, & !: number of processors following j |
---|
| 24 | jpnij = 1 !: nb of local domain = nb of processors |
---|
| 25 | ! ! ( <= jpni x jpnj ) |
---|
| 26 | # else |
---|
| 27 | jpni = key_nproci, & !: number of processors following i |
---|
| 28 | jpnj = key_nprocj, & !: number of processors following j |
---|
| 29 | # if ! defined key_nprocij |
---|
| 30 | jpnij = key_nproci * key_nprocj !: nb of local domain = nb of processors |
---|
| 31 | ! ! ( <= jpni x jpnj ) |
---|
| 32 | # else |
---|
| 33 | jpnij = key_nprocij !: nb of local domain = nb of processors |
---|
| 34 | ! ! ( <= jpni x jpnj ) |
---|
| 35 | # endif |
---|
| 36 | # endif |
---|
[635] | 37 | #else |
---|
[2104] | 38 | INTEGER, PUBLIC :: jpni !: number of processors following i |
---|
| 39 | INTEGER, PUBLIC :: jpnj !: number of processors following j |
---|
| 40 | INTEGER, PUBLIC :: jpnij !: nb of local domain = nb of processors ( <= jpni x jpnj ) |
---|
[635] | 41 | #endif |
---|
[2104] | 42 | INTEGER, PUBLIC, PARAMETER :: jpr2di = 0 !: number of columns for extra outer halo |
---|
| 43 | INTEGER, PUBLIC, PARAMETER :: jpr2dj = 0 !: number of rows for extra outer halo |
---|
| 44 | INTEGER, PUBLIC, PARAMETER :: jpreci = 1 !: number of columns for overlap |
---|
| 45 | INTEGER, PUBLIC, PARAMETER :: jprecj = 1 !: number of rows for overlap |
---|
[635] | 46 | |
---|
[3] | 47 | !! Ocean Domain sizes |
---|
| 48 | !! ------------------ |
---|
| 49 | !! data domain (jpidta,jpjdta) |
---|
| 50 | !! global or zoom domain (jpiglo,jpjglo) |
---|
| 51 | !! local domain ( jpi , jpj ) |
---|
| 52 | |
---|
| 53 | #if defined key_orca_r4 |
---|
| 54 | !!--------------------------------------------------------------------- |
---|
| 55 | !! 'key_orca_r4' : global ocean : ORCA R4 |
---|
| 56 | !!--------------------------------------------------------------------- |
---|
| 57 | # include "par_ORCA_R4.h90" |
---|
| 58 | #elif defined key_orca_r2 |
---|
| 59 | !!--------------------------------------------------------------------- |
---|
| 60 | !! 'key_orca_r2' : global ocean : ORCA R4 |
---|
| 61 | !!--------------------------------------------------------------------- |
---|
| 62 | # include "par_ORCA_R2.h90" |
---|
| 63 | #elif defined key_orca_r05 |
---|
| 64 | !!--------------------------------------------------------------------- |
---|
| 65 | !! 'key_orca_r05' : global ocean : ORCA R05 |
---|
| 66 | !!--------------------------------------------------------------------- |
---|
| 67 | # include "par_ORCA_R05.h90" |
---|
| 68 | #elif defined key_orca_r025 |
---|
| 69 | !!--------------------------------------------------------------------- |
---|
| 70 | !! 'key_orca_r025' : global ocean : ORCA R025 |
---|
| 71 | !!--------------------------------------------------------------------- |
---|
| 72 | # include "par_ORCA_R025.h90" |
---|
| 73 | #elif defined key_eel_r2 |
---|
| 74 | !!--------------------------------------------------------------------- |
---|
| 75 | !! 'key_eel_r2' : channel : EEL R2 |
---|
| 76 | !!--------------------------------------------------------------------- |
---|
| 77 | # include "par_EEL_R2.h90" |
---|
| 78 | #elif defined key_eel_r5 |
---|
| 79 | !!--------------------------------------------------------------------- |
---|
| 80 | !! 'key_eel_r5' : channel : EEL R5 |
---|
| 81 | !!--------------------------------------------------------------------- |
---|
| 82 | # include "par_EEL_R5.h90" |
---|
| 83 | #elif defined key_eel_r6 |
---|
| 84 | !!--------------------------------------------------------------------- |
---|
| 85 | !! 'key_eel_r6' : channel : EEL R6 |
---|
| 86 | !!--------------------------------------------------------------------- |
---|
| 87 | # include "par_EEL_R6.h90" |
---|
[93] | 88 | #elif defined key_gyre |
---|
| 89 | !!--------------------------------------------------------------------- |
---|
[294] | 90 | !! 'key_gyre' : mid-latitude basin : GYRE |
---|
[93] | 91 | !!--------------------------------------------------------------------- |
---|
| 92 | # include "par_GYRE.h90" |
---|
[1647] | 93 | #elif defined key_pomme_r025 |
---|
| 94 | !!--------------------------------------------------------------------- |
---|
| 95 | !! 'key_pomme_r025': regional basin : POMME025 |
---|
| 96 | !!--------------------------------------------------------------------- |
---|
| 97 | # include "par_POMME_R025.h90" |
---|
[3] | 98 | #else |
---|
| 99 | !!--------------------------------------------------------------------- |
---|
| 100 | !! default option : small closed basin |
---|
| 101 | !!--------------------------------------------------------------------- |
---|
[2104] | 102 | CHARACTER(len=16), PUBLIC, PARAMETER :: cp_cfg = "default" !: name of the configuration |
---|
| 103 | INTEGER , PUBLIC, PARAMETER :: jp_cfg = 0 !: resolution of the configuration |
---|
[3] | 104 | |
---|
[2104] | 105 | ! data size !!! * size of all input files * |
---|
| 106 | INTEGER, PUBLIC, PARAMETER :: jpidta = 10 !: 1st lateral dimension ( >= jpi ) |
---|
| 107 | INTEGER, PUBLIC, PARAMETER :: jpjdta = 12 !: 2nd " " ( >= jpj ) |
---|
| 108 | INTEGER, PUBLIC, PARAMETER :: jpkdta = 31 !: number of levels ( >= jpk ) |
---|
[3] | 109 | |
---|
[2104] | 110 | ! global or zoom domain size !!! * computational domain * |
---|
| 111 | INTEGER, PUBLIC, PARAMETER :: jpiglo = jpidta !: 1st dimension of global domain --> i |
---|
| 112 | INTEGER, PUBLIC, PARAMETER :: jpjglo = jpjdta !: 2nd - - --> j |
---|
| 113 | INTEGER, PUBLIC, PARAMETER :: jpk = jpkdta !: number of vertical levels |
---|
| 114 | ! zoom starting position |
---|
| 115 | INTEGER, PUBLIC, PARAMETER :: jpizoom = 1 !: left bottom (i,j) indices of the zoom |
---|
| 116 | INTEGER, PUBLIC, PARAMETER :: jpjzoom = 1 !: in data domain indices |
---|
[3] | 117 | |
---|
[2104] | 118 | ! Domain characteristics |
---|
| 119 | INTEGER, PUBLIC, PARAMETER :: jperio = 0 !: lateral cond. type (between 0 and 6) |
---|
| 120 | ! ! = 0 closed ; = 1 cyclic East-West |
---|
| 121 | ! ! = 2 equatorial symmetric ; = 3 North fold T-point pivot |
---|
| 122 | ! ! = 4 cyclic East-West AND North fold T-point pivot |
---|
| 123 | ! ! = 5 North fold F-point pivot |
---|
| 124 | ! ! = 6 cyclic East-West AND North fold F-point pivot |
---|
[3] | 125 | |
---|
[2104] | 126 | !! Values set to pp_not_used indicates that this parameter is not used in THIS config. |
---|
| 127 | !! Values set to pp_to_be_computed indicates that variables will be computed in domzgr |
---|
| 128 | REAL(wp), PUBLIC, PARAMETER :: pp_not_used = 999999._wp !: vertical grid parameter |
---|
| 129 | REAL(wp), PUBLIC, PARAMETER :: pp_to_be_computed = 999999._wp !: - - - |
---|
[15] | 130 | |
---|
| 131 | |
---|
[3] | 132 | !! Horizontal grid parameters for domhgr |
---|
| 133 | !! ===================================== |
---|
[2104] | 134 | INTEGER, PUBLIC, PARAMETER :: jphgr_msh = 0 !: type of horizontal mesh |
---|
| 135 | ! ! = 0 curvilinear coordinate on the sphere read in coordinate.nc |
---|
| 136 | ! ! = 1 geographical mesh on the sphere with regular grid-spacing |
---|
| 137 | ! ! = 2 f-plane with regular grid-spacing |
---|
| 138 | ! ! = 3 beta-plane with regular grid-spacing |
---|
| 139 | ! ! = 4 Mercator grid with T/U point at the equator |
---|
[3] | 140 | |
---|
[2104] | 141 | REAL(wp) , PUBLIC, PARAMETER :: ppglam0 = 0.0_wp !: longitude of first raw and column T-point (jphgr_msh = 1) |
---|
| 142 | REAL(wp) , PUBLIC, PARAMETER :: ppgphi0 = -35.0_wp !: latitude of first raw and column T-point (jphgr_msh = 1) |
---|
| 143 | ! ! used for Coriolis & Beta parameters (jphgr_msh = 2 or 3) |
---|
| 144 | REAL(wp) , PUBLIC, PARAMETER :: ppe1_deg = 1.0_wp !: zonal grid-spacing (degrees) |
---|
| 145 | REAL(wp) , PUBLIC, PARAMETER :: ppe2_deg = 0.5_wp !: meridional grid-spacing (degrees) |
---|
| 146 | REAL(wp) , PUBLIC, PARAMETER :: ppe1_m = 5000.0_wp !: zonal grid-spacing (degrees) |
---|
| 147 | REAL(wp) , PUBLIC, PARAMETER :: ppe2_m = 5000.0_wp !: meridional grid-spacing (degrees) |
---|
[3] | 148 | |
---|
| 149 | !! Vertical grid parameter for domzgr |
---|
| 150 | !! ================================== |
---|
[2104] | 151 | REAL(wp), PUBLIC, PARAMETER :: ppsur = -4762.96143546300_wp !: ORCA r4, r2 and r05 coefficients |
---|
| 152 | REAL(wp), PUBLIC, PARAMETER :: ppa0 = 255.58049070440_wp !: (default coefficients) |
---|
| 153 | REAL(wp), PUBLIC, PARAMETER :: ppa1 = 245.58132232490_wp !: |
---|
| 154 | REAL(wp), PUBLIC, PARAMETER :: ppkth = 21.43336197938_wp !: |
---|
| 155 | REAL(wp), PUBLIC, PARAMETER :: ppacr = 3.00000000000_wp !: |
---|
| 156 | ! |
---|
| 157 | ! If both ppa0 ppa1 and ppsur are specified to 0, then |
---|
| 158 | ! they are computed from ppdzmin, pphmax , ppkth, ppacr in dom_zgr |
---|
| 159 | REAL(wp), PUBLIC, PARAMETER :: ppdzmin = 10._wp !: Minimum vertical spacing |
---|
| 160 | REAL(wp), PUBLIC, PARAMETER :: pphmax = 5000._wp !: Maximum depth |
---|
[3] | 161 | |
---|
| 162 | #endif |
---|
| 163 | |
---|
[2025] | 164 | |
---|
[3] | 165 | !!--------------------------------------------------------------------- |
---|
[2104] | 166 | !! Active tracer parameters |
---|
[3] | 167 | !!--------------------------------------------------------------------- |
---|
[2104] | 168 | INTEGER, PUBLIC, PARAMETER :: jpts = 2 !: Number of active tracers (=2, i.e. T & S ) |
---|
| 169 | INTEGER, PUBLIC, PARAMETER :: jp_tem = 1 !: indice for temperature |
---|
| 170 | INTEGER, PUBLIC, PARAMETER :: jp_sal = 2 !: indice for salinity |
---|
[3] | 171 | |
---|
| 172 | !!--------------------------------------------------------------------- |
---|
[2104] | 173 | !! Domain Matrix size (if AGRIF, they are not all parameters) |
---|
[389] | 174 | !!--------------------------------------------------------------------- |
---|
[2104] | 175 | #if defined key_agrif |
---|
| 176 | INTEGER, PUBLIC, PARAMETER :: nbghostcells = 1 !: number of ghost cells |
---|
| 177 | INTEGER, PUBLIC :: nbcellsx = jpiglo - 2 - 2*nbghostcells !: number of cells in i-direction |
---|
| 178 | INTEGER, PUBLIC :: nbcellsy = jpjglo - 2 - 2*nbghostcells !: number of cells in j-direction |
---|
| 179 | ! |
---|
| 180 | INTEGER, PUBLIC :: jpi = ( jpiglo-2*jpreci + (jpni-1) ) / jpni + 2*jpreci !: first dimension |
---|
| 181 | INTEGER, PUBLIC :: jpj = ( jpjglo-2*jprecj + (jpnj-1) ) / jpnj + 2*jprecj !: second dimension |
---|
| 182 | INTEGER, PUBLIC :: jpim1 = jpi-1 !: inner domain indices |
---|
| 183 | INTEGER, PUBLIC :: jpjm1 = jpj-1 !: - - - |
---|
| 184 | INTEGER, PUBLIC :: jpkm1 = jpk-1 !: - - - |
---|
| 185 | INTEGER, PUBLIC :: jpij = jpi*jpj !: jpi x jpj |
---|
| 186 | #else |
---|
| 187 | INTEGER, PUBLIC, PARAMETER :: jpi = ( jpiglo-2*jpreci + (jpni-1) ) / jpni + 2*jpreci !: first dimension |
---|
| 188 | INTEGER, PUBLIC, PARAMETER :: jpj = ( jpjglo-2*jprecj + (jpnj-1) ) / jpnj + 2*jprecj !: second dimension |
---|
| 189 | INTEGER, PUBLIC, PARAMETER :: jpim1 = jpi-1 !: inner domain indices |
---|
| 190 | INTEGER, PUBLIC, PARAMETER :: jpjm1 = jpj-1 !: - - - |
---|
| 191 | INTEGER, PUBLIC, PARAMETER :: jpkm1 = jpk-1 !: - - - |
---|
| 192 | INTEGER, PUBLIC, PARAMETER :: jpij = jpi*jpj !: jpi x jpj |
---|
[389] | 193 | #endif |
---|
[2104] | 194 | |
---|
[389] | 195 | !!--------------------------------------------------------------------- |
---|
[15] | 196 | !! Optimization/control flags |
---|
[3] | 197 | !!--------------------------------------------------------------------- |
---|
| 198 | #if defined key_esopa |
---|
[15] | 199 | LOGICAL, PUBLIC, PARAMETER :: lk_esopa = .TRUE. !: flag to activate the all options |
---|
[3] | 200 | #else |
---|
[15] | 201 | LOGICAL, PUBLIC, PARAMETER :: lk_esopa = .FALSE. !: flag to activate the all options |
---|
[3] | 202 | #endif |
---|
| 203 | |
---|
[15] | 204 | #if defined key_vectopt_loop |
---|
| 205 | LOGICAL, PUBLIC, PARAMETER :: lk_vopt_loop = .TRUE. !: vector optimization flag |
---|
| 206 | #else |
---|
| 207 | LOGICAL, PUBLIC, PARAMETER :: lk_vopt_loop = .FALSE. !: vector optimization flag |
---|
| 208 | #endif |
---|
| 209 | |
---|
[2104] | 210 | !!---------------------------------------------------------------------- |
---|
| 211 | !! NEMO/OPA 3.3 , LOCEAN-IPSL (2010) |
---|
| 212 | !! $Id$ |
---|
| 213 | !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt) |
---|
[3] | 214 | !!====================================================================== |
---|
| 215 | END MODULE par_oce |
---|