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