[3] | 1 | MODULE domain |
---|
| 2 | !!============================================================================== |
---|
| 3 | !! *** MODULE domain *** |
---|
| 4 | !! Ocean initialization : domain initialization |
---|
| 5 | !!============================================================================== |
---|
[1438] | 6 | !! History : OPA ! 1990-10 (C. Levy - G. Madec) Original code |
---|
| 7 | !! ! 1992-01 (M. Imbard) insert time step initialization |
---|
[14072] | 8 | !! ! 1996-06 (G. Madec) generalized vertical coordinate |
---|
[1438] | 9 | !! ! 1997-02 (G. Madec) creation of domwri.F |
---|
| 10 | !! ! 2001-05 (E.Durand - G. Madec) insert closed sea |
---|
| 11 | !! NEMO 1.0 ! 2002-08 (G. Madec) F90: Free form and module |
---|
| 12 | !! 2.0 ! 2005-11 (V. Garnier) Surface pressure gradient organization |
---|
[4152] | 13 | !! 3.6 ! 2013 ( J. Simeon, C. Calone, G. Madec, C. Ethe ) Online coarsening of outputs |
---|
[6140] | 14 | !! 3.7 ! 2015-11 (G. Madec, A. Coward) time varying zgr by default |
---|
[7646] | 15 | !! 4.0 ! 2016-10 (G. Madec, S. Flavoni) domain configuration / user defined interface |
---|
[14053] | 16 | !! 4.1 ! 2020-02 (G. Madec, S. Techene) introduce ssh to h0 ratio |
---|
[3] | 17 | !!---------------------------------------------------------------------- |
---|
[14072] | 18 | |
---|
[1438] | 19 | !!---------------------------------------------------------------------- |
---|
[7646] | 20 | !! dom_init : initialize the space and time domain |
---|
| 21 | !! dom_glo : initialize global domain <--> local domain indices |
---|
| 22 | !! dom_nam : read and contral domain namelists |
---|
| 23 | !! dom_ctl : control print for the ocean domain |
---|
| 24 | !! domain_cfg : read the global domain size in domain configuration file |
---|
| 25 | !! cfg_write : create the domain configuration file |
---|
[3] | 26 | !!---------------------------------------------------------------------- |
---|
[7646] | 27 | USE oce ! ocean variables |
---|
| 28 | USE dom_oce ! domain: ocean |
---|
[14139] | 29 | USE domtile ! tiling utilities |
---|
[14053] | 30 | #if defined key_qco |
---|
[14139] | 31 | USE domqco ! quasi-eulerian coord. |
---|
| 32 | #elif defined key_linssh |
---|
| 33 | ! ! fix in time coord. |
---|
[14053] | 34 | #else |
---|
[14139] | 35 | USE domvvl ! variable volume coord. |
---|
[14053] | 36 | #endif |
---|
[14125] | 37 | #if defined key_agrif |
---|
| 38 | USE agrif_oce_interp, ONLY : Agrif_istate_ssh ! ssh interpolated from parent |
---|
| 39 | #endif |
---|
[7646] | 40 | USE sbc_oce ! surface boundary condition: ocean |
---|
| 41 | USE trc_oce ! shared ocean & passive tracers variab |
---|
| 42 | USE phycst ! physical constants |
---|
| 43 | USE domhgr ! domain: set the horizontal mesh |
---|
| 44 | USE domzgr ! domain: set the vertical mesh |
---|
| 45 | USE dommsk ! domain: set the mask system |
---|
| 46 | USE domwri ! domain: write the meshmask file |
---|
[14053] | 47 | USE wet_dry , ONLY : ll_wd ! wet & drying flag |
---|
| 48 | USE closea , ONLY : dom_clo ! closed seas routine |
---|
[5836] | 49 | ! |
---|
[7646] | 50 | USE in_out_manager ! I/O manager |
---|
| 51 | USE iom ! I/O library |
---|
| 52 | USE lbclnk ! ocean lateral boundary condition (or mpp link) |
---|
| 53 | USE lib_mpp ! distributed memory computing library |
---|
[14139] | 54 | USE restart ! only for lrst_oce and rst_read_ssh |
---|
[3] | 55 | |
---|
| 56 | IMPLICIT NONE |
---|
| 57 | PRIVATE |
---|
| 58 | |
---|
[7646] | 59 | PUBLIC dom_init ! called by nemogcm.F90 |
---|
| 60 | PUBLIC domain_cfg ! called by nemogcm.F90 |
---|
[3] | 61 | |
---|
[14053] | 62 | !! * Substitutions |
---|
| 63 | # include "do_loop_substitute.h90" |
---|
[1438] | 64 | !!------------------------------------------------------------------------- |
---|
[9598] | 65 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
---|
[888] | 66 | !! $Id$ |
---|
[10068] | 67 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
[1438] | 68 | !!------------------------------------------------------------------------- |
---|
[3] | 69 | CONTAINS |
---|
| 70 | |
---|
[13970] | 71 | SUBROUTINE dom_init( Kbb, Kmm, Kaa ) |
---|
[3] | 72 | !!---------------------------------------------------------------------- |
---|
| 73 | !! *** ROUTINE dom_init *** |
---|
[14072] | 74 | !! |
---|
| 75 | !! ** Purpose : Domain initialization. Call the routines that are |
---|
| 76 | !! required to create the arrays which define the space |
---|
[1601] | 77 | !! and time domain of the ocean model. |
---|
[3] | 78 | !! |
---|
[1601] | 79 | !! ** Method : - dom_msk: compute the masks from the bathymetry file |
---|
| 80 | !! - dom_hgr: compute or read the horizontal grid-point position |
---|
| 81 | !! and scale factors, and the coriolis factor |
---|
| 82 | !! - dom_zgr: define the vertical coordinate and the bathymetry |
---|
[9169] | 83 | !! - dom_wri: create the meshmask file (ln_meshmask=T) |
---|
[2528] | 84 | !! - 1D configuration, move Coriolis, u and v at T-point |
---|
[3] | 85 | !!---------------------------------------------------------------------- |
---|
[12377] | 86 | INTEGER , INTENT(in) :: Kbb, Kmm, Kaa ! ocean time level indices |
---|
| 87 | ! |
---|
[13237] | 88 | INTEGER :: ji, jj, jk, jt ! dummy loop indices |
---|
[7646] | 89 | INTEGER :: iconf = 0 ! local integers |
---|
[14053] | 90 | REAL(wp):: zrdt |
---|
[14072] | 91 | CHARACTER (len=64) :: cform = "(A12, 3(A13, I7))" |
---|
[7646] | 92 | INTEGER , DIMENSION(jpi,jpj) :: ik_top , ik_bot ! top and bottom ocean level |
---|
| 93 | REAL(wp), DIMENSION(jpi,jpj) :: z1_hu_0, z1_hv_0 |
---|
[3] | 94 | !!---------------------------------------------------------------------- |
---|
[1601] | 95 | ! |
---|
[7646] | 96 | IF(lwp) THEN ! Ocean domain Parameters (control print) |
---|
[3] | 97 | WRITE(numout,*) |
---|
| 98 | WRITE(numout,*) 'dom_init : domain initialization' |
---|
| 99 | WRITE(numout,*) '~~~~~~~~' |
---|
[7646] | 100 | ! |
---|
| 101 | WRITE(numout,*) ' Domain info' |
---|
| 102 | WRITE(numout,*) ' dimension of model:' |
---|
| 103 | WRITE(numout,*) ' Local domain Global domain Data domain ' |
---|
| 104 | WRITE(numout,cform) ' ',' jpi : ', jpi, ' jpiglo : ', jpiglo |
---|
| 105 | WRITE(numout,cform) ' ',' jpj : ', jpj, ' jpjglo : ', jpjglo |
---|
| 106 | WRITE(numout,cform) ' ',' jpk : ', jpk, ' jpkglo : ', jpkglo |
---|
| 107 | WRITE(numout,cform) ' ' ,' jpij : ', jpij |
---|
| 108 | WRITE(numout,*) ' mpp local domain info (mpp):' |
---|
[9019] | 109 | WRITE(numout,*) ' jpni : ', jpni, ' nn_hls : ', nn_hls |
---|
| 110 | WRITE(numout,*) ' jpnj : ', jpnj, ' nn_hls : ', nn_hls |
---|
[7646] | 111 | WRITE(numout,*) ' jpnij : ', jpnij |
---|
[14433] | 112 | WRITE(numout,*) ' lateral boundary of the Global domain:' |
---|
| 113 | WRITE(numout,*) ' cyclic east-west :', l_Iperio |
---|
| 114 | WRITE(numout,*) ' cyclic north-south :', l_Jperio |
---|
| 115 | WRITE(numout,*) ' North Pole folding :', l_NFold |
---|
| 116 | WRITE(numout,*) ' type of North pole Folding:', c_NFtype |
---|
[7646] | 117 | WRITE(numout,*) ' Ocean model configuration used:' |
---|
[14433] | 118 | WRITE(numout,*) ' cn_cfg = ', TRIM( cn_cfg ), ' nn_cfg = ', nn_cfg |
---|
[3] | 119 | ENDIF |
---|
[14072] | 120 | |
---|
[1601] | 121 | ! |
---|
[7646] | 122 | ! !== Reference coordinate system ==! |
---|
[6140] | 123 | ! |
---|
[14834] | 124 | CALL dom_glo ! global domain versus local domain |
---|
| 125 | CALL dom_nam ! read namelist ( namrun, namdom ) |
---|
| 126 | CALL dom_tile_init ! Tile domain |
---|
[13982] | 127 | |
---|
[9367] | 128 | ! |
---|
[12377] | 129 | CALL dom_hgr ! Horizontal mesh |
---|
| 130 | |
---|
| 131 | IF( ln_closea ) CALL dom_clo ! Read in masks to define closed seas and lakes |
---|
| 132 | |
---|
[13237] | 133 | CALL dom_zgr( ik_top, ik_bot ) ! Vertical mesh and bathymetry (return top and bottom ocean t-level indices) |
---|
[12377] | 134 | |
---|
| 135 | CALL dom_msk( ik_top, ik_bot ) ! Masks |
---|
[7646] | 136 | ! |
---|
[7753] | 137 | ht_0(:,:) = 0._wp ! Reference ocean thickness |
---|
| 138 | hu_0(:,:) = 0._wp |
---|
| 139 | hv_0(:,:) = 0._wp |
---|
[13237] | 140 | hf_0(:,:) = 0._wp |
---|
[14053] | 141 | DO jk = 1, jpkm1 |
---|
[7753] | 142 | ht_0(:,:) = ht_0(:,:) + e3t_0(:,:,jk) * tmask(:,:,jk) |
---|
| 143 | hu_0(:,:) = hu_0(:,:) + e3u_0(:,:,jk) * umask(:,:,jk) |
---|
| 144 | hv_0(:,:) = hv_0(:,:) + e3v_0(:,:,jk) * vmask(:,:,jk) |
---|
[4490] | 145 | END DO |
---|
| 146 | ! |
---|
[14053] | 147 | DO jk = 1, jpkm1 |
---|
| 148 | hf_0(1:jpim1,:) = hf_0(1:jpim1,:) + e3f_0(1:jpim1,:,jk)*vmask(1:jpim1,:,jk)*vmask(2:jpi,:,jk) |
---|
| 149 | END DO |
---|
| 150 | CALL lbc_lnk('domain', hf_0, 'F', 1._wp) |
---|
| 151 | ! |
---|
| 152 | IF( lk_SWE ) THEN ! SWE case redefine hf_0 |
---|
| 153 | hf_0(:,:) = hf_0(:,:) + e3f_0(:,:,1) * ssfmask(:,:) |
---|
| 154 | ENDIF |
---|
| 155 | ! |
---|
[13237] | 156 | r1_ht_0(:,:) = ssmask (:,:) / ( ht_0(:,:) + 1._wp - ssmask (:,:) ) |
---|
| 157 | r1_hu_0(:,:) = ssumask(:,:) / ( hu_0(:,:) + 1._wp - ssumask(:,:) ) |
---|
| 158 | r1_hv_0(:,:) = ssvmask(:,:) / ( hv_0(:,:) + 1._wp - ssvmask(:,:) ) |
---|
| 159 | r1_hf_0(:,:) = ssfmask(:,:) / ( hf_0(:,:) + 1._wp - ssfmask(:,:) ) |
---|
| 160 | ! |
---|
[14053] | 161 | IF( ll_wd ) THEN ! wet and drying (check ht_0 >= 0) |
---|
| 162 | DO_2D( 1, 1, 1, 1 ) |
---|
| 163 | IF( ht_0(ji,jj) < 0._wp .AND. ssmask(ji,jj) == 1._wp ) THEN |
---|
[14139] | 164 | CALL ctl_stop( 'dom_init : ht_0 must be positive at potentially wet points' ) |
---|
[14053] | 165 | ENDIF |
---|
| 166 | END_2D |
---|
| 167 | ENDIF |
---|
| 168 | ! |
---|
| 169 | ! !== initialisation of time varying coordinate ==! |
---|
| 170 | ! |
---|
| 171 | ! != ssh initialization |
---|
[14139] | 172 | ! |
---|
[14255] | 173 | IF( l_SAS ) THEN !* No ocean dynamics calculation : set to 0 |
---|
[14139] | 174 | ssh(:,:,:) = 0._wp |
---|
[14125] | 175 | #if defined key_agrif |
---|
[14139] | 176 | ELSEIF( .NOT.Agrif_root() .AND. & |
---|
| 177 | & ln_init_chfrpar ) THEN !* Interpolate initial ssh from parent |
---|
[14171] | 178 | CALL Agrif_istate_ssh( Kbb, Kmm, Kaa ) |
---|
[14125] | 179 | #endif |
---|
[14139] | 180 | ELSE !* Read in restart file or set by user |
---|
| 181 | CALL rst_read_ssh( Kbb, Kmm, Kaa ) |
---|
[14053] | 182 | ENDIF |
---|
[14139] | 183 | ! |
---|
[13237] | 184 | #if defined key_qco |
---|
[14053] | 185 | ! != Quasi-Euerian coordinate case |
---|
[13237] | 186 | ! |
---|
| 187 | IF( .NOT.l_offline ) CALL dom_qco_init( Kbb, Kmm, Kaa ) |
---|
[14139] | 188 | #elif defined key_linssh |
---|
| 189 | ! != Fix in time : key_linssh case, set through domzgr_substitute.h90 |
---|
[13237] | 190 | #else |
---|
[1601] | 191 | ! |
---|
[14053] | 192 | IF( ln_linssh ) THEN != Fix in time : set to the reference one for all |
---|
[13458] | 193 | ! |
---|
[13237] | 194 | DO jt = 1, jpt ! depth of t- and w-grid-points |
---|
| 195 | gdept(:,:,:,jt) = gdept_0(:,:,:) |
---|
| 196 | gdepw(:,:,:,jt) = gdepw_0(:,:,:) |
---|
| 197 | END DO |
---|
| 198 | gde3w(:,:,:) = gde3w_0(:,:,:) ! = gdept as the sum of e3t |
---|
[6140] | 199 | ! |
---|
[13237] | 200 | DO jt = 1, jpt ! vertical scale factors |
---|
[14053] | 201 | e3t (:,:,:,jt) = e3t_0(:,:,:) |
---|
| 202 | e3u (:,:,:,jt) = e3u_0(:,:,:) |
---|
| 203 | e3v (:,:,:,jt) = e3v_0(:,:,:) |
---|
| 204 | e3w (:,:,:,jt) = e3w_0(:,:,:) |
---|
[13237] | 205 | e3uw(:,:,:,jt) = e3uw_0(:,:,:) |
---|
| 206 | e3vw(:,:,:,jt) = e3vw_0(:,:,:) |
---|
| 207 | END DO |
---|
[14053] | 208 | e3f (:,:,:) = e3f_0(:,:,:) |
---|
[6140] | 209 | ! |
---|
[13237] | 210 | DO jt = 1, jpt ! water column thickness and its inverse |
---|
[14053] | 211 | hu(:,:,jt) = hu_0(:,:) |
---|
| 212 | hv(:,:,jt) = hv_0(:,:) |
---|
[13237] | 213 | r1_hu(:,:,jt) = r1_hu_0(:,:) |
---|
| 214 | r1_hv(:,:,jt) = r1_hv_0(:,:) |
---|
| 215 | END DO |
---|
[14053] | 216 | ht (:,:) = ht_0(:,:) |
---|
[6140] | 217 | ! |
---|
[14053] | 218 | ELSE != Time varying : initialize before/now/after variables |
---|
[6140] | 219 | ! |
---|
[13458] | 220 | IF( .NOT.l_offline ) CALL dom_vvl_init( Kbb, Kmm, Kaa ) |
---|
[6140] | 221 | ! |
---|
| 222 | ENDIF |
---|
[13237] | 223 | #endif |
---|
| 224 | |
---|
[2528] | 225 | ! |
---|
[13216] | 226 | |
---|
| 227 | #if defined key_agrif |
---|
| 228 | IF( .NOT. Agrif_Root() ) CALL Agrif_Init_Domain( Kbb, Kmm, Kaa ) |
---|
| 229 | #endif |
---|
[12377] | 230 | IF( ln_meshmask ) CALL dom_wri ! Create a domain file |
---|
| 231 | IF( .NOT.ln_rstart ) CALL dom_ctl ! Domain control |
---|
[1438] | 232 | ! |
---|
[12377] | 233 | IF( ln_write_cfg ) CALL cfg_write ! create the configuration file |
---|
[9169] | 234 | ! |
---|
[7646] | 235 | IF(lwp) THEN |
---|
| 236 | WRITE(numout,*) |
---|
[9169] | 237 | WRITE(numout,*) 'dom_init : ==>>> END of domain initialization' |
---|
| 238 | WRITE(numout,*) '~~~~~~~~' |
---|
[14072] | 239 | WRITE(numout,*) |
---|
[7646] | 240 | ENDIF |
---|
| 241 | ! |
---|
[3] | 242 | END SUBROUTINE dom_init |
---|
| 243 | |
---|
| 244 | |
---|
[7646] | 245 | SUBROUTINE dom_glo |
---|
| 246 | !!---------------------------------------------------------------------- |
---|
| 247 | !! *** ROUTINE dom_glo *** |
---|
| 248 | !! |
---|
| 249 | !! ** Purpose : initialization of global domain <--> local domain indices |
---|
| 250 | !! |
---|
[14072] | 251 | !! ** Method : |
---|
[7646] | 252 | !! |
---|
[13286] | 253 | !! ** Action : - mig , mjg : local domain indices ==> global domain, including halos, indices |
---|
| 254 | !! - mig0, mjg0: local domain indices ==> global domain, excluding halos, indices |
---|
[7646] | 255 | !! - mi0 , mi1 : global domain indices ==> local domain indices |
---|
[13286] | 256 | !! - mj0 , mj1 (if global point not in the local domain ==> mi0>mi1 and/or mj0>mj1) |
---|
[7646] | 257 | !!---------------------------------------------------------------------- |
---|
| 258 | INTEGER :: ji, jj ! dummy loop argument |
---|
| 259 | !!---------------------------------------------------------------------- |
---|
| 260 | ! |
---|
[13458] | 261 | DO ji = 1, jpi ! local domain indices ==> global domain indices, including halos |
---|
[7646] | 262 | mig(ji) = ji + nimpp - 1 |
---|
| 263 | END DO |
---|
| 264 | DO jj = 1, jpj |
---|
| 265 | mjg(jj) = jj + njmpp - 1 |
---|
| 266 | END DO |
---|
[13458] | 267 | ! ! local domain indices ==> global domain indices, excluding halos |
---|
[13286] | 268 | ! |
---|
| 269 | mig0(:) = mig(:) - nn_hls |
---|
[14072] | 270 | mjg0(:) = mjg(:) - nn_hls |
---|
[13286] | 271 | ! ! global domain, including halos, indices ==> local domain indices |
---|
[14072] | 272 | ! ! (return (m.0,m.1)=(1,0) if data domain gridpoint is to the west/south of the |
---|
| 273 | ! ! local domain, or (m.0,m.1)=(jp.+1,jp.) to the east/north of local domain. |
---|
[7646] | 274 | DO ji = 1, jpiglo |
---|
| 275 | mi0(ji) = MAX( 1 , MIN( ji - nimpp + 1, jpi+1 ) ) |
---|
| 276 | mi1(ji) = MAX( 0 , MIN( ji - nimpp + 1, jpi ) ) |
---|
| 277 | END DO |
---|
| 278 | DO jj = 1, jpjglo |
---|
| 279 | mj0(jj) = MAX( 1 , MIN( jj - njmpp + 1, jpj+1 ) ) |
---|
| 280 | mj1(jj) = MAX( 0 , MIN( jj - njmpp + 1, jpj ) ) |
---|
| 281 | END DO |
---|
| 282 | IF(lwp) THEN ! control print |
---|
| 283 | WRITE(numout,*) |
---|
| 284 | WRITE(numout,*) 'dom_glo : domain: global <<==>> local ' |
---|
| 285 | WRITE(numout,*) '~~~~~~~ ' |
---|
| 286 | WRITE(numout,*) ' global domain: jpiglo = ', jpiglo, ' jpjglo = ', jpjglo, ' jpkglo = ', jpkglo |
---|
| 287 | WRITE(numout,*) ' local domain: jpi = ', jpi , ' jpj = ', jpj , ' jpk = ', jpk |
---|
| 288 | WRITE(numout,*) |
---|
| 289 | ENDIF |
---|
| 290 | ! |
---|
| 291 | END SUBROUTINE dom_glo |
---|
| 292 | |
---|
| 293 | |
---|
[3] | 294 | SUBROUTINE dom_nam |
---|
| 295 | !!---------------------------------------------------------------------- |
---|
| 296 | !! *** ROUTINE dom_nam *** |
---|
[14072] | 297 | !! |
---|
[3] | 298 | !! ** Purpose : read domaine namelists and print the variables. |
---|
| 299 | !! |
---|
| 300 | !! ** input : - namrun namelist |
---|
| 301 | !! - namdom namelist |
---|
[13982] | 302 | !! - namtile namelist |
---|
[2528] | 303 | !! - namnc4 namelist ! "key_netcdf4" only |
---|
[3] | 304 | !!---------------------------------------------------------------------- |
---|
| 305 | USE ioipsl |
---|
[9169] | 306 | !! |
---|
[14053] | 307 | INTEGER :: ios ! Local integer |
---|
| 308 | REAL(wp):: zrdt |
---|
| 309 | !!---------------------------------------------------------------------- |
---|
[9169] | 310 | ! |
---|
[6140] | 311 | NAMELIST/namrun/ cn_ocerst_indir, cn_ocerst_outdir, nn_stocklist, ln_rst_list, & |
---|
[7646] | 312 | & nn_no , cn_exp , cn_ocerst_in, cn_ocerst_out, ln_rstart , nn_rstctl , & |
---|
[6140] | 313 | & nn_it000, nn_itend , nn_date0 , nn_time0 , nn_leapy , nn_istate , & |
---|
[12489] | 314 | & nn_stock, nn_write , ln_mskland , ln_clobber , nn_chunksz, ln_1st_euler , & |
---|
[12377] | 315 | & ln_cfmeta, ln_xios_read, nn_wxios |
---|
[15006] | 316 | NAMELIST/namdom/ ln_linssh, rn_Dt, rn_atfp, ln_crs, ln_c1d, ln_meshmask |
---|
[13982] | 317 | NAMELIST/namtile/ ln_tile, nn_ltile_i, nn_ltile_j |
---|
[2528] | 318 | #if defined key_netcdf4 |
---|
| 319 | NAMELIST/namnc4/ nn_nchunks_i, nn_nchunks_j, nn_nchunks_k, ln_nc4zip |
---|
| 320 | #endif |
---|
[3] | 321 | !!---------------------------------------------------------------------- |
---|
[7646] | 322 | ! |
---|
[9169] | 323 | IF(lwp) THEN |
---|
| 324 | WRITE(numout,*) |
---|
[9190] | 325 | WRITE(numout,*) 'dom_nam : domain initialization through namelist read' |
---|
[9169] | 326 | WRITE(numout,*) '~~~~~~~ ' |
---|
| 327 | ENDIF |
---|
| 328 | ! |
---|
[14053] | 329 | ! !=======================! |
---|
| 330 | ! !== namelist namdom ==! |
---|
| 331 | ! !=======================! |
---|
[9367] | 332 | ! |
---|
[14053] | 333 | READ ( numnam_ref, namdom, IOSTAT = ios, ERR = 903) |
---|
| 334 | 903 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namdom in reference namelist' ) |
---|
| 335 | READ ( numnam_cfg, namdom, IOSTAT = ios, ERR = 904 ) |
---|
| 336 | 904 IF( ios > 0 ) CALL ctl_nam ( ios , 'namdom in configuration namelist' ) |
---|
| 337 | IF(lwm) WRITE( numond, namdom ) |
---|
| 338 | ! |
---|
[14139] | 339 | #if defined key_linssh |
---|
| 340 | ln_linssh = lk_linssh ! overwrite ln_linssh with the logical associated with key_linssh |
---|
| 341 | #endif |
---|
| 342 | ! |
---|
[14053] | 343 | #if defined key_agrif |
---|
| 344 | IF( .NOT. Agrif_Root() ) THEN ! AGRIF child, subdivide the Parent timestep |
---|
| 345 | rn_Dt = Agrif_Parent (rn_Dt ) / Agrif_Rhot() |
---|
| 346 | ENDIF |
---|
| 347 | #endif |
---|
| 348 | ! |
---|
| 349 | IF(lwp) THEN |
---|
| 350 | WRITE(numout,*) |
---|
| 351 | WRITE(numout,*) ' Namelist : namdom --- space & time domain' |
---|
| 352 | WRITE(numout,*) ' linear free surface (=T) ln_linssh = ', ln_linssh |
---|
| 353 | WRITE(numout,*) ' create mesh/mask file ln_meshmask = ', ln_meshmask |
---|
| 354 | WRITE(numout,*) ' ocean time step rn_Dt = ', rn_Dt |
---|
| 355 | WRITE(numout,*) ' asselin time filter parameter rn_atfp = ', rn_atfp |
---|
| 356 | WRITE(numout,*) ' online coarsening of dynamical fields ln_crs = ', ln_crs |
---|
[15006] | 357 | WRITE(numout,*) ' single column domain (1x1pt) ln_c1d = ', ln_c1d |
---|
[14053] | 358 | ENDIF |
---|
| 359 | ! |
---|
| 360 | ! set current model timestep rDt = 2*rn_Dt if MLF or rDt = rn_Dt if RK3 |
---|
| 361 | rDt = 2._wp * rn_Dt |
---|
| 362 | r1_Dt = 1._wp / rDt |
---|
| 363 | ! |
---|
| 364 | IF( l_SAS .AND. .NOT.ln_linssh ) THEN |
---|
| 365 | CALL ctl_warn( 'SAS requires linear ssh : force ln_linssh = T' ) |
---|
| 366 | ln_linssh = .TRUE. |
---|
| 367 | ENDIF |
---|
| 368 | ! |
---|
| 369 | #if defined key_qco |
---|
[14139] | 370 | IF( ln_linssh ) CALL ctl_stop( 'STOP','domain: key_qco and ln_linssh=T or key_linssh are incompatible' ) |
---|
[14053] | 371 | #endif |
---|
| 372 | ! |
---|
| 373 | ! !=======================! |
---|
| 374 | ! !== namelist namrun ==! |
---|
| 375 | ! !=======================! |
---|
| 376 | ! |
---|
[4147] | 377 | READ ( numnam_ref, namrun, IOSTAT = ios, ERR = 901) |
---|
[11536] | 378 | 901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namrun in reference namelist' ) |
---|
[4147] | 379 | READ ( numnam_cfg, namrun, IOSTAT = ios, ERR = 902 ) |
---|
[11536] | 380 | 902 IF( ios > 0 ) CALL ctl_nam ( ios , 'namrun in configuration namelist' ) |
---|
[4624] | 381 | IF(lwm) WRITE ( numond, namrun ) |
---|
[13216] | 382 | |
---|
| 383 | #if defined key_agrif |
---|
| 384 | IF( .NOT. Agrif_Root() ) THEN |
---|
| 385 | nn_it000 = (Agrif_Parent(nn_it000)-1)*Agrif_IRhot() + 1 |
---|
| 386 | nn_itend = Agrif_Parent(nn_itend) *Agrif_IRhot() |
---|
| 387 | ENDIF |
---|
| 388 | #endif |
---|
[1601] | 389 | ! |
---|
| 390 | IF(lwp) THEN ! control print |
---|
[9190] | 391 | WRITE(numout,*) ' Namelist : namrun --- run parameters' |
---|
[9490] | 392 | WRITE(numout,*) ' Assimilation cycle nn_no = ', nn_no |
---|
[9169] | 393 | WRITE(numout,*) ' experiment name for output cn_exp = ', TRIM( cn_exp ) |
---|
| 394 | WRITE(numout,*) ' file prefix restart input cn_ocerst_in = ', TRIM( cn_ocerst_in ) |
---|
| 395 | WRITE(numout,*) ' restart input directory cn_ocerst_indir = ', TRIM( cn_ocerst_indir ) |
---|
| 396 | WRITE(numout,*) ' file prefix restart output cn_ocerst_out = ', TRIM( cn_ocerst_out ) |
---|
| 397 | WRITE(numout,*) ' restart output directory cn_ocerst_outdir= ', TRIM( cn_ocerst_outdir ) |
---|
| 398 | WRITE(numout,*) ' restart logical ln_rstart = ', ln_rstart |
---|
[12489] | 399 | WRITE(numout,*) ' start with forward time step ln_1st_euler = ', ln_1st_euler |
---|
[9169] | 400 | WRITE(numout,*) ' control of time step nn_rstctl = ', nn_rstctl |
---|
| 401 | WRITE(numout,*) ' number of the first time step nn_it000 = ', nn_it000 |
---|
| 402 | WRITE(numout,*) ' number of the last time step nn_itend = ', nn_itend |
---|
| 403 | WRITE(numout,*) ' initial calendar date aammjj nn_date0 = ', nn_date0 |
---|
| 404 | WRITE(numout,*) ' initial time of day in hhmm nn_time0 = ', nn_time0 |
---|
| 405 | WRITE(numout,*) ' leap year calendar (0/1) nn_leapy = ', nn_leapy |
---|
| 406 | WRITE(numout,*) ' initial state output nn_istate = ', nn_istate |
---|
[5341] | 407 | IF( ln_rst_list ) THEN |
---|
[9169] | 408 | WRITE(numout,*) ' list of restart dump times nn_stocklist =', nn_stocklist |
---|
[5341] | 409 | ELSE |
---|
[9169] | 410 | WRITE(numout,*) ' frequency of restart file nn_stock = ', nn_stock |
---|
[5341] | 411 | ENDIF |
---|
[14239] | 412 | #if ! defined key_xios |
---|
[9169] | 413 | WRITE(numout,*) ' frequency of output file nn_write = ', nn_write |
---|
[11536] | 414 | #endif |
---|
[9169] | 415 | WRITE(numout,*) ' mask land points ln_mskland = ', ln_mskland |
---|
| 416 | WRITE(numout,*) ' additional CF standard metadata ln_cfmeta = ', ln_cfmeta |
---|
| 417 | WRITE(numout,*) ' overwrite an existing file ln_clobber = ', ln_clobber |
---|
| 418 | WRITE(numout,*) ' NetCDF chunksize (bytes) nn_chunksz = ', nn_chunksz |
---|
[9367] | 419 | IF( TRIM(Agrif_CFixed()) == '0' ) THEN |
---|
| 420 | WRITE(numout,*) ' READ restart for a single file using XIOS ln_xios_read =', ln_xios_read |
---|
| 421 | WRITE(numout,*) ' Write restart using XIOS nn_wxios = ', nn_wxios |
---|
| 422 | ELSE |
---|
| 423 | WRITE(numout,*) " AGRIF: nn_wxios will be ingored. See setting for parent" |
---|
| 424 | WRITE(numout,*) " AGRIF: ln_xios_read will be ingored. See setting for parent" |
---|
| 425 | ENDIF |
---|
[3] | 426 | ENDIF |
---|
| 427 | |
---|
[9490] | 428 | cexper = cn_exp ! conversion DOCTOR names into model names (this should disappear soon) |
---|
[1601] | 429 | nrstdt = nn_rstctl |
---|
| 430 | nit000 = nn_it000 |
---|
| 431 | nitend = nn_itend |
---|
| 432 | ndate0 = nn_date0 |
---|
| 433 | nleapy = nn_leapy |
---|
| 434 | ninist = nn_istate |
---|
[14053] | 435 | ! |
---|
| 436 | ! !== Set parameters for restart reading using xIOS ==! |
---|
| 437 | ! |
---|
| 438 | IF( TRIM(Agrif_CFixed()) == '0' ) THEN |
---|
| 439 | lrxios = ln_xios_read .AND. ln_rstart |
---|
| 440 | IF( nn_wxios > 0 ) lwxios = .TRUE. !* set output file type for XIOS based on NEMO namelist |
---|
| 441 | nxioso = nn_wxios |
---|
| 442 | ENDIF |
---|
| 443 | ! !== Check consistency between ln_rstart and ln_1st_euler ==! (i.e. set l_1st_euler) |
---|
[12489] | 444 | l_1st_euler = ln_1st_euler |
---|
[14053] | 445 | ! |
---|
| 446 | IF( ln_rstart ) THEN !* Restart case |
---|
| 447 | ! |
---|
| 448 | IF(lwp) WRITE(numout,*) |
---|
| 449 | IF(lwp) WRITE(numout,*) ' open the restart file' |
---|
| 450 | CALL rst_read_open !- Open the restart file |
---|
| 451 | ! |
---|
| 452 | IF( iom_varid( numror, 'rdt', ldstop = .FALSE. ) > 0 ) THEN !- Check time-step consistency and force Euler restart if changed |
---|
| 453 | CALL iom_get( numror, 'rdt', zrdt ) |
---|
| 454 | IF( zrdt /= rn_Dt ) THEN |
---|
| 455 | IF(lwp) WRITE( numout,*) |
---|
| 456 | IF(lwp) WRITE( numout,*) ' rn_Dt = ', rn_Dt,' not equal to the READ one rdt = ', zrdt |
---|
| 457 | IF(lwp) WRITE( numout,*) |
---|
| 458 | IF(lwp) WRITE( numout,*) ' ==>>> forced euler first time-step' |
---|
| 459 | l_1st_euler = .TRUE. |
---|
| 460 | ENDIF |
---|
| 461 | ENDIF |
---|
| 462 | ! |
---|
| 463 | IF( .NOT.l_SAS .AND. iom_varid( numror, 'sshb', ldstop = .FALSE. ) <= 0 ) THEN !- Check absence of one of the Kbb field (here sshb) |
---|
[14072] | 464 | ! ! (any Kbb field is missing ==> all Kbb fields are missing) |
---|
[14053] | 465 | IF( .NOT.l_1st_euler ) THEN |
---|
| 466 | CALL ctl_warn('dom_nam : ssh at Kbb not found in restart files ', & |
---|
| 467 | & 'l_1st_euler forced to .true. and ' , & |
---|
| 468 | & 'ssh(Kbb) = ssh(Kmm) ' ) |
---|
| 469 | l_1st_euler = .TRUE. |
---|
| 470 | ENDIF |
---|
| 471 | ENDIF |
---|
| 472 | ELSEIF( .NOT.l_1st_euler ) THEN !* Initialization case |
---|
[14072] | 473 | IF(lwp) WRITE(numout,*) |
---|
[9169] | 474 | IF(lwp) WRITE(numout,*)' ==>>> Start from rest (ln_rstart=F)' |
---|
[14072] | 475 | IF(lwp) WRITE(numout,*)' an Euler initial time step is used : l_1st_euler is forced to .true. ' |
---|
[14053] | 476 | l_1st_euler = .TRUE. |
---|
[4370] | 477 | ENDIF |
---|
[14053] | 478 | ! |
---|
| 479 | ! !== control of output frequency ==! |
---|
| 480 | ! |
---|
| 481 | IF( .NOT. ln_rst_list ) THEN ! we use nn_stock |
---|
[11536] | 482 | IF( nn_stock == -1 ) CALL ctl_warn( 'nn_stock = -1 --> no restart will be done' ) |
---|
| 483 | IF( nn_stock == 0 .OR. nn_stock > nitend ) THEN |
---|
| 484 | WRITE(ctmp1,*) 'nn_stock = ', nn_stock, ' it is forced to ', nitend |
---|
| 485 | CALL ctl_warn( ctmp1 ) |
---|
| 486 | nn_stock = nitend |
---|
| 487 | ENDIF |
---|
[3] | 488 | ENDIF |
---|
[14239] | 489 | #if ! defined key_xios |
---|
[11536] | 490 | IF( nn_write == -1 ) CALL ctl_warn( 'nn_write = -1 --> no output files will be done' ) |
---|
| 491 | IF ( nn_write == 0 ) THEN |
---|
| 492 | WRITE(ctmp1,*) 'nn_write = ', nn_write, ' it is forced to ', nitend |
---|
[783] | 493 | CALL ctl_warn( ctmp1 ) |
---|
[11536] | 494 | nn_write = nitend |
---|
[3] | 495 | ENDIF |
---|
[11536] | 496 | #endif |
---|
[3] | 497 | |
---|
[1601] | 498 | IF( Agrif_Root() ) THEN |
---|
[13286] | 499 | IF(lwp) WRITE(numout,*) |
---|
[14053] | 500 | SELECT CASE ( nleapy ) !== Choose calendar for IOIPSL ==! |
---|
[14072] | 501 | CASE ( 1 ) |
---|
[13286] | 502 | CALL ioconf_calendar('gregorian') |
---|
| 503 | IF(lwp) WRITE(numout,*) ' ==>>> The IOIPSL calendar is "gregorian", i.e. leap year' |
---|
| 504 | CASE ( 0 ) |
---|
| 505 | CALL ioconf_calendar('noleap') |
---|
| 506 | IF(lwp) WRITE(numout,*) ' ==>>> The IOIPSL calendar is "noleap", i.e. no leap year' |
---|
| 507 | CASE ( 30 ) |
---|
| 508 | CALL ioconf_calendar('360d') |
---|
| 509 | IF(lwp) WRITE(numout,*) ' ==>>> The IOIPSL calendar is "360d", i.e. 360 days in a year' |
---|
| 510 | END SELECT |
---|
[1601] | 511 | ENDIF |
---|
[5836] | 512 | ! |
---|
[14053] | 513 | ! !========================! |
---|
| 514 | ! !== namelist namtile ==! |
---|
| 515 | ! !========================! |
---|
[13216] | 516 | ! |
---|
[13982] | 517 | READ ( numnam_ref, namtile, IOSTAT = ios, ERR = 905 ) |
---|
| 518 | 905 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtile in reference namelist' ) |
---|
| 519 | READ ( numnam_cfg, namtile, IOSTAT = ios, ERR = 906 ) |
---|
| 520 | 906 IF( ios > 0 ) CALL ctl_nam ( ios , 'namtile in configuration namelist' ) |
---|
| 521 | IF(lwm) WRITE( numond, namtile ) |
---|
| 522 | |
---|
| 523 | IF(lwp) THEN |
---|
| 524 | WRITE(numout,*) |
---|
| 525 | WRITE(numout,*) ' Namelist : namtile --- Domain tiling decomposition' |
---|
| 526 | WRITE(numout,*) ' Tiling (T) or not (F) ln_tile = ', ln_tile |
---|
| 527 | WRITE(numout,*) ' Length of tile in i nn_ltile_i = ', nn_ltile_i |
---|
| 528 | WRITE(numout,*) ' Length of tile in j nn_ltile_j = ', nn_ltile_j |
---|
| 529 | WRITE(numout,*) |
---|
| 530 | IF( ln_tile ) THEN |
---|
| 531 | WRITE(numout,*) ' The domain will be decomposed into tiles of size', nn_ltile_i, 'x', nn_ltile_j |
---|
| 532 | ELSE |
---|
| 533 | WRITE(numout,*) ' Domain tiling will NOT be used' |
---|
| 534 | ENDIF |
---|
| 535 | ENDIF |
---|
[14053] | 536 | ! |
---|
[2528] | 537 | #if defined key_netcdf4 |
---|
[14053] | 538 | ! !=======================! |
---|
| 539 | ! !== namelist namnc4 ==! NetCDF 4 case ("key_netcdf4" defined) |
---|
| 540 | ! !=======================! |
---|
| 541 | ! |
---|
[4147] | 542 | READ ( numnam_ref, namnc4, IOSTAT = ios, ERR = 907) |
---|
[11536] | 543 | 907 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namnc4 in reference namelist' ) |
---|
[4147] | 544 | READ ( numnam_cfg, namnc4, IOSTAT = ios, ERR = 908 ) |
---|
[11536] | 545 | 908 IF( ios > 0 ) CALL ctl_nam ( ios , 'namnc4 in configuration namelist' ) |
---|
[4624] | 546 | IF(lwm) WRITE( numond, namnc4 ) |
---|
[4147] | 547 | |
---|
[2528] | 548 | IF(lwp) THEN ! control print |
---|
| 549 | WRITE(numout,*) |
---|
[14053] | 550 | WRITE(numout,*) ' Namelist namnc4 - Netcdf4 chunking parameters ("key_netcdf4" defined)' |
---|
[9169] | 551 | WRITE(numout,*) ' number of chunks in i-dimension nn_nchunks_i = ', nn_nchunks_i |
---|
| 552 | WRITE(numout,*) ' number of chunks in j-dimension nn_nchunks_j = ', nn_nchunks_j |
---|
| 553 | WRITE(numout,*) ' number of chunks in k-dimension nn_nchunks_k = ', nn_nchunks_k |
---|
| 554 | WRITE(numout,*) ' apply netcdf4/hdf5 chunking & compression ln_nc4zip = ', ln_nc4zip |
---|
[2528] | 555 | ENDIF |
---|
[1601] | 556 | |
---|
[2528] | 557 | ! Put the netcdf4 settings into a simple structure (snc4set, defined in in_out_manager module) |
---|
| 558 | ! Note the chunk size in the unlimited (time) dimension will be fixed at 1 |
---|
| 559 | snc4set%ni = nn_nchunks_i |
---|
| 560 | snc4set%nj = nn_nchunks_j |
---|
| 561 | snc4set%nk = nn_nchunks_k |
---|
| 562 | snc4set%luse = ln_nc4zip |
---|
| 563 | #else |
---|
| 564 | snc4set%luse = .FALSE. ! No NetCDF 4 case |
---|
| 565 | #endif |
---|
[1438] | 566 | ! |
---|
[3] | 567 | END SUBROUTINE dom_nam |
---|
| 568 | |
---|
| 569 | |
---|
| 570 | SUBROUTINE dom_ctl |
---|
| 571 | !!---------------------------------------------------------------------- |
---|
| 572 | !! *** ROUTINE dom_ctl *** |
---|
| 573 | !! |
---|
| 574 | !! ** Purpose : Domain control. |
---|
| 575 | !! |
---|
| 576 | !! ** Method : compute and print extrema of masked scale factors |
---|
| 577 | !!---------------------------------------------------------------------- |
---|
[13286] | 578 | LOGICAL, DIMENSION(jpi,jpj) :: llmsk |
---|
| 579 | INTEGER, DIMENSION(2) :: imil, imip, imi1, imi2, imal, imap, ima1, ima2 |
---|
| 580 | REAL(wp) :: zglmin, zglmax, zgpmin, zgpmax, ze1min, ze1max, ze2min, ze2max |
---|
[3] | 581 | !!---------------------------------------------------------------------- |
---|
[1601] | 582 | ! |
---|
[13458] | 583 | llmsk = tmask_h(:,:) == 1._wp |
---|
[13286] | 584 | ! |
---|
[13458] | 585 | CALL mpp_minloc( 'domain', glamt(:,:), llmsk, zglmin, imil ) |
---|
| 586 | CALL mpp_minloc( 'domain', gphit(:,:), llmsk, zgpmin, imip ) |
---|
| 587 | CALL mpp_minloc( 'domain', e1t(:,:), llmsk, ze1min, imi1 ) |
---|
| 588 | CALL mpp_minloc( 'domain', e2t(:,:), llmsk, ze2min, imi2 ) |
---|
| 589 | CALL mpp_maxloc( 'domain', glamt(:,:), llmsk, zglmax, imal ) |
---|
| 590 | CALL mpp_maxloc( 'domain', gphit(:,:), llmsk, zgpmax, imap ) |
---|
| 591 | CALL mpp_maxloc( 'domain', e1t(:,:), llmsk, ze1max, ima1 ) |
---|
| 592 | CALL mpp_maxloc( 'domain', e2t(:,:), llmsk, ze2max, ima2 ) |
---|
| 593 | ! |
---|
[3] | 594 | IF(lwp) THEN |
---|
[1601] | 595 | WRITE(numout,*) |
---|
| 596 | WRITE(numout,*) 'dom_ctl : extrema of the masked scale factors' |
---|
| 597 | WRITE(numout,*) '~~~~~~~' |
---|
[13286] | 598 | WRITE(numout,"(14x,'glamt mini: ',1f10.2,' at i = ',i5,' j= ',i5)") zglmin, imil(1), imil(2) |
---|
| 599 | WRITE(numout,"(14x,'glamt maxi: ',1f10.2,' at i = ',i5,' j= ',i5)") zglmax, imal(1), imal(2) |
---|
| 600 | WRITE(numout,"(14x,'gphit mini: ',1f10.2,' at i = ',i5,' j= ',i5)") zgpmin, imip(1), imip(2) |
---|
| 601 | WRITE(numout,"(14x,'gphit maxi: ',1f10.2,' at i = ',i5,' j= ',i5)") zgpmax, imap(1), imap(2) |
---|
| 602 | WRITE(numout,"(14x,' e1t mini: ',1f10.2,' at i = ',i5,' j= ',i5)") ze1min, imi1(1), imi1(2) |
---|
| 603 | WRITE(numout,"(14x,' e1t maxi: ',1f10.2,' at i = ',i5,' j= ',i5)") ze1max, ima1(1), ima1(2) |
---|
| 604 | WRITE(numout,"(14x,' e2t mini: ',1f10.2,' at i = ',i5,' j= ',i5)") ze2min, imi2(1), imi2(2) |
---|
| 605 | WRITE(numout,"(14x,' e2t maxi: ',1f10.2,' at i = ',i5,' j= ',i5)") ze2max, ima2(1), ima2(2) |
---|
[3] | 606 | ENDIF |
---|
[1438] | 607 | ! |
---|
[3] | 608 | END SUBROUTINE dom_ctl |
---|
| 609 | |
---|
[5836] | 610 | |
---|
[14433] | 611 | SUBROUTINE domain_cfg( cd_cfg, kk_cfg, kpi, kpj, kpk, ldIperio, ldJperio, ldNFold, cdNFtype ) |
---|
[3680] | 612 | !!---------------------------------------------------------------------- |
---|
[14053] | 613 | !! *** ROUTINE domain_cfg *** |
---|
[14072] | 614 | !! |
---|
[7646] | 615 | !! ** Purpose : read the domain size in domain configuration file |
---|
[3680] | 616 | !! |
---|
[9169] | 617 | !! ** Method : read the cn_domcfg NetCDF file |
---|
[3680] | 618 | !!---------------------------------------------------------------------- |
---|
[14433] | 619 | CHARACTER(len=*), INTENT(out) :: cd_cfg ! configuration name |
---|
| 620 | INTEGER , INTENT(out) :: kk_cfg ! configuration resolution |
---|
| 621 | INTEGER , INTENT(out) :: kpi, kpj, kpk ! global domain sizes |
---|
| 622 | LOGICAL , INTENT(out) :: ldIperio, ldJperio ! i- and j- periodicity |
---|
| 623 | LOGICAL , INTENT(out) :: ldNFold ! North pole folding |
---|
| 624 | CHARACTER(len=1), INTENT(out) :: cdNFtype ! Folding type: T or F |
---|
[7646] | 625 | ! |
---|
[14433] | 626 | CHARACTER(len=7) :: catt ! 'T', 'F', '-' or 'UNKNOWN' |
---|
| 627 | INTEGER :: inum, iperio, iatt ! local integer |
---|
[7646] | 628 | REAL(wp) :: zorca_res ! local scalars |
---|
[11536] | 629 | REAL(wp) :: zperio ! - - |
---|
| 630 | INTEGER, DIMENSION(4) :: idvar, idimsz ! size of dimensions |
---|
[3680] | 631 | !!---------------------------------------------------------------------- |
---|
[5836] | 632 | ! |
---|
[11536] | 633 | IF(lwp) THEN |
---|
| 634 | WRITE(numout,*) ' ' |
---|
| 635 | WRITE(numout,*) 'domain_cfg : domain size read in ', TRIM( cn_domcfg ), ' file' |
---|
| 636 | WRITE(numout,*) '~~~~~~~~~~ ' |
---|
| 637 | ENDIF |
---|
[5836] | 638 | ! |
---|
[7646] | 639 | CALL iom_open( cn_domcfg, inum ) |
---|
[5836] | 640 | ! |
---|
[14433] | 641 | CALL iom_getatt( inum, 'CfgName', cd_cfg ) ! returns 'UNKNOWN' if not found |
---|
| 642 | CALL iom_getatt( inum, 'CfgIndex', kk_cfg ) ! returns -999 if not found |
---|
| 643 | ! |
---|
| 644 | ! ------- keep compatibility with OLD VERSION... start ------- |
---|
| 645 | IF( cd_cfg == 'UNKNOWN' .AND. kk_cfg == -999 ) THEN |
---|
| 646 | IF( iom_varid( inum, 'ORCA' , ldstop = .FALSE. ) > 0 .AND. & |
---|
| 647 | & iom_varid( inum, 'ORCA_index' , ldstop = .FALSE. ) > 0 ) THEN |
---|
| 648 | ! |
---|
| 649 | cd_cfg = 'ORCA' |
---|
| 650 | CALL iom_get( inum, 'ORCA_index', zorca_res ) ; kk_cfg = NINT( zorca_res ) |
---|
| 651 | ! |
---|
| 652 | ELSE |
---|
| 653 | CALL iom_getatt( inum, 'cn_cfg', cd_cfg ) ! returns 'UNKNOWN' if not found |
---|
| 654 | CALL iom_getatt( inum, 'nn_cfg', kk_cfg ) ! returns -999 if not found |
---|
[11536] | 655 | ENDIF |
---|
[7646] | 656 | ENDIF |
---|
[14433] | 657 | ! ------- keep compatibility with OLD VERSION... end ------- |
---|
| 658 | ! |
---|
[11536] | 659 | idvar = iom_varid( inum, 'e3t_0', kdimsz = idimsz ) ! use e3t_0, that must exist, to get jp(ijk)glo |
---|
| 660 | kpi = idimsz(1) |
---|
| 661 | kpj = idimsz(2) |
---|
| 662 | kpk = idimsz(3) |
---|
[14433] | 663 | ! |
---|
| 664 | CALL iom_getatt( inum, 'Iperio', iatt ) ; ldIperio = iatt == 1 ! returns -999 if not found -> default = .false. |
---|
| 665 | CALL iom_getatt( inum, 'Jperio', iatt ) ; ldJperio = iatt == 1 ! returns -999 if not found -> default = .false. |
---|
| 666 | CALL iom_getatt( inum, 'NFold', iatt ) ; ldNFold = iatt == 1 ! returns -999 if not found -> default = .false. |
---|
| 667 | CALL iom_getatt( inum, 'NFtype', catt ) ! returns 'UNKNOWN' if not found |
---|
| 668 | IF( LEN_TRIM(catt) == 1 ) THEN ; cdNFtype = TRIM(catt) |
---|
| 669 | ELSE ; cdNFtype = '-' |
---|
| 670 | ENDIF |
---|
| 671 | ! |
---|
| 672 | ! ------- keep compatibility with OLD VERSION... start ------- |
---|
| 673 | IF( iatt == -999 .AND. catt == 'UNKNOWN' .AND. iom_varid( inum, 'jperio', ldstop = .FALSE. ) > 0 ) THEN |
---|
| 674 | CALL iom_get( inum, 'jperio', zperio ) ; iperio = NINT( zperio ) |
---|
| 675 | ldIperio = iperio == 1 .OR. iperio == 4 .OR. iperio == 6 .OR. iperio == 7 ! i-periodicity |
---|
| 676 | ldJperio = iperio == 2 .OR. iperio == 7 ! j-periodicity |
---|
| 677 | ldNFold = iperio >= 3 .AND. iperio <= 6 ! North pole folding |
---|
| 678 | IF( iperio == 3 .OR. iperio == 4 ) THEN ; cdNFtype = 'T' ! folding at T point |
---|
| 679 | ELSEIF( iperio == 5 .OR. iperio == 6 ) THEN ; cdNFtype = 'F' ! folding at F point |
---|
| 680 | ELSE ; cdNFtype = '-' ! default value |
---|
| 681 | ENDIF |
---|
| 682 | ENDIF |
---|
| 683 | ! ------- keep compatibility with OLD VERSION... end ------- |
---|
| 684 | ! |
---|
[7646] | 685 | CALL iom_close( inum ) |
---|
| 686 | ! |
---|
[11536] | 687 | IF(lwp) THEN |
---|
[14433] | 688 | WRITE(numout,*) ' .' |
---|
| 689 | WRITE(numout,*) ' ==>>> ', TRIM(cn_cfg), ' configuration ' |
---|
| 690 | WRITE(numout,*) ' .' |
---|
| 691 | WRITE(numout,*) ' nn_cfg = ', kk_cfg |
---|
[13286] | 692 | WRITE(numout,*) ' Ni0glo = ', kpi |
---|
| 693 | WRITE(numout,*) ' Nj0glo = ', kpj |
---|
[11536] | 694 | WRITE(numout,*) ' jpkglo = ', kpk |
---|
| 695 | ENDIF |
---|
[14072] | 696 | ! |
---|
[7646] | 697 | END SUBROUTINE domain_cfg |
---|
[14072] | 698 | |
---|
| 699 | |
---|
[7646] | 700 | SUBROUTINE cfg_write |
---|
| 701 | !!---------------------------------------------------------------------- |
---|
| 702 | !! *** ROUTINE cfg_write *** |
---|
[14072] | 703 | !! |
---|
| 704 | !! ** Purpose : Create the "cn_domcfg_out" file, a NetCDF file which |
---|
| 705 | !! contains all the ocean domain informations required to |
---|
[7646] | 706 | !! define an ocean configuration. |
---|
| 707 | !! |
---|
| 708 | !! ** Method : Write in a file all the arrays required to set up an |
---|
| 709 | !! ocean configuration. |
---|
| 710 | !! |
---|
[14072] | 711 | !! ** output file : domcfg_out.nc : domain size, characteristics, horizontal |
---|
[7646] | 712 | !! mesh, Coriolis parameter, and vertical scale factors |
---|
| 713 | !! NB: also contain ORCA family information |
---|
| 714 | !!---------------------------------------------------------------------- |
---|
| 715 | INTEGER :: ji, jj, jk ! dummy loop indices |
---|
| 716 | INTEGER :: inum ! local units |
---|
| 717 | CHARACTER(len=21) :: clnam ! filename (mesh and mask informations) |
---|
| 718 | REAL(wp), DIMENSION(jpi,jpj) :: z2d ! workspace |
---|
| 719 | !!---------------------------------------------------------------------- |
---|
| 720 | ! |
---|
| 721 | IF(lwp) WRITE(numout,*) |
---|
| 722 | IF(lwp) WRITE(numout,*) 'cfg_write : create the domain configuration file (', TRIM(cn_domcfg_out),'.nc)' |
---|
| 723 | IF(lwp) WRITE(numout,*) '~~~~~~~~~' |
---|
| 724 | ! |
---|
| 725 | ! ! ============================= ! |
---|
| 726 | ! ! create 'domcfg_out.nc' file ! |
---|
| 727 | ! ! ============================= ! |
---|
[14072] | 728 | ! |
---|
[9019] | 729 | clnam = cn_domcfg_out ! filename (configuration information) |
---|
[14072] | 730 | CALL iom_open( TRIM(clnam), inum, ldwrt = .TRUE. ) |
---|
[7646] | 731 | ! |
---|
[14433] | 732 | ! !== Configuration specificities ==! |
---|
[5836] | 733 | ! |
---|
[14433] | 734 | CALL iom_putatt( inum, 'CfgName', TRIM(cn_cfg) ) |
---|
| 735 | CALL iom_putatt( inum, 'CfgIndex', nn_cfg ) |
---|
| 736 | ! |
---|
[7646] | 737 | ! !== domain characteristics ==! |
---|
| 738 | ! |
---|
| 739 | ! ! lateral boundary of the global domain |
---|
[14433] | 740 | CALL iom_putatt( inum, 'Iperio', COUNT( (/l_Iperio/) ) ) |
---|
| 741 | CALL iom_putatt( inum, 'Jperio', COUNT( (/l_Jperio/) ) ) |
---|
| 742 | CALL iom_putatt( inum, 'NFold', COUNT( (/l_NFold /) ) ) |
---|
| 743 | CALL iom_putatt( inum, 'NFtype', c_NFtype ) |
---|
| 744 | |
---|
[7646] | 745 | ! ! type of vertical coordinate |
---|
[14433] | 746 | IF(ln_zco) CALL iom_putatt( inum, 'VertCoord', 'zco' ) |
---|
| 747 | IF(ln_zps) CALL iom_putatt( inum, 'VertCoord', 'zps' ) |
---|
| 748 | IF(ln_sco) CALL iom_putatt( inum, 'VertCoord', 'sco' ) |
---|
| 749 | |
---|
[7646] | 750 | ! ! ocean cavities under iceshelves |
---|
[14433] | 751 | CALL iom_putatt( inum, 'IsfCav', COUNT( (/ln_isfcav/) ) ) |
---|
[7646] | 752 | ! |
---|
| 753 | ! !== horizontal mesh ! |
---|
| 754 | ! |
---|
| 755 | CALL iom_rstput( 0, 0, inum, 'glamt', glamt, ktype = jp_r8 ) ! latitude |
---|
| 756 | CALL iom_rstput( 0, 0, inum, 'glamu', glamu, ktype = jp_r8 ) |
---|
| 757 | CALL iom_rstput( 0, 0, inum, 'glamv', glamv, ktype = jp_r8 ) |
---|
| 758 | CALL iom_rstput( 0, 0, inum, 'glamf', glamf, ktype = jp_r8 ) |
---|
[14072] | 759 | ! |
---|
[7646] | 760 | CALL iom_rstput( 0, 0, inum, 'gphit', gphit, ktype = jp_r8 ) ! longitude |
---|
| 761 | CALL iom_rstput( 0, 0, inum, 'gphiu', gphiu, ktype = jp_r8 ) |
---|
| 762 | CALL iom_rstput( 0, 0, inum, 'gphiv', gphiv, ktype = jp_r8 ) |
---|
| 763 | CALL iom_rstput( 0, 0, inum, 'gphif', gphif, ktype = jp_r8 ) |
---|
[14072] | 764 | ! |
---|
[7646] | 765 | CALL iom_rstput( 0, 0, inum, 'e1t' , e1t , ktype = jp_r8 ) ! i-scale factors (e1.) |
---|
| 766 | CALL iom_rstput( 0, 0, inum, 'e1u' , e1u , ktype = jp_r8 ) |
---|
| 767 | CALL iom_rstput( 0, 0, inum, 'e1v' , e1v , ktype = jp_r8 ) |
---|
| 768 | CALL iom_rstput( 0, 0, inum, 'e1f' , e1f , ktype = jp_r8 ) |
---|
| 769 | ! |
---|
| 770 | CALL iom_rstput( 0, 0, inum, 'e2t' , e2t , ktype = jp_r8 ) ! j-scale factors (e2.) |
---|
| 771 | CALL iom_rstput( 0, 0, inum, 'e2u' , e2u , ktype = jp_r8 ) |
---|
| 772 | CALL iom_rstput( 0, 0, inum, 'e2v' , e2v , ktype = jp_r8 ) |
---|
| 773 | CALL iom_rstput( 0, 0, inum, 'e2f' , e2f , ktype = jp_r8 ) |
---|
| 774 | ! |
---|
| 775 | CALL iom_rstput( 0, 0, inum, 'ff_f' , ff_f , ktype = jp_r8 ) ! coriolis factor |
---|
| 776 | CALL iom_rstput( 0, 0, inum, 'ff_t' , ff_t , ktype = jp_r8 ) |
---|
| 777 | ! |
---|
| 778 | ! !== vertical mesh ==! |
---|
[14072] | 779 | ! |
---|
[7646] | 780 | CALL iom_rstput( 0, 0, inum, 'e3t_1d' , e3t_1d , ktype = jp_r8 ) ! reference 1D-coordinate |
---|
| 781 | CALL iom_rstput( 0, 0, inum, 'e3w_1d' , e3w_1d , ktype = jp_r8 ) |
---|
| 782 | ! |
---|
| 783 | CALL iom_rstput( 0, 0, inum, 'e3t_0' , e3t_0 , ktype = jp_r8 ) ! vertical scale factors |
---|
| 784 | CALL iom_rstput( 0, 0, inum, 'e3u_0' , e3u_0 , ktype = jp_r8 ) |
---|
| 785 | CALL iom_rstput( 0, 0, inum, 'e3v_0' , e3v_0 , ktype = jp_r8 ) |
---|
| 786 | CALL iom_rstput( 0, 0, inum, 'e3f_0' , e3f_0 , ktype = jp_r8 ) |
---|
| 787 | CALL iom_rstput( 0, 0, inum, 'e3w_0' , e3w_0 , ktype = jp_r8 ) |
---|
| 788 | CALL iom_rstput( 0, 0, inum, 'e3uw_0' , e3uw_0 , ktype = jp_r8 ) |
---|
| 789 | CALL iom_rstput( 0, 0, inum, 'e3vw_0' , e3vw_0 , ktype = jp_r8 ) |
---|
[14072] | 790 | ! |
---|
[7646] | 791 | ! !== wet top and bottom level ==! (caution: multiplied by ssmask) |
---|
| 792 | ! |
---|
| 793 | CALL iom_rstput( 0, 0, inum, 'top_level' , REAL( mikt, wp )*ssmask , ktype = jp_i4 ) ! nb of ocean T-points (ISF) |
---|
| 794 | CALL iom_rstput( 0, 0, inum, 'bottom_level' , REAL( mbkt, wp )*ssmask , ktype = jp_i4 ) ! nb of ocean T-points |
---|
| 795 | ! |
---|
| 796 | IF( ln_sco ) THEN ! s-coordinate: store grid stiffness ratio (Not required anyway) |
---|
| 797 | CALL dom_stiff( z2d ) |
---|
| 798 | CALL iom_rstput( 0, 0, inum, 'stiffness', z2d ) ! ! Max. grid stiffness ratio |
---|
| 799 | ENDIF |
---|
| 800 | ! |
---|
[9023] | 801 | IF( ll_wd ) THEN ! wetting and drying domain |
---|
[7646] | 802 | CALL iom_rstput( 0, 0, inum, 'ht_0' , ht_0 , ktype = jp_r8 ) |
---|
| 803 | ENDIF |
---|
[14433] | 804 | ! ! ============================ ! |
---|
| 805 | ! ! close the files |
---|
| 806 | ! ! ============================ ! |
---|
[7646] | 807 | CALL iom_close( inum ) |
---|
| 808 | ! |
---|
| 809 | END SUBROUTINE cfg_write |
---|
[3680] | 810 | |
---|
[3] | 811 | !!====================================================================== |
---|
| 812 | END MODULE domain |
---|