[2496] | 1 | MODULE nemogcm |
---|
[2442] | 2 | !!====================================================================== |
---|
[2496] | 3 | !! *** MODULE nemogcm *** |
---|
| 4 | !! Ocean system : NEMO GCM (ocean dynamics, on-line tracers, biochemistry and sea-ice) |
---|
[2442] | 5 | !!====================================================================== |
---|
[1593] | 6 | !! History : OPA ! 1990-10 (C. Levy, G. Madec) Original code |
---|
| 7 | !! 7.0 ! 1991-11 (M. Imbard, C. Levy, G. Madec) |
---|
[3764] | 8 | !! 7.1 ! 1993-03 (M. Imbard, C. Levy, G. Madec, O. Marti, M. Guyon, A. Lazar, |
---|
| 9 | !! P. Delecluse, C. Perigaud, G. Caniaux, B. Colot, C. Maes) release 7.1 |
---|
[1593] | 10 | !! - ! 1992-06 (L.Terray) coupling implementation |
---|
[3764] | 11 | !! - ! 1993-11 (M.A. Filiberti) IGLOO sea-ice |
---|
| 12 | !! 8.0 ! 1996-03 (M. Imbard, C. Levy, G. Madec, O. Marti, M. Guyon, A. Lazar, |
---|
[2104] | 13 | !! P. Delecluse, L.Terray, M.A. Filiberti, J. Vialar, A.M. Treguier, M. Levy) release 8.0 |
---|
[1593] | 14 | !! 8.1 ! 1997-06 (M. Imbard, G. Madec) |
---|
[3764] | 15 | !! 8.2 ! 1999-11 (M. Imbard, H. Goosse) LIM sea-ice model |
---|
| 16 | !! ! 1999-12 (V. Thierry, A-M. Treguier, M. Imbard, M-A. Foujols) OPEN-MP |
---|
[1593] | 17 | !! ! 2000-07 (J-M Molines, M. Imbard) Open Boundary Conditions (CLIPPER) |
---|
| 18 | !! NEMO 1.0 ! 2002-08 (G. Madec) F90: Free form and modules |
---|
| 19 | !! - ! 2004-06 (R. Redler, NEC CCRLE, Germany) add OASIS[3/4] coupled interfaces |
---|
| 20 | !! - ! 2004-08 (C. Talandier) New trends organization |
---|
| 21 | !! - ! 2005-06 (C. Ethe) Add the 1D configuration possibility |
---|
| 22 | !! - ! 2005-11 (V. Garnier) Surface pressure gradient organization |
---|
| 23 | !! - ! 2006-03 (L. Debreu, C. Mazauric) Agrif implementation |
---|
| 24 | !! - ! 2006-04 (G. Madec, R. Benshila) Step reorganization |
---|
| 25 | !! - ! 2007-07 (J. Chanut, A. Sellar) Unstructured open boundaries (BDY) |
---|
| 26 | !! 3.2 ! 2009-08 (S. Masson) open/write in the listing file in mpp |
---|
[3764] | 27 | !! 3.3 ! 2010-05 (K. Mogensen, A. Weaver, M. Martin, D. Lea) Assimilation interface |
---|
[2236] | 28 | !! - ! 2010-10 (C. Ethe, G. Madec) reorganisation of initialisation phase |
---|
[3294] | 29 | !! 3.3.1! 2011-01 (A. R. Porter, STFC Daresbury) dynamical allocation |
---|
| 30 | !! 3.4 ! 2011-11 (C. Harris) decomposition changes for running with CICE |
---|
[4152] | 31 | !! ! 2012-05 (C. Calone, J. Simeon, G. Madec, C. Ethe) Add grid coarsening |
---|
[1593] | 32 | !!---------------------------------------------------------------------- |
---|
[3] | 33 | |
---|
| 34 | !!---------------------------------------------------------------------- |
---|
[2496] | 35 | !! nemo_gcm : solve ocean dynamics, tracer, biogeochemistry and/or sea-ice |
---|
| 36 | !! nemo_init : initialization of the NEMO system |
---|
[3764] | 37 | !! nemo_ctl : initialisation of the contol print |
---|
[2496] | 38 | !! nemo_closefile : close remaining open files |
---|
[2715] | 39 | !! nemo_alloc : dynamical allocation |
---|
| 40 | !! nemo_partition : calculate MPP domain decomposition |
---|
| 41 | !! factorise : calculate the factors of the no. of MPI processes |
---|
[3] | 42 | !!---------------------------------------------------------------------- |
---|
[2382] | 43 | USE step_oce ! module used in the ocean time stepping module |
---|
[2392] | 44 | USE cla ! cross land advection (tra_cla routine) |
---|
[3] | 45 | USE domcfg ! domain configuration (dom_cfg routine) |
---|
| 46 | USE mppini ! shared/distributed memory setting (mpp_init routine) |
---|
| 47 | USE domain ! domain initialization (dom_init routine) |
---|
[3625] | 48 | #if defined key_nemocice_decomp |
---|
| 49 | USE ice_domain_size, only: nx_global, ny_global |
---|
| 50 | #endif |
---|
[3651] | 51 | USE tideini ! tidal components initialization (tide_ini routine) |
---|
[4990] | 52 | USE bdyini ! open boundary cond. setting (bdy_init routine) |
---|
| 53 | USE bdydta ! open boundary cond. setting (bdy_dta_init routine) |
---|
| 54 | USE bdytides ! open boundary cond. setting (bdytide_init routine) |
---|
[3] | 55 | USE istate ! initial state setting (istate_init routine) |
---|
| 56 | USE ldfdyn ! lateral viscosity setting (ldfdyn_init routine) |
---|
| 57 | USE ldftra ! lateral diffusivity setting (ldftra_init routine) |
---|
[2392] | 58 | USE zdfini ! vertical physics setting (zdf_init routine) |
---|
[3] | 59 | USE phycst ! physical constant (par_cst routine) |
---|
[4990] | 60 | USE trdini ! dyn/tra trends initialization (trd_init routine) |
---|
[3768] | 61 | USE asminc ! assimilation increments |
---|
| 62 | USE asmbkg ! writing out state trajectory |
---|
[2236] | 63 | USE diaptr ! poleward transports (dia_ptr_init routine) |
---|
[3294] | 64 | USE diadct ! sections transports (dia_dct_init routine) |
---|
[2236] | 65 | USE diaobs ! Observation diagnostics (dia_obs_init routine) |
---|
[3764] | 66 | USE lib_fortran ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined) |
---|
[2496] | 67 | USE step ! NEMO time-stepping (stp routine) |
---|
[3609] | 68 | USE icbini ! handle bergs, initialisation |
---|
| 69 | USE icbstp ! handle bergs, calving, themodynamics and transport |
---|
[1359] | 70 | USE cpl_oasis3 ! OASIS3 coupling |
---|
[900] | 71 | USE c1d ! 1D configuration |
---|
| 72 | USE step_c1d ! Time stepping loop for the 1D configuration |
---|
[4245] | 73 | USE dyndmp ! Momentum damping |
---|
[1594] | 74 | #if defined key_top |
---|
[1593] | 75 | USE trcini ! passive tracer initialisation |
---|
[1594] | 76 | #endif |
---|
[1593] | 77 | USE lib_mpp ! distributed memory computing |
---|
[1412] | 78 | #if defined key_iomput |
---|
[3701] | 79 | USE xios |
---|
[1359] | 80 | #endif |
---|
[3651] | 81 | USE sbctide, ONLY: lk_tide |
---|
[4152] | 82 | USE crsini ! initialise grid coarsening utility |
---|
[4671] | 83 | USE lbcnfd, ONLY: isendto, nsndto, nfsloop, nfeloop ! Setup of north fold exchanges |
---|
[5666] | 84 | USE sbc_oce, ONLY: lk_oasis |
---|
| 85 | USE stopar |
---|
| 86 | USE stopts |
---|
[5427] | 87 | USE diatmb ! Top,middle,bottom output |
---|
| 88 | USE dia25h ! 25h mean output |
---|
[268] | 89 | |
---|
[2715] | 90 | IMPLICIT NONE |
---|
[3] | 91 | PRIVATE |
---|
| 92 | |
---|
[2496] | 93 | PUBLIC nemo_gcm ! called by model.F90 |
---|
| 94 | PUBLIC nemo_init ! needed by AGRIF |
---|
[3764] | 95 | PUBLIC nemo_alloc ! needed by TAM |
---|
[467] | 96 | |
---|
[2498] | 97 | CHARACTER(lc) :: cform_aaa="( /, 'AAAAAAAA', / ) " ! flag for output listing |
---|
[1593] | 98 | |
---|
[3] | 99 | !!---------------------------------------------------------------------- |
---|
[2715] | 100 | !! NEMO/OPA 4.0 , NEMO Consortium (2011) |
---|
[2392] | 101 | !! $Id$ |
---|
[2329] | 102 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
---|
[3] | 103 | !!---------------------------------------------------------------------- |
---|
| 104 | CONTAINS |
---|
| 105 | |
---|
[2496] | 106 | SUBROUTINE nemo_gcm |
---|
[3] | 107 | !!---------------------------------------------------------------------- |
---|
[2496] | 108 | !! *** ROUTINE nemo_gcm *** |
---|
[3] | 109 | !! |
---|
[3764] | 110 | !! ** Purpose : NEMO solves the primitive equations on an orthogonal |
---|
[1593] | 111 | !! curvilinear mesh on the sphere. |
---|
[3] | 112 | !! |
---|
| 113 | !! ** Method : - model general initialization |
---|
| 114 | !! - launch the time-stepping (stp routine) |
---|
[1593] | 115 | !! - finalize the run by closing files and communications |
---|
[3] | 116 | !! |
---|
[2715] | 117 | !! References : Madec, Delecluse, Imbard, and Levy, 1997: internal report, IPSL. |
---|
[1593] | 118 | !! Madec, 2008, internal report, IPSL. |
---|
[3] | 119 | !!---------------------------------------------------------------------- |
---|
| 120 | INTEGER :: istp ! time step index |
---|
[389] | 121 | !!---------------------------------------------------------------------- |
---|
[2382] | 122 | ! |
---|
[392] | 123 | #if defined key_agrif |
---|
[1593] | 124 | CALL Agrif_Init_Grids() ! AGRIF: set the meshes |
---|
[389] | 125 | #endif |
---|
| 126 | |
---|
[1593] | 127 | ! !-----------------------! |
---|
[2496] | 128 | CALL nemo_init !== Initialisations ==! |
---|
[1593] | 129 | ! !-----------------------! |
---|
[2715] | 130 | #if defined key_agrif |
---|
[3680] | 131 | CALL Agrif_Declare_Var_dom ! AGRIF: set the meshes for DOM |
---|
| 132 | CALL Agrif_Declare_Var ! " " " " " DYN/TRA |
---|
[2715] | 133 | # if defined key_top |
---|
[3680] | 134 | CALL Agrif_Declare_Var_top ! " " " " " TOP |
---|
[2715] | 135 | # endif |
---|
[3680] | 136 | # if defined key_lim2 |
---|
| 137 | CALL Agrif_Declare_Var_lim2 ! " " " " " LIM |
---|
| 138 | # endif |
---|
[2715] | 139 | #endif |
---|
[682] | 140 | ! check that all process are still there... If some process have an error, |
---|
| 141 | ! they will never enter in step and other processes will wait until the end of the cpu time! |
---|
[900] | 142 | IF( lk_mpp ) CALL mpp_max( nstop ) |
---|
[682] | 143 | |
---|
[1593] | 144 | IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA |
---|
| 145 | |
---|
| 146 | ! !-----------------------! |
---|
| 147 | ! !== time stepping ==! |
---|
| 148 | ! !-----------------------! |
---|
[900] | 149 | istp = nit000 |
---|
[2236] | 150 | #if defined key_c1d |
---|
[389] | 151 | DO WHILE ( istp <= nitend .AND. nstop == 0 ) |
---|
[900] | 152 | CALL stp_c1d( istp ) |
---|
[389] | 153 | istp = istp + 1 |
---|
| 154 | END DO |
---|
[2236] | 155 | #else |
---|
| 156 | IF( lk_asminc ) THEN |
---|
| 157 | IF( ln_bkgwri ) CALL asm_bkg_wri( nit000 - 1 ) ! Output background fields |
---|
| 158 | IF( ln_asmdin ) THEN ! Direct initialization |
---|
| 159 | IF( ln_trainc ) CALL tra_asm_inc( nit000 - 1 ) ! Tracers |
---|
[3764] | 160 | IF( ln_dyninc ) CALL dyn_asm_inc( nit000 - 1 ) ! Dynamics |
---|
[2236] | 161 | IF( ln_sshinc ) CALL ssh_asm_inc( nit000 - 1 ) ! SSH |
---|
| 162 | ENDIF |
---|
| 163 | ENDIF |
---|
[3764] | 164 | |
---|
[389] | 165 | DO WHILE ( istp <= nitend .AND. nstop == 0 ) |
---|
[392] | 166 | #if defined key_agrif |
---|
[1593] | 167 | CALL Agrif_Step( stp ) ! AGRIF: time stepping |
---|
[389] | 168 | #else |
---|
[1593] | 169 | CALL stp( istp ) ! standard time stepping |
---|
[389] | 170 | #endif |
---|
| 171 | istp = istp + 1 |
---|
[900] | 172 | IF( lk_mpp ) CALL mpp_max( nstop ) |
---|
[389] | 173 | END DO |
---|
[2236] | 174 | #endif |
---|
| 175 | |
---|
[3609] | 176 | IF( lk_diaobs ) CALL dia_obs_wri |
---|
| 177 | ! |
---|
| 178 | IF( ln_icebergs ) CALL icb_end( nitend ) |
---|
[3764] | 179 | |
---|
[1593] | 180 | ! !------------------------! |
---|
| 181 | ! !== finalize the run ==! |
---|
| 182 | ! !------------------------! |
---|
| 183 | IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA |
---|
| 184 | ! |
---|
| 185 | IF( nstop /= 0 .AND. lwp ) THEN ! error print |
---|
[682] | 186 | WRITE(numout,cform_err) |
---|
[3764] | 187 | WRITE(numout,*) nstop, ' error have been found' |
---|
[389] | 188 | ENDIF |
---|
[1593] | 189 | ! |
---|
[3294] | 190 | #if defined key_agrif |
---|
[5666] | 191 | IF ( Agrif_Level() < Agrif_MaxLevel() ) THEN |
---|
| 192 | CALL Agrif_ParentGrid_To_ChildGrid() |
---|
| 193 | IF( lk_diaobs ) CALL dia_obs_wri |
---|
| 194 | IF( nn_timing == 1 ) CALL timing_finalize |
---|
| 195 | CALL Agrif_ChildGrid_To_ParentGrid() |
---|
| 196 | ENDIF |
---|
[3294] | 197 | #endif |
---|
| 198 | IF( nn_timing == 1 ) CALL timing_finalize |
---|
| 199 | ! |
---|
[2496] | 200 | CALL nemo_closefile |
---|
[4990] | 201 | ! |
---|
[3769] | 202 | #if defined key_iomput |
---|
| 203 | CALL xios_finalize ! end mpp communications with xios |
---|
[5666] | 204 | IF( lk_oasis ) CALL cpl_finalize ! end coupling and mpp communications with OASIS |
---|
[532] | 205 | #else |
---|
[5666] | 206 | IF( lk_oasis ) THEN |
---|
[4990] | 207 | CALL cpl_finalize ! end coupling and mpp communications with OASIS |
---|
| 208 | ELSE |
---|
| 209 | IF( lk_mpp ) CALL mppstop ! end mpp communications |
---|
| 210 | ENDIF |
---|
[532] | 211 | #endif |
---|
[900] | 212 | ! |
---|
[2496] | 213 | END SUBROUTINE nemo_gcm |
---|
[389] | 214 | |
---|
| 215 | |
---|
[2496] | 216 | SUBROUTINE nemo_init |
---|
[389] | 217 | !!---------------------------------------------------------------------- |
---|
[2496] | 218 | !! *** ROUTINE nemo_init *** |
---|
[389] | 219 | !! |
---|
[2496] | 220 | !! ** Purpose : initialization of the NEMO GCM |
---|
[389] | 221 | !!---------------------------------------------------------------------- |
---|
[2715] | 222 | INTEGER :: ji ! dummy loop indices |
---|
| 223 | INTEGER :: ilocal_comm ! local integer |
---|
[4147] | 224 | INTEGER :: ios |
---|
[2715] | 225 | CHARACTER(len=80), DIMENSION(16) :: cltxt |
---|
[4990] | 226 | ! |
---|
| 227 | NAMELIST/namctl/ ln_ctl , nn_print, nn_ictls, nn_ictle, & |
---|
[3294] | 228 | & nn_isplt, nn_jsplt, nn_jctls, nn_jctle, & |
---|
| 229 | & nn_bench, nn_timing |
---|
[4147] | 230 | NAMELIST/namcfg/ cp_cfg, cp_cfz, jp_cfg, jpidta, jpjdta, jpkdta, jpiglo, jpjglo, & |
---|
[5118] | 231 | & jpizoom, jpjzoom, jperio, ln_use_jattr |
---|
[3] | 232 | !!---------------------------------------------------------------------- |
---|
[1593] | 233 | ! |
---|
[2496] | 234 | cltxt = '' |
---|
[5666] | 235 | cxios_context = 'nemo' |
---|
[2496] | 236 | ! |
---|
[4147] | 237 | ! ! Open reference namelist and configuration namelist files |
---|
| 238 | CALL ctl_opn( numnam_ref, 'namelist_ref', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. ) |
---|
| 239 | CALL ctl_opn( numnam_cfg, 'namelist_cfg', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. ) |
---|
[1593] | 240 | ! |
---|
[4147] | 241 | REWIND( numnam_ref ) ! Namelist namctl in reference namelist : Control prints & Benchmark |
---|
| 242 | READ ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 ) |
---|
[4289] | 243 | 901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in reference namelist', .TRUE. ) |
---|
[4147] | 244 | |
---|
| 245 | REWIND( numnam_cfg ) ! Namelist namctl in confguration namelist : Control prints & Benchmark |
---|
| 246 | READ ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 ) |
---|
[4289] | 247 | 902 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in configuration namelist', .TRUE. ) |
---|
[4147] | 248 | |
---|
[1593] | 249 | ! |
---|
[4147] | 250 | REWIND( numnam_ref ) ! Namelist namcfg in reference namelist : Control prints & Benchmark |
---|
| 251 | READ ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 ) |
---|
[4289] | 252 | 903 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in reference namelist', .TRUE. ) |
---|
[4147] | 253 | |
---|
| 254 | REWIND( numnam_cfg ) ! Namelist namcfg in confguration namelist : Control prints & Benchmark |
---|
| 255 | READ ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 ) |
---|
[4289] | 256 | 904 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in configuration namelist', .TRUE. ) |
---|
[4309] | 257 | |
---|
[4147] | 258 | ! Force values for AGRIF zoom (cf. agrif_user.F90) |
---|
| 259 | #if defined key_agrif |
---|
| 260 | IF( .NOT. Agrif_Root() ) THEN |
---|
| 261 | jpiglo = nbcellsx + 2 + 2*nbghostcells |
---|
| 262 | jpjglo = nbcellsy + 2 + 2*nbghostcells |
---|
| 263 | jpi = ( jpiglo-2*jpreci + (jpni-1+0) ) / jpni + 2*jpreci |
---|
| 264 | jpj = ( jpjglo-2*jprecj + (jpnj-1+0) ) / jpnj + 2*jprecj |
---|
| 265 | jpidta = jpiglo |
---|
| 266 | jpjdta = jpjglo |
---|
| 267 | jpizoom = 1 |
---|
| 268 | jpjzoom = 1 |
---|
| 269 | nperio = 0 |
---|
| 270 | jperio = 0 |
---|
[5118] | 271 | ln_use_jattr = .false. |
---|
[4147] | 272 | ENDIF |
---|
| 273 | #endif |
---|
| 274 | ! |
---|
[1593] | 275 | ! !--------------------------------------------! |
---|
| 276 | ! ! set communicator & select the local node ! |
---|
[4624] | 277 | ! ! NB: mynode also opens output.namelist.dyn ! |
---|
| 278 | ! ! on unit number numond on first proc ! |
---|
[1593] | 279 | ! !--------------------------------------------! |
---|
[1412] | 280 | #if defined key_iomput |
---|
[2200] | 281 | IF( Agrif_Root() ) THEN |
---|
[5666] | 282 | IF( lk_oasis ) THEN |
---|
| 283 | CALL cpl_init( "oceanx", ilocal_comm ) ! nemo local communicator given by oasis |
---|
| 284 | CALL xios_initialize( "not used",local_comm=ilocal_comm ) ! send nemo communicator to xios |
---|
[4990] | 285 | ELSE |
---|
[5666] | 286 | CALL xios_initialize( "for_xios_mpi_id",return_comm=ilocal_comm ) ! nemo local communicator given by xios |
---|
[4990] | 287 | ENDIF |
---|
[2200] | 288 | ENDIF |
---|
[5666] | 289 | ! Nodes selection (control print return in cltxt) |
---|
| 290 | narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm ) |
---|
[532] | 291 | #else |
---|
[5666] | 292 | IF( lk_oasis ) THEN |
---|
[4990] | 293 | IF( Agrif_Root() ) THEN |
---|
[5666] | 294 | CALL cpl_init( "oceanx", ilocal_comm ) ! nemo local communicator given by oasis |
---|
[4990] | 295 | ENDIF |
---|
[5666] | 296 | ! Nodes selection (control print return in cltxt) |
---|
| 297 | narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm ) |
---|
[4990] | 298 | ELSE |
---|
| 299 | ilocal_comm = 0 |
---|
[5666] | 300 | ! Nodes selection (control print return in cltxt) |
---|
| 301 | narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop ) |
---|
[2236] | 302 | ENDIF |
---|
[532] | 303 | #endif |
---|
[2715] | 304 | narea = narea + 1 ! mynode return the rank of proc (0 --> jpnij -1 ) |
---|
[3] | 305 | |
---|
[4624] | 306 | lwm = (narea == 1) ! control of output namelists |
---|
[2715] | 307 | lwp = (narea == 1) .OR. ln_ctl ! control of all listing output print |
---|
[1579] | 308 | |
---|
[4624] | 309 | IF(lwm) THEN |
---|
| 310 | ! write merged namelists from earlier to output namelist now that the |
---|
| 311 | ! file has been opened in call to mynode. nammpp has already been |
---|
| 312 | ! written in mynode (if lk_mpp_mpi) |
---|
| 313 | WRITE( numond, namctl ) |
---|
| 314 | WRITE( numond, namcfg ) |
---|
| 315 | ENDIF |
---|
| 316 | |
---|
[3764] | 317 | ! If dimensions of processor grid weren't specified in the namelist file |
---|
[2715] | 318 | ! then we calculate them here now that we have our communicator size |
---|
| 319 | IF( (jpni < 1) .OR. (jpnj < 1) )THEN |
---|
| 320 | #if defined key_mpp_mpi |
---|
| 321 | IF( Agrif_Root() ) CALL nemo_partition(mppsize) |
---|
| 322 | #else |
---|
| 323 | jpni = 1 |
---|
| 324 | jpnj = 1 |
---|
| 325 | jpnij = jpni*jpnj |
---|
| 326 | #endif |
---|
| 327 | END IF |
---|
| 328 | |
---|
| 329 | ! Calculate domain dimensions given calculated jpni and jpnj |
---|
| 330 | ! This used to be done in par_oce.F90 when they were parameters rather |
---|
| 331 | ! than variables |
---|
| 332 | IF( Agrif_Root() ) THEN |
---|
[3294] | 333 | #if defined key_nemocice_decomp |
---|
[3625] | 334 | jpi = ( nx_global+2-2*jpreci + (jpni-1) ) / jpni + 2*jpreci ! first dim. |
---|
| 335 | jpj = ( ny_global+2-2*jprecj + (jpnj-1) ) / jpnj + 2*jprecj ! second dim. |
---|
[3294] | 336 | #else |
---|
[3625] | 337 | jpi = ( jpiglo-2*jpreci + (jpni-1) ) / jpni + 2*jpreci ! first dim. |
---|
[2715] | 338 | jpj = ( jpjglo-2*jprecj + (jpnj-1) ) / jpnj + 2*jprecj ! second dim. |
---|
[3294] | 339 | #endif |
---|
[4147] | 340 | ENDIF |
---|
[2715] | 341 | jpk = jpkdta ! third dim |
---|
| 342 | jpim1 = jpi-1 ! inner domain indices |
---|
| 343 | jpjm1 = jpj-1 ! " " |
---|
| 344 | jpkm1 = jpk-1 ! " " |
---|
| 345 | jpij = jpi*jpj ! jpi x j |
---|
| 346 | |
---|
[1593] | 347 | IF(lwp) THEN ! open listing units |
---|
| 348 | ! |
---|
[1581] | 349 | CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE., narea ) |
---|
[1593] | 350 | ! |
---|
[1579] | 351 | WRITE(numout,*) |
---|
[3294] | 352 | WRITE(numout,*) ' CNRS - NERC - Met OFFICE - MERCATOR-ocean - INGV - CMCC' |
---|
[1593] | 353 | WRITE(numout,*) ' NEMO team' |
---|
[1579] | 354 | WRITE(numout,*) ' Ocean General Circulation Model' |
---|
[5120] | 355 | WRITE(numout,*) ' version 3.6 (2015) ' |
---|
[1579] | 356 | WRITE(numout,*) |
---|
| 357 | WRITE(numout,*) |
---|
[3764] | 358 | DO ji = 1, SIZE(cltxt) |
---|
[1593] | 359 | IF( TRIM(cltxt(ji)) /= '' ) WRITE(numout,*) cltxt(ji) ! control print of mynode |
---|
[1579] | 360 | END DO |
---|
[1593] | 361 | WRITE(numout,cform_aaa) ! Flag AAAAAAA |
---|
| 362 | ! |
---|
[473] | 363 | ENDIF |
---|
[2715] | 364 | |
---|
[3764] | 365 | ! Now we know the dimensions of the grid and numout has been set we can |
---|
[2715] | 366 | ! allocate arrays |
---|
| 367 | CALL nemo_alloc() |
---|
| 368 | |
---|
[2496] | 369 | ! !-------------------------------! |
---|
| 370 | ! ! NEMO general initialization ! |
---|
| 371 | ! !-------------------------------! |
---|
[473] | 372 | |
---|
[2496] | 373 | CALL nemo_ctl ! Control prints & Benchmark |
---|
[531] | 374 | |
---|
[2082] | 375 | ! ! Domain decomposition |
---|
[1593] | 376 | IF( jpni*jpnj == jpnij ) THEN ; CALL mpp_init ! standard cutting out |
---|
| 377 | ELSE ; CALL mpp_init2 ! eliminate land processors |
---|
[3] | 378 | ENDIF |
---|
[2382] | 379 | ! |
---|
[3294] | 380 | IF( nn_timing == 1 ) CALL timing_init |
---|
| 381 | ! |
---|
[2082] | 382 | ! ! General initialization |
---|
[2027] | 383 | CALL phy_cst ! Physical constants |
---|
| 384 | CALL eos_init ! Equation of state |
---|
[4245] | 385 | IF( lk_c1d ) CALL c1d_init ! 1D column configuration |
---|
[2027] | 386 | CALL dom_cfg ! Domain configuration |
---|
| 387 | CALL dom_init ! Domain |
---|
[413] | 388 | |
---|
[3294] | 389 | IF( ln_nnogather ) CALL nemo_northcomms ! Initialise the northfold neighbour lists (must be done after the masks are defined) |
---|
| 390 | |
---|
[2027] | 391 | IF( ln_ctl ) CALL prt_ctl_init ! Print control |
---|
| 392 | |
---|
[3651] | 393 | CALL istate_init ! ocean initial state (Dynamics and tracers) |
---|
| 394 | |
---|
[4292] | 395 | IF( lk_tide ) CALL tide_init( nit000 ) ! Initialisation of the tidal harmonics |
---|
[3651] | 396 | |
---|
[5123] | 397 | CALL sbc_init ! Forcings : surface module (clem: moved here for bdy purpose) |
---|
| 398 | |
---|
[4990] | 399 | IF( lk_bdy ) CALL bdy_init ! Open boundaries initialisation |
---|
| 400 | IF( lk_bdy ) CALL bdy_dta_init ! Open boundaries initialisation of external data arrays |
---|
[4292] | 401 | IF( lk_bdy .AND. lk_tide ) & |
---|
[4990] | 402 | & CALL bdytide_init ! Open boundaries initialisation of tidal harmonic forcing |
---|
[2027] | 403 | |
---|
[3294] | 404 | CALL dyn_nept_init ! simplified form of Neptune effect |
---|
[4152] | 405 | ! |
---|
| 406 | IF( ln_crs ) CALL crs_init ! Domain initialization of coarsened grid |
---|
| 407 | ! |
---|
| 408 | ! Ocean physics |
---|
[2082] | 409 | ! ! Vertical physics |
---|
| 410 | CALL zdf_init ! namelist read |
---|
| 411 | CALL zdf_bfr_init ! bottom friction |
---|
| 412 | IF( lk_zdfric ) CALL zdf_ric_init ! Richardson number dependent Kz |
---|
[2329] | 413 | IF( lk_zdftke ) CALL zdf_tke_init ! TKE closure scheme |
---|
| 414 | IF( lk_zdfgls ) CALL zdf_gls_init ! GLS closure scheme |
---|
| 415 | IF( lk_zdfkpp ) CALL zdf_kpp_init ! KPP closure scheme |
---|
[2082] | 416 | IF( lk_zdftmx ) CALL zdf_tmx_init ! tidal vertical mixing |
---|
[3764] | 417 | IF( lk_zdfddm .AND. .NOT. lk_zdfkpp ) & |
---|
[2082] | 418 | & CALL zdf_ddm_init ! double diffusive mixing |
---|
| 419 | ! ! Lateral physics |
---|
| 420 | CALL ldf_tra_init ! Lateral ocean tracer physics |
---|
| 421 | CALL ldf_dyn_init ! Lateral ocean momentum physics |
---|
[2392] | 422 | IF( lk_ldfslp ) CALL ldf_slp_init ! slope of lateral mixing |
---|
[2082] | 423 | |
---|
[2027] | 424 | ! ! Active tracers |
---|
| 425 | CALL tra_qsr_init ! penetrative solar radiation qsr |
---|
[2325] | 426 | CALL tra_bbc_init ! bottom heat flux |
---|
[2027] | 427 | IF( lk_trabbl ) CALL tra_bbl_init ! advective (and/or diffusive) bottom boundary layer scheme |
---|
[4245] | 428 | CALL tra_dmp_init ! internal damping trends- tracers |
---|
[2027] | 429 | CALL tra_adv_init ! horizontal & vertical advection |
---|
| 430 | CALL tra_ldf_init ! lateral mixing |
---|
| 431 | CALL tra_zdf_init ! vertical mixing and after tracer fields |
---|
| 432 | |
---|
| 433 | ! ! Dynamics |
---|
[4245] | 434 | IF( lk_c1d ) CALL dyn_dmp_init ! internal damping trends- momentum |
---|
[2027] | 435 | CALL dyn_adv_init ! advection (vector or flux form) |
---|
[2104] | 436 | CALL dyn_vor_init ! vorticity term including Coriolis |
---|
[2027] | 437 | CALL dyn_ldf_init ! lateral mixing |
---|
[2104] | 438 | CALL dyn_hpg_init ! horizontal gradient of Hydrostatic pressure |
---|
[2027] | 439 | CALL dyn_zdf_init ! vertical diffusion |
---|
| 440 | CALL dyn_spg_init ! surface pressure gradient |
---|
[3764] | 441 | |
---|
[2392] | 442 | ! ! Misc. options |
---|
[4147] | 443 | IF( nn_cla == 1 .AND. cp_cfg == 'orca' .AND. jp_cfg == 2 ) CALL cla_init ! Cross Land Advection |
---|
[3609] | 444 | CALL icb_init( rdt, nit000) ! initialise icebergs instance |
---|
[5666] | 445 | CALL sto_par_init ! Stochastic parametrization |
---|
| 446 | IF( ln_sto_eos ) CALL sto_pts_init ! RRandom T/S fluctuations |
---|
[4147] | 447 | |
---|
[1594] | 448 | #if defined key_top |
---|
[2027] | 449 | ! ! Passive tracers |
---|
[2082] | 450 | CALL trc_init |
---|
[1594] | 451 | #endif |
---|
[4990] | 452 | ! ! Diagnostics |
---|
[3294] | 453 | IF( lk_floats ) CALL flo_init ! drifting Floats |
---|
[2392] | 454 | IF( lk_diaar5 ) CALL dia_ar5_init ! ar5 diag |
---|
[2027] | 455 | CALL dia_ptr_init ! Poleward TRansports initialization |
---|
[3294] | 456 | IF( lk_diadct ) CALL dia_dct_init ! Sections tranports |
---|
[2148] | 457 | CALL dia_hsb_init ! heat content, salt content and volume budgets |
---|
[4990] | 458 | CALL trd_init ! Mixed-layer/Vorticity/Integral constraints trends |
---|
[2392] | 459 | IF( lk_diaobs ) THEN ! Observation & model comparison |
---|
[2382] | 460 | CALL dia_obs_init ! Initialize observational data |
---|
| 461 | CALL dia_obs( nit000 - 1 ) ! Observation operator for restart |
---|
[3764] | 462 | ENDIF |
---|
[4990] | 463 | |
---|
[2382] | 464 | ! ! Assimilation increments |
---|
[2392] | 465 | IF( lk_asminc ) CALL asm_inc_init ! Initialize assimilation increments |
---|
[2382] | 466 | IF(lwp) WRITE(numout,*) 'Euler time step switch is ', neuler |
---|
[5427] | 467 | CALL dia_tmb_init ! TMB outputs |
---|
| 468 | CALL dia_25h_init ! 25h mean outputs |
---|
| 469 | |
---|
[1593] | 470 | ! |
---|
[2496] | 471 | END SUBROUTINE nemo_init |
---|
[467] | 472 | |
---|
| 473 | |
---|
[2496] | 474 | SUBROUTINE nemo_ctl |
---|
[467] | 475 | !!---------------------------------------------------------------------- |
---|
[2496] | 476 | !! *** ROUTINE nemo_ctl *** |
---|
[467] | 477 | !! |
---|
[3764] | 478 | !! ** Purpose : control print setting |
---|
[467] | 479 | !! |
---|
[2442] | 480 | !! ** Method : - print namctl information and check some consistencies |
---|
[467] | 481 | !!---------------------------------------------------------------------- |
---|
[2442] | 482 | ! |
---|
[2496] | 483 | IF(lwp) THEN ! control print |
---|
[531] | 484 | WRITE(numout,*) |
---|
[2496] | 485 | WRITE(numout,*) 'nemo_ctl: Control prints & Benchmark' |
---|
[531] | 486 | WRITE(numout,*) '~~~~~~~ ' |
---|
[1593] | 487 | WRITE(numout,*) ' Namelist namctl' |
---|
[1601] | 488 | WRITE(numout,*) ' run control (for debugging) ln_ctl = ', ln_ctl |
---|
| 489 | WRITE(numout,*) ' level of print nn_print = ', nn_print |
---|
| 490 | WRITE(numout,*) ' Start i indice for SUM control nn_ictls = ', nn_ictls |
---|
| 491 | WRITE(numout,*) ' End i indice for SUM control nn_ictle = ', nn_ictle |
---|
| 492 | WRITE(numout,*) ' Start j indice for SUM control nn_jctls = ', nn_jctls |
---|
| 493 | WRITE(numout,*) ' End j indice for SUM control nn_jctle = ', nn_jctle |
---|
| 494 | WRITE(numout,*) ' number of proc. following i nn_isplt = ', nn_isplt |
---|
| 495 | WRITE(numout,*) ' number of proc. following j nn_jsplt = ', nn_jsplt |
---|
| 496 | WRITE(numout,*) ' benchmark parameter (0/1) nn_bench = ', nn_bench |
---|
[3610] | 497 | WRITE(numout,*) ' timing activated (0/1) nn_timing = ', nn_timing |
---|
[531] | 498 | ENDIF |
---|
[2442] | 499 | ! |
---|
[1601] | 500 | nprint = nn_print ! convert DOCTOR namelist names into OLD names |
---|
| 501 | nictls = nn_ictls |
---|
| 502 | nictle = nn_ictle |
---|
| 503 | njctls = nn_jctls |
---|
| 504 | njctle = nn_jctle |
---|
| 505 | isplt = nn_isplt |
---|
| 506 | jsplt = nn_jsplt |
---|
| 507 | nbench = nn_bench |
---|
[4147] | 508 | |
---|
| 509 | IF(lwp) THEN ! control print |
---|
| 510 | WRITE(numout,*) |
---|
| 511 | WRITE(numout,*) 'namcfg : configuration initialization through namelist read' |
---|
| 512 | WRITE(numout,*) '~~~~~~~ ' |
---|
| 513 | WRITE(numout,*) ' Namelist namcfg' |
---|
| 514 | WRITE(numout,*) ' configuration name cp_cfg = ', TRIM(cp_cfg) |
---|
| 515 | WRITE(numout,*) ' configuration zoom name cp_cfz = ', TRIM(cp_cfz) |
---|
| 516 | WRITE(numout,*) ' configuration resolution jp_cfg = ', jp_cfg |
---|
| 517 | WRITE(numout,*) ' 1st lateral dimension ( >= jpi ) jpidta = ', jpidta |
---|
| 518 | WRITE(numout,*) ' 2nd " " ( >= jpj ) jpjdta = ', jpjdta |
---|
| 519 | WRITE(numout,*) ' 3nd " " jpkdta = ', jpkdta |
---|
| 520 | WRITE(numout,*) ' 1st dimension of global domain in i jpiglo = ', jpiglo |
---|
| 521 | WRITE(numout,*) ' 2nd - - in j jpjglo = ', jpjglo |
---|
| 522 | WRITE(numout,*) ' left bottom i index of the zoom (in data domain) jpizoom = ', jpizoom |
---|
| 523 | WRITE(numout,*) ' left bottom j index of the zoom (in data domain) jpizoom = ', jpjzoom |
---|
| 524 | WRITE(numout,*) ' lateral cond. type (between 0 and 6) jperio = ', jperio |
---|
[5118] | 525 | WRITE(numout,*) ' use file attribute if exists as i/p j-start ln_use_jattr = ', ln_use_jattr |
---|
[4147] | 526 | ENDIF |
---|
[2442] | 527 | ! ! Parameter control |
---|
[1593] | 528 | ! |
---|
| 529 | IF( ln_ctl ) THEN ! sub-domain area indices for the control prints |
---|
[3294] | 530 | IF( lk_mpp .AND. jpnij > 1 ) THEN |
---|
[2496] | 531 | isplt = jpni ; jsplt = jpnj ; ijsplt = jpni*jpnj ! the domain is forced to the real split domain |
---|
[531] | 532 | ELSE |
---|
| 533 | IF( isplt == 1 .AND. jsplt == 1 ) THEN |
---|
[1593] | 534 | CALL ctl_warn( ' - isplt & jsplt are equal to 1', & |
---|
| 535 | & ' - the print control will be done over the whole domain' ) |
---|
[531] | 536 | ENDIF |
---|
[1593] | 537 | ijsplt = isplt * jsplt ! total number of processors ijsplt |
---|
[531] | 538 | ENDIF |
---|
| 539 | IF(lwp) WRITE(numout,*)' - The total number of processors over which the' |
---|
| 540 | IF(lwp) WRITE(numout,*)' print control will be done is ijsplt : ', ijsplt |
---|
[1593] | 541 | ! |
---|
| 542 | ! ! indices used for the SUM control |
---|
| 543 | IF( nictls+nictle+njctls+njctle == 0 ) THEN ! print control done over the default area |
---|
[3764] | 544 | lsp_area = .FALSE. |
---|
[1593] | 545 | ELSE ! print control done over a specific area |
---|
[531] | 546 | lsp_area = .TRUE. |
---|
| 547 | IF( nictls < 1 .OR. nictls > jpiglo ) THEN |
---|
| 548 | CALL ctl_warn( ' - nictls must be 1<=nictls>=jpiglo, it is forced to 1' ) |
---|
| 549 | nictls = 1 |
---|
| 550 | ENDIF |
---|
| 551 | IF( nictle < 1 .OR. nictle > jpiglo ) THEN |
---|
| 552 | CALL ctl_warn( ' - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' ) |
---|
| 553 | nictle = jpiglo |
---|
| 554 | ENDIF |
---|
| 555 | IF( njctls < 1 .OR. njctls > jpjglo ) THEN |
---|
| 556 | CALL ctl_warn( ' - njctls must be 1<=njctls>=jpjglo, it is forced to 1' ) |
---|
| 557 | njctls = 1 |
---|
| 558 | ENDIF |
---|
| 559 | IF( njctle < 1 .OR. njctle > jpjglo ) THEN |
---|
| 560 | CALL ctl_warn( ' - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' ) |
---|
| 561 | njctle = jpjglo |
---|
| 562 | ENDIF |
---|
[1593] | 563 | ENDIF |
---|
| 564 | ENDIF |
---|
[2442] | 565 | ! |
---|
[3764] | 566 | IF( nbench == 1 ) THEN ! Benchmark |
---|
[531] | 567 | SELECT CASE ( cp_cfg ) |
---|
[1593] | 568 | CASE ( 'gyre' ) ; CALL ctl_warn( ' The Benchmark is activated ' ) |
---|
| 569 | CASE DEFAULT ; CALL ctl_stop( ' The Benchmark is based on the GYRE configuration:', & |
---|
[4147] | 570 | & ' cp_cfg = "gyre" in namelist &namcfg or set nbench = 0' ) |
---|
[531] | 571 | END SELECT |
---|
| 572 | ENDIF |
---|
[1593] | 573 | ! |
---|
[3764] | 574 | IF( 1_wp /= SIGN(1._wp,-0._wp) ) CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows ', & |
---|
| 575 | & 'f2003 standard. ' , & |
---|
| 576 | & 'Compile with key_nosignedzero enabled' ) |
---|
| 577 | ! |
---|
[2496] | 578 | END SUBROUTINE nemo_ctl |
---|
[467] | 579 | |
---|
| 580 | |
---|
[2496] | 581 | SUBROUTINE nemo_closefile |
---|
[467] | 582 | !!---------------------------------------------------------------------- |
---|
[2496] | 583 | !! *** ROUTINE nemo_closefile *** |
---|
[467] | 584 | !! |
---|
| 585 | !! ** Purpose : Close the files |
---|
| 586 | !!---------------------------------------------------------------------- |
---|
[1593] | 587 | ! |
---|
| 588 | IF( lk_mpp ) CALL mppsync |
---|
| 589 | ! |
---|
[1685] | 590 | CALL iom_close ! close all input/output files managed by iom_* |
---|
[1593] | 591 | ! |
---|
[4147] | 592 | IF( numstp /= -1 ) CLOSE( numstp ) ! time-step file |
---|
| 593 | IF( numsol /= -1 ) CLOSE( numsol ) ! solver file |
---|
| 594 | IF( numnam_ref /= -1 ) CLOSE( numnam_ref ) ! oce reference namelist |
---|
| 595 | IF( numnam_cfg /= -1 ) CLOSE( numnam_cfg ) ! oce configuration namelist |
---|
[4624] | 596 | IF( lwm.AND.numond /= -1 ) CLOSE( numond ) ! oce output namelist |
---|
[4147] | 597 | IF( numnam_ice_ref /= -1 ) CLOSE( numnam_ice_ref ) ! ice reference namelist |
---|
| 598 | IF( numnam_ice_cfg /= -1 ) CLOSE( numnam_ice_cfg ) ! ice configuration namelist |
---|
[4624] | 599 | IF( lwm.AND.numoni /= -1 ) CLOSE( numoni ) ! ice output namelist |
---|
[4147] | 600 | IF( numevo_ice /= -1 ) CLOSE( numevo_ice ) ! ice variables (temp. evolution) |
---|
| 601 | IF( numout /= 6 ) CLOSE( numout ) ! standard model output file |
---|
| 602 | IF( numdct_vol /= -1 ) CLOSE( numdct_vol ) ! volume transports |
---|
| 603 | IF( numdct_heat /= -1 ) CLOSE( numdct_heat ) ! heat transports |
---|
| 604 | IF( numdct_salt /= -1 ) CLOSE( numdct_salt ) ! salt transports |
---|
[3294] | 605 | |
---|
[1593] | 606 | ! |
---|
[2442] | 607 | numout = 6 ! redefine numout in case it is used after this point... |
---|
| 608 | ! |
---|
[2496] | 609 | END SUBROUTINE nemo_closefile |
---|
[467] | 610 | |
---|
[2715] | 611 | |
---|
| 612 | SUBROUTINE nemo_alloc |
---|
| 613 | !!---------------------------------------------------------------------- |
---|
| 614 | !! *** ROUTINE nemo_alloc *** |
---|
| 615 | !! |
---|
| 616 | !! ** Purpose : Allocate all the dynamic arrays of the OPA modules |
---|
| 617 | !! |
---|
| 618 | !! ** Method : |
---|
| 619 | !!---------------------------------------------------------------------- |
---|
| 620 | USE diawri , ONLY: dia_wri_alloc |
---|
| 621 | USE dom_oce , ONLY: dom_oce_alloc |
---|
| 622 | USE ldfdyn_oce, ONLY: ldfdyn_oce_alloc |
---|
| 623 | USE ldftra_oce, ONLY: ldftra_oce_alloc |
---|
| 624 | USE trc_oce , ONLY: trc_oce_alloc |
---|
[5427] | 625 | USE diainsitutem, ONLY: insitu_tem_alloc |
---|
[3680] | 626 | #if defined key_diadct |
---|
| 627 | USE diadct , ONLY: diadct_alloc |
---|
| 628 | #endif |
---|
[4354] | 629 | #if defined key_bdy |
---|
| 630 | USE bdy_oce , ONLY: bdy_oce_alloc |
---|
| 631 | #endif |
---|
[2715] | 632 | ! |
---|
| 633 | INTEGER :: ierr |
---|
| 634 | !!---------------------------------------------------------------------- |
---|
| 635 | ! |
---|
[3764] | 636 | ierr = oce_alloc () ! ocean |
---|
[2715] | 637 | ierr = ierr + dia_wri_alloc () |
---|
| 638 | ierr = ierr + dom_oce_alloc () ! ocean domain |
---|
| 639 | ierr = ierr + ldfdyn_oce_alloc() ! ocean lateral physics : dynamics |
---|
| 640 | ierr = ierr + ldftra_oce_alloc() ! ocean lateral physics : tracers |
---|
| 641 | ierr = ierr + zdf_oce_alloc () ! ocean vertical physics |
---|
[5427] | 642 | ierr = ierr + insitu_tem_alloc() |
---|
[2715] | 643 | ! |
---|
| 644 | ierr = ierr + trc_oce_alloc () ! shared TRC / TRA arrays |
---|
| 645 | ! |
---|
[3680] | 646 | #if defined key_diadct |
---|
| 647 | ierr = ierr + diadct_alloc () ! |
---|
| 648 | #endif |
---|
[4354] | 649 | #if defined key_bdy |
---|
| 650 | ierr = ierr + bdy_oce_alloc () ! bdy masks (incl. initialization) |
---|
| 651 | #endif |
---|
[3680] | 652 | ! |
---|
[2715] | 653 | IF( lk_mpp ) CALL mpp_sum( ierr ) |
---|
| 654 | IF( ierr /= 0 ) CALL ctl_stop( 'STOP', 'nemo_alloc : unable to allocate standard ocean arrays' ) |
---|
| 655 | ! |
---|
| 656 | END SUBROUTINE nemo_alloc |
---|
| 657 | |
---|
| 658 | |
---|
| 659 | SUBROUTINE nemo_partition( num_pes ) |
---|
| 660 | !!---------------------------------------------------------------------- |
---|
| 661 | !! *** ROUTINE nemo_partition *** |
---|
| 662 | !! |
---|
[3764] | 663 | !! ** Purpose : |
---|
[2715] | 664 | !! |
---|
| 665 | !! ** Method : |
---|
| 666 | !!---------------------------------------------------------------------- |
---|
[4990] | 667 | INTEGER, INTENT(in) :: num_pes ! The number of MPI processes we have |
---|
[2715] | 668 | ! |
---|
| 669 | INTEGER, PARAMETER :: nfactmax = 20 |
---|
| 670 | INTEGER :: nfact ! The no. of factors returned |
---|
| 671 | INTEGER :: ierr ! Error flag |
---|
| 672 | INTEGER :: ji |
---|
| 673 | INTEGER :: idiff, mindiff, imin ! For choosing pair of factors that are closest in value |
---|
| 674 | INTEGER, DIMENSION(nfactmax) :: ifact ! Array of factors |
---|
| 675 | !!---------------------------------------------------------------------- |
---|
[4990] | 676 | ! |
---|
[2715] | 677 | ierr = 0 |
---|
[4990] | 678 | ! |
---|
[2715] | 679 | CALL factorise( ifact, nfactmax, nfact, num_pes, ierr ) |
---|
[4990] | 680 | ! |
---|
[2715] | 681 | IF( nfact <= 1 ) THEN |
---|
| 682 | WRITE (numout, *) 'WARNING: factorisation of number of PEs failed' |
---|
| 683 | WRITE (numout, *) ' : using grid of ',num_pes,' x 1' |
---|
| 684 | jpnj = 1 |
---|
| 685 | jpni = num_pes |
---|
| 686 | ELSE |
---|
| 687 | ! Search through factors for the pair that are closest in value |
---|
| 688 | mindiff = 1000000 |
---|
| 689 | imin = 1 |
---|
| 690 | DO ji = 1, nfact-1, 2 |
---|
| 691 | idiff = ABS( ifact(ji) - ifact(ji+1) ) |
---|
| 692 | IF( idiff < mindiff ) THEN |
---|
| 693 | mindiff = idiff |
---|
| 694 | imin = ji |
---|
| 695 | ENDIF |
---|
| 696 | END DO |
---|
| 697 | jpnj = ifact(imin) |
---|
| 698 | jpni = ifact(imin + 1) |
---|
| 699 | ENDIF |
---|
| 700 | ! |
---|
| 701 | jpnij = jpni*jpnj |
---|
| 702 | ! |
---|
| 703 | END SUBROUTINE nemo_partition |
---|
| 704 | |
---|
| 705 | |
---|
| 706 | SUBROUTINE factorise( kfax, kmaxfax, knfax, kn, kerr ) |
---|
| 707 | !!---------------------------------------------------------------------- |
---|
| 708 | !! *** ROUTINE factorise *** |
---|
| 709 | !! |
---|
| 710 | !! ** Purpose : return the prime factors of n. |
---|
[3764] | 711 | !! knfax factors are returned in array kfax which is of |
---|
[2715] | 712 | !! maximum dimension kmaxfax. |
---|
| 713 | !! ** Method : |
---|
| 714 | !!---------------------------------------------------------------------- |
---|
| 715 | INTEGER , INTENT(in ) :: kn, kmaxfax |
---|
| 716 | INTEGER , INTENT( out) :: kerr, knfax |
---|
| 717 | INTEGER, DIMENSION(kmaxfax), INTENT( out) :: kfax |
---|
| 718 | ! |
---|
| 719 | INTEGER :: ifac, jl, inu |
---|
| 720 | INTEGER, PARAMETER :: ntest = 14 |
---|
| 721 | INTEGER :: ilfax(ntest) |
---|
[4990] | 722 | ! |
---|
[2715] | 723 | ! lfax contains the set of allowed factors. |
---|
| 724 | data (ilfax(jl),jl=1,ntest) / 16384, 8192, 4096, 2048, 1024, 512, 256, & |
---|
| 725 | & 128, 64, 32, 16, 8, 4, 2 / |
---|
| 726 | !!---------------------------------------------------------------------- |
---|
| 727 | |
---|
| 728 | ! Clear the error flag and initialise output vars |
---|
| 729 | kerr = 0 |
---|
| 730 | kfax = 1 |
---|
| 731 | knfax = 0 |
---|
| 732 | |
---|
| 733 | ! Find the factors of n. |
---|
| 734 | IF( kn == 1 ) GOTO 20 |
---|
| 735 | |
---|
| 736 | ! nu holds the unfactorised part of the number. |
---|
| 737 | ! knfax holds the number of factors found. |
---|
| 738 | ! l points to the allowed factor list. |
---|
| 739 | ! ifac holds the current factor. |
---|
| 740 | |
---|
| 741 | inu = kn |
---|
| 742 | knfax = 0 |
---|
| 743 | |
---|
| 744 | DO jl = ntest, 1, -1 |
---|
| 745 | ! |
---|
| 746 | ifac = ilfax(jl) |
---|
| 747 | IF( ifac > inu ) CYCLE |
---|
| 748 | |
---|
| 749 | ! Test whether the factor will divide. |
---|
| 750 | |
---|
| 751 | IF( MOD(inu,ifac) == 0 ) THEN |
---|
| 752 | ! |
---|
| 753 | knfax = knfax + 1 ! Add the factor to the list |
---|
| 754 | IF( knfax > kmaxfax ) THEN |
---|
| 755 | kerr = 6 |
---|
| 756 | write (*,*) 'FACTOR: insufficient space in factor array ', knfax |
---|
| 757 | return |
---|
| 758 | ENDIF |
---|
| 759 | kfax(knfax) = ifac |
---|
| 760 | ! Store the other factor that goes with this one |
---|
| 761 | knfax = knfax + 1 |
---|
| 762 | kfax(knfax) = inu / ifac |
---|
| 763 | !WRITE (*,*) 'ARPDBG, factors ',knfax-1,' & ',knfax,' are ', kfax(knfax-1),' and ',kfax(knfax) |
---|
| 764 | ENDIF |
---|
| 765 | ! |
---|
| 766 | END DO |
---|
| 767 | |
---|
| 768 | 20 CONTINUE ! Label 20 is the exit point from the factor search loop. |
---|
| 769 | ! |
---|
| 770 | END SUBROUTINE factorise |
---|
| 771 | |
---|
[3294] | 772 | #if defined key_mpp_mpi |
---|
[4990] | 773 | |
---|
[3294] | 774 | SUBROUTINE nemo_northcomms |
---|
| 775 | !!====================================================================== |
---|
| 776 | !! *** ROUTINE nemo_northcomms *** |
---|
[4230] | 777 | !! nemo_northcomms : Setup for north fold exchanges with explicit |
---|
| 778 | !! point-to-point messaging |
---|
[3294] | 779 | !!===================================================================== |
---|
| 780 | !!---------------------------------------------------------------------- |
---|
[3764] | 781 | !! |
---|
[3294] | 782 | !! ** Purpose : Initialization of the northern neighbours lists. |
---|
| 783 | !!---------------------------------------------------------------------- |
---|
[3764] | 784 | !! 1.0 ! 2011-10 (A. C. Coward, NOCS & J. Donners, PRACE) |
---|
[4230] | 785 | !! 2.0 ! 2013-06 Setup avoiding MPI communication (I. Epicoco, S. Mocavero, CMCC) |
---|
[3294] | 786 | !!---------------------------------------------------------------------- |
---|
| 787 | |
---|
[4230] | 788 | INTEGER :: sxM, dxM, sxT, dxT, jn |
---|
| 789 | INTEGER :: njmppmax |
---|
[3294] | 790 | |
---|
[4230] | 791 | njmppmax = MAXVAL( njmppt ) |
---|
| 792 | |
---|
| 793 | !initializes the north-fold communication variables |
---|
| 794 | isendto(:) = 0 |
---|
[3294] | 795 | nsndto = 0 |
---|
| 796 | |
---|
[4230] | 797 | !if I am a process in the north |
---|
| 798 | IF ( njmpp == njmppmax ) THEN |
---|
| 799 | !sxM is the first point (in the global domain) needed to compute the |
---|
| 800 | !north-fold for the current process |
---|
| 801 | sxM = jpiglo - nimppt(narea) - nlcit(narea) + 1 |
---|
| 802 | !dxM is the last point (in the global domain) needed to compute the |
---|
| 803 | !north-fold for the current process |
---|
| 804 | dxM = jpiglo - nimppt(narea) + 2 |
---|
[3294] | 805 | |
---|
[4230] | 806 | !loop over the other north-fold processes to find the processes |
---|
| 807 | !managing the points belonging to the sxT-dxT range |
---|
[4671] | 808 | |
---|
| 809 | DO jn = 1, jpni |
---|
[4230] | 810 | !sxT is the first point (in the global domain) of the jn |
---|
| 811 | !process |
---|
[4671] | 812 | sxT = nfiimpp(jn, jpnj) |
---|
[4230] | 813 | !dxT is the last point (in the global domain) of the jn |
---|
| 814 | !process |
---|
[4671] | 815 | dxT = nfiimpp(jn, jpnj) + nfilcit(jn, jpnj) - 1 |
---|
[4230] | 816 | IF ((sxM .gt. sxT) .AND. (sxM .lt. dxT)) THEN |
---|
| 817 | nsndto = nsndto + 1 |
---|
[4671] | 818 | isendto(nsndto) = jn |
---|
[4645] | 819 | ELSEIF ((sxM .le. sxT) .AND. (dxM .ge. dxT)) THEN |
---|
[4230] | 820 | nsndto = nsndto + 1 |
---|
[4671] | 821 | isendto(nsndto) = jn |
---|
[4230] | 822 | ELSEIF ((dxM .lt. dxT) .AND. (sxT .lt. dxM)) THEN |
---|
| 823 | nsndto = nsndto + 1 |
---|
[4671] | 824 | isendto(nsndto) = jn |
---|
[4230] | 825 | END IF |
---|
| 826 | END DO |
---|
[4671] | 827 | nfsloop = 1 |
---|
| 828 | nfeloop = nlci |
---|
| 829 | DO jn = 2,jpni-1 |
---|
| 830 | IF(nfipproc(jn,jpnj) .eq. (narea - 1)) THEN |
---|
| 831 | IF (nfipproc(jn - 1 ,jpnj) .eq. -1) THEN |
---|
| 832 | nfsloop = nldi |
---|
| 833 | ENDIF |
---|
| 834 | IF (nfipproc(jn + 1,jpnj) .eq. -1) THEN |
---|
| 835 | nfeloop = nlei |
---|
| 836 | ENDIF |
---|
| 837 | ENDIF |
---|
| 838 | END DO |
---|
| 839 | |
---|
[3294] | 840 | ENDIF |
---|
[4230] | 841 | l_north_nogather = .TRUE. |
---|
[3294] | 842 | END SUBROUTINE nemo_northcomms |
---|
| 843 | #else |
---|
| 844 | SUBROUTINE nemo_northcomms ! Dummy routine |
---|
| 845 | WRITE(*,*) 'nemo_northcomms: You should not have seen this print! error?' |
---|
| 846 | END SUBROUTINE nemo_northcomms |
---|
| 847 | #endif |
---|
[4990] | 848 | |
---|
[3] | 849 | !!====================================================================== |
---|
[2496] | 850 | END MODULE nemogcm |
---|
[4354] | 851 | |
---|
| 852 | |
---|