[3324] | 1 | MODULE nemogcm |
---|
| 2 | !!====================================================================== |
---|
| 3 | !! *** MODULE nemogcm *** |
---|
[7646] | 4 | !! StandAlone Surface module : surface fluxes + sea-ice + iceberg floats |
---|
[3324] | 5 | !!====================================================================== |
---|
[7646] | 6 | !! History : 3.6 ! 2011-11 (S. Alderson, G. Madec) original code |
---|
| 7 | !! - ! 2013-06 (I. Epicoco, S. Mocavero, CMCC) nemo_northcomms: setup avoiding MPI communication |
---|
| 8 | !! - ! 2014-12 (G. Madec) remove KPP scheme and cross-land advection (cla) |
---|
| 9 | !! 4.0 ! 2016-10 (G. Madec, S. Flavoni) domain configuration / user defined interface |
---|
[3324] | 10 | !!---------------------------------------------------------------------- |
---|
| 11 | |
---|
| 12 | !!---------------------------------------------------------------------- |
---|
[7646] | 13 | !! nemo_gcm : solve ocean dynamics, tracer, biogeochemistry and/or sea-ice |
---|
| 14 | !! nemo_init : initialization of the NEMO system |
---|
| 15 | !! nemo_ctl : initialisation of the contol print |
---|
| 16 | !! nemo_closefile: close remaining open files |
---|
| 17 | !! nemo_alloc : dynamical allocation |
---|
[3324] | 18 | !!---------------------------------------------------------------------- |
---|
[7646] | 19 | USE step_oce ! module used in the ocean time stepping module |
---|
| 20 | USE sbc_oce ! surface boundary condition: ocean |
---|
| 21 | USE phycst ! physical constant (par_cst routine) |
---|
| 22 | USE domain ! domain initialization (dom_init & dom_cfg routines) |
---|
[9200] | 23 | USE closea ! treatment of closed seas (for ln_closea) |
---|
[7646] | 24 | USE usrdef_nam ! user defined configuration |
---|
| 25 | USE daymod ! calendar |
---|
[8583] | 26 | USE restart ! open restart file |
---|
[7646] | 27 | USE step ! NEMO time-stepping (stp routine) |
---|
| 28 | USE cpl_oasis3 ! |
---|
| 29 | USE sbcssm ! |
---|
| 30 | USE icbini ! handle bergs, initialisation |
---|
| 31 | USE icbstp ! handle bergs, calving, themodynamics and transport |
---|
[9019] | 32 | USE bdyini ! open boundary cond. setting (bdy_init routine). mandatory for sea-ice |
---|
| 33 | USE bdydta ! open boundary cond. setting (bdy_dta_init routine). mandatory for sea-ice |
---|
[12377] | 34 | USE diu_layers ! diurnal bulk SST and coolskin |
---|
| 35 | USE step_diu ! diurnal bulk SST timestepping (called from here if run offline) |
---|
[7646] | 36 | ! |
---|
[12641] | 37 | USE in_out_manager ! I/O manager |
---|
[7646] | 38 | USE lib_mpp ! distributed memory computing |
---|
| 39 | USE mppini ! shared/distributed memory setting (mpp_init routine) |
---|
[9213] | 40 | USE lbcnfd , ONLY : isendto, nsndto, nfsloop, nfeloop ! Setup of north fold exchanges |
---|
[7646] | 41 | USE lib_fortran ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined) |
---|
[3324] | 42 | #if defined key_iomput |
---|
[7646] | 43 | USE xios ! xIOserver |
---|
[3324] | 44 | #endif |
---|
[9781] | 45 | #if defined key_agrif && defined key_si3 |
---|
| 46 | USE agrif_ice_update ! ice update |
---|
| 47 | #endif |
---|
[3324] | 48 | |
---|
| 49 | IMPLICIT NONE |
---|
| 50 | PRIVATE |
---|
| 51 | |
---|
| 52 | PUBLIC nemo_gcm ! called by model.F90 |
---|
| 53 | PUBLIC nemo_init ! needed by AGRIF |
---|
| 54 | |
---|
| 55 | CHARACTER(lc) :: cform_aaa="( /, 'AAAAAAAA', / ) " ! flag for output listing |
---|
| 56 | |
---|
[12377] | 57 | #if defined key_mpp_mpi |
---|
| 58 | INCLUDE 'mpif.h' |
---|
| 59 | #endif |
---|
| 60 | |
---|
[3324] | 61 | !!---------------------------------------------------------------------- |
---|
[10068] | 62 | !! NEMO/SAS 4.0 , NEMO Consortium (2018) |
---|
[5215] | 63 | !! $Id$ |
---|
[10068] | 64 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
[3324] | 65 | !!---------------------------------------------------------------------- |
---|
| 66 | CONTAINS |
---|
| 67 | |
---|
| 68 | SUBROUTINE nemo_gcm |
---|
| 69 | !!---------------------------------------------------------------------- |
---|
| 70 | !! *** ROUTINE nemo_gcm *** |
---|
| 71 | !! |
---|
[7646] | 72 | !! ** Purpose : NEMO solves the primitive equations on an orthogonal |
---|
[3324] | 73 | !! curvilinear mesh on the sphere. |
---|
| 74 | !! |
---|
| 75 | !! ** Method : - model general initialization |
---|
| 76 | !! - launch the time-stepping (stp routine) |
---|
| 77 | !! - finalize the run by closing files and communications |
---|
| 78 | !! |
---|
| 79 | !! References : Madec, Delecluse, Imbard, and Levy, 1997: internal report, IPSL. |
---|
| 80 | !! Madec, 2008, internal report, IPSL. |
---|
| 81 | !!---------------------------------------------------------------------- |
---|
[7646] | 82 | INTEGER :: istp ! time step index |
---|
[3324] | 83 | !!---------------------------------------------------------------------- |
---|
| 84 | ! |
---|
| 85 | #if defined key_agrif |
---|
[9213] | 86 | CALL Agrif_Init_Grids() ! AGRIF: set the meshes |
---|
[3324] | 87 | #endif |
---|
| 88 | ! !-----------------------! |
---|
| 89 | CALL nemo_init !== Initialisations ==! |
---|
| 90 | ! !-----------------------! |
---|
| 91 | #if defined key_agrif |
---|
[12377] | 92 | Kbb_a = Nbb; Kmm_a = Nnn; Krhs_a = Nrhs ! agrif_oce module copies of time level indices |
---|
[5407] | 93 | CALL Agrif_Declare_Var_dom ! AGRIF: set the meshes for DOM |
---|
| 94 | CALL Agrif_Declare_Var ! " " " " " DYN/TRA |
---|
| 95 | # if defined key_top |
---|
| 96 | CALL Agrif_Declare_Var_top ! " " " " " TOP |
---|
| 97 | # endif |
---|
[9570] | 98 | # if defined key_si3 |
---|
[9611] | 99 | CALL Agrif_Declare_Var_ice ! " " " " " Sea ice |
---|
[7646] | 100 | # endif |
---|
[3324] | 101 | #endif |
---|
| 102 | ! check that all process are still there... If some process have an error, |
---|
| 103 | ! they will never enter in step and other processes will wait until the end of the cpu time! |
---|
[10425] | 104 | CALL mpp_max( 'nemogcm', nstop ) |
---|
[3324] | 105 | |
---|
| 106 | IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA |
---|
| 107 | |
---|
| 108 | ! !-----------------------! |
---|
| 109 | ! !== time stepping ==! |
---|
| 110 | ! !-----------------------! |
---|
| 111 | istp = nit000 |
---|
[9213] | 112 | ! |
---|
[7646] | 113 | #if defined key_agrif |
---|
[9213] | 114 | ! !== AGRIF time-stepping ==! |
---|
[7646] | 115 | CALL Agrif_Regrid() |
---|
[9213] | 116 | ! |
---|
[9781] | 117 | #if defined key_si3 |
---|
| 118 | ! Recursive update from highest nested level to lowest: |
---|
[12377] | 119 | Kbb_a = Nbb; Kmm_a = Nnn; Krhs_a = Nrhs ! agrif_oce module copies of time level indices |
---|
[9781] | 120 | CALL Agrif_step_child_adj(Agrif_update_ice) |
---|
| 121 | #endif |
---|
| 122 | ! |
---|
[9213] | 123 | DO WHILE( istp <= nitend .AND. nstop == 0 ) |
---|
| 124 | CALL stp |
---|
| 125 | istp = istp + 1 |
---|
| 126 | END DO |
---|
| 127 | ! |
---|
| 128 | IF( .NOT. Agrif_Root() ) THEN |
---|
| 129 | CALL Agrif_ParentGrid_To_ChildGrid() |
---|
| 130 | IF( ln_timing ) CALL timing_finalize |
---|
| 131 | CALL Agrif_ChildGrid_To_ParentGrid() |
---|
| 132 | ENDIF |
---|
| 133 | ! |
---|
[3324] | 134 | #else |
---|
[9213] | 135 | ! |
---|
| 136 | IF( .NOT.ln_diurnal_only ) THEN !== Standard time-stepping ==! |
---|
| 137 | ! |
---|
| 138 | DO WHILE( istp <= nitend .AND. nstop == 0 ) |
---|
[12377] | 139 | #if defined key_mpp_mpi |
---|
| 140 | ncom_stp = istp |
---|
| 141 | IF ( istp == ( nit000 + 1 ) ) elapsed_time = MPI_Wtime() |
---|
| 142 | IF ( istp == nitend ) elapsed_time = MPI_Wtime() - elapsed_time |
---|
| 143 | #endif |
---|
[9213] | 144 | CALL stp ( istp ) |
---|
| 145 | istp = istp + 1 |
---|
[7646] | 146 | END DO |
---|
[9213] | 147 | ! |
---|
| 148 | ELSE !== diurnal SST time-steeping only ==! |
---|
| 149 | ! |
---|
| 150 | DO WHILE( istp <= nitend .AND. nstop == 0 ) |
---|
| 151 | CALL stp_diurnal( istp ) ! time step only the diurnal SST |
---|
| 152 | istp = istp + 1 |
---|
| 153 | END DO |
---|
| 154 | ! |
---|
| 155 | ENDIF |
---|
[5407] | 156 | ! |
---|
[9213] | 157 | #endif |
---|
| 158 | ! |
---|
[5407] | 159 | IF( ln_icebergs ) CALL icb_end( nitend ) |
---|
| 160 | |
---|
[3324] | 161 | ! !------------------------! |
---|
| 162 | ! !== finalize the run ==! |
---|
| 163 | ! !------------------------! |
---|
[7646] | 164 | IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA |
---|
[3324] | 165 | ! |
---|
[7646] | 166 | IF( nstop /= 0 .AND. lwp ) THEN ! error print |
---|
[11536] | 167 | WRITE(ctmp1,*) ' ==>>> nemo_gcm: a total of ', nstop, ' errors have been found' |
---|
| 168 | CALL ctl_stop( ctmp1 ) |
---|
[3324] | 169 | ENDIF |
---|
| 170 | ! |
---|
[9019] | 171 | IF( ln_timing ) CALL timing_finalize |
---|
[3324] | 172 | ! |
---|
| 173 | CALL nemo_closefile |
---|
[5407] | 174 | ! |
---|
[3769] | 175 | #if defined key_iomput |
---|
[9213] | 176 | CALL xios_finalize ! end mpp communications with xios |
---|
| 177 | IF( lk_oasis ) CALL cpl_finalize ! end coupling and mpp communications with OASIS |
---|
[3769] | 178 | #else |
---|
[9213] | 179 | IF ( lk_oasis ) THEN ; CALL cpl_finalize ! end coupling and mpp communications with OASIS |
---|
[11536] | 180 | ELSEIF( lk_mpp ) THEN ; CALL mppstop ! end mpp communications |
---|
[5407] | 181 | ENDIF |
---|
[3769] | 182 | #endif |
---|
[3324] | 183 | ! |
---|
[11229] | 184 | IF(lwm) THEN |
---|
| 185 | IF( nstop == 0 ) THEN ; STOP 0 |
---|
[11536] | 186 | ELSE ; STOP 123 |
---|
[11229] | 187 | ENDIF |
---|
| 188 | ENDIF |
---|
| 189 | ! |
---|
[3324] | 190 | END SUBROUTINE nemo_gcm |
---|
| 191 | |
---|
| 192 | |
---|
| 193 | SUBROUTINE nemo_init |
---|
| 194 | !!---------------------------------------------------------------------- |
---|
| 195 | !! *** ROUTINE nemo_init *** |
---|
| 196 | !! |
---|
| 197 | !! ** Purpose : initialization of the NEMO GCM |
---|
| 198 | !!---------------------------------------------------------------------- |
---|
[11536] | 199 | INTEGER :: ios, ilocal_comm ! local integers |
---|
[9213] | 200 | !! |
---|
[12377] | 201 | NAMELIST/namctl/ sn_cfctl, nn_print, nn_ictls, nn_ictle, & |
---|
[10570] | 202 | & nn_isplt , nn_jsplt, nn_jctls, nn_jctle, & |
---|
[9019] | 203 | & ln_timing, ln_diacfl |
---|
[9213] | 204 | NAMELIST/namcfg/ ln_read_cfg, cn_domcfg, ln_closea, ln_write_cfg, cn_domcfg_out, ln_use_jattr |
---|
[3324] | 205 | !!---------------------------------------------------------------------- |
---|
[5407] | 206 | ! |
---|
[11536] | 207 | IF( lk_oasis ) THEN ; cxios_context = 'sas' |
---|
| 208 | ELSE ; cxios_context = 'nemo' |
---|
[7646] | 209 | ENDIF |
---|
| 210 | ! |
---|
[11536] | 211 | ! !-------------------------------------------------! |
---|
| 212 | ! ! set communicator & select the local rank ! |
---|
| 213 | ! ! must be done as soon as possible to get narea ! |
---|
| 214 | ! !-------------------------------------------------! |
---|
[7646] | 215 | ! |
---|
[3324] | 216 | #if defined key_iomput |
---|
| 217 | IF( Agrif_Root() ) THEN |
---|
[5407] | 218 | IF( lk_oasis ) THEN |
---|
[11536] | 219 | CALL cpl_init( "sas", ilocal_comm ) ! nemo local communicator given by oasis |
---|
| 220 | CALL xios_initialize( "not used",local_comm=ilocal_comm ) ! send nemo communicator to xios |
---|
[5407] | 221 | ELSE |
---|
[7646] | 222 | CALL xios_initialize( "for_xios_mpi_id",return_comm=ilocal_comm ) ! nemo local communicator given by xios |
---|
[5407] | 223 | ENDIF |
---|
[3324] | 224 | ENDIF |
---|
[11536] | 225 | CALL mpp_start( ilocal_comm ) |
---|
[3324] | 226 | #else |
---|
[5407] | 227 | IF( lk_oasis ) THEN |
---|
| 228 | IF( Agrif_Root() ) THEN |
---|
[11536] | 229 | CALL cpl_init( "sas", ilocal_comm ) ! nemo local communicator given by oasis |
---|
[5407] | 230 | ENDIF |
---|
[11536] | 231 | CALL mpp_start( ilocal_comm ) |
---|
[5407] | 232 | ELSE |
---|
[11536] | 233 | CALL mpp_start( ) |
---|
[5407] | 234 | ENDIF |
---|
[3324] | 235 | #endif |
---|
[11536] | 236 | ! |
---|
| 237 | narea = mpprank + 1 ! mpprank: the rank of proc (0 --> mppsize -1 ) |
---|
| 238 | lwm = (narea == 1) ! control of output namelists |
---|
| 239 | ! |
---|
| 240 | ! !---------------------------------------------------------------! |
---|
| 241 | ! ! Open output files, reference and configuration namelist files ! |
---|
| 242 | ! !---------------------------------------------------------------! |
---|
| 243 | ! |
---|
| 244 | ! open ocean.output as soon as possible to get all output prints (including errors messages) |
---|
| 245 | IF( lk_oasis ) THEN |
---|
[12377] | 246 | IF( lwm ) CALL ctl_opn( numout, 'sas.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. ) |
---|
[11536] | 247 | ! open reference and configuration namelist files |
---|
[12377] | 248 | CALL load_nml( numnam_ref, 'namelist_sas_ref', -1, lwm ) |
---|
| 249 | CALL load_nml( numnam_cfg, 'namelist_sas_cfg', -1, lwm ) |
---|
| 250 | IF( lwm ) CALL ctl_opn( numond, 'output.namelist_sas.dyn', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. ) |
---|
[10570] | 251 | ELSE |
---|
[12377] | 252 | IF( lwm ) CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. ) |
---|
[11536] | 253 | ! open reference and configuration namelist files |
---|
[12377] | 254 | CALL load_nml( numnam_ref, 'namelist_ref', -1, lwm ) |
---|
| 255 | CALL load_nml( numnam_cfg, 'namelist_cfg', -1, lwm ) |
---|
| 256 | IF( lwm ) CALL ctl_opn( numond, 'output.namelist.dyn', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. ) |
---|
[10570] | 257 | ENDIF |
---|
[11536] | 258 | ! open /dev/null file to be able to supress output write easily |
---|
[12641] | 259 | IF( Agrif_Root() ) THEN |
---|
[11536] | 260 | CALL ctl_opn( numnul, '/dev/null', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. ) |
---|
[12641] | 261 | #ifdef key_agrif |
---|
| 262 | ELSE |
---|
| 263 | numnul = Agrif_Parent(numnul) |
---|
| 264 | #endif |
---|
| 265 | ENDIF |
---|
[11536] | 266 | ! |
---|
| 267 | ! !--------------------! |
---|
[12377] | 268 | ! ! Open listing units ! -> need sn_cfctl from namctl to define lwp |
---|
[11536] | 269 | ! !--------------------! |
---|
| 270 | ! |
---|
| 271 | READ ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 ) |
---|
| 272 | 901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in reference namelist' ) |
---|
| 273 | READ ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 ) |
---|
| 274 | 902 IF( ios > 0 ) CALL ctl_nam ( ios , 'namctl in configuration namelist' ) |
---|
| 275 | ! |
---|
[12377] | 276 | ! finalize the definition of namctl variables |
---|
| 277 | IF( sn_cfctl%l_allon ) THEN |
---|
| 278 | ! Turn on all options. |
---|
| 279 | CALL nemo_set_cfctl( sn_cfctl, .TRUE., .TRUE. ) |
---|
| 280 | ! Ensure all processors are active |
---|
| 281 | sn_cfctl%procmin = 0 ; sn_cfctl%procmax = 1000000 ; sn_cfctl%procincr = 1 |
---|
| 282 | ELSEIF( sn_cfctl%l_config ) THEN |
---|
| 283 | ! Activate finer control of report outputs |
---|
| 284 | ! optionally switch off output from selected areas (note this only |
---|
| 285 | ! applies to output which does not involve global communications) |
---|
| 286 | IF( ( narea < sn_cfctl%procmin .OR. narea > sn_cfctl%procmax ) .OR. & |
---|
| 287 | & ( MOD( narea - sn_cfctl%procmin, sn_cfctl%procincr ) /= 0 ) ) & |
---|
| 288 | & CALL nemo_set_cfctl( sn_cfctl, .FALSE., .FALSE. ) |
---|
| 289 | ELSE |
---|
| 290 | ! turn off all options. |
---|
| 291 | CALL nemo_set_cfctl( sn_cfctl, .FALSE., .TRUE. ) |
---|
| 292 | ENDIF |
---|
[11536] | 293 | ! |
---|
[12377] | 294 | lwp = (narea == 1) .OR. sn_cfctl%l_oceout ! control of all listing output print |
---|
| 295 | ! |
---|
[11536] | 296 | IF(lwp) THEN ! open listing units |
---|
[3324] | 297 | ! |
---|
[11536] | 298 | IF( .NOT. lwm ) THEN ! alreay opened for narea == 1 |
---|
| 299 | IF(lk_oasis) THEN ; CALL ctl_opn( numout, 'sas.output','REPLACE','FORMATTED','SEQUENTIAL',-1,-1, .FALSE., narea ) |
---|
| 300 | ELSE ; CALL ctl_opn( numout, 'ocean.output','REPLACE','FORMATTED','SEQUENTIAL',-1,-1, .FALSE., narea ) |
---|
| 301 | ENDIF |
---|
[5407] | 302 | ENDIF |
---|
[3324] | 303 | ! |
---|
| 304 | WRITE(numout,*) |
---|
[11536] | 305 | WRITE(numout,*) ' CNRS - NERC - Met OFFICE - MERCATOR-ocean - CMCC' |
---|
[3324] | 306 | WRITE(numout,*) ' NEMO team' |
---|
| 307 | WRITE(numout,*) ' Ocean General Circulation Model' |
---|
[10570] | 308 | WRITE(numout,*) ' NEMO version 4.0 (2019) ' |
---|
[3331] | 309 | WRITE(numout,*) ' StandAlone Surface version (SAS) ' |
---|
[10570] | 310 | WRITE(numout,*) " ._ ._ ._ ._ ._ " |
---|
| 311 | WRITE(numout,*) " _.-._)`\_.-._)`\_.-._)`\_.-._)`\_.-._)`\_ " |
---|
[3324] | 312 | WRITE(numout,*) |
---|
[10570] | 313 | WRITE(numout,*) " o _, _, " |
---|
| 314 | WRITE(numout,*) " o .' ( .-' / " |
---|
| 315 | WRITE(numout,*) " o _/..._'. .' / " |
---|
| 316 | WRITE(numout,*) " ( o .-'` ` '-./ _.' " |
---|
| 317 | WRITE(numout,*) " ) ( o) ;= <_ ( " |
---|
| 318 | WRITE(numout,*) " ( '-.,\\__ __.-;`\ '. ) " |
---|
| 319 | WRITE(numout,*) " ) ) \) |`\ \) '. \ ( ( " |
---|
| 320 | WRITE(numout,*) " ( ( \_/ '-._\ ) ) " |
---|
[11229] | 321 | WRITE(numout,*) " ) ) jgs ` ( ( " |
---|
[10570] | 322 | WRITE(numout,*) " ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ " |
---|
[3324] | 323 | WRITE(numout,*) |
---|
[7646] | 324 | WRITE(numout,*) |
---|
[3324] | 325 | ! |
---|
[7646] | 326 | WRITE(numout,cform_aaa) ! Flag AAAAAAA |
---|
| 327 | ! |
---|
[3324] | 328 | ENDIF |
---|
[10459] | 329 | ! |
---|
[11536] | 330 | IF(lwm) WRITE( numond, namctl ) |
---|
| 331 | ! |
---|
| 332 | ! !------------------------------------! |
---|
| 333 | ! ! Set global domain size parameters ! |
---|
| 334 | ! !------------------------------------! |
---|
| 335 | ! |
---|
| 336 | READ ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 ) |
---|
| 337 | 903 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in reference namelist' ) |
---|
| 338 | READ ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 ) |
---|
| 339 | 904 IF( ios > 0 ) CALL ctl_nam ( ios , 'namcfg in configuration namelist' ) |
---|
| 340 | ! |
---|
| 341 | IF( ln_read_cfg ) THEN ! Read sizes in domain configuration file |
---|
| 342 | CALL domain_cfg ( cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio ) |
---|
| 343 | ELSE ! user-defined namelist |
---|
| 344 | CALL usr_def_nam( cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio ) |
---|
| 345 | ENDIF |
---|
| 346 | ! |
---|
| 347 | IF(lwm) WRITE( numond, namcfg ) |
---|
| 348 | ! |
---|
| 349 | ! !-----------------------------------------! |
---|
| 350 | ! ! mpp parameters and domain decomposition ! |
---|
| 351 | ! !-----------------------------------------! |
---|
| 352 | CALL mpp_init |
---|
[3324] | 353 | |
---|
[7646] | 354 | ! Now we know the dimensions of the grid and numout has been set: we can allocate arrays |
---|
[3324] | 355 | CALL nemo_alloc() |
---|
[9213] | 356 | |
---|
[12377] | 357 | ! Initialise time level indices |
---|
| 358 | Nbb = 1; Nnn = 2; Naa = 3; Nrhs = Naa |
---|
| 359 | |
---|
[3324] | 360 | ! !-------------------------------! |
---|
| 361 | ! ! NEMO general initialization ! |
---|
| 362 | ! !-------------------------------! |
---|
| 363 | |
---|
[7646] | 364 | CALL nemo_ctl ! Control prints |
---|
[3324] | 365 | ! |
---|
[9213] | 366 | ! ! General initialization |
---|
| 367 | IF( ln_timing ) CALL timing_init ! timing |
---|
| 368 | IF( ln_timing ) CALL timing_start( 'nemo_init') |
---|
[3324] | 369 | |
---|
[9213] | 370 | CALL phy_cst ! Physical constants |
---|
| 371 | CALL eos_init ! Equation of seawater |
---|
[12977] | 372 | CALL dom_init( Nbb, Nnn, Naa ) ! Domain |
---|
[12377] | 373 | IF( sn_cfctl%l_prtctl ) & |
---|
| 374 | & CALL prt_ctl_init ! Print control |
---|
[12977] | 375 | IF( ln_rstart ) CALL rst_read_open |
---|
[9213] | 376 | CALL day_init ! model calendar (using both namelist and restart infos) |
---|
[3324] | 377 | |
---|
[9213] | 378 | ! ! external forcing |
---|
[12377] | 379 | CALL sbc_init( Nbb, Nnn, Naa ) ! Forcings : surface module |
---|
[3324] | 380 | |
---|
[9019] | 381 | ! ==> clem: open boundaries init. is mandatory for sea-ice because ice BDY is not decoupled from |
---|
[5510] | 382 | ! the environment of ocean BDY. Therefore bdy is called in both OPA and SAS modules. |
---|
| 383 | ! This is not clean and should be changed in the future. |
---|
[9019] | 384 | CALL bdy_init |
---|
[5510] | 385 | ! ==> |
---|
[12489] | 386 | CALL icb_init( rn_Dt, nit000) ! initialise icebergs instance |
---|
[3324] | 387 | ! |
---|
[9213] | 388 | IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA |
---|
| 389 | ! |
---|
| 390 | IF( ln_timing ) CALL timing_stop( 'nemo_init') |
---|
| 391 | ! |
---|
[3324] | 392 | END SUBROUTINE nemo_init |
---|
| 393 | |
---|
| 394 | |
---|
| 395 | SUBROUTINE nemo_ctl |
---|
| 396 | !!---------------------------------------------------------------------- |
---|
| 397 | !! *** ROUTINE nemo_ctl *** |
---|
| 398 | !! |
---|
[9213] | 399 | !! ** Purpose : control print setting |
---|
[3324] | 400 | !! |
---|
[12377] | 401 | !! ** Method : - print namctl and namcfg information and check some consistencies |
---|
[3324] | 402 | !!---------------------------------------------------------------------- |
---|
| 403 | ! |
---|
| 404 | IF(lwp) THEN ! control print |
---|
| 405 | WRITE(numout,*) |
---|
[7646] | 406 | WRITE(numout,*) 'nemo_ctl: Control prints' |
---|
[9213] | 407 | WRITE(numout,*) '~~~~~~~~' |
---|
[3324] | 408 | WRITE(numout,*) ' Namelist namctl' |
---|
[12377] | 409 | WRITE(numout,*) ' sn_cfctl%l_glochk = ', sn_cfctl%l_glochk |
---|
| 410 | WRITE(numout,*) ' sn_cfctl%l_allon = ', sn_cfctl%l_allon |
---|
[10570] | 411 | WRITE(numout,*) ' finer control over o/p sn_cfctl%l_config = ', sn_cfctl%l_config |
---|
| 412 | WRITE(numout,*) ' sn_cfctl%l_runstat = ', sn_cfctl%l_runstat |
---|
| 413 | WRITE(numout,*) ' sn_cfctl%l_trcstat = ', sn_cfctl%l_trcstat |
---|
| 414 | WRITE(numout,*) ' sn_cfctl%l_oceout = ', sn_cfctl%l_oceout |
---|
| 415 | WRITE(numout,*) ' sn_cfctl%l_layout = ', sn_cfctl%l_layout |
---|
[12377] | 416 | WRITE(numout,*) ' sn_cfctl%l_prtctl = ', sn_cfctl%l_prtctl |
---|
| 417 | WRITE(numout,*) ' sn_cfctl%l_prttrc = ', sn_cfctl%l_prttrc |
---|
| 418 | WRITE(numout,*) ' sn_cfctl%l_oasout = ', sn_cfctl%l_oasout |
---|
[10570] | 419 | WRITE(numout,*) ' sn_cfctl%procmin = ', sn_cfctl%procmin |
---|
| 420 | WRITE(numout,*) ' sn_cfctl%procmax = ', sn_cfctl%procmax |
---|
| 421 | WRITE(numout,*) ' sn_cfctl%procincr = ', sn_cfctl%procincr |
---|
| 422 | WRITE(numout,*) ' sn_cfctl%ptimincr = ', sn_cfctl%ptimincr |
---|
[3324] | 423 | WRITE(numout,*) ' level of print nn_print = ', nn_print |
---|
| 424 | WRITE(numout,*) ' Start i indice for SUM control nn_ictls = ', nn_ictls |
---|
| 425 | WRITE(numout,*) ' End i indice for SUM control nn_ictle = ', nn_ictle |
---|
| 426 | WRITE(numout,*) ' Start j indice for SUM control nn_jctls = ', nn_jctls |
---|
| 427 | WRITE(numout,*) ' End j indice for SUM control nn_jctle = ', nn_jctle |
---|
| 428 | WRITE(numout,*) ' number of proc. following i nn_isplt = ', nn_isplt |
---|
| 429 | WRITE(numout,*) ' number of proc. following j nn_jsplt = ', nn_jsplt |
---|
[9019] | 430 | WRITE(numout,*) ' timing by routine ln_timing = ', ln_timing |
---|
| 431 | WRITE(numout,*) ' CFL diagnostics ln_diacfl = ', ln_diacfl |
---|
[3324] | 432 | ENDIF |
---|
| 433 | ! |
---|
| 434 | nprint = nn_print ! convert DOCTOR namelist names into OLD names |
---|
| 435 | nictls = nn_ictls |
---|
| 436 | nictle = nn_ictle |
---|
| 437 | njctls = nn_jctls |
---|
| 438 | njctle = nn_jctle |
---|
| 439 | isplt = nn_isplt |
---|
| 440 | jsplt = nn_jsplt |
---|
[4147] | 441 | |
---|
| 442 | IF(lwp) THEN ! control print |
---|
| 443 | WRITE(numout,*) |
---|
| 444 | WRITE(numout,*) ' Namelist namcfg' |
---|
[9213] | 445 | WRITE(numout,*) ' read domain configuration file ln_read_cfg = ', ln_read_cfg |
---|
[7646] | 446 | WRITE(numout,*) ' filename to be read cn_domcfg = ', TRIM(cn_domcfg) |
---|
[9213] | 447 | WRITE(numout,*) ' keep closed seas in the domain (if exist) ln_closea = ', ln_closea |
---|
| 448 | WRITE(numout,*) ' create a configuration definition file ln_write_cfg = ', ln_write_cfg |
---|
[7646] | 449 | WRITE(numout,*) ' filename to be written cn_domcfg_out = ', TRIM(cn_domcfg_out) |
---|
| 450 | WRITE(numout,*) ' use file attribute if exists as i/p j-start ln_use_jattr = ', ln_use_jattr |
---|
[4147] | 451 | ENDIF |
---|
[9213] | 452 | IF( .NOT.ln_read_cfg ) ln_closea = .false. ! dealing possible only with a domcfg file |
---|
| 453 | ! |
---|
[3324] | 454 | ! ! Parameter control |
---|
| 455 | ! |
---|
[12377] | 456 | IF( sn_cfctl%l_prtctl .OR. sn_cfctl%l_prttrc ) THEN ! sub-domain area indices for the control prints |
---|
[3324] | 457 | IF( lk_mpp .AND. jpnij > 1 ) THEN |
---|
| 458 | isplt = jpni ; jsplt = jpnj ; ijsplt = jpni*jpnj ! the domain is forced to the real split domain |
---|
| 459 | ELSE |
---|
| 460 | IF( isplt == 1 .AND. jsplt == 1 ) THEN |
---|
| 461 | CALL ctl_warn( ' - isplt & jsplt are equal to 1', & |
---|
| 462 | & ' - the print control will be done over the whole domain' ) |
---|
| 463 | ENDIF |
---|
| 464 | ijsplt = isplt * jsplt ! total number of processors ijsplt |
---|
| 465 | ENDIF |
---|
| 466 | IF(lwp) WRITE(numout,*)' - The total number of processors over which the' |
---|
| 467 | IF(lwp) WRITE(numout,*)' print control will be done is ijsplt : ', ijsplt |
---|
| 468 | ! |
---|
| 469 | ! ! indices used for the SUM control |
---|
| 470 | IF( nictls+nictle+njctls+njctle == 0 ) THEN ! print control done over the default area |
---|
[7646] | 471 | lsp_area = .FALSE. |
---|
[3324] | 472 | ELSE ! print control done over a specific area |
---|
| 473 | lsp_area = .TRUE. |
---|
| 474 | IF( nictls < 1 .OR. nictls > jpiglo ) THEN |
---|
| 475 | CALL ctl_warn( ' - nictls must be 1<=nictls>=jpiglo, it is forced to 1' ) |
---|
| 476 | nictls = 1 |
---|
| 477 | ENDIF |
---|
| 478 | IF( nictle < 1 .OR. nictle > jpiglo ) THEN |
---|
| 479 | CALL ctl_warn( ' - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' ) |
---|
| 480 | nictle = jpiglo |
---|
| 481 | ENDIF |
---|
| 482 | IF( njctls < 1 .OR. njctls > jpjglo ) THEN |
---|
| 483 | CALL ctl_warn( ' - njctls must be 1<=njctls>=jpjglo, it is forced to 1' ) |
---|
| 484 | njctls = 1 |
---|
| 485 | ENDIF |
---|
| 486 | IF( njctle < 1 .OR. njctle > jpjglo ) THEN |
---|
| 487 | CALL ctl_warn( ' - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' ) |
---|
| 488 | njctle = jpjglo |
---|
| 489 | ENDIF |
---|
| 490 | ENDIF |
---|
| 491 | ENDIF |
---|
| 492 | ! |
---|
[9213] | 493 | IF( 1._wp /= SIGN(1._wp,-0._wp) ) CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows f2003 standard.', & |
---|
[11229] | 494 | & 'Compile with key_nosignedzero enabled:', & |
---|
| 495 | & '--> add -Dkey_nosignedzero to the definition of %CPP in your arch file' ) |
---|
[5407] | 496 | ! |
---|
[9213] | 497 | #if defined key_agrif |
---|
| 498 | IF( ln_timing ) CALL ctl_stop( 'AGRIF not implemented with ln_timing = true') |
---|
| 499 | #endif |
---|
| 500 | ! |
---|
[3324] | 501 | END SUBROUTINE nemo_ctl |
---|
| 502 | |
---|
| 503 | |
---|
| 504 | SUBROUTINE nemo_closefile |
---|
| 505 | !!---------------------------------------------------------------------- |
---|
| 506 | !! *** ROUTINE nemo_closefile *** |
---|
| 507 | !! |
---|
| 508 | !! ** Purpose : Close the files |
---|
| 509 | !!---------------------------------------------------------------------- |
---|
| 510 | ! |
---|
| 511 | IF( lk_mpp ) CALL mppsync |
---|
| 512 | ! |
---|
| 513 | CALL iom_close ! close all input/output files managed by iom_* |
---|
| 514 | ! |
---|
[9213] | 515 | IF( numstp /= -1 ) CLOSE( numstp ) ! time-step file |
---|
[9267] | 516 | IF( numrun /= -1 ) CLOSE( numrun ) ! run statistics file |
---|
[4624] | 517 | IF( lwm.AND.numond /= -1 ) CLOSE( numond ) ! oce output namelist |
---|
| 518 | IF( lwm.AND.numoni /= -1 ) CLOSE( numoni ) ! ice output namelist |
---|
[9213] | 519 | IF( numevo_ice /= -1 ) CLOSE( numevo_ice ) ! ice variables (temp. evolution) |
---|
| 520 | IF( numout /= 6 ) CLOSE( numout ) ! standard model output file |
---|
[3324] | 521 | ! |
---|
| 522 | numout = 6 ! redefine numout in case it is used after this point... |
---|
| 523 | ! |
---|
| 524 | END SUBROUTINE nemo_closefile |
---|
| 525 | |
---|
| 526 | |
---|
| 527 | SUBROUTINE nemo_alloc |
---|
| 528 | !!---------------------------------------------------------------------- |
---|
| 529 | !! *** ROUTINE nemo_alloc *** |
---|
| 530 | !! |
---|
| 531 | !! ** Purpose : Allocate all the dynamic arrays of the OPA modules |
---|
| 532 | !! |
---|
| 533 | !! ** Method : |
---|
| 534 | !!---------------------------------------------------------------------- |
---|
[9213] | 535 | USE diawri , ONLY : dia_wri_alloc |
---|
| 536 | USE dom_oce , ONLY : dom_oce_alloc |
---|
| 537 | USE bdy_oce , ONLY : ln_bdy, bdy_oce_alloc |
---|
[9019] | 538 | USE oce ! mandatory for sea-ice because needed for bdy arrays |
---|
[3324] | 539 | ! |
---|
[7646] | 540 | INTEGER :: ierr |
---|
[3324] | 541 | !!---------------------------------------------------------------------- |
---|
| 542 | ! |
---|
[9213] | 543 | ierr = dia_wri_alloc() |
---|
| 544 | ierr = ierr + dom_oce_alloc() ! ocean domain |
---|
[9570] | 545 | ierr = ierr + oce_alloc () ! (tsn...) needed for agrif and/or SI3 and bdy |
---|
[9213] | 546 | ierr = ierr + bdy_oce_alloc() ! bdy masks (incl. initialization) |
---|
[3324] | 547 | ! |
---|
[10425] | 548 | CALL mpp_sum( 'nemogcm', ierr ) |
---|
[9213] | 549 | IF( ierr /= 0 ) CALL ctl_stop( 'STOP', 'nemo_alloc: unable to allocate standard ocean arrays' ) |
---|
[3324] | 550 | ! |
---|
| 551 | END SUBROUTINE nemo_alloc |
---|
| 552 | |
---|
[10570] | 553 | SUBROUTINE nemo_set_cfctl(sn_cfctl, setto, for_all ) |
---|
| 554 | !!---------------------------------------------------------------------- |
---|
| 555 | !! *** ROUTINE nemo_set_cfctl *** |
---|
| 556 | !! |
---|
| 557 | !! ** Purpose : Set elements of the output control structure to setto. |
---|
| 558 | !! for_all should be .false. unless all areas are to be |
---|
| 559 | !! treated identically. |
---|
| 560 | !! |
---|
| 561 | !! ** Method : Note this routine can be used to switch on/off some |
---|
| 562 | !! types of output for selected areas but any output types |
---|
| 563 | !! that involve global communications (e.g. mpp_max, glob_sum) |
---|
| 564 | !! should be protected from selective switching by the |
---|
| 565 | !! for_all argument |
---|
| 566 | !!---------------------------------------------------------------------- |
---|
| 567 | LOGICAL :: setto, for_all |
---|
[10601] | 568 | TYPE(sn_ctl) :: sn_cfctl |
---|
[10570] | 569 | !!---------------------------------------------------------------------- |
---|
| 570 | IF( for_all ) THEN |
---|
| 571 | sn_cfctl%l_runstat = setto |
---|
| 572 | sn_cfctl%l_trcstat = setto |
---|
| 573 | ENDIF |
---|
| 574 | sn_cfctl%l_oceout = setto |
---|
| 575 | sn_cfctl%l_layout = setto |
---|
[12377] | 576 | sn_cfctl%l_prtctl = setto |
---|
| 577 | sn_cfctl%l_prttrc = setto |
---|
| 578 | sn_cfctl%l_oasout = setto |
---|
[10570] | 579 | END SUBROUTINE nemo_set_cfctl |
---|
| 580 | |
---|
[3324] | 581 | !!====================================================================== |
---|
| 582 | END MODULE nemogcm |
---|
[9213] | 583 | |
---|