| [2574] | 1 | MODULE nemogcm |
|---|
| 2 | !!====================================================================== |
|---|
| 3 | !! *** MODULE nemogcm *** |
|---|
| 4 | !! Off-line Ocean : passive tracer evolution, dynamics read in files |
|---|
| 5 | !!====================================================================== |
|---|
| 6 | !! History : 3.3 ! 2010-05 (C. Ethe) Full reorganization of the off-line: phasing with the on-line |
|---|
| [7646] | 7 | !! 3.4 ! 2011-01 (C. Ethe, A. R. Porter, STFC Daresbury) dynamical allocation |
|---|
| 8 | !! 4.0 ! 2016-10 (C. Ethe, G. Madec, S. Flavoni) domain configuration / user defined interface |
|---|
| [2574] | 9 | !!---------------------------------------------------------------------- |
|---|
| 10 | |
|---|
| 11 | !!---------------------------------------------------------------------- |
|---|
| [9213] | 12 | !! nemo_gcm : off-line: solve ocean tracer only |
|---|
| 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 |
|---|
| 18 | !! istate_init : simple initialization to zero of ocean fields |
|---|
| 19 | !! stp_ctl : reduced step control (no dynamics in off-line) |
|---|
| [2574] | 20 | !!---------------------------------------------------------------------- |
|---|
| [9213] | 21 | USE dom_oce ! ocean space domain variables |
|---|
| 22 | USE oce ! dynamics and tracers variables |
|---|
| 23 | USE trc_oce ! Shared ocean/passive tracers variables |
|---|
| 24 | USE c1d ! 1D configuration |
|---|
| 25 | USE domain ! domain initialization from coordinate & bathymetry (dom_init routine) |
|---|
| 26 | USE closea ! treatment of closed seas (for ln_closea) |
|---|
| 27 | USE usrdef_nam ! user defined configuration |
|---|
| 28 | USE eosbn2 ! equation of state (eos bn2 routine) |
|---|
| [2574] | 29 | ! ! ocean physics |
|---|
| [9213] | 30 | USE ldftra ! lateral diffusivity setting (ldf_tra_init routine) |
|---|
| 31 | USE ldfslp ! slopes of neutral surfaces (ldf_slp_init routine) |
|---|
| [9751] | 32 | USE traqsr ! solar radiation penetration (tra_qsr_init routine) |
|---|
| [9213] | 33 | USE trabbl ! bottom boundary layer (tra_bbl_init routine) |
|---|
| 34 | USE traldf ! lateral physics (tra_ldf_init routine) |
|---|
| 35 | USE sbcmod ! surface boundary condition (sbc_init routine) |
|---|
| 36 | USE phycst ! physical constant (par_cst routine) |
|---|
| 37 | USE dtadyn ! Lecture and Interpolation of the dynamical fields |
|---|
| 38 | USE trcini ! Initilization of the passive tracers |
|---|
| 39 | USE daymod ! calendar (day routine) |
|---|
| 40 | USE trcstp ! passive tracer time-stepping (trc_stp routine) |
|---|
| 41 | USE dtadyn ! Lecture and interpolation of the dynamical fields |
|---|
| [7646] | 42 | ! ! Passive tracers needs |
|---|
| [9213] | 43 | USE trc ! passive tracer : variables |
|---|
| 44 | USE trcnam ! passive tracer : namelist |
|---|
| 45 | USE trcrst ! passive tracer restart |
|---|
| 46 | USE diaptr ! Need to initialise this as some variables are used in if statements later |
|---|
| 47 | USE sbc_oce , ONLY : ln_rnf |
|---|
| 48 | USE sbcrnf ! surface boundary condition : runoffs |
|---|
| [2574] | 49 | ! ! I/O & MPP |
|---|
| [9213] | 50 | USE iom ! I/O library |
|---|
| 51 | USE in_out_manager ! I/O manager |
|---|
| 52 | USE mppini ! shared/distributed memory setting (mpp_init routine) |
|---|
| 53 | USE lib_mpp ! distributed memory computing |
|---|
| [2574] | 54 | #if defined key_iomput |
|---|
| [9213] | 55 | USE xios ! xIOserver |
|---|
| [2574] | 56 | #endif |
|---|
| [9213] | 57 | USE prtctl ! Print control (prt_ctl_init routine) |
|---|
| 58 | USE timing ! Timing |
|---|
| 59 | USE lib_fortran ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined) |
|---|
| 60 | USE lbcnfd , ONLY : isendto, nsndto, nfsloop, nfeloop ! Setup of north fold exchanges |
|---|
| [10905] | 61 | USE step, ONLY : update_pointers |
|---|
| [2574] | 62 | |
|---|
| 63 | IMPLICIT NONE |
|---|
| 64 | PRIVATE |
|---|
| 65 | |
|---|
| 66 | PUBLIC nemo_gcm ! called by nemo.F90 |
|---|
| 67 | |
|---|
| 68 | CHARACTER (len=64) :: cform_aaa="( /, 'AAAAAAAA', / ) " ! flag for output listing |
|---|
| 69 | |
|---|
| 70 | !!---------------------------------------------------------------------- |
|---|
| [10905] | 71 | !! time level indices |
|---|
| 72 | !!---------------------------------------------------------------------- |
|---|
| 73 | INTEGER :: Nbb, Nnn, Naa, Nrhs |
|---|
| 74 | |
|---|
| 75 | !!---------------------------------------------------------------------- |
|---|
| [9213] | 76 | !! NEMO/OFF 4.0 , NEMO Consortium (2018) |
|---|
| [5215] | 77 | !! $Id$ |
|---|
| [10068] | 78 | !! Software governed by the CeCILL license (see ./LICENSE) |
|---|
| [2574] | 79 | !!---------------------------------------------------------------------- |
|---|
| 80 | CONTAINS |
|---|
| 81 | |
|---|
| 82 | SUBROUTINE nemo_gcm |
|---|
| 83 | !!---------------------------------------------------------------------- |
|---|
| 84 | !! *** ROUTINE nemo_gcm *** |
|---|
| 85 | !! |
|---|
| [9213] | 86 | !! ** Purpose : NEMO solves the primitive equations on an orthogonal |
|---|
| 87 | !! curvilinear mesh on the sphere. |
|---|
| [2574] | 88 | !! |
|---|
| 89 | !! ** Method : - model general initialization |
|---|
| 90 | !! - launch the time-stepping (dta_dyn and trc_stp) |
|---|
| 91 | !! - finalize the run by closing files and communications |
|---|
| 92 | !! |
|---|
| 93 | !! References : Madec, Delecluse,Imbard, and Levy, 1997: internal report, IPSL. |
|---|
| 94 | !! Madec, 2008, internal report, IPSL. |
|---|
| 95 | !!---------------------------------------------------------------------- |
|---|
| 96 | INTEGER :: istp, indic ! time step index |
|---|
| 97 | !!---------------------------------------------------------------------- |
|---|
| 98 | |
|---|
| 99 | CALL nemo_init ! Initializations |
|---|
| 100 | |
|---|
| 101 | ! check that all process are still there... If some process have an error, |
|---|
| 102 | ! they will never enter in step and other processes will wait until the end of the cpu time! |
|---|
| [10425] | 103 | CALL mpp_max( 'nemogcm', nstop ) |
|---|
| [2574] | 104 | |
|---|
| 105 | ! !-----------------------! |
|---|
| 106 | ! !== time stepping ==! |
|---|
| 107 | ! !-----------------------! |
|---|
| 108 | istp = nit000 |
|---|
| [6140] | 109 | ! |
|---|
| [9213] | 110 | IF( ln_rnf ) CALL sbc_rnf(istp) ! runoffs initialization |
|---|
| [3827] | 111 | ! |
|---|
| [9213] | 112 | CALL iom_init( cxios_context ) ! iom_put initialization (must be done after nemo_init for AGRIF+XIOS+OASIS) |
|---|
| [3827] | 113 | ! |
|---|
| [9213] | 114 | DO WHILE ( istp <= nitend .AND. nstop == 0 ) !== OFF time-stepping ==! |
|---|
| [2574] | 115 | ! |
|---|
| [7646] | 116 | IF( istp /= nit000 ) CALL day ( istp ) ! Calendar (day was already called at nit000 in day_init) |
|---|
| [9539] | 117 | CALL iom_setkt ( istp - nit000 + 1, cxios_context ) ! say to iom that we are at time step kstp |
|---|
| [10222] | 118 | #if defined key_sed_off |
|---|
| [10921] | 119 | CALL dta_dyn_sed( istp, Nnn ) ! Interpolation of the dynamical fields |
|---|
| [10222] | 120 | #else |
|---|
| [10921] | 121 | CALL dta_dyn ( istp, Nbb, Nnn, Naa ) ! Interpolation of the dynamical fields |
|---|
| 122 | IF( .NOT.ln_linssh ) CALL dta_dyn_swp( istp, Nbb, Nnn, Naa ) ! swap of sea surface height and vertical scale factors |
|---|
| [10222] | 123 | #endif |
|---|
| [10921] | 124 | CALL trc_stp ( istp, Nbb, Nnn, Nrhs, Naa ) ! time-stepping |
|---|
| [7646] | 125 | CALL stp_ctl ( istp, indic ) ! Time loop: control and print |
|---|
| [2574] | 126 | istp = istp + 1 |
|---|
| 127 | END DO |
|---|
| [9213] | 128 | ! |
|---|
| [3769] | 129 | #if defined key_iomput |
|---|
| [5504] | 130 | CALL iom_context_finalize( cxios_context ) ! needed for XIOS+AGRIF |
|---|
| [3769] | 131 | #endif |
|---|
| [2574] | 132 | |
|---|
| 133 | ! !------------------------! |
|---|
| 134 | ! !== finalize the run ==! |
|---|
| 135 | ! !------------------------! |
|---|
| 136 | IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA |
|---|
| 137 | |
|---|
| 138 | IF( nstop /= 0 .AND. lwp ) THEN ! error print |
|---|
| 139 | WRITE(numout,cform_err) |
|---|
| [9213] | 140 | WRITE(numout,*) ' ==>>> nemo_gcm: a total of ', nstop, ' errors have been found' |
|---|
| 141 | WRITE(numout,*) |
|---|
| [2574] | 142 | ENDIF |
|---|
| 143 | ! |
|---|
| [9124] | 144 | IF( ln_timing ) CALL timing_finalize |
|---|
| [3294] | 145 | ! |
|---|
| [2574] | 146 | CALL nemo_closefile |
|---|
| 147 | ! |
|---|
| [9213] | 148 | #if defined key_iomput |
|---|
| 149 | CALL xios_finalize ! end mpp communications with xios |
|---|
| 150 | #else |
|---|
| 151 | IF( lk_mpp ) CALL mppstop ! end mpp communications |
|---|
| 152 | #endif |
|---|
| [2574] | 153 | ! |
|---|
| 154 | END SUBROUTINE nemo_gcm |
|---|
| 155 | |
|---|
| 156 | |
|---|
| 157 | SUBROUTINE nemo_init |
|---|
| 158 | !!---------------------------------------------------------------------- |
|---|
| [9213] | 159 | !! *** ROUTINE nemo_init *** |
|---|
| [2574] | 160 | !! |
|---|
| 161 | !! ** Purpose : initialization of the nemo model in off-line mode |
|---|
| 162 | !!---------------------------------------------------------------------- |
|---|
| [9019] | 163 | INTEGER :: ji ! dummy loop indices |
|---|
| [9213] | 164 | INTEGER :: ios, ilocal_comm ! local integers |
|---|
| [7646] | 165 | CHARACTER(len=120), DIMENSION(30) :: cltxt, cltxt2, clnam |
|---|
| [2574] | 166 | !! |
|---|
| [10570] | 167 | NAMELIST/namctl/ ln_ctl , sn_cfctl, nn_print, nn_ictls, nn_ictle, & |
|---|
| 168 | & nn_isplt , nn_jsplt, nn_jctls, nn_jctle, & |
|---|
| [9019] | 169 | & ln_timing, ln_diacfl |
|---|
| [9213] | 170 | NAMELIST/namcfg/ ln_read_cfg, cn_domcfg, ln_closea, ln_write_cfg, cn_domcfg_out, ln_use_jattr |
|---|
| [2574] | 171 | !!---------------------------------------------------------------------- |
|---|
| [9213] | 172 | ! |
|---|
| [7646] | 173 | cltxt = '' |
|---|
| 174 | cltxt2 = '' |
|---|
| 175 | clnam = '' |
|---|
| [5407] | 176 | cxios_context = 'nemo' |
|---|
| [3716] | 177 | ! |
|---|
| [4147] | 178 | ! ! Open reference namelist and configuration namelist files |
|---|
| 179 | CALL ctl_opn( numnam_ref, 'namelist_ref', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. ) |
|---|
| 180 | CALL ctl_opn( numnam_cfg, 'namelist_cfg', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. ) |
|---|
| [2574] | 181 | ! |
|---|
| [9213] | 182 | REWIND( numnam_ref ) ! Namelist namctl in reference namelist |
|---|
| [4147] | 183 | READ ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 ) |
|---|
| [9169] | 184 | 901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in reference namelist', .TRUE. ) |
|---|
| [9213] | 185 | REWIND( numnam_cfg ) ! Namelist namctl in confguration namelist |
|---|
| [4147] | 186 | READ ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 ) |
|---|
| [9169] | 187 | 902 IF( ios > 0 ) CALL ctl_nam ( ios , 'namctl in configuration namelist', .TRUE. ) |
|---|
| [4147] | 188 | ! |
|---|
| [9213] | 189 | REWIND( numnam_ref ) ! Namelist namcfg in reference namelist |
|---|
| [4147] | 190 | READ ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 ) |
|---|
| [9169] | 191 | 903 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in reference namelist', .TRUE. ) |
|---|
| [9213] | 192 | REWIND( numnam_cfg ) ! Namelist namcfg in confguration namelist |
|---|
| [4147] | 193 | READ ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 ) |
|---|
| [9169] | 194 | 904 IF( ios > 0 ) CALL ctl_nam ( ios , 'namcfg in configuration namelist', .TRUE. ) |
|---|
| [4290] | 195 | |
|---|
| [7646] | 196 | ! !--------------------------! |
|---|
| 197 | ! ! Set global domain size ! (control print return in cltxt2) |
|---|
| [9213] | 198 | ! !--------------------------! |
|---|
| [7646] | 199 | IF( ln_read_cfg ) THEN ! Read sizes in domain configuration file |
|---|
| 200 | CALL domain_cfg ( cltxt2, cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio ) |
|---|
| 201 | ! |
|---|
| 202 | ELSE ! user-defined namelist |
|---|
| 203 | CALL usr_def_nam( cltxt2, clnam, cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio ) |
|---|
| 204 | ENDIF |
|---|
| 205 | ! |
|---|
| [9213] | 206 | l_offline = .true. ! passive tracers are run offline |
|---|
| [7646] | 207 | ! |
|---|
| [2574] | 208 | ! !--------------------------------------------! |
|---|
| 209 | ! ! set communicator & select the local node ! |
|---|
| [4624] | 210 | ! ! NB: mynode also opens output.namelist.dyn ! |
|---|
| 211 | ! ! on unit number numond on first proc ! |
|---|
| [2574] | 212 | ! !--------------------------------------------! |
|---|
| 213 | #if defined key_iomput |
|---|
| [5504] | 214 | CALL xios_initialize( "for_xios_mpi_id",return_comm=ilocal_comm ) |
|---|
| [5407] | 215 | narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm ) ! Nodes selection |
|---|
| [2574] | 216 | #else |
|---|
| [2715] | 217 | ilocal_comm = 0 |
|---|
| [5407] | 218 | narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop ) ! Nodes selection (control print return in cltxt) |
|---|
| [2574] | 219 | #endif |
|---|
| [2715] | 220 | |
|---|
| [2574] | 221 | narea = narea + 1 ! mynode return the rank of proc (0 --> jpnij -1 ) |
|---|
| 222 | |
|---|
| [10570] | 223 | IF( sn_cfctl%l_config ) THEN |
|---|
| 224 | ! Activate finer control of report outputs |
|---|
| 225 | ! optionally switch off output from selected areas (note this only |
|---|
| 226 | ! applies to output which does not involve global communications) |
|---|
| 227 | IF( ( narea < sn_cfctl%procmin .OR. narea > sn_cfctl%procmax ) .OR. & |
|---|
| 228 | & ( MOD( narea - sn_cfctl%procmin, sn_cfctl%procincr ) /= 0 ) ) & |
|---|
| 229 | & CALL nemo_set_cfctl( sn_cfctl, .FALSE., .FALSE. ) |
|---|
| 230 | ELSE |
|---|
| 231 | ! Use ln_ctl to turn on or off all options. |
|---|
| 232 | CALL nemo_set_cfctl( sn_cfctl, ln_ctl, .TRUE. ) |
|---|
| 233 | ENDIF |
|---|
| 234 | |
|---|
| [4624] | 235 | lwm = (narea == 1) ! control of output namelists |
|---|
| [2574] | 236 | lwp = (narea == 1) .OR. ln_ctl ! control of all listing output print |
|---|
| 237 | |
|---|
| [9213] | 238 | IF(lwm) THEN ! write merged namelists from earlier to output namelist |
|---|
| 239 | ! ! now that the file has been opened in call to mynode. |
|---|
| 240 | ! ! NB: nammpp has already been written in mynode (if lk_mpp_mpi) |
|---|
| [4624] | 241 | WRITE( numond, namctl ) |
|---|
| 242 | WRITE( numond, namcfg ) |
|---|
| [7646] | 243 | IF( .NOT.ln_read_cfg ) THEN |
|---|
| 244 | DO ji = 1, SIZE(clnam) |
|---|
| [9213] | 245 | IF( TRIM(clnam(ji)) /= '' ) WRITE(numond, * ) clnam(ji) ! namusr_def print |
|---|
| [7646] | 246 | END DO |
|---|
| 247 | ENDIF |
|---|
| [4624] | 248 | ENDIF |
|---|
| 249 | |
|---|
| [2574] | 250 | IF(lwp) THEN ! open listing units |
|---|
| 251 | ! |
|---|
| 252 | CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE., narea ) |
|---|
| 253 | ! |
|---|
| 254 | WRITE(numout,*) |
|---|
| [3680] | 255 | WRITE(numout,*) ' CNRS - NERC - Met OFFICE - MERCATOR-ocean - INGV - CMCC' |
|---|
| [2574] | 256 | WRITE(numout,*) ' NEMO team' |
|---|
| [9213] | 257 | WRITE(numout,*) ' Off-line TOP Model' |
|---|
| [10570] | 258 | WRITE(numout,*) ' NEMO version 4.0 (2019) ' |
|---|
| [2574] | 259 | WRITE(numout,*) |
|---|
| [10570] | 260 | WRITE(numout,*) " ._ ._ ._ ._ ._ " |
|---|
| 261 | WRITE(numout,*) " _.-._)`\_.-._)`\_.-._)`\_.-._)`\_.-._)`\_ " |
|---|
| [2574] | 262 | WRITE(numout,*) |
|---|
| [10570] | 263 | WRITE(numout,*) " o _, _, " |
|---|
| 264 | WRITE(numout,*) " o .' ( .-' / " |
|---|
| 265 | WRITE(numout,*) " o _/..._'. .' / " |
|---|
| 266 | WRITE(numout,*) " ( o .-'` ` '-./ _.' " |
|---|
| 267 | WRITE(numout,*) " ) ( o) ;= <_ ( " |
|---|
| 268 | WRITE(numout,*) " ( '-.,\\__ __.-;`\ '. ) " |
|---|
| 269 | WRITE(numout,*) " ) ) \) |`\ \) '. \ ( ( " |
|---|
| 270 | WRITE(numout,*) " ( ( \_/ '-._\ ) ) " |
|---|
| 271 | WRITE(numout,*) " ) ) ` ( ( " |
|---|
| 272 | WRITE(numout,*) " ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ " |
|---|
| 273 | WRITE(numout,*) |
|---|
| [9213] | 274 | DO ji = 1, SIZE(cltxt) |
|---|
| [10570] | 275 | IF( TRIM(cltxt (ji)) /= '' ) WRITE(numout,*) TRIM(cltxt(ji)) ! control print of mynode |
|---|
| [2574] | 276 | END DO |
|---|
| [9213] | 277 | WRITE(numout,*) |
|---|
| 278 | WRITE(numout,*) |
|---|
| 279 | DO ji = 1, SIZE(cltxt2) |
|---|
| [10570] | 280 | IF( TRIM(cltxt2(ji)) /= '' ) WRITE(numout,*) TRIM(cltxt2(ji)) ! control print of domain size |
|---|
| [9213] | 281 | END DO |
|---|
| [2574] | 282 | ! |
|---|
| [9213] | 283 | WRITE(numout,cform_aaa) ! Flag AAAAAAA |
|---|
| 284 | ! |
|---|
| [2574] | 285 | ENDIF |
|---|
| [10457] | 286 | ! open /dev/null file to be able to supress output write easily |
|---|
| 287 | CALL ctl_opn( numnul, '/dev/null', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. ) |
|---|
| 288 | ! |
|---|
| [9436] | 289 | ! ! Domain decomposition |
|---|
| 290 | CALL mpp_init ! MPP |
|---|
| [2715] | 291 | |
|---|
| [9213] | 292 | ! Now we know the dimensions of the grid and numout has been set: we can allocate arrays |
|---|
| [2715] | 293 | CALL nemo_alloc() |
|---|
| 294 | |
|---|
| [10905] | 295 | ! Initialise time level indices |
|---|
| 296 | Nbb = 1; Nnn = 2; Naa = 3; Nrhs = Naa |
|---|
| 297 | |
|---|
| 298 | ! Initialisation of temporary pointers (to be deleted after development finished) |
|---|
| 299 | CALL update_pointers( Nbb, Nnn, Naa ) |
|---|
| 300 | |
|---|
| [9213] | 301 | ! !-------------------------------! |
|---|
| 302 | ! ! NEMO general initialization ! |
|---|
| 303 | ! !-------------------------------! |
|---|
| [2574] | 304 | |
|---|
| [9213] | 305 | CALL nemo_ctl ! Control prints |
|---|
| [2574] | 306 | ! |
|---|
| [9213] | 307 | ! ! General initialization |
|---|
| [9019] | 308 | IF( ln_timing ) CALL timing_init |
|---|
| 309 | IF( ln_timing ) CALL timing_start( 'nemo_init') |
|---|
| [3294] | 310 | ! |
|---|
| [9367] | 311 | CALL phy_cst ! Physical constants |
|---|
| 312 | CALL eos_init ! Equation of state |
|---|
| 313 | IF( lk_c1d ) CALL c1d_init ! 1D column configuration |
|---|
| [10978] | 314 | CALL dom_init( Nbb, Nnn, Naa, "OPA") ! Domain |
|---|
| [9367] | 315 | IF( ln_ctl ) CALL prt_ctl_init ! Print control |
|---|
| [7646] | 316 | |
|---|
| [10928] | 317 | CALL istate_init( Nnn, Naa ) ! ocean initial state (Dynamics and tracers) |
|---|
| [7646] | 318 | |
|---|
| [10922] | 319 | CALL sbc_init( Nbb, Nnn ) ! Forcings : surface module |
|---|
| [2574] | 320 | |
|---|
| [9213] | 321 | ! ! Tracer physics |
|---|
| 322 | CALL ldf_tra_init ! Lateral ocean tracer physics |
|---|
| 323 | CALL ldf_eiv_init ! Eddy induced velocity param |
|---|
| 324 | CALL tra_ldf_init ! lateral mixing |
|---|
| 325 | IF( l_ldfslp ) CALL ldf_slp_init ! slope of lateral mixing |
|---|
| [9751] | 326 | IF( ln_traqsr ) CALL tra_qsr_init ! penetrative solar radiation |
|---|
| [9213] | 327 | IF( ln_trabbl ) CALL tra_bbl_init ! advective (and/or diffusive) bottom boundary layer scheme |
|---|
| [2715] | 328 | |
|---|
| [9213] | 329 | ! ! Passive tracers |
|---|
| [9019] | 330 | CALL trc_nam_run ! Needed to get restart parameters for passive tracers |
|---|
| 331 | CALL trc_rst_cal( nit000, 'READ' ) ! calendar |
|---|
| [10222] | 332 | #if defined key_sed_off |
|---|
| [10921] | 333 | CALL dta_dyn_sed_init( Nnn ) ! Initialization for the dynamics |
|---|
| [10222] | 334 | #else |
|---|
| [10921] | 335 | CALL dta_dyn_init( Nbb, Nnn, Naa ) ! Initialization for the dynamics |
|---|
| [10222] | 336 | #endif |
|---|
| [2574] | 337 | |
|---|
| [10905] | 338 | CALL trc_init( Nbb, Nnn, Naa ) ! Passive tracers initialization |
|---|
| [9213] | 339 | CALL dia_ptr_init ! Poleward TRansports initialization |
|---|
| 340 | |
|---|
| [5504] | 341 | IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA |
|---|
| [4749] | 342 | ! |
|---|
| [9019] | 343 | IF( ln_timing ) CALL timing_stop( 'nemo_init') |
|---|
| [3294] | 344 | ! |
|---|
| [2574] | 345 | END SUBROUTINE nemo_init |
|---|
| 346 | |
|---|
| 347 | |
|---|
| 348 | SUBROUTINE nemo_ctl |
|---|
| 349 | !!---------------------------------------------------------------------- |
|---|
| 350 | !! *** ROUTINE nemo_ctl *** |
|---|
| 351 | !! |
|---|
| [7646] | 352 | !! ** Purpose : control print setting |
|---|
| [2574] | 353 | !! |
|---|
| 354 | !! ** Method : - print namctl information and check some consistencies |
|---|
| 355 | !!---------------------------------------------------------------------- |
|---|
| 356 | ! |
|---|
| [7646] | 357 | IF(lwp) THEN ! control print |
|---|
| [2574] | 358 | WRITE(numout,*) |
|---|
| [7646] | 359 | WRITE(numout,*) 'nemo_ctl: Control prints' |
|---|
| [9213] | 360 | WRITE(numout,*) '~~~~~~~~' |
|---|
| [2574] | 361 | WRITE(numout,*) ' Namelist namctl' |
|---|
| 362 | WRITE(numout,*) ' run control (for debugging) ln_ctl = ', ln_ctl |
|---|
| [10570] | 363 | WRITE(numout,*) ' finer control over o/p sn_cfctl%l_config = ', sn_cfctl%l_config |
|---|
| 364 | WRITE(numout,*) ' sn_cfctl%l_runstat = ', sn_cfctl%l_runstat |
|---|
| 365 | WRITE(numout,*) ' sn_cfctl%l_trcstat = ', sn_cfctl%l_trcstat |
|---|
| 366 | WRITE(numout,*) ' sn_cfctl%l_oceout = ', sn_cfctl%l_oceout |
|---|
| 367 | WRITE(numout,*) ' sn_cfctl%l_layout = ', sn_cfctl%l_layout |
|---|
| 368 | WRITE(numout,*) ' sn_cfctl%l_mppout = ', sn_cfctl%l_mppout |
|---|
| 369 | WRITE(numout,*) ' sn_cfctl%l_mpptop = ', sn_cfctl%l_mpptop |
|---|
| 370 | WRITE(numout,*) ' sn_cfctl%procmin = ', sn_cfctl%procmin |
|---|
| 371 | WRITE(numout,*) ' sn_cfctl%procmax = ', sn_cfctl%procmax |
|---|
| 372 | WRITE(numout,*) ' sn_cfctl%procincr = ', sn_cfctl%procincr |
|---|
| 373 | WRITE(numout,*) ' sn_cfctl%ptimincr = ', sn_cfctl%ptimincr |
|---|
| [2574] | 374 | WRITE(numout,*) ' level of print nn_print = ', nn_print |
|---|
| 375 | WRITE(numout,*) ' Start i indice for SUM control nn_ictls = ', nn_ictls |
|---|
| 376 | WRITE(numout,*) ' End i indice for SUM control nn_ictle = ', nn_ictle |
|---|
| 377 | WRITE(numout,*) ' Start j indice for SUM control nn_jctls = ', nn_jctls |
|---|
| 378 | WRITE(numout,*) ' End j indice for SUM control nn_jctle = ', nn_jctle |
|---|
| 379 | WRITE(numout,*) ' number of proc. following i nn_isplt = ', nn_isplt |
|---|
| 380 | WRITE(numout,*) ' number of proc. following j nn_jsplt = ', nn_jsplt |
|---|
| [9019] | 381 | WRITE(numout,*) ' timing by routine ln_timing = ', ln_timing |
|---|
| 382 | WRITE(numout,*) ' CFL diagnostics ln_diacfl = ', ln_diacfl |
|---|
| [2574] | 383 | ENDIF |
|---|
| 384 | ! |
|---|
| 385 | nprint = nn_print ! convert DOCTOR namelist names into OLD names |
|---|
| 386 | nictls = nn_ictls |
|---|
| 387 | nictle = nn_ictle |
|---|
| 388 | njctls = nn_jctls |
|---|
| 389 | njctle = nn_jctle |
|---|
| 390 | isplt = nn_isplt |
|---|
| 391 | jsplt = nn_jsplt |
|---|
| [7646] | 392 | |
|---|
| 393 | IF(lwp) THEN ! control print |
|---|
| [4147] | 394 | WRITE(numout,*) |
|---|
| 395 | WRITE(numout,*) ' Namelist namcfg' |
|---|
| [9213] | 396 | WRITE(numout,*) ' read domain configuration file ln_read_cfg = ', ln_read_cfg |
|---|
| [7646] | 397 | WRITE(numout,*) ' filename to be read cn_domcfg = ', TRIM(cn_domcfg) |
|---|
| [9436] | 398 | WRITE(numout,*) ' keep closed seas in the domain (if exist) ln_closea = ', ln_closea |
|---|
| [9213] | 399 | WRITE(numout,*) ' create a configuration definition file ln_write_cfg = ', ln_write_cfg |
|---|
| [7646] | 400 | WRITE(numout,*) ' filename to be written cn_domcfg_out = ', TRIM(cn_domcfg_out) |
|---|
| 401 | WRITE(numout,*) ' use file attribute if exists as i/p j-start ln_use_jattr = ', ln_use_jattr |
|---|
| [4147] | 402 | ENDIF |
|---|
| [9213] | 403 | IF( .NOT.ln_read_cfg ) ln_closea = .false. ! dealing possible only with a domcfg file |
|---|
| 404 | ! |
|---|
| [2574] | 405 | ! ! Parameter control |
|---|
| 406 | ! |
|---|
| 407 | IF( ln_ctl ) THEN ! sub-domain area indices for the control prints |
|---|
| [7646] | 408 | IF( lk_mpp .AND. jpnij > 1 ) THEN |
|---|
| 409 | isplt = jpni ; jsplt = jpnj ; ijsplt = jpni*jpnj ! the domain is forced to the real split domain |
|---|
| [2574] | 410 | ELSE |
|---|
| 411 | IF( isplt == 1 .AND. jsplt == 1 ) THEN |
|---|
| 412 | CALL ctl_warn( ' - isplt & jsplt are equal to 1', & |
|---|
| 413 | & ' - the print control will be done over the whole domain' ) |
|---|
| 414 | ENDIF |
|---|
| 415 | ijsplt = isplt * jsplt ! total number of processors ijsplt |
|---|
| 416 | ENDIF |
|---|
| 417 | IF(lwp) WRITE(numout,*)' - The total number of processors over which the' |
|---|
| 418 | IF(lwp) WRITE(numout,*)' print control will be done is ijsplt : ', ijsplt |
|---|
| 419 | ! |
|---|
| 420 | ! ! indices used for the SUM control |
|---|
| 421 | IF( nictls+nictle+njctls+njctle == 0 ) THEN ! print control done over the default area |
|---|
| 422 | lsp_area = .FALSE. |
|---|
| 423 | ELSE ! print control done over a specific area |
|---|
| 424 | lsp_area = .TRUE. |
|---|
| 425 | IF( nictls < 1 .OR. nictls > jpiglo ) THEN |
|---|
| 426 | CALL ctl_warn( ' - nictls must be 1<=nictls>=jpiglo, it is forced to 1' ) |
|---|
| 427 | nictls = 1 |
|---|
| 428 | ENDIF |
|---|
| 429 | IF( nictle < 1 .OR. nictle > jpiglo ) THEN |
|---|
| 430 | CALL ctl_warn( ' - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' ) |
|---|
| 431 | nictle = jpiglo |
|---|
| 432 | ENDIF |
|---|
| 433 | IF( njctls < 1 .OR. njctls > jpjglo ) THEN |
|---|
| 434 | CALL ctl_warn( ' - njctls must be 1<=njctls>=jpjglo, it is forced to 1' ) |
|---|
| 435 | njctls = 1 |
|---|
| 436 | ENDIF |
|---|
| 437 | IF( njctle < 1 .OR. njctle > jpjglo ) THEN |
|---|
| 438 | CALL ctl_warn( ' - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' ) |
|---|
| 439 | njctle = jpjglo |
|---|
| 440 | ENDIF |
|---|
| 441 | ENDIF |
|---|
| 442 | ENDIF |
|---|
| 443 | ! |
|---|
| [9213] | 444 | IF( 1._wp /= SIGN(1._wp,-0._wp) ) CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows f2003 standard.', & |
|---|
| 445 | & 'Compile with key_nosignedzero enabled' ) |
|---|
| [3764] | 446 | ! |
|---|
| [2574] | 447 | END SUBROUTINE nemo_ctl |
|---|
| 448 | |
|---|
| 449 | |
|---|
| 450 | SUBROUTINE nemo_closefile |
|---|
| 451 | !!---------------------------------------------------------------------- |
|---|
| 452 | !! *** ROUTINE nemo_closefile *** |
|---|
| 453 | !! |
|---|
| 454 | !! ** Purpose : Close the files |
|---|
| 455 | !!---------------------------------------------------------------------- |
|---|
| 456 | ! |
|---|
| [9213] | 457 | IF( lk_mpp ) CALL mppsync |
|---|
| [2574] | 458 | ! |
|---|
| 459 | CALL iom_close ! close all input/output files managed by iom_* |
|---|
| 460 | ! |
|---|
| 461 | IF( numstp /= -1 ) CLOSE( numstp ) ! time-step file |
|---|
| [4147] | 462 | IF( numnam_ref /= -1 ) CLOSE( numnam_ref ) ! oce reference namelist |
|---|
| 463 | IF( numnam_cfg /= -1 ) CLOSE( numnam_cfg ) ! oce configuration namelist |
|---|
| [2574] | 464 | IF( numout /= 6 ) CLOSE( numout ) ! standard model output file |
|---|
| [7646] | 465 | IF( lwm.AND.numond /= -1 ) CLOSE( numond ) ! oce output namelist |
|---|
| [9213] | 466 | ! |
|---|
| [2574] | 467 | numout = 6 ! redefine numout in case it is used after this point... |
|---|
| 468 | ! |
|---|
| 469 | END SUBROUTINE nemo_closefile |
|---|
| 470 | |
|---|
| [2715] | 471 | |
|---|
| 472 | SUBROUTINE nemo_alloc |
|---|
| 473 | !!---------------------------------------------------------------------- |
|---|
| 474 | !! *** ROUTINE nemo_alloc *** |
|---|
| 475 | !! |
|---|
| 476 | !! ** Purpose : Allocate all the dynamic arrays of the OPA modules |
|---|
| 477 | !! |
|---|
| 478 | !! ** Method : |
|---|
| 479 | !!---------------------------------------------------------------------- |
|---|
| [9213] | 480 | USE diawri , ONLY : dia_wri_alloc |
|---|
| 481 | USE dom_oce, ONLY : dom_oce_alloc |
|---|
| 482 | USE zdf_oce, ONLY : zdf_oce_alloc |
|---|
| 483 | USE trc_oce, ONLY : trc_oce_alloc |
|---|
| [2715] | 484 | ! |
|---|
| 485 | INTEGER :: ierr |
|---|
| 486 | !!---------------------------------------------------------------------- |
|---|
| 487 | ! |
|---|
| [9213] | 488 | ierr = oce_alloc () ! ocean |
|---|
| 489 | ierr = ierr + dia_wri_alloc() |
|---|
| 490 | ierr = ierr + dom_oce_alloc() ! ocean domain |
|---|
| 491 | ierr = ierr + zdf_oce_alloc() ! ocean vertical physics |
|---|
| 492 | ierr = ierr + trc_oce_alloc() ! shared TRC / TRA arrays |
|---|
| [2715] | 493 | ! |
|---|
| [10425] | 494 | CALL mpp_sum( 'nemogcm', ierr ) |
|---|
| [2715] | 495 | IF( ierr /= 0 ) CALL ctl_stop( 'STOP', 'nemo_alloc: unable to allocate standard ocean arrays' ) |
|---|
| 496 | ! |
|---|
| 497 | END SUBROUTINE nemo_alloc |
|---|
| 498 | |
|---|
| [10570] | 499 | SUBROUTINE nemo_set_cfctl(sn_cfctl, setto, for_all ) |
|---|
| 500 | !!---------------------------------------------------------------------- |
|---|
| 501 | !! *** ROUTINE nemo_set_cfctl *** |
|---|
| 502 | !! |
|---|
| 503 | !! ** Purpose : Set elements of the output control structure to setto. |
|---|
| 504 | !! for_all should be .false. unless all areas are to be |
|---|
| 505 | !! treated identically. |
|---|
| 506 | !! |
|---|
| 507 | !! ** Method : Note this routine can be used to switch on/off some |
|---|
| 508 | !! types of output for selected areas but any output types |
|---|
| 509 | !! that involve global communications (e.g. mpp_max, glob_sum) |
|---|
| 510 | !! should be protected from selective switching by the |
|---|
| 511 | !! for_all argument |
|---|
| 512 | !!---------------------------------------------------------------------- |
|---|
| 513 | LOGICAL :: setto, for_all |
|---|
| [10601] | 514 | TYPE(sn_ctl) :: sn_cfctl |
|---|
| [10570] | 515 | !!---------------------------------------------------------------------- |
|---|
| 516 | IF( for_all ) THEN |
|---|
| 517 | sn_cfctl%l_runstat = setto |
|---|
| 518 | sn_cfctl%l_trcstat = setto |
|---|
| 519 | ENDIF |
|---|
| 520 | sn_cfctl%l_oceout = setto |
|---|
| 521 | sn_cfctl%l_layout = setto |
|---|
| 522 | sn_cfctl%l_mppout = setto |
|---|
| 523 | sn_cfctl%l_mpptop = setto |
|---|
| 524 | END SUBROUTINE nemo_set_cfctl |
|---|
| 525 | |
|---|
| [10928] | 526 | SUBROUTINE istate_init( Kmm, Kaa ) |
|---|
| [5504] | 527 | !!---------------------------------------------------------------------- |
|---|
| 528 | !! *** ROUTINE istate_init *** |
|---|
| 529 | !! |
|---|
| 530 | !! ** Purpose : Initialization to zero of the dynamics and tracers. |
|---|
| 531 | !!---------------------------------------------------------------------- |
|---|
| [10928] | 532 | INTEGER, INTENT(in) :: Kmm, Kaa ! ocean time level indices |
|---|
| [5504] | 533 | ! |
|---|
| 534 | ! now fields ! after fields ! |
|---|
| [10928] | 535 | uu (:,:,:,Kmm) = 0._wp ; uu(:,:,:,Kaa) = 0._wp ! |
|---|
| 536 | vv (:,:,:,Kmm) = 0._wp ; vv(:,:,:,Kaa) = 0._wp ! |
|---|
| 537 | ww (:,:,:) = 0._wp ! ! |
|---|
| [5504] | 538 | hdivn(:,:,:) = 0._wp ! ! |
|---|
| [10928] | 539 | ts (:,:,:,:,Kmm) = 0._wp ! ! |
|---|
| [5504] | 540 | ! |
|---|
| 541 | rhd (:,:,:) = 0.e0 |
|---|
| 542 | rhop (:,:,:) = 0.e0 |
|---|
| 543 | rn2 (:,:,:) = 0.e0 |
|---|
| 544 | ! |
|---|
| 545 | END SUBROUTINE istate_init |
|---|
| 546 | |
|---|
| [9213] | 547 | |
|---|
| [5504] | 548 | SUBROUTINE stp_ctl( kt, kindic ) |
|---|
| 549 | !!---------------------------------------------------------------------- |
|---|
| 550 | !! *** ROUTINE stp_ctl *** |
|---|
| 551 | !! |
|---|
| 552 | !! ** Purpose : Control the run |
|---|
| 553 | !! |
|---|
| 554 | !! ** Method : - Save the time step in numstp |
|---|
| 555 | !! |
|---|
| 556 | !! ** Actions : 'time.step' file containing the last ocean time-step |
|---|
| 557 | !!---------------------------------------------------------------------- |
|---|
| 558 | INTEGER, INTENT(in ) :: kt ! ocean time-step index |
|---|
| 559 | INTEGER, INTENT(inout) :: kindic ! indicator of solver convergence |
|---|
| 560 | !!---------------------------------------------------------------------- |
|---|
| 561 | ! |
|---|
| [10425] | 562 | IF( kt == nit000 .AND. lwm ) THEN |
|---|
| [5504] | 563 | WRITE(numout,*) |
|---|
| 564 | WRITE(numout,*) 'stp_ctl : time-stepping control' |
|---|
| 565 | WRITE(numout,*) '~~~~~~~' |
|---|
| 566 | ! open time.step file |
|---|
| 567 | CALL ctl_opn( numstp, 'time.step', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, numout, lwp, narea ) |
|---|
| 568 | ENDIF |
|---|
| 569 | ! |
|---|
| [10425] | 570 | IF(lwm) WRITE ( numstp, '(1x, i8)' ) kt !* save the current time step in numstp |
|---|
| 571 | IF(lwm) REWIND( numstp ) ! -------------------------- |
|---|
| [5504] | 572 | ! |
|---|
| 573 | END SUBROUTINE stp_ctl |
|---|
| [2574] | 574 | !!====================================================================== |
|---|
| 575 | END MODULE nemogcm |
|---|
