[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 |
---|
[5836] | 30 | !! - ! 2011-11 (C. Harris) decomposition changes for running with CICE |
---|
| 31 | !! 3.6 ! 2012-05 (C. Calone, J. Simeon, G. Madec, C. Ethe) Add grid coarsening |
---|
| 32 | !! - ! 2014-12 (G. Madec) remove KPP scheme and cross-land advection (cla) |
---|
[7646] | 33 | !! 4.0 ! 2016-10 (G. Madec, S. Flavoni) domain configuration / user defined interface |
---|
[1593] | 34 | !!---------------------------------------------------------------------- |
---|
[3] | 35 | |
---|
| 36 | !!---------------------------------------------------------------------- |
---|
[6140] | 37 | !! nemo_gcm : solve ocean dynamics, tracer, biogeochemistry and/or sea-ice |
---|
| 38 | !! nemo_init : initialization of the NEMO system |
---|
| 39 | !! nemo_ctl : initialisation of the contol print |
---|
| 40 | !! nemo_closefile: close remaining open files |
---|
| 41 | !! nemo_alloc : dynamical allocation |
---|
[3] | 42 | !!---------------------------------------------------------------------- |
---|
[6140] | 43 | USE step_oce ! module used in the ocean time stepping module (step.F90) |
---|
[7646] | 44 | USE phycst ! physical constant (par_cst routine) |
---|
| 45 | USE domain ! domain initialization (dom_init & dom_cfg routines) |
---|
[9161] | 46 | USE closea ! treatment of closed seas (for ln_closea) |
---|
[7646] | 47 | USE usrdef_nam ! user defined configuration |
---|
[6140] | 48 | USE tideini ! tidal components initialization (tide_ini routine) |
---|
[9019] | 49 | USE bdy_oce, ONLY : ln_bdy |
---|
[6140] | 50 | USE bdyini ! open boundary cond. setting (bdy_init routine) |
---|
| 51 | USE istate ! initial state setting (istate_init routine) |
---|
| 52 | USE ldfdyn ! lateral viscosity setting (ldfdyn_init routine) |
---|
| 53 | USE ldftra ! lateral diffusivity setting (ldftra_init routine) |
---|
| 54 | USE trdini ! dyn/tra trends initialization (trd_init routine) |
---|
| 55 | USE asminc ! assimilation increments |
---|
| 56 | USE asmbkg ! writing out state trajectory |
---|
| 57 | USE diaptr ! poleward transports (dia_ptr_init routine) |
---|
| 58 | USE diadct ! sections transports (dia_dct_init routine) |
---|
| 59 | USE diaobs ! Observation diagnostics (dia_obs_init routine) |
---|
| 60 | USE diacfl ! CFL diagnostics (dia_cfl_init routine) |
---|
| 61 | USE step ! NEMO time-stepping (stp routine) |
---|
| 62 | USE icbini ! handle bergs, initialisation |
---|
| 63 | USE icbstp ! handle bergs, calving, themodynamics and transport |
---|
| 64 | USE cpl_oasis3 ! OASIS3 coupling |
---|
| 65 | USE c1d ! 1D configuration |
---|
| 66 | USE step_c1d ! Time stepping loop for the 1D configuration |
---|
| 67 | USE dyndmp ! Momentum damping |
---|
| 68 | USE stopar ! Stochastic param.: ??? |
---|
| 69 | USE stopts ! Stochastic param.: ??? |
---|
[7646] | 70 | USE diurnal_bulk ! diurnal bulk SST |
---|
| 71 | USE step_diu ! diurnal bulk SST timestepping (called from here if run offline) |
---|
| 72 | USE crsini ! initialise grid coarsening utility |
---|
| 73 | USE diatmb ! Top,middle,bottom output |
---|
| 74 | USE dia25h ! 25h mean output |
---|
| 75 | USE sbc_oce , ONLY : lk_oasis |
---|
| 76 | USE wet_dry ! Wetting and drying setting (wad_init routine) |
---|
[1594] | 77 | #if defined key_top |
---|
[6140] | 78 | USE trcini ! passive tracer initialisation |
---|
[1594] | 79 | #endif |
---|
[7646] | 80 | #if defined key_nemocice_decomp |
---|
| 81 | USE ice_domain_size, only: nx_global, ny_global |
---|
| 82 | #endif |
---|
| 83 | ! |
---|
[6140] | 84 | USE lib_mpp ! distributed memory computing |
---|
[7646] | 85 | USE mppini ! shared/distributed memory setting (mpp_init routine) |
---|
[9213] | 86 | USE lbcnfd , ONLY : isendto, nsndto, nfsloop, nfeloop ! Setup of north fold exchanges |
---|
[7646] | 87 | USE lib_fortran ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined) |
---|
[1412] | 88 | #if defined key_iomput |
---|
[6140] | 89 | USE xios ! xIOserver |
---|
[1359] | 90 | #endif |
---|
[268] | 91 | |
---|
[2715] | 92 | IMPLICIT NONE |
---|
[3] | 93 | PRIVATE |
---|
| 94 | |
---|
[2496] | 95 | PUBLIC nemo_gcm ! called by model.F90 |
---|
| 96 | PUBLIC nemo_init ! needed by AGRIF |
---|
[3764] | 97 | PUBLIC nemo_alloc ! needed by TAM |
---|
[467] | 98 | |
---|
[2498] | 99 | CHARACTER(lc) :: cform_aaa="( /, 'AAAAAAAA', / ) " ! flag for output listing |
---|
[1593] | 100 | |
---|
[3] | 101 | !!---------------------------------------------------------------------- |
---|
[9213] | 102 | !! NEMO/OPA 4.0 , NEMO Consortium (2018) |
---|
[2392] | 103 | !! $Id$ |
---|
[2329] | 104 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
---|
[3] | 105 | !!---------------------------------------------------------------------- |
---|
| 106 | CONTAINS |
---|
| 107 | |
---|
[2496] | 108 | SUBROUTINE nemo_gcm |
---|
[3] | 109 | !!---------------------------------------------------------------------- |
---|
[2496] | 110 | !! *** ROUTINE nemo_gcm *** |
---|
[3] | 111 | !! |
---|
[3764] | 112 | !! ** Purpose : NEMO solves the primitive equations on an orthogonal |
---|
[1593] | 113 | !! curvilinear mesh on the sphere. |
---|
[3] | 114 | !! |
---|
| 115 | !! ** Method : - model general initialization |
---|
| 116 | !! - launch the time-stepping (stp routine) |
---|
[1593] | 117 | !! - finalize the run by closing files and communications |
---|
[3] | 118 | !! |
---|
[2715] | 119 | !! References : Madec, Delecluse, Imbard, and Levy, 1997: internal report, IPSL. |
---|
[1593] | 120 | !! Madec, 2008, internal report, IPSL. |
---|
[3] | 121 | !!---------------------------------------------------------------------- |
---|
[7646] | 122 | INTEGER :: istp ! time step index |
---|
[389] | 123 | !!---------------------------------------------------------------------- |
---|
[2382] | 124 | ! |
---|
[392] | 125 | #if defined key_agrif |
---|
[1593] | 126 | CALL Agrif_Init_Grids() ! AGRIF: set the meshes |
---|
[389] | 127 | #endif |
---|
[1593] | 128 | ! !-----------------------! |
---|
[2496] | 129 | CALL nemo_init !== Initialisations ==! |
---|
[1593] | 130 | ! !-----------------------! |
---|
[2715] | 131 | #if defined key_agrif |
---|
[3680] | 132 | CALL Agrif_Declare_Var_dom ! AGRIF: set the meshes for DOM |
---|
| 133 | CALL Agrif_Declare_Var ! " " " " " DYN/TRA |
---|
[2715] | 134 | # if defined key_top |
---|
[3680] | 135 | CALL Agrif_Declare_Var_top ! " " " " " TOP |
---|
[2715] | 136 | # endif |
---|
[7646] | 137 | # if defined key_lim3 |
---|
| 138 | CALL Agrif_Declare_Var_lim3 ! " " " " " LIM3 |
---|
| 139 | # endif |
---|
[2715] | 140 | #endif |
---|
[682] | 141 | ! check that all process are still there... If some process have an error, |
---|
| 142 | ! they will never enter in step and other processes will wait until the end of the cpu time! |
---|
[900] | 143 | IF( lk_mpp ) CALL mpp_max( nstop ) |
---|
[682] | 144 | |
---|
[1593] | 145 | IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA |
---|
| 146 | |
---|
| 147 | ! !-----------------------! |
---|
| 148 | ! !== time stepping ==! |
---|
| 149 | ! !-----------------------! |
---|
[900] | 150 | istp = nit000 |
---|
[9210] | 151 | ! |
---|
[2236] | 152 | #if defined key_c1d |
---|
[9210] | 153 | DO WHILE ( istp <= nitend .AND. nstop == 0 ) !== C1D time-stepping ==! |
---|
| 154 | CALL stp_c1d( istp ) |
---|
| 155 | istp = istp + 1 |
---|
| 156 | END DO |
---|
[2236] | 157 | #else |
---|
[9210] | 158 | ! |
---|
| 159 | # if defined key_agrif |
---|
| 160 | ! !== AGRIF time-stepping ==! |
---|
| 161 | CALL Agrif_Regrid() |
---|
[9213] | 162 | ! |
---|
[9210] | 163 | DO WHILE( istp <= nitend .AND. nstop == 0 ) |
---|
| 164 | CALL stp |
---|
| 165 | istp = istp + 1 |
---|
| 166 | END DO |
---|
| 167 | ! |
---|
| 168 | IF( .NOT. Agrif_Root() ) THEN |
---|
| 169 | CALL Agrif_ParentGrid_To_ChildGrid() |
---|
| 170 | IF( ln_diaobs ) CALL dia_obs_wri |
---|
| 171 | IF( ln_timing ) CALL timing_finalize |
---|
| 172 | CALL Agrif_ChildGrid_To_ParentGrid() |
---|
| 173 | ENDIF |
---|
| 174 | ! |
---|
| 175 | # else |
---|
| 176 | ! |
---|
| 177 | IF( .NOT.ln_diurnal_only ) THEN !== Standard time-stepping ==! |
---|
| 178 | ! |
---|
| 179 | DO WHILE( istp <= nitend .AND. nstop == 0 ) |
---|
| 180 | CALL stp ( istp ) |
---|
[389] | 181 | istp = istp + 1 |
---|
| 182 | END DO |
---|
[9210] | 183 | ! |
---|
| 184 | ELSE !== diurnal SST time-steeping only ==! |
---|
| 185 | ! |
---|
| 186 | DO WHILE( istp <= nitend .AND. nstop == 0 ) |
---|
| 187 | CALL stp_diurnal( istp ) ! time step only the diurnal SST |
---|
| 188 | istp = istp + 1 |
---|
| 189 | END DO |
---|
| 190 | ! |
---|
| 191 | ENDIF |
---|
| 192 | ! |
---|
| 193 | # endif |
---|
| 194 | ! |
---|
[2236] | 195 | #endif |
---|
[9210] | 196 | ! |
---|
[6140] | 197 | IF( ln_diaobs ) CALL dia_obs_wri |
---|
[3609] | 198 | ! |
---|
| 199 | IF( ln_icebergs ) CALL icb_end( nitend ) |
---|
[3764] | 200 | |
---|
[1593] | 201 | ! !------------------------! |
---|
| 202 | ! !== finalize the run ==! |
---|
| 203 | ! !------------------------! |
---|
[7646] | 204 | IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA |
---|
[1593] | 205 | ! |
---|
[7646] | 206 | IF( nstop /= 0 .AND. lwp ) THEN ! error print |
---|
[682] | 207 | WRITE(numout,cform_err) |
---|
[9213] | 208 | WRITE(numout,*) ' ==>>> nemo_gcm: a total of ', nstop, ' errors have been found' |
---|
[9210] | 209 | WRITE(numout,*) |
---|
[389] | 210 | ENDIF |
---|
[1593] | 211 | ! |
---|
[9124] | 212 | IF( ln_timing ) CALL timing_finalize |
---|
[3294] | 213 | ! |
---|
[2496] | 214 | CALL nemo_closefile |
---|
[4990] | 215 | ! |
---|
[3769] | 216 | #if defined key_iomput |
---|
[9210] | 217 | CALL xios_finalize ! end mpp communications with xios |
---|
| 218 | IF( lk_oasis ) CALL cpl_finalize ! end coupling and mpp communications with OASIS |
---|
[532] | 219 | #else |
---|
[9210] | 220 | IF ( lk_oasis ) THEN ; CALL cpl_finalize ! end coupling and mpp communications with OASIS |
---|
| 221 | ELSEIF( lk_mpp ) THEN ; CALL mppstop ! end mpp communications |
---|
[4990] | 222 | ENDIF |
---|
[532] | 223 | #endif |
---|
[900] | 224 | ! |
---|
[2496] | 225 | END SUBROUTINE nemo_gcm |
---|
[389] | 226 | |
---|
| 227 | |
---|
[2496] | 228 | SUBROUTINE nemo_init |
---|
[389] | 229 | !!---------------------------------------------------------------------- |
---|
[2496] | 230 | !! *** ROUTINE nemo_init *** |
---|
[389] | 231 | !! |
---|
[2496] | 232 | !! ** Purpose : initialization of the NEMO GCM |
---|
[389] | 233 | !!---------------------------------------------------------------------- |
---|
[7646] | 234 | INTEGER :: ji ! dummy loop indices |
---|
[9213] | 235 | INTEGER :: ios, ilocal_comm ! local integers |
---|
[9490] | 236 | CHARACTER(len=120), DIMENSION(60) :: cltxt, cltxt2, clnam |
---|
[9213] | 237 | !! |
---|
[7646] | 238 | NAMELIST/namctl/ ln_ctl , nn_print, nn_ictls, nn_ictle, & |
---|
| 239 | & nn_isplt , nn_jsplt, nn_jctls, nn_jctle, & |
---|
[9019] | 240 | & ln_timing, ln_diacfl |
---|
[9213] | 241 | NAMELIST/namcfg/ ln_read_cfg, cn_domcfg, ln_closea, ln_write_cfg, cn_domcfg_out, ln_use_jattr |
---|
[3] | 242 | !!---------------------------------------------------------------------- |
---|
[1593] | 243 | ! |
---|
[7646] | 244 | cltxt = '' |
---|
| 245 | cltxt2 = '' |
---|
| 246 | clnam = '' |
---|
[5407] | 247 | cxios_context = 'nemo' |
---|
[2496] | 248 | ! |
---|
[4147] | 249 | ! ! Open reference namelist and configuration namelist files |
---|
| 250 | CALL ctl_opn( numnam_ref, 'namelist_ref', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. ) |
---|
| 251 | CALL ctl_opn( numnam_cfg, 'namelist_cfg', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. ) |
---|
[1593] | 252 | ! |
---|
[9213] | 253 | REWIND( numnam_ref ) ! Namelist namctl in reference namelist |
---|
[4147] | 254 | READ ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 ) |
---|
[9168] | 255 | 901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in reference namelist', .TRUE. ) |
---|
[7646] | 256 | REWIND( numnam_cfg ) ! Namelist namctl in confguration namelist |
---|
[4147] | 257 | READ ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 ) |
---|
[9168] | 258 | 902 IF( ios > 0 ) CALL ctl_nam ( ios , 'namctl in configuration namelist', .TRUE. ) |
---|
[1593] | 259 | ! |
---|
[9213] | 260 | REWIND( numnam_ref ) ! Namelist namcfg in reference namelist |
---|
[4147] | 261 | READ ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 ) |
---|
[9168] | 262 | 903 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in reference namelist', .TRUE. ) |
---|
[9213] | 263 | REWIND( numnam_cfg ) ! Namelist namcfg in confguration namelist |
---|
[4147] | 264 | READ ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 ) |
---|
[9168] | 265 | 904 IF( ios > 0 ) CALL ctl_nam ( ios , 'namcfg in configuration namelist', .TRUE. ) |
---|
[4309] | 266 | |
---|
[7646] | 267 | ! !--------------------------! |
---|
| 268 | ! ! Set global domain size ! (control print return in cltxt2) |
---|
| 269 | ! !--------------------------! |
---|
| 270 | IF( ln_read_cfg ) THEN ! Read sizes in domain configuration file |
---|
| 271 | CALL domain_cfg ( cltxt2, cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio ) |
---|
| 272 | ! |
---|
| 273 | ELSE ! user-defined namelist |
---|
| 274 | CALL usr_def_nam( cltxt2, clnam, cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio ) |
---|
| 275 | ENDIF |
---|
| 276 | ! |
---|
| 277 | ! |
---|
[1593] | 278 | ! !--------------------------------------------! |
---|
| 279 | ! ! set communicator & select the local node ! |
---|
[4624] | 280 | ! ! NB: mynode also opens output.namelist.dyn ! |
---|
| 281 | ! ! on unit number numond on first proc ! |
---|
[1593] | 282 | ! !--------------------------------------------! |
---|
[1412] | 283 | #if defined key_iomput |
---|
[2200] | 284 | IF( Agrif_Root() ) THEN |
---|
[5407] | 285 | IF( lk_oasis ) THEN |
---|
[7646] | 286 | CALL cpl_init( "oceanx", ilocal_comm ) ! nemo local communicator given by oasis |
---|
| 287 | CALL xios_initialize( "not used" ,local_comm= ilocal_comm ) ! send nemo communicator to xios |
---|
[4990] | 288 | ELSE |
---|
[7646] | 289 | CALL xios_initialize( "for_xios_mpi_id",return_comm=ilocal_comm ) ! nemo local communicator given by xios |
---|
[4990] | 290 | ENDIF |
---|
[2200] | 291 | ENDIF |
---|
[5407] | 292 | ! Nodes selection (control print return in cltxt) |
---|
| 293 | narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm ) |
---|
[532] | 294 | #else |
---|
[5407] | 295 | IF( lk_oasis ) THEN |
---|
[4990] | 296 | IF( Agrif_Root() ) THEN |
---|
[7646] | 297 | CALL cpl_init( "oceanx", ilocal_comm ) ! nemo local communicator given by oasis |
---|
[4990] | 298 | ENDIF |
---|
[5407] | 299 | ! Nodes selection (control print return in cltxt) |
---|
| 300 | narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm ) |
---|
[4990] | 301 | ELSE |
---|
[7646] | 302 | ilocal_comm = 0 ! Nodes selection (control print return in cltxt) |
---|
[5407] | 303 | narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop ) |
---|
[2236] | 304 | ENDIF |
---|
[532] | 305 | #endif |
---|
[7646] | 306 | |
---|
[2715] | 307 | narea = narea + 1 ! mynode return the rank of proc (0 --> jpnij -1 ) |
---|
[3] | 308 | |
---|
[4624] | 309 | lwm = (narea == 1) ! control of output namelists |
---|
[2715] | 310 | lwp = (narea == 1) .OR. ln_ctl ! control of all listing output print |
---|
[1579] | 311 | |
---|
[7646] | 312 | IF(lwm) THEN ! write merged namelists from earlier to output namelist |
---|
| 313 | ! ! now that the file has been opened in call to mynode. |
---|
| 314 | ! ! NB: nammpp has already been written in mynode (if lk_mpp_mpi) |
---|
[4624] | 315 | WRITE( numond, namctl ) |
---|
| 316 | WRITE( numond, namcfg ) |
---|
[7646] | 317 | IF( .NOT.ln_read_cfg ) THEN |
---|
| 318 | DO ji = 1, SIZE(clnam) |
---|
| 319 | IF( TRIM(clnam(ji)) /= '' ) WRITE(numond, * ) clnam(ji) ! namusr_def print |
---|
| 320 | END DO |
---|
| 321 | ENDIF |
---|
[4624] | 322 | ENDIF |
---|
| 323 | |
---|
[1593] | 324 | IF(lwp) THEN ! open listing units |
---|
| 325 | ! |
---|
[1581] | 326 | CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE., narea ) |
---|
[1593] | 327 | ! |
---|
[1579] | 328 | WRITE(numout,*) |
---|
[3294] | 329 | WRITE(numout,*) ' CNRS - NERC - Met OFFICE - MERCATOR-ocean - INGV - CMCC' |
---|
[1593] | 330 | WRITE(numout,*) ' NEMO team' |
---|
[1579] | 331 | WRITE(numout,*) ' Ocean General Circulation Model' |
---|
[9169] | 332 | WRITE(numout,*) ' NEMO version 4.0 (2017) ' |
---|
[1579] | 333 | WRITE(numout,*) |
---|
| 334 | WRITE(numout,*) |
---|
[3764] | 335 | DO ji = 1, SIZE(cltxt) |
---|
[7646] | 336 | IF( TRIM(cltxt (ji)) /= '' ) WRITE(numout,*) cltxt(ji) ! control print of mynode |
---|
[1579] | 337 | END DO |
---|
[7646] | 338 | WRITE(numout,*) |
---|
| 339 | WRITE(numout,*) |
---|
| 340 | DO ji = 1, SIZE(cltxt2) |
---|
| 341 | IF( TRIM(cltxt2(ji)) /= '' ) WRITE(numout,*) cltxt2(ji) ! control print of domain size |
---|
| 342 | END DO |
---|
[1593] | 343 | ! |
---|
[7646] | 344 | WRITE(numout,cform_aaa) ! Flag AAAAAAA |
---|
| 345 | ! |
---|
[473] | 346 | ENDIF |
---|
[9436] | 347 | ! ! Domain decomposition |
---|
| 348 | CALL mpp_init ! MPP |
---|
[2715] | 349 | |
---|
[7646] | 350 | ! Now we know the dimensions of the grid and numout has been set: we can allocate arrays |
---|
[2715] | 351 | CALL nemo_alloc() |
---|
| 352 | |
---|
[2496] | 353 | ! !-------------------------------! |
---|
| 354 | ! ! NEMO general initialization ! |
---|
| 355 | ! !-------------------------------! |
---|
[473] | 356 | |
---|
[7646] | 357 | CALL nemo_ctl ! Control prints |
---|
[2382] | 358 | ! |
---|
[9213] | 359 | ! ! General initialization |
---|
| 360 | IF( ln_timing ) CALL timing_init ! timing |
---|
| 361 | IF( ln_timing ) CALL timing_start( 'nemo_init') |
---|
[3294] | 362 | ! |
---|
[9367] | 363 | CALL phy_cst ! Physical constants |
---|
| 364 | CALL eos_init ! Equation of state |
---|
| 365 | IF( lk_c1d ) CALL c1d_init ! 1D column configuration |
---|
| 366 | CALL wad_init ! Wetting and drying options |
---|
| 367 | CALL dom_init("OPA") ! Domain |
---|
| 368 | IF( ln_crs ) CALL crs_init ! coarsened grid: domain initialization |
---|
| 369 | IF( ln_ctl ) CALL prt_ctl_init ! Print control |
---|
[6140] | 370 | |
---|
[9213] | 371 | CALL diurnal_sst_bulk_init ! diurnal sst |
---|
| 372 | IF( ln_diurnal ) CALL diurnal_sst_coolskin_init ! cool skin |
---|
| 373 | ! |
---|
| 374 | IF( ln_diurnal_only ) THEN ! diurnal only: a subset of the initialisation routines |
---|
| 375 | CALL istate_init ! ocean initial state (Dynamics and tracers) |
---|
| 376 | CALL sbc_init ! Forcings : surface module |
---|
| 377 | CALL tra_qsr_init ! penetrative solar radiation qsr |
---|
| 378 | IF( ln_diaobs ) THEN ! Observation & model comparison |
---|
| 379 | CALL dia_obs_init ! Initialize observational data |
---|
| 380 | CALL dia_obs( nit000 - 1 ) ! Observation operator for restart |
---|
[6140] | 381 | ENDIF |
---|
[9213] | 382 | IF( lk_asminc ) CALL asm_inc_init ! Assimilation increments |
---|
| 383 | ! |
---|
| 384 | RETURN ! end of initialization |
---|
[6140] | 385 | ENDIF |
---|
| 386 | |
---|
[9213] | 387 | CALL istate_init ! ocean initial state (Dynamics and tracers) |
---|
[3651] | 388 | |
---|
[5836] | 389 | ! ! external forcing |
---|
[9213] | 390 | CALL tide_init ! tidal harmonics |
---|
| 391 | CALL sbc_init ! surface boundary conditions (including sea-ice) |
---|
| 392 | CALL bdy_init ! Open boundaries initialisation |
---|
[9019] | 393 | |
---|
[5836] | 394 | ! ! Ocean physics |
---|
[9019] | 395 | CALL zdf_phy_init ! Vertical physics |
---|
| 396 | |
---|
[2082] | 397 | ! ! Lateral physics |
---|
[9019] | 398 | CALL ldf_tra_init ! Lateral ocean tracer physics |
---|
| 399 | CALL ldf_eiv_init ! eddy induced velocity param. |
---|
| 400 | CALL ldf_dyn_init ! Lateral ocean momentum physics |
---|
[2082] | 401 | |
---|
[9019] | 402 | ! ! Active tracers |
---|
| 403 | IF( ln_traqsr ) CALL tra_qsr_init ! penetrative solar radiation qsr |
---|
| 404 | CALL tra_bbc_init ! bottom heat flux |
---|
| 405 | IF( ln_trabbl ) CALL tra_bbl_init ! advective (and/or diffusive) bottom boundary layer scheme |
---|
| 406 | CALL tra_dmp_init ! internal tracer damping |
---|
| 407 | CALL tra_adv_init ! horizontal & vertical advection |
---|
| 408 | CALL tra_ldf_init ! lateral mixing |
---|
[2027] | 409 | |
---|
[9019] | 410 | ! ! Dynamics |
---|
| 411 | IF( lk_c1d ) CALL dyn_dmp_init ! internal momentum damping |
---|
| 412 | CALL dyn_adv_init ! advection (vector or flux form) |
---|
| 413 | CALL dyn_vor_init ! vorticity term including Coriolis |
---|
| 414 | CALL dyn_ldf_init ! lateral mixing |
---|
| 415 | CALL dyn_hpg_init ! horizontal gradient of Hydrostatic pressure |
---|
| 416 | CALL dyn_spg_init ! surface pressure gradient |
---|
[3764] | 417 | |
---|
[5836] | 418 | #if defined key_top |
---|
| 419 | ! ! Passive tracers |
---|
[9019] | 420 | CALL trc_init |
---|
[5836] | 421 | #endif |
---|
[9019] | 422 | IF( l_ldfslp ) CALL ldf_slp_init ! slope of lateral mixing |
---|
[5836] | 423 | |
---|
| 424 | ! ! Icebergs |
---|
[9019] | 425 | CALL icb_init( rdt, nit000) ! initialise icebergs instance |
---|
[5836] | 426 | |
---|
| 427 | ! ! Misc. options |
---|
[9019] | 428 | CALL sto_par_init ! Stochastic parametrization |
---|
| 429 | IF( ln_sto_eos ) CALL sto_pts_init ! RRandom T/S fluctuations |
---|
[4147] | 430 | |
---|
[5836] | 431 | ! ! Diagnostics |
---|
[9019] | 432 | IF( lk_floats ) CALL flo_init ! drifting Floats |
---|
| 433 | IF( ln_diacfl ) CALL dia_cfl_init ! Initialise CFL diagnostics |
---|
| 434 | CALL dia_ptr_init ! Poleward TRansports initialization |
---|
| 435 | IF( lk_diadct ) CALL dia_dct_init ! Sections tranports |
---|
| 436 | CALL dia_hsb_init ! heat content, salt content and volume budgets |
---|
| 437 | CALL trd_init ! Mixed-layer/Vorticity/Integral constraints trends |
---|
| 438 | CALL dia_obs_init ! Initialize observational data |
---|
[9213] | 439 | CALL dia_tmb_init ! TMB outputs |
---|
| 440 | CALL dia_25h_init ! 25h mean outputs |
---|
| 441 | IF( ln_diaobs ) CALL dia_obs( nit000-1 ) ! Observation operator for restart |
---|
[6140] | 442 | |
---|
[9019] | 443 | ! ! Assimilation increments |
---|
| 444 | IF( lk_asminc ) CALL asm_inc_init ! Initialize assimilation increments |
---|
[1593] | 445 | ! |
---|
[9213] | 446 | IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA |
---|
| 447 | ! |
---|
| 448 | IF( ln_timing ) CALL timing_stop( 'nemo_init') |
---|
| 449 | ! |
---|
[2496] | 450 | END SUBROUTINE nemo_init |
---|
[467] | 451 | |
---|
| 452 | |
---|
[2496] | 453 | SUBROUTINE nemo_ctl |
---|
[467] | 454 | !!---------------------------------------------------------------------- |
---|
[2496] | 455 | !! *** ROUTINE nemo_ctl *** |
---|
[467] | 456 | !! |
---|
[3764] | 457 | !! ** Purpose : control print setting |
---|
[467] | 458 | !! |
---|
[2442] | 459 | !! ** Method : - print namctl information and check some consistencies |
---|
[467] | 460 | !!---------------------------------------------------------------------- |
---|
[2442] | 461 | ! |
---|
[2496] | 462 | IF(lwp) THEN ! control print |
---|
[531] | 463 | WRITE(numout,*) |
---|
[7646] | 464 | WRITE(numout,*) 'nemo_ctl: Control prints' |
---|
[9213] | 465 | WRITE(numout,*) '~~~~~~~~' |
---|
[1593] | 466 | WRITE(numout,*) ' Namelist namctl' |
---|
[1601] | 467 | WRITE(numout,*) ' run control (for debugging) ln_ctl = ', ln_ctl |
---|
| 468 | WRITE(numout,*) ' level of print nn_print = ', nn_print |
---|
| 469 | WRITE(numout,*) ' Start i indice for SUM control nn_ictls = ', nn_ictls |
---|
| 470 | WRITE(numout,*) ' End i indice for SUM control nn_ictle = ', nn_ictle |
---|
| 471 | WRITE(numout,*) ' Start j indice for SUM control nn_jctls = ', nn_jctls |
---|
| 472 | WRITE(numout,*) ' End j indice for SUM control nn_jctle = ', nn_jctle |
---|
| 473 | WRITE(numout,*) ' number of proc. following i nn_isplt = ', nn_isplt |
---|
| 474 | WRITE(numout,*) ' number of proc. following j nn_jsplt = ', nn_jsplt |
---|
[9019] | 475 | WRITE(numout,*) ' timing by routine ln_timing = ', ln_timing |
---|
| 476 | WRITE(numout,*) ' CFL diagnostics ln_diacfl = ', ln_diacfl |
---|
[531] | 477 | ENDIF |
---|
[2442] | 478 | ! |
---|
[1601] | 479 | nprint = nn_print ! convert DOCTOR namelist names into OLD names |
---|
| 480 | nictls = nn_ictls |
---|
| 481 | nictle = nn_ictle |
---|
| 482 | njctls = nn_jctls |
---|
| 483 | njctle = nn_jctle |
---|
| 484 | isplt = nn_isplt |
---|
[9213] | 485 | jsplt = nn_jsplt |
---|
[4147] | 486 | |
---|
| 487 | IF(lwp) THEN ! control print |
---|
| 488 | WRITE(numout,*) |
---|
| 489 | WRITE(numout,*) ' Namelist namcfg' |
---|
[7646] | 490 | WRITE(numout,*) ' read domain configuration file ln_read_cfg = ', ln_read_cfg |
---|
| 491 | WRITE(numout,*) ' filename to be read cn_domcfg = ', TRIM(cn_domcfg) |
---|
[9213] | 492 | WRITE(numout,*) ' keep closed seas in the domain (if exist) ln_closea = ', ln_closea |
---|
| 493 | WRITE(numout,*) ' create a configuration definition file ln_write_cfg = ', ln_write_cfg |
---|
[7646] | 494 | WRITE(numout,*) ' filename to be written cn_domcfg_out = ', TRIM(cn_domcfg_out) |
---|
| 495 | WRITE(numout,*) ' use file attribute if exists as i/p j-start ln_use_jattr = ', ln_use_jattr |
---|
[4147] | 496 | ENDIF |
---|
[9213] | 497 | IF( .NOT.ln_read_cfg ) ln_closea = .false. ! dealing possible only with a domcfg file |
---|
| 498 | ! |
---|
[2442] | 499 | ! ! Parameter control |
---|
[1593] | 500 | ! |
---|
| 501 | IF( ln_ctl ) THEN ! sub-domain area indices for the control prints |
---|
[3294] | 502 | IF( lk_mpp .AND. jpnij > 1 ) THEN |
---|
[2496] | 503 | isplt = jpni ; jsplt = jpnj ; ijsplt = jpni*jpnj ! the domain is forced to the real split domain |
---|
[531] | 504 | ELSE |
---|
| 505 | IF( isplt == 1 .AND. jsplt == 1 ) THEN |
---|
[1593] | 506 | CALL ctl_warn( ' - isplt & jsplt are equal to 1', & |
---|
| 507 | & ' - the print control will be done over the whole domain' ) |
---|
[531] | 508 | ENDIF |
---|
[1593] | 509 | ijsplt = isplt * jsplt ! total number of processors ijsplt |
---|
[531] | 510 | ENDIF |
---|
| 511 | IF(lwp) WRITE(numout,*)' - The total number of processors over which the' |
---|
| 512 | IF(lwp) WRITE(numout,*)' print control will be done is ijsplt : ', ijsplt |
---|
[1593] | 513 | ! |
---|
| 514 | ! ! indices used for the SUM control |
---|
| 515 | IF( nictls+nictle+njctls+njctle == 0 ) THEN ! print control done over the default area |
---|
[3764] | 516 | lsp_area = .FALSE. |
---|
[1593] | 517 | ELSE ! print control done over a specific area |
---|
[531] | 518 | lsp_area = .TRUE. |
---|
| 519 | IF( nictls < 1 .OR. nictls > jpiglo ) THEN |
---|
| 520 | CALL ctl_warn( ' - nictls must be 1<=nictls>=jpiglo, it is forced to 1' ) |
---|
| 521 | nictls = 1 |
---|
| 522 | ENDIF |
---|
| 523 | IF( nictle < 1 .OR. nictle > jpiglo ) THEN |
---|
| 524 | CALL ctl_warn( ' - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' ) |
---|
| 525 | nictle = jpiglo |
---|
| 526 | ENDIF |
---|
| 527 | IF( njctls < 1 .OR. njctls > jpjglo ) THEN |
---|
| 528 | CALL ctl_warn( ' - njctls must be 1<=njctls>=jpjglo, it is forced to 1' ) |
---|
| 529 | njctls = 1 |
---|
| 530 | ENDIF |
---|
| 531 | IF( njctle < 1 .OR. njctle > jpjglo ) THEN |
---|
| 532 | CALL ctl_warn( ' - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' ) |
---|
| 533 | njctle = jpjglo |
---|
| 534 | ENDIF |
---|
[1593] | 535 | ENDIF |
---|
| 536 | ENDIF |
---|
[2442] | 537 | ! |
---|
[9213] | 538 | IF( 1._wp /= SIGN(1._wp,-0._wp) ) CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows f2003 standard.', & |
---|
| 539 | & 'Compile with key_nosignedzero enabled' ) |
---|
[3764] | 540 | ! |
---|
[9023] | 541 | #if defined key_agrif |
---|
[9124] | 542 | IF( ln_timing ) CALL ctl_stop( 'AGRIF not implemented with ln_timing = true') |
---|
[9023] | 543 | #endif |
---|
| 544 | ! |
---|
[2496] | 545 | END SUBROUTINE nemo_ctl |
---|
[467] | 546 | |
---|
| 547 | |
---|
[2496] | 548 | SUBROUTINE nemo_closefile |
---|
[467] | 549 | !!---------------------------------------------------------------------- |
---|
[2496] | 550 | !! *** ROUTINE nemo_closefile *** |
---|
[467] | 551 | !! |
---|
| 552 | !! ** Purpose : Close the files |
---|
| 553 | !!---------------------------------------------------------------------- |
---|
[1593] | 554 | ! |
---|
| 555 | IF( lk_mpp ) CALL mppsync |
---|
| 556 | ! |
---|
[1685] | 557 | CALL iom_close ! close all input/output files managed by iom_* |
---|
[1593] | 558 | ! |
---|
[4147] | 559 | IF( numstp /= -1 ) CLOSE( numstp ) ! time-step file |
---|
[9019] | 560 | IF( numrun /= -1 ) CLOSE( numrun ) ! run statistics file |
---|
[4147] | 561 | IF( numnam_ref /= -1 ) CLOSE( numnam_ref ) ! oce reference namelist |
---|
| 562 | IF( numnam_cfg /= -1 ) CLOSE( numnam_cfg ) ! oce configuration namelist |
---|
[4624] | 563 | IF( lwm.AND.numond /= -1 ) CLOSE( numond ) ! oce output namelist |
---|
[4147] | 564 | IF( numnam_ice_ref /= -1 ) CLOSE( numnam_ice_ref ) ! ice reference namelist |
---|
| 565 | IF( numnam_ice_cfg /= -1 ) CLOSE( numnam_ice_cfg ) ! ice configuration namelist |
---|
[4624] | 566 | IF( lwm.AND.numoni /= -1 ) CLOSE( numoni ) ! ice output namelist |
---|
[4147] | 567 | IF( numevo_ice /= -1 ) CLOSE( numevo_ice ) ! ice variables (temp. evolution) |
---|
| 568 | IF( numout /= 6 ) CLOSE( numout ) ! standard model output file |
---|
| 569 | IF( numdct_vol /= -1 ) CLOSE( numdct_vol ) ! volume transports |
---|
| 570 | IF( numdct_heat /= -1 ) CLOSE( numdct_heat ) ! heat transports |
---|
| 571 | IF( numdct_salt /= -1 ) CLOSE( numdct_salt ) ! salt transports |
---|
[1593] | 572 | ! |
---|
[2442] | 573 | numout = 6 ! redefine numout in case it is used after this point... |
---|
| 574 | ! |
---|
[2496] | 575 | END SUBROUTINE nemo_closefile |
---|
[467] | 576 | |
---|
[2715] | 577 | |
---|
| 578 | SUBROUTINE nemo_alloc |
---|
| 579 | !!---------------------------------------------------------------------- |
---|
| 580 | !! *** ROUTINE nemo_alloc *** |
---|
| 581 | !! |
---|
| 582 | !! ** Purpose : Allocate all the dynamic arrays of the OPA modules |
---|
| 583 | !! |
---|
| 584 | !! ** Method : |
---|
| 585 | !!---------------------------------------------------------------------- |
---|
[9213] | 586 | USE diawri , ONLY : dia_wri_alloc |
---|
| 587 | USE dom_oce , ONLY : dom_oce_alloc |
---|
| 588 | USE trc_oce , ONLY : trc_oce_alloc |
---|
| 589 | USE bdy_oce , ONLY : bdy_oce_alloc |
---|
[3680] | 590 | #if defined key_diadct |
---|
[9213] | 591 | USE diadct , ONLY : diadct_alloc |
---|
[3680] | 592 | #endif |
---|
[2715] | 593 | ! |
---|
| 594 | INTEGER :: ierr |
---|
| 595 | !!---------------------------------------------------------------------- |
---|
| 596 | ! |
---|
[9213] | 597 | ierr = oce_alloc () ! ocean |
---|
| 598 | ierr = ierr + dia_wri_alloc() |
---|
| 599 | ierr = ierr + dom_oce_alloc() ! ocean domain |
---|
| 600 | ierr = ierr + zdf_oce_alloc() ! ocean vertical physics |
---|
| 601 | ierr = ierr + trc_oce_alloc() ! shared TRC / TRA arrays |
---|
| 602 | ierr = ierr + bdy_oce_alloc() ! bdy masks (incl. initialization) |
---|
[2715] | 603 | ! |
---|
[3680] | 604 | #if defined key_diadct |
---|
[9213] | 605 | ierr = ierr + diadct_alloc () ! |
---|
[3680] | 606 | #endif |
---|
| 607 | ! |
---|
[2715] | 608 | IF( lk_mpp ) CALL mpp_sum( ierr ) |
---|
[9213] | 609 | IF( ierr /= 0 ) CALL ctl_stop( 'STOP', 'nemo_alloc: unable to allocate standard ocean arrays' ) |
---|
[2715] | 610 | ! |
---|
| 611 | END SUBROUTINE nemo_alloc |
---|
| 612 | |
---|
[3] | 613 | !!====================================================================== |
---|
[2496] | 614 | END MODULE nemogcm |
---|
[4354] | 615 | |
---|